Skip to content

readme.md

Latest commit

 

History

History
90 lines (59 loc) · 2.5 KB

readme.md

File metadata and controls

90 lines (59 loc) · 2.5 KB

React Material Icons

npm package license

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 filled
  • Icon10kOutlined > Outlined
  • Icon10kRounded > Rounded
  • Icon10kSharp > Sharp
  • Icon10kTwoTone > 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 build and publish the package, visit the GitHub Actions page of the repository.

You can choose between two workflows:

  • Release Package to publish a new version of the package.
  • Pre-Release Package to publish a new pre-release version of the package.

Note: Pre-releases need to be supplied with a pre-id.

Note: To increment a pre-release, you have to run the normal release workflow and select "prerelease". For this action you need to already be on a pre-release version.

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 info@aboutbits.it.

Credits

License

The MIT License (MIT). Please see the license file for more information.