4.0.0 • Published 6 years ago

material-react-icons v4.0.0

Weekly downloads
392
License
MIT
Repository
github
Last release
6 years ago

material-react-icons

This package provides all the Material Design Icons by Google, as React SVG Components. The main inspiration for this package is from @material-ui/icons, the only difference being that the latter depends on the Material-UI's SvgIcon React Component, while this package boasts zero dependencies.

All the icons, included in the package can be found here.


Installation

  npm install material-react-icons

Usage

The import path for each Material icon component includes the icon name in PascalCase. For example 'access_alarm' icon is named as 'AccessAlarm'

Note: One exception is '3d rotation', which is named 'ThreeDRotation'.

  1. Recommended Way
  import AddIcon from 'material-react-icons/Add';
  import RemoveIcon from 'material-react-icons/Remove';
  ...
  ...
    render() {
      ...
      return (
        ...
        <AddIcon />
        <RemoveIcon />
        ...
      );
  ...
  }
  1. With tree-shaking configured
import { Add, Remove } from 'material-react-icons';
...
  ...
    render() {
      ...
      return (
        ...
        <Add />
        <Remove />
        ...
      );
  ...
  }

Props

PropTypeRequiredDefaultDescription
colorstringfalseinheritColor of the icon (Ex: '#000000', 'rgba(255, 255, 255, 1)', 'black'). Default being inherit, the icon will take the color of its parent.
classNamestringfalse-Class Name for the svg component
sizenumberfalse24Font size of the icon
stylesobjectfalse{}Inline Styles for the svg component
viewBoxstringfalse0 0 24 24View Box attribute to the svg tag, which is '0 0 24 24' for the icons

Note: Any other prop passed will be spread on to the root element (<svg />).


Default Inline Styles of the Icon Component (Can be overridden by styles prop)

  {
    userSelect: 'none',
    width: '100%',
    fill: 'currentColor',
    height: '1em',
    verticalAlign: 'middle',
    width: '1em'
  }

Note: The size of the icon can be adjusted font-size CSS property. (24px is the default size).


Peer Dependencies

  • react
  • prop-types

License

This project is licensed under the terms of the MIT license.

4.0.0

6 years ago

3.1.0

6 years ago

3.0.2

6 years ago

3.0.1

6 years ago

3.0.0

6 years ago

2.1.0

6 years ago

2.0.0

6 years ago

1.3.0

6 years ago

1.2.0

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.0

6 years ago