https://github.com/nestarz/icons

https://github.com/nestarz/icons

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/nestarz/icons
• Owner: nestarz
• Created: 2024-04-08T10:46:09.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T16:04:43.000Z (4 months ago)
• Last Synced: 2024-11-22T00:51:35.039Z (about 1 month ago)
• Language: TypeScript
• Size: 35.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# @bureaudouble/icons

A comprehensive icon meta library optimized for JSR (JavaScript Registry) package manager, offering efficient per-URL fetching and caching.

## Features

- Wide variety of icons from two popular sets (Lucide, Radix)

- Optimized for JSR package manager

- Per-URL fetching and caching for improved performance

- TypeScript support

- Easy to use with React and other frameworks

## Installation

To use this package with JSR, simply import the icons directly in your code. There's no need for a separate installation step.

## Usage

Import icons directly from the package using the JSR syntax:

```tsx

import UserRoundCheckIcon from "jsr:@bureaudouble/icons/lucide/UserRoundCheckIcon"

import AccessibilityIcon from "jsr:@bureaudouble/icons/radix/AccessibilityIcon"

// Use in your React component

function MyComponent() {

  return (

    


      

      

    

  )

}

```


## Advantages

- **Efficient Loading**: Only the specific icons you import are fetched and cached, reducing unnecessary network requests and improving load times.

- **No Bundle Bloat**: Avoid including the entire icon library in your bundle. Each icon is loaded separately as needed.

- **Easy Updates**: Quickly update to the latest version by changing the version number in the import statement.

- **Framework Agnostic**: While the example uses React, the icons can be used with any JavaScript framework or vanilla JS.

## Available Icons

The package includes icons from various popular sets. Explore the available icons in the package documentation or repository.

## License

MIT