GithubHelp home page GithubHelp logo

phodonou / material-icons Goto Github PK

View Code? Open in Web Editor NEW

This project forked from material-icons/material-icons

0.0 1.0 0.0 16.16 MB

Updated version of Google Material Design Icons from material.io. Each icon comes in 5 variations: baseline, sharp, outline, round, two tone.

License: Apache License 2.0

material-icons's Introduction

Material design icons, updated set

Material design icons is the official icon set from Google. The icons are designed under the material design guidelines.

Updated set

This is updated version of icons, directly from material.io.

You can find older version of this icons set in google/material-design-icons repository.

Because official repository is no longer maintained, I have decided to make alternative repository with latest icons.

Available icons

Version 3 that is available in official icons repository only includes 1 variation of each icon.

This repository includes several variations for each icon:

  • baseline
  • sharp
  • outline
  • round
  • twotone

This repository includes only icons in SVG format. Other available formats are in different repositories:

If you need other format, please open issue on this repository and specify what format, size and color you need.

Getting started

This readme explains how to use updated icons set in your projects.

This repository does not use same build process as official Google MDI repository and has different folder structure.

Using SVG

SVG are available in directory "svg", followed by icon name. Each directory contains up to 5 SVG files, one for each icon variation.

All icons are 24x24, cleaned up and optimized. If you need different size, change width and height attributes in icon. SVG are scalable, duplicating them for different sizes is pointless.

Web font

Web font is is available in material-icons-font repository.

However you should avoid using font if you can. Font loads all icons that take a while to load and quite big stylesheet. Also fonts render with blurred ugly edges on some operating systems, worst offender is Windows.

Good news, all icons are available as modern JavaScript framework that replaces glyph fonts. See below.

JavaScript framework

All icons are available with Iconify JavaScript framework.

What is Iconify?

Iconify project makes it easy to add SVG icons to websites and offers over 40,000 icons to choose from.

You can use Iconify not only with this icon set, but also Templarian's Material Design Icons, Material Design Light, FontAwesome 5 and many other icon sets on same page without loading massive fonts.

How is it achieved? Iconify project uses new innovative approach to loading icons. Unlike fonts and SVG frameworks, Iconify only loads icons that are used on page instead of loading entire fonts. How is it done? By serving icons dynamically from publicly available JSON API (you can make a copy of script and API if you prefer to keep everything on your servers).

Iconify is designed to be as easy to use as possible. It uses icon placeholder syntax and icons inherit size and color from parent element, so they are easy to style with css.

How to use this icons set with Iconify?

Add this line to your page to load Iconify:

<script src="https://code.iconify.design/1/1.0.3/iconify.min.js"></script>

you can add it to <head> section of page or before </body>.

To add any icon, write something like this:

<span class="iconify" data-icon="ic:baseline-access-time" data-inline="false"></span>

or this:

<iconify-icon data-icon="ic:twotone-account-circle"></iconify-icon>

There are 2 small differences in icon names when using Iconify: icons have "ic:" prefix and underscores in icon name have been replaced by dash.

See how to use Iconify tutorial and browse MDI icons list to get code for each icon.

React components

No need to reinvent components. See Iconify for React.

How to use it:

npm install @iconify/react @iconify/icons-ic
import { Icon, InlineIcon } from "@iconify/react";
import face from "@iconify/icons-ic/baseline-face";
import home from "@iconify/icons-ic/twotone-home";
<Icon icon={home} />
<p>This is some text with <InlineIcon icon={face} /></p>

Linking to SVG

This repository is available on github.io. You can link to any SVG file like this:

https://material-icons.github.io/material-icons/svg/{name}/{family}.svg

where {name} is icon name, {family} is icon variation.

Branches

There are 2 branches of this repository: official and master.

Original branch includes only icons from material.io with some bug fixes.

Master branch includes few custom icons as well as fixed icons that were slightly modified (such as "outline" icon being changed to actually have outline).

Icon categories/tags

Icon categories, tags and version numbers are available in data.json

Format is similar to meta data Google provides for latest icons.

CLA

If you want to add icons to master branch, you need to sign Google's Contributor License Agreement. Why Google's CLA? Maybe one day these icons will be merged into official repository.

See CONTRIBUTING.md

Custom icons

All contributed icons must be 24x24, must have all 5 variations and must match material design guidelines.

If contributed icon does not fit into existing category, such as "AV", "Editor", new category will have to be created. For new category to be added there needs to be large enough number of icons that cover that category.

See https://github.com/material-icons/build

License

(copied from Google's repository)

We have made these icons available for you to incorporate into your products under the Apache License Version 2.0. Feel free to remix and re-share these icons and documentation in your products. We'd love attribution in your app's about screen, but it's not required. The only thing we ask is that you not re-sell these icons.

material-icons's People

Contributors

cyberalien avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.