Skip to content

bolonio/react-puxl-icons

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

react-puxl-icons

npm version

A react icons library based on the collection of accessible PUXL icons library from PUXL framework

The PUXL icons library is an open source collection of more than 300 SVG icons custom tailored for PUXL framework, each with its own accessible title and description. You can see the collection of icons in the PUXL icons website

Install

Using NPM:

$ npm i --save react-puxl-icons

Using Yarn:

$ yarn add react-puxl-icons

Usage

Basic usage

import React from 'react'
import { IconAccessibility } from 'react-puxl-icons'

export const App = () => (
  <div>
    <IconAccessibility />
  </div>
)

Passing SVG props/attributes

You can pass any SVG attribute as prop, as you would use in a SVG element.

<IconAccessibility width="3em" height="3em" fill="red" />
<IconAccessibility width="5em" height="5em" />
<IconAccessibility width="40px" height="40px" fill="green" />
<IconAccessibility fill="blue" />

You can see all SVG atributes in the SVG Attribute reference .

Contributing

If you have any suggestion for how this project could be improved, please read the contributing guidelines.

Author & Contributors

react-puxl-icons is created by Adrián Bolonio using the collection of accessible PUXL icons library from PUXL framework. Thanks to Iñigo Garcia for creating the the collection of accessible icons library.

Sources

License

ISC License, 2020, Adrián Bolonio

Please check the license of the PUXL icons library.