## kivex-icons
A lightweight, pixel-perfect, and dynamic icon library for web developers.
## Why Kivex Icons?
- **Lightweight**: Minimalist SVG construction.
- **Dynamic**: Easily control size and color via JavaScript.
- **Easy to use**: Designed for vanilla JS and modern frameworks.
## Quick Start
```sh
npm install kivex-icons
```
```sh
pnpm add kivex-icons
```
```sh
yarn add kivex-icons
```
```sh
bun add kivex-icons
```
## Usage
### Kivex Icons [](https://www.npmjs.com/package/kivex-icons) provides multiple professional ways to inject icons into your application depending on your use case.
1. Direct Icon Import (Recommended for Bundlers)
You can import individual icons directly. Each icon is exposed as a structured object ready to be parsed.
```js
import { Menu, buildKivexIcon } from 'kivex-icons';
// Build a real SVG DOM element
const menuIcon = buildKivexIcon(Menu, { size: 30, color: "#47acff", strokeWidth: 2 });
// Append directly to the DOM
document.getElementById('app').appendChild(menuIcon);
```
2. Auto-Replacing HTML Elements (Vanilla JS / CDN Style)
Drop `` placeholder tags in your HTML with data-kivex attributes, and let Kivex take care of the rest dynamically!
```html
```
3. Server-Side Rendering & String Generation (Node.js / Express / SSR)
Need a raw HTML string instead of a DOM element? Use getKivexIconString which works flawlessly in environments without a browser window object (No document is not defined errors!).
```js
import { Menu, getKivexIconString } from 'kivex-icons';
// Generates a pure '' HTML string
const menuString = getKivexIconString(Menu, { size: 24, color: 'currentColor' });
```
## CDN Usage
If you prefer not to use a package manager, you can include Kivex Icons directly in your HTML:
```html
```
### License
This project is licensed under the MIT License. You are free to use, modify, and distribute this library for any project, including commercial applications.
## Documentation
For full documentation, architecture design, and core guidelines, please visit our main repository at [Kivex System Root](https://github.com/motionmind2007/kivex).
## Contribution
Feel free to open issues or contribute to the library! Check out our GitHub repository.
## Author
[MotionMind2007](https://github.com/MotionMind2007)
