@aboutbits/react-material-icons
v2.0.0
Published
Material design icon components for React
Downloads
469
Readme
React Material Icons
This package includes all Material Icons as reusable React components.
Table of content
Usage
First, you have to install the package:
npm install @aboutbits/react-material-icons
Second, you can use the icons in you React application like this:
import React from 'react'
import IconCached from '@aboutbits/react-material-icons/dist/IconCached'
const MyCommponent = () => {
return (
<IconCached/>
);
}
SVG related parameters like height and width can be passed as props.
To import the different variants of an icon you can add the variants as a postfix:
Icon10k
> Default filledIcon10kOutlined
> OutlinedIcon10kRounded
> RoundedIcon10kSharp
> SharpIcon10kTwoTone
> Tow tone
Generate Components
To clear the directory with the existing icons before regenerating them:
npm run clear
To generate the components, simply run the following command:
npm run generate
Build & Publish
To publish the package commit all changes and push them to master. Then run one of the following commands locally:
npm version patch
npm version minor
npm version major
Information
About Bits is a company based in South Tyrol, Italy. You can find more information about us on our website.
Support
For support, please contact [email protected].
Credits
License
The MIT License (MIT). Please see the license file for more information.