Skip to content

arnellebalane/mdi-core

Repository files navigation

mdi-core

Node module for generating Material Design icons.

All icons are based on the @mdi/svg package, which is what materialdesignicons.com uses.

Installation

$ npm install --save mdi-core

Usage

const mdi = require('mdi-core');
const options = {...};

mdi(options);

Options

  • names (Array): The names of the icons to generate. Please refer to @mdi/svg's available icons for a complete list of icons that can be generated.
  • size (Number): The size of the icon to generate, in pixels. Defaults to 24px.
  • padding (Number): The padding on the icon to generate, in pixels. Defaults to 0px.
  • radius (Number): The border radius of the icon to generate, in pixels. Defaults to 0px.
  • foreground (String): The foreground color of the icon to generate. Defaults to #333.
  • background (String): The background color of the icon to generate. Defaults to transparent.
  • output (String): The output directory where the generated icons will be written to. Defaults to the current directory ..

Related Projects

  • mdi-cli: Generate material design icons from the command line

License

MIT License