Skip to content
/ pix31 Public

A CLI to add pixelarticons to your React and React Native projects

License

Notifications You must be signed in to change notification settings

c14mx/pix31

Repository files navigation

pix31

A CLI to add pixelarticons to your React and React Native projects.

Dependencies

  • pixelarticons package is required to be installed in your project
  • React web components are built with Tailwind and use tailwindcss, tailwind-merge and tailwindcss-animate
  • React Native components are built with react-native-svg

Getting started

Run the init to install dependencies and create a pix31.json config file.

npx pix31 init

Commands

Use the browse command to open the pixelarticons website on your browser and browse the available icons.

Note: Only the free pixelarticons are available to install with pix31

npx pix31 browse

Use the add command to add icons to your project. Icon names use the same lowercase naming-convention as pixelarticons:

npx pix31 add [pixelarticon-name]

If you type an icon name that doesn't exist, you'll see a suggested list of icons that most closely match your input.

Feedback

If you have feedback or catch a bug open an issue!

Acknowledgments

This project uses SVG icons from pixelarticons.