✨ Iconico / React Icon Library

Commands

Make modifications or add features to the library inside /src, and in /example there is a playground for testing Icons

The recommended workflow is to run the playground in terminal on this way:

npm run start

This builds to /dist and runs the project in watch mode so any edits you save inside src causes a rebuild to /dist.

Then run the example inside another:

cd example
npm i # or yarn to install dependencies
npm start # or yarn start

The default example imports and live reloads whatever is in /dist, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.

To do a one-off build, use npm run build or yarn build.

To run tests, use npm test or yarn test.

Configuration

Code quality is set up for you with prettier, husky, and lint-staged. Adjust the respective fields in package.json accordingly.

Setup Files

This is the folder structure we set up for you:

/example
  index.html
  index.tsx       # test your component here in a demo app
  package.json
  tsconfig.json
/src
  index.tsx       # Modify here
/test
.gitignore
package.json
README.md         # Modify here
tsconfig.json

Named Exports

Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.