react-icons

A collection of React icons created with TypeScript.

Installation

You can install the package from the GitHub repository using npm or yarn:

npm install nui-react-icons
yarn add nui-react-icons

Usage

Import the icons you need from the package:

import { UploadIcon } from "nui-react-icons";

Then, use the icons as React components in your application:

function App() {
  return (
    <div>
      <UploadIcon size={48} className="h-16 w-16" fill="#007bff" />
    </div>
  );
}

Props

The icon components accept the following props:

• size (number, optional): The size of the icon in pixels. If not provided, the default size of 36 will be used.
• width (number, optional): The width of the icon in pixels.
• height (number, optional): The height of the icon in pixels.
• Any other valid SVG props (e.g., fill, stroke, className, etc.).

Development

To develop and build the package locally, follow these steps:

1. Clone the repository:

git clone https://github.com/teebarg/react-icons.git

2. Install dependencies:

npm install

3. Build the package:

npm run build

This will compile the TypeScript code into the dist directory.

Contributing

Contributions are welcome! If you find any issues or want to add new icons, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.