@pillar-ui/icons
TypeScript icon, indicating that this package has built-in type declarations

0.6.1 • Public • Published

Pillar Icons

Pillar Icons is a library of scalable icons suitable for various web development projects. These icons are highly customizable, accessible, and designed to seamlessly integrate into modern user interfaces.

Features

  • Scalable Icons: A collection of vector icons that can be scaled to any size without losing quality.
  • Wide Range of Icons: Pillar Icons offers a wide variety of icons to choose from, covering different categories and use cases.
  • Customization: Icons can be customized with different colors, sizes, and styles to match your application's design.
  • Seamless Integration: The icons are designed to integrate smoothly with modern web development frameworks and libraries.
  • Accessibility: The icons are designed with accessibility in mind, ensuring they are perceivable and usable by all users.
  • Simple to Use: The icons are easy to implement and use in your projects, requiring minimal configuration.

Installation

To start using Pillar Icons in your project, follow these simple steps:

  1. Make sure you have Node.js and npm (Node Package Manager) installed on your machine.

  2. Create a new project or navigate to your existing project directory in the terminal.

  3. Install the Pillar Icons package by running the following command:

npm install @pillar-ui/icons

Usage

Pillar Icons can be imported and used in your projects. Here's an example of how to use the icons:

import { Eye, ArrowDown, Minimize } from '@pillar-ui/icons'

function MyComponent() {
  return (
    <div>
      <Eye size={24} fill="primary" />
      <ArrowDown size={32} fill="secondary" />
      <Minimize size={48} fill="accent" />
    </div>
  )
}

Make sure to explore the Pillar Icons documentation for the full list of available icons and their usage.

Customization

Pillar Icons can be customized to fit your application's design. You can change the size, color, and style of the icons using CSS or props provided by your chosen framework.

Contributing

We welcome contributions to Pillar Icons! If you have new icon suggestions, improvements, or bug fixes, please refer to our Contributing Guidelines for more information.

Let Us Know

If you have any questions, feedback, or need assistance with Pillar Utils, feel free to open a discussion on our GitHub page. We are committed to providing fast and helpful responses to ensure your success with the library.

You can visit the [Pillar Utils GitHub Discussions page]: https://github.com/HamzaAmar/pillar-ui/discussions to start a new discussion or join existing ones. We are here to support you and provide answers as quickly as possible.

License

Pillar Icons is released under the MIT License.

Feel free to customize the readme file further with specific links to your documentation, contributing guidelines, and any other relevant information for the users of the Pillar Icons package.

Package Sidebar

Install

npm i @pillar-ui/icons

Weekly Downloads

60

Version

0.6.1

License

MIT

Unpacked Size

1.87 MB

Total Files

8

Last publish

Collaborators

  • hamzaamar