Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/digitalservicebund/icons
Material UI icons as React components (npm package)
https://github.com/digitalservicebund/icons
icons mui
Last synced: about 1 month ago
JSON representation
Material UI icons as React components (npm package)
- Host: GitHub
- URL: https://github.com/digitalservicebund/icons
- Owner: digitalservicebund
- License: mit
- Created: 2023-12-20T12:53:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-23T18:33:13.000Z (9 months ago)
- Last Synced: 2024-04-23T20:30:09.151Z (9 months ago)
- Topics: icons, mui
- Language: Shell
- Homepage: https://www.npmjs.com/package/@digitalservicebund/icons
- Size: 627 KB
- Stars: 2
- Watchers: 9
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Icons
[Google's Material UI icons](https://mui.com/material-ui/material-icons/) re-packaged as a set of **React components** without being dependent on [Emotion](https://emotion.sh/).
## Changelog
[Please read here](CHANGELOG.md)## Installation
```sh
npm install --save @digitalservicebund/icons
```## Usage
```jsx
import WarningAmberIcon from "@digitalservicebund/icons/WarningAmber";```
## Accessibility
By default, the icons provided are hidden from screen readers (using `aria-hidden="true"`). It is assumed that icons are used purely for decorative purposes. That they only ever accompany a text that is meaningful even without an icon.
If this is not the case and the icon has sematic meaning, you have to take extra steps. Sara Soueidan shows some techniques regarding [Accessible Icon Buttons](https://www.sarasoueidan.com/blog/accessible-icon-buttons/).
Just in case you make an icon visible to screen readers, icons also have an appropriate ARIA role (`role="graphics-symbol"`).