MaterialDesign README

The project's README from github.com/Templarian/MaterialDesign. As one markdown file: README.md.

Material Design

This repo contains all the planning for current and work-in-progress Material Design Icons.

Getting Started

npm GitHub issues

Icons

View at Material Design Icons. This repo also contains converted icons from Google's official icon set.

NPM Dist Repo
Webfont / SCSS npm install @mdi/font MaterialDesign-Webfont npm
JavaScript / TypeScript npm install @mdi/js MaterialDesign-JS npm
ReactJS npm install @mdi/react MaterialDesign-React npm
SVG / Meta.json npm install @mdi/svg MaterialDesign-SVG npm
Desktop Font n/a MaterialDesign-Font

Upgrade Guide | Changelog Guide

Icons

Warning (Cordova only): You will need to manually edit the css file to remove the version query string. Read More.

Contribute

Please do not make pull requests against this repositiory. All icons are managed through the Material Design Icons site by the various contributors and synced instantly. If you want to become a contributor read more.

Icon Suggestions

Submit icon suggestions through the issue tab. Please include examples.

Third Party (Plugins / Extensions / etc)

License

View the License

Code of Conduct

View and submit violations.

MaterialDesign (Templarian/MaterialDesign)

Searching Database…

What is this?This is the source repo for Material Design Icons (MDI), a community-driven icon set with 7000+ icons, including Google's official Material Design icons converted into developer-friendly formats.
Does it include Google's official icons, or only community-made ones?Both — the repo ships Google's official icon set converted into these formats, plus thousands of icons contributed by the community through the Material Design Icons site.
How do I add these icons to my project?Install the npm package that matches your stack: '@mdi/font' for a webfont/SCSS, '@mdi/svg' for raw SVG files and meta.json, '@mdi/js' for JS/TS path strings, or '@mdi/react' for ready-made React components.
Do I need npm, or can I just grab the fonts directly?The official distributions (webfont, JS, React, SVG) are all published via npm, but there's also a separate Desktop Font repo for using the icons as a plain system font without any package manager.
What happens if I skip the Cordova webfont fix after upgrading?In Cordova apps the version query string in the CSS file won't be handled automatically, so you have to manually edit the CSS to remove it after an upgrade, per the migration guide.
Which npm packages does the project actually publish?@mdi/font for webfont/SCSS, @mdi/js for JS/TS icon path data, @mdi/react for React components, and @mdi/svg for raw SVG files plus a meta.json index.
Is there a non-npm way to use the icons, like on desktop?Yes, a separate MaterialDesign-Font distribution repo provides a desktop font version of the icon set for non-web use.
Creator
Templarian
Size
142.8 MB
Stars
11.3K
Updated
CommitJan 20
Age
12y
Commits · 90 Days