What is @mdi/js?
@mdi/js is a package that provides Material Design Icons as JavaScript constants. It allows developers to easily integrate Material Design Icons into their web applications by using SVG paths.
What are @mdi/js's main functionalities?
Importing Icons
You can import individual icons from the @mdi/js package. This allows you to use specific icons in your application without importing the entire library.
const { mdiAccount } = require('@mdi/js');
Using Icons in SVG
You can use the imported icon paths in your SVG elements. This allows you to render the icons directly in your HTML.
<svg viewBox="0 0 24 24"><path d="M12,2A10,10 0 1,0 22,12A10,10 0 0,0 12,2M12,4A8,8 0 1,1 4,12A8,8 0 0,1 12,4M12,6A6,6 0 1,0 18,12A6,6 0 0,0 12,6Z" /></svg>
Dynamic Icon Rendering
You can dynamically render icons by using the icon paths in your JavaScript code. This is useful for applications that need to render different icons based on user interactions or data.
const iconPath = require('@mdi/js').mdiAccount;
const svgElement = `<svg viewBox="0 0 24 24"><path d="${iconPath}" /></svg>`;
Other packages similar to @mdi/js
react-icons
react-icons provides a set of popular icons as React components. It supports multiple icon libraries, including Material Design Icons, FontAwesome, and more. Unlike @mdi/js, which provides raw SVG paths, react-icons offers ready-to-use React components.
material-design-icons
material-design-icons is the official icon set from Google for Material Design. It provides icons in various formats, including SVG, PNG, and web fonts. While @mdi/js focuses on providing SVG paths as JavaScript constants, material-design-icons offers a broader range of formats.
mdi-react
mdi-react is a package that provides Material Design Icons as React components. It is similar to @mdi/js in that it focuses on Material Design Icons, but it offers the icons as React components instead of raw SVG paths.
Note: Please use the main MaterialDesign repo to report issues. This repo is for distribution of the JavaScript files only.
JavaScript/TypeScript - Material Design Icons
JavaScript and TypeScript distribution for the Material Design Icons. This module contains all the path data for all icons.
npm install @mdi/js
Usage
import { mdiAccount } from '@mdi/js'
console.log(mdiAccount);
Note: WebPack 4 or Rollup will tree shake unused icons.
Related Packages
NPM @MDI Organization
Learn More