Gathering detailed insights and metrics for @vtex/phosphor-icons
Gathering detailed insights and metrics for @vtex/phosphor-icons
Installations
npm install @vtex/phosphor-iconsDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=10
Node Version
16.14.2
NPM Version
8.5.0
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
50
Package Meta Information
Latest Version
0.2.8
Package Id
@vtex/phosphor-icons@0.2.8
Unpacked Size
16.87 MB
Size
1.76 MB
File Count
1,814
NPM Version
8.5.0
Node Version
16.14.2
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
48
@babel/core@babel/plugin-proposal-class-properties@babel/plugin-proposal-object-rest-spread@babel/plugin-proposal-optional-chaining@babel/preset-env@babel/preset-react@babel/preset-typescript@commitlint/cli@commitlint/config-conventional@commitlint/prompt@rollup/plugin-url@storybook/addon-actions@storybook/addon-essentials@storybook/addon-links@storybook/react@testing-library/jest-dom@testing-library/react@testing-library/react-hooks@testing-library/user-event@types/jest-axe@types/react@types/react-dom@types/testing-library__jest-dom@typescript-eslint/eslint-plugin@typescript-eslint/parser@vtex/prettier-config@vtex/tsconfigbabel-loaderbabel-plugin-macrosbabel-plugin-module-resolverchalkcommitizeneslinteslint-config-vtexeslint-config-vtex-reacteslint-plugin-graphqleslint-plugin-importeslint-plugin-jesteslint-plugin-tschuskyjest-axelint-stagedprettierreactreact-domstandard-versiontsdxtypescript
VTEX Phosphor Icons
Reach us on #admin-ui channel on Slack | Tag us with @dev-team-admin on Slack
Icons library based on phosphor-icons React library.
Usage
1yarn add @vtex/phosphor-icons
Development
- Clone the repository.
- Install the project dependencies by running
yarn - Generate the icons by running
yarn generate
Add/edit or remove an icon.
All of the vtex.phosphor-icons are auto-generated so, every time you want to change some asset of the library you must change directly under the /assets folder. Be careful to maintain the same code style.
Add/edit or remove functionalities.
If you want to add a behavioral change to the project, you probably will need to apply changes to a file under the /lib folder or under the /bin folder.
The /lib is where you find everything related to the "IconBase" used to generate the icons.
The /bin is where you find everything related to the script that generates the React files.
Generating icons
Every time you make changes to the /bin or the /assets folder, you must generate the icons. To this, you must run yarn generate
Checking your changes live.
We use Storybook as a canvas to check the changes applied. To do this, you only need to run yarn storybook
Publishing new version
To make a publish/release, you must follow these steps:
- Run
yarn generateto generate the icons with the latest version of your local changes. - Run
yarn build. - Run
yarn standard-version -- --release-as minorwhether is a minor oryarn standard-version -- --release-as patchwhether is a patch.
Why forking Phosphor repository?
Forking the original repository allows us to start to build our icons lib on top of the existing ones. It also gives us the flexibility to add/remove or edit anything we want on the codebase.
No vulnerabilities found.
No security vulnerabilities found.