Skip to content

Slick SVG Icons is a lightweight and elegant collection of SVG icons designed for seamless integration into React.js projects. This package provides a simple and efficient way to import and use scalable vector icons in your web applications. Built with modularity in mind, it ensures optimized performance and easy customization while maintaining a

License

Notifications You must be signed in to change notification settings

FL45h-09/slick-svg-icons

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 

Repository files navigation

Slick SVG Icons

Slick SVG Icons is a lightweight and elegant collection of SVG icons designed for seamless integration into React.js projects. This package provides a simple and efficient way to import and use scalable vector icons in your web applications. Built with modularity in mind, it ensures optimized performance and easy customization while maintaining a sleek and modern aesthetic.

πŸ”₯ Key Features:

βœ… Easy to Import & Use – Simplified syntax for hassle-free integration.
βœ… Optimized for React.js – Supports JSX-based rendering.
βœ… Lightweight & Scalable – SVG-based, ensuring crisp visuals on any screen.
βœ… Customizable – Adjust colors, sizes, and styles effortlessly.
βœ… Tree-shakable – Only includes the icons you use, keeping your bundle size small.


πŸ“¦ Installation

Install the package using npm or yarn:

npm install slick-svg-icons

or

yarn add slick-svg-icons

πŸš€ Usage

Import and use any icon in your React component:

import { ArrowRight } from "slick-svg-icons";

function App() {
  return <ArrowRight size={32} color="red" />;
}

export default App;

🎨 Props

Each icon component accepts the following props:

Prop Type Default Description
size number 24 Defines the width & height of the icon
color string currentColor Sets the stroke or fill color

πŸ“ Folder Structure

slick-svg-icons/
│── src/                        # Source files
β”‚   β”œβ”€β”€ icons/                  # Folder containing individual SVG components
β”‚   β”‚   β”œβ”€β”€ ArrowRight.tsx       # Example icon component
β”‚   β”‚   β”œβ”€β”€ Home.tsx             # Example icon component
β”‚   β”‚   β”œβ”€β”€ User.tsx             # Example icon component
β”‚   β”‚   └── index.ts             # Exports all icons
β”‚   β”œβ”€β”€ index.ts                 # Main entry point for the package
│── dist/                        # Compiled output (ignored in Git, auto-generated)
│── examples/                    # Example projects or usage demos
│── tests/                       # Unit tests for components (optional)
│── package.json                 # NPM package metadata
│── tsconfig.json                # TypeScript configuration
│── README.md                    # Documentation
│── .gitignore                    # Ignoring unnecessary files
│── .npmignore                    # Ignoring files not needed in the published package
│── rollup.config.js / vite.config.js  # Build configuration (Rollup/Vite for bundling)

⚑ Development & Contribution

  1. Clone the repository:
    git clone https://github.com/your-username/slick-svg-icons.git
  2. Install dependencies:
    cd slick-svg-icons
    npm install
  3. Start development:
    npm run dev
  4. Run tests:
    npm run test
  5. Submit a pull request with improvements or new icons.

πŸ“œ License

This project is licensed under the MIT License.


πŸ™Œ Support

If you find this package helpful, consider starring the repository and sharing it with others. πŸš€

About

Slick SVG Icons is a lightweight and elegant collection of SVG icons designed for seamless integration into React.js projects. This package provides a simple and efficient way to import and use scalable vector icons in your web applications. Built with modularity in mind, it ensures optimized performance and easy customization while maintaining a

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published