{"id":17827031,"url":"https://github.com/whaaaley/material-icons-scss","last_synced_at":"2025-04-02T12:15:54.325Z","repository":{"id":52839903,"uuid":"273805082","full_name":"whaaaley/material-icons-scss","owner":"whaaaley","description":"Material design icons for SCSS","archived":false,"fork":false,"pushed_at":"2021-05-12T02:48:05.000Z","size":2834,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-26T11:21:29.802Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whaaaley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-21T00:11:38.000Z","updated_at":"2022-03-22T12:08:25.000Z","dependencies_parsed_at":"2022-08-20T02:01:24.227Z","dependency_job_id":null,"html_url":"https://github.com/whaaaley/material-icons-scss","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whaaaley%2Fmaterial-icons-scss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whaaaley%2Fmaterial-icons-scss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whaaaley%2Fmaterial-icons-scss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whaaaley%2Fmaterial-icons-scss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whaaaley","download_url":"https://codeload.github.com/whaaaley/material-icons-scss/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246811309,"owners_count":20837752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-27T18:57:45.534Z","updated_at":"2025-04-02T12:15:54.305Z","avatar_url":"https://github.com/whaaaley.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\r\n# material-icons-scss\r\n\r\n\u003e Material design icon functions for SCSS\r\n\r\nThis project contains and generates SCSS functions that output SVG Data URLs using SVGs from the official [google/material-design-icons](https://github.com/google/material-design-icons) repository, optimized using [SVGO](https://github.com/svg/svgo) and this project.\r\n\r\n## Notice\r\nYou can see all the current icons in their data URL form at the following locations.\r\n\r\n+ [stable/filled](https://demo-dist.netlify.app/stable/filled.html)\r\n+ [stable/outlined](https://demo-dist.netlify.app/stable/outlined.html)\r\n+ [stable/round](https://demo-dist.netlify.app/stable/round.html)\r\n+ [stable/sharp](https://demo-dist.netlify.app/stable/sharp.html)\r\n+ [stable/twotone](https://demo-dist.netlify.app/stable/twotone.html)\r\n\r\n+ [extended/filled](https://demo-dist.netlify.app/extended/filled.html)\r\n+ [extended/outlined](https://demo-dist.netlify.app/extended/outlined.html)\r\n+ [extended/round](https://demo-dist.netlify.app/extended/round.html)\r\n+ [extended/sharp](https://demo-dist.netlify.app/extended/sharp.html)\r\n+ [extended/twotone](https://demo-dist.netlify.app/extended/twotone.html)\r\n\r\n## Install\r\n\r\n```\r\n$ npm i @whaaaley/material-icons-scss\r\n```\r\n\r\n## Setup\r\n\r\nIf you're using the `dart-sass` CLI I recommend using the `--load-path` flag set to `node_modules`. Load paths add additional paths for Sass to look for stylesheets.\r\n\r\n```\r\n$ sass src/app.scss public/app.min.css --load-path=node_modules\r\n```\r\n\r\nIf you're using `dart-sass`'s JavaScript API this is called `includePaths`.\r\n\r\n```js\r\nconst css = sass.renderSync({\r\n  file: 'src/app.js',\r\n  includePaths: ['node_modules']\r\n})\r\n```\r\n\r\n## Usage\r\n\r\nFirst, import a stylesheet of the icon style you'd like to use. Only import one of the following.\r\n\r\nThe icons in `stable` are the 4.0.0 icons _only_ whereas the icons in `extended` include all the icons from 4.0.0 plus all the icons seen on Google fonts. Extended icons have not stabilized and may be subject to change.\r\n\r\nYou can find a list of all available _extended_ icons, styles, and sizes on [Google Fonts.](https://fonts.google.com/icons?selected=Material+Icons)\r\n\r\n```scss\r\n@import '@whaaaley/material-icons-scss/stable/filled';\r\n@import '@whaaaley/material-icons-scss/stable/outlined';\r\n@import '@whaaaley/material-icons-scss/stable/round';\r\n@import '@whaaaley/material-icons-scss/stable/sharp';\r\n@import '@whaaaley/material-icons-scss/stable/twotone';\r\n\r\n@import '@whaaaley/material-icons-scss/extended/filled';\r\n@import '@whaaaley/material-icons-scss/extended/outlined';\r\n@import '@whaaaley/material-icons-scss/extended/round';\r\n@import '@whaaaley/material-icons-scss/extended/sharp';\r\n@import '@whaaaley/material-icons-scss/extended/twotone';\r\n```\r\n\r\nNext, create an icon data URL by using one of the icon functions.\r\n\r\nIcon function names are prefixed with `ic`, names are kebab cased, and sizes can be 18px, 20px, or 24px.\r\n\r\n```\r\nic-name-size($color)\r\n```\r\n\r\nIn this example, I'm storing the SVG data URL in the variable `$icon-menu` then using that variable in the background URL function.\r\n\r\n### Input:\r\n\r\n```scss\r\n@import '@whaaaley/material-icons-scss/style/filled';\r\n\r\n$red: #FF0000;\r\n$icon-menu: ic-menu-24px($red);\r\n\r\n.foobar {\r\n  width: 24px;\r\n  height: 24px;\r\n  background: url($icon-menu) center no-repeat;\r\n}\r\n```\r\n\r\n### Output:\r\n\r\n```css\r\n.foobar {\r\n  width: 24px;\r\n  height: 24px;\r\n  background: url('data:image/svg+xml;utf8,\u003csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\"\u003e\u003cpath fill=\"%23f00\" d=\"M3 18h18v-2H3v2zm0-5h18v-2H3v2zm0-7v2h18V6H3z\"/\u003e\u003c/svg\u003e') center no-repeat;\r\n}\r\n```\r\n\r\n## How to build\r\n\r\nThis builds both `stable` and `extended` icon sets and demo files.\r\n\r\n**`Notice:`** Running `update_repo.py` can take over 2 hours to download all the files.\r\n\r\n```\r\n$ cd icons/stable\r\n$ git clone https://github.com/google/material-design-icons.git\r\n$ cd ..\r\n$ cd extended\r\n$ git clone https://github.com/google/material-design-icons.git\r\n$ cd material-design-icons/update\r\n$ pip3 install -r requirements.txt\r\n$ python3 update_repo.py\r\n$ cd ../../..\r\n$ make optimize\r\n$ make build\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhaaaley%2Fmaterial-icons-scss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhaaaley%2Fmaterial-icons-scss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhaaaley%2Fmaterial-icons-scss/lists"}