@tadashi/base-icon

Everything you need to build a Icon library, powered by @steeze-ui/icons.

Creating a project

Run the command below to create a skeleton project.

# create a new project in the current directory
npx tiged lagden/base-icon#main my-icon-project

Building

Once you've created a project, put the svg files into svg/raw directory.

⚠️ Warning

The file names must be respect the kebab-case convention.

After that, run the command:

npm run build:icons

The command will generate:

• svg/optimized directory
• themes/default directory
• src/lib/index.ts file
• src/lib/types.d.ts file

You can see the generated icons by running the command below:

npm run dev

Publishing

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

npm publish

Usage

See the example of how you can use the icon library in your project.

Donate ❤️

BTC: bc1q7famhuj5f25n6qvlm3sssnymk2qpxrfwpyq7g4

License

MIT © Thiago Lagden MIT © Justin Voitel