1.0.1 • Published 6 years ago

rmdi v1.0.1

Weekly downloads
5,960
License
MIT
Repository
-
Last release
6 years ago

React Material Design Icons

Built with Pixo, Styled Components, and Styled System

https://jxnblk.com/rmdi

npm i rmdi
// import icons individually for better tree-shaking
import Accessibility from 'rmdi/lib/Accessibility'

const App = props => (
  <Accessibility
    size={32}
    color='tomato'
  />
)
// import all icons as a single component
import { Icon } from 'rmdi'

const App = props => (
  <Icon
    name='accessibility'
    size={32}
    color='tomato'
  />
)

List of Icons

See the icon list for a complete list of all icons available

Props

PropTypeDescription
sizenumberwidth and height in pixels
colorstringfill color, uses Styled System's color function

Spacing Props

Margin can be applied with the following props, which use Styled System's space function. Margin props accept numbers for pixel values, strings with CSS units, or arrays for responsive margin

PropDescription
mmargin
mtmargin-top
mrmargin-right
mbmargin-bottom
mlmargin-left
mxmargin-left and margin-right
mymargin-top and margin-bottom

Contributing

npm install

The build process will:

  1. Parse the material-design-icons package for SVG source code
  2. Copy the icons to the svg/ folder
  3. Create an examples/ folder for tests and development
  4. Run Pixo on the svg/ folder and output to src/
  5. Run Babel on the src/ folder and output to lib/

Tests:

npm test

To run the development server:

npm start

Related

MIT License