README.md

Material Design JS

Note: This package is a dependency of another package, which I will create for React that automatically load the icon.

If you using the @mdi/js from Templarian, All variables of icons are stored in one file and you can import specific icon.

But if you want a dynamic import icons, which need when you create a dynamic application, you can not import icons dynamically.

This package read the original file(@mdi/js/mdi.js) which stored all variables of icons from @mdi/js and write them in one JS file per icon. So you can also dynamically import icons.

Installation

via npm:

npm install materialdesign-js

via yarn:

yarn add materialdesign-js

Usage

Simply import an icon:

import mdiAccount from 'mdi-js/icons/mdiAccount';
console.log(mdiAccount); // "M...Z"

Create dynamically load icons:

If you need a dynamically load icon, you can create the following component:

import React from "react";
import { Icon as MDIcon } from "@mdi/react";

class Icon extends React.Component {
  render() {
    let icon = require(`materialdesign-js/icons/${this.props.icon}`).default;
    if (!icon) {
      throw Error(`Could not find materialdesign-js/icons/${icon}`);
    }
    return <MDIcon path={icon} />;
  }
}

export default Icon;

and use like this:

import Icon from "./Icon";
...
<Icon icon="mdiAccount" />

Contribute

I will be happy if know someone like to contribute this package. Just fork this repository, commit and make pull request.