npmpackage.info

@nexite/create-chakra-icons

Transform SVGs to React Chakra UI <Icon /> ✨

1.1.1

MIT

JavaScript

114.96 kB

340 2.9

Installations

npm install @nexite/create-chakra-icons

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.15.0

NPM Version

9.3.1 Score

68.7

Supply Chain

98.4

Quality

75.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

7

Total

502

Closed

189

Merged

306

Issues

Open

8

Total

17

Closed

9

Releases

create-chakra-icons@1.3.0

Published on 12 Sept 2023

@chakra-icons/tabler-icons@1.29.0

Published on 07 Aug 2023

@chakra-icons/octicons@1.18.0

Published on 07 Aug 2023

@chakra-icons/tabler-icons@1.28.0

Published on 27 Jul 2023

@chakra-icons/tabler-icons@1.27.0

Published on 03 Jul 2023

@chakra-icons/tabler-icons@1.26.0

Published on 02 Jul 2023

View all 89 releases

Contributors

Unable to fetch Contributors

View all 10 contributors

Languages

JavaScript

TypeScript

Shell

JavaScript (54.86%)

TypeScript (44.74%)

Shell (0.41%)

Developer

kodingdotninja

Download Statistics

Total Downloads

340

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

99 Stars

499 Commits

10 Forks

3 Watching

8 Branches

10 Contributors

Bundle Size

464.44 kB

Minified

114.96 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.1.1

Package Id

@nexite/create-chakra-icons@1.1.1

Unpacked Size

25.55 kB

Size

7.25 kB

File Count

NPM Version

9.3.1

Node Version

16.15.0

Publised On

01 Mar 2023

Total Downloads

Cumulative downloads

Total Downloads

340

Last day

Compared to previous day

Last week

-20%

Compared to previous week

Last month

62.5%

Compared to previous month

Last year

-71.7%

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@babel/generator @babel/types @svgr/hast-util-to-babel-ast change-case minimist svg-parser

Dev Dependencies

@tooling/tsconfig @tooling/msrconfig eslint eslint-config-kdnj tsup

Versions

Transform SVG to React Chakra UI ✨
from SVG file to CODE

create-chakra-icons

Features

Transform <SVG/> to Chakra-UI Icon Component or Functional createIcon(...).
- <Icon /> Component, See.
- createIcon(...) Functional, See.
Multiple input with directories or files as input value for option -i or --input.
Multiple outputs for each input svg.
Support case in export name declaration (camel|snake|pascal|constant).
Suffix and Prefix for generated code of export name declaration.
Support type annotation when code generated is <Icon />.

Usage

Command Line Arguments

1create-chakra-icons [FLAGS] [OPTIONS] [INPUT]

Flags

1-h, --help      Prints help information
2-V, --version   Prints version information

Options

1-i, --input <PATH>      This option for read the input from PATH of FILE or DIRECTORIES.
2                        [e.g.: -i some/path , -i file.svg]
3-o, --output <PATH>     Writes the output or sets output directory. [default: stdout]
4-n, --name <STRING>     Sets value for `displayName` properties
5                        (*ONLY for pipelines command). [default: Unamed] [e.g. -n "MyIcon"]
6-C, --case <snake|camel|constant|pascal>
7                        Sets for case [snake|camel|constant|pascal] in export named declaration
8                        output. [default: pascal]
9-S, --suffix <STRING>   Sets for suffix in export named declaration.
10-P, --prefix <STRING>   Sets for prefix in export named declaration.
11                        [e.g.: -S "Icon"]
12--ts, --typescript      Sets output as TypeScript code.
13
14--m, --multi             Creates separate output for each input (*ONLY for CLI command).
15
16-T, --type <TYPE>       TYPE:
17                        (F|f). Sets output code with function \`createIcon({...})\`.
18                        (C|c). Sets output code with Component Icon \`(props) => <Icon> {...} </Icon>\`.
19
20                        [e.g.: -T C]
21

Input

1[INPUT]     This option for read the input from PATH of FILE or DIRECTORIES.
2            [e.g.: create-chakra-icons ./MyICON.svg ~/assets]

Examples

Pipelines command:

input in pipe

1echo "
2<svg viewBox=\"0 0 200 200\">
3    <path
4      fill=\"#666\"
5      d=\"M 100, 100 m -75, 0 a 75,75 0 1,0 150,0 a 75,75 0 1,0 -150,0\"
6    />
7  </svg>
8" | create-chakra-icons -n "KodingNinjaIcon"

output in stdout

1import { createIcon } from "@chakra-ui/react";
2export const KodingNinjaIcon = createIcon({
3  displayName: "KodingNinjaIcon",
4  viewBox: "0 0 200 200",
5  d: "M 100, 100 m -75, 0 a 75,75 0 1,0 150,0 a 75,75 0 1,0 -150,0",
6});

Multiple Input

input per-file

1create-chakra-icons  -o Icons.js ./Facebook.svg ./Apple.svg ./Amazon.svg ./Netflix.svg ./Google.svg

input directories

1create-chakra-icons  -o Icons.js ./social-icons

input directories and per-file at the same time

1create-chakra-icons  -o Icons.js ./MyCompany.svg ./social-icons

output will be make in Icons.js (argument -o or --output).

Multiple Output

1create-chakra-icons  -o output_dir ./Facebook.svg ./Apple.svg ./Amazon.svg ./Netflix.svg ./Google.svg --m

output will make files for each svg in output_dir (argument --m or --multi).

Roadmap

TypeScript Support (Type Annotation or Type Definition).
- Only when code generated is <Icon /> component See.
ReScript Support.
Feel free for give me any feedback or feature request (create an issue first).

Maintainer

Rin (@ri7nz)

Contribution

Feel free for making an issue, pull request, or give any feedback. 🙌

Documentation

Write the documentation 📝, you just need to modify comments in lib/*.js.
When you done write the documentation, you just need to run yarn docs in the root repository.
The command yarn docs will modify README.md and see the changes.

LICENSE

See Here

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/pr.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sync.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/sync.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/sync.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/kodingdotninja/chakra-icons/sync.yml/main?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned

0

SAST

Determines if the project uses static code analysis.

Score

2.9

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More