Blame view
README.md
2.51 KB
95c4d7afc Add a LICENSE, RE... |
1 2 3 4 5 6 7 |
# Material Design Icons Material Design Icons are the official open-source icons featured in the Google [Material Design](http://www.google.com/design/spec) specification. ## What's included? * SVG versions of all icons in both 24px and 48px flavours |
ad8543d2e Add section on CS... |
8 |
* SVG and CSS sprites of all icons |
95c4d7afc Add a LICENSE, RE... |
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
* 1x, 2x icons targeted at the Web (PNG) * 1x, 2x, 3x icons targeted at iOS (PNG) * Hi-dpi versions of all icons (hdpi, mdpi, xhdpi, xxhdpi, xxxhdpi) (PNG) ## Getting Started You have a few options for getting the icon set. ### Download the Zip Grab the latest [zip archive](https://github.com/google/material-design-icons/archive/master.zip) of all icons. ### Bower Install the icons using the [Bower](http://bower.io) package manager. ```sh $ bower install material-design-icons ``` ### npm You can also find all the icons on [npm](http://npmjs.org). ```sh $ npm install material-design-icons ``` |
ad8543d2e Add section on CS... |
37 38 39 |
## Structure ### Icons |
c739074e9 Add structure > i... |
40 41 42 43 44 45 46 47 |
In general, an icon category (e.g `action`) will include the following directories, containing multiple resolutions of our icons. * 1x, 2x Web * 1x, 2x, 3x iOS * drawable hdpi, mdpi, xhdpi, xxhdpi, xxxhdpi * svg Decide on the icon resolution required for your project and copy, then reference the icons you wish to use. |
ad8543d2e Add section on CS... |
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
### Spritesheets Material Design icons come with SVG and CSS sprites for each category of icon we include. These can be found in the `sprites` directory, under the `svg-sprite` and `css-sprite` sub-directories. #### Using CSS Sprites To use a CSS spritesheet, reference the stylesheet for the icon category you wish to use, then include the icon definition in your markup. E.g: to use one of the play icons in `css-sprite-av`, we would do the following: Reference the stylesheet: ```html <link href="css-sprite/sprite-av-black.css" rel="stylesheet"> ``` Create an element which will use the icon as a background: ```html <div></div> ``` Add a class referencing the `icon` spritesheet and specific icon `icon-ic_play_circle_outline_black_24dp`, which you can get from the above stylesheet. ```html <div class="icon icon-ic_play_circle_outline_black_24dp"></div> ``` That's it! Don't forget to publish the corresponding CSS and SVG/PNG files when deploying your project. |
c739074e9 Add structure > i... |
79 |
|
95c4d7afc Add a LICENSE, RE... |
80 81 82 83 84 85 86 |
## Usage Take a look at the included `index.html` file for a preview of all icons included in the set. You are free to use the icons in the way that makes most sense to your project. ## Licence All icons are released under an [Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) license. |