Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bolonio/react-puxl-icons
A react icons library based on the collection of accessible PUXL icons library from PUXL framework
https://github.com/bolonio/react-puxl-icons
a11y accessibility icon-library icon-pack icons npm open-source opensource puxl puxl-icons react react-component react-icon-kit react-library react-puxl-icons typescript web web-accessibility
Last synced: 13 days ago
JSON representation
A react icons library based on the collection of accessible PUXL icons library from PUXL framework
- Host: GitHub
- URL: https://github.com/bolonio/react-puxl-icons
- Owner: bolonio
- License: isc
- Created: 2020-05-20T15:30:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-22T13:33:28.000Z (over 4 years ago)
- Last Synced: 2024-10-24T06:35:35.875Z (14 days ago)
- Topics: a11y, accessibility, icon-library, icon-pack, icons, npm, open-source, opensource, puxl, puxl-icons, react, react-component, react-icon-kit, react-library, react-puxl-icons, typescript, web, web-accessibility
- Language: TypeScript
- Homepage:
- Size: 356 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# react-puxl-icons
[](https://www.npmjs.com/package/react-puxl-icons)
> A react icons library based on the collection of accessible [PUXL icons library](https://github.com/puxl/puxl-icons) from [PUXL framework](https://github.com/puxl/puxl-framework)
The PUXL icons library is an open source collection of more than 300 SVG icons custom tailored for [PUXL framework](https://puxl.io/), each with its own accessible title and description. You can see the collection of icons in the [PUXL icons website](https://puxl.io/puxl-icons/)
## Install
### Using NPM:
```
$ npm i --save react-puxl-icons
```
### Using Yarn:
```
$ yarn add react-puxl-icons
```
## Usage
### Basic usage
```jsx
import React from 'react'
import { IconAccessibility } from 'react-puxl-icons'
export const App = () => (
)
```
### Passing SVG props/attributes
You can pass any SVG attribute as prop, as you would use in a SVG element.
```jsx
```
You can see all SVG atributes in the [SVG Attribute reference
](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute).
## Contributing
If you have any suggestion for how this project could be improved, please read the [contributing guidelines](https://github.com/bolonio/react-puxl-icons/blob/master/CONTRIBUTING.md).
## Author & Contributors
react-puxl-icons is created by [Adrián Bolonio](https://twitter.com/bolonio) using the collection of accessible [PUXL icons library](https://github.com/puxl/puxl-icons) from [PUXL framework](https://github.com/puxl/puxl-framework). Thanks to [Iñigo Garcia](https://github.com/MrKanuel) for creating the the collection of accessible icons library.
## Sources
- [PUXL framework](https://github.com/puxl/puxl-framework)
- [PUXL icons library](https://github.com/puxl/puxl-icons)
## License
ISC License, 2020, Adrián Bolonio
Please check the [license of the PUXL icons library](https://github.com/puxl/puxl-icons/blob/master/LICENSE).