styled-icons
Version:
Icons from packs like Font Awesome, Material, Octicons, Feather, Icomoon, and Boxicons available as Styled Components
401 lines (295 loc) • 17.8 kB
Markdown
<h1 align="center">💅 styled-icons</h1>
<p align="center"><a href="https://github.com/styled-icons/styled-icons/actions"><img src="https://github.com/styled-icons/styled-icons/workflows/CI/badge.svg" alt="Build Status" /></a>
<a href="https://www.npmjs.com/package/styled-icons"><img src="https://badgen.net/npm/dm/styled-icons" alt="npm" /></a>
<a href="https://www.npmjs.com/package/styled-icons"><img src="https://badgen.net/npm/v/styled-icons" alt="npm" /></a>
<a href="https://www.styled-components.com/"><img src="https://badgen.net/badge/built%20with/styled%20components/db7093" alt="Built with Styled Components" /></a>
<img src="https://badgen.net/badge/powered%20by/typescript/blue" alt="Powered by TypeScript" /> <a href="#contributors" alt="sponsors on Open Collective"><img src="https://opencollective.com/styled-icons/backers/badge.svg" /></a> <a href="#contributors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/styled-icons/sponsors/badge.svg" /></a></p>
<p align="center"><a href="https://vercel.com/?utm_source=styled-icons"><img height="32" src="https://styled-icons.dev/powered-by-vercel.svg" alt="Powered by Vercel" /></a></p>
`styled-icons` provides over 20,000 icons from the following icon packs as [Styled Components](https://www.styled-components.com/), with full support for TypeScript types and tree-shaking / ES modules.
**[➡️ View the Icon Explorer](https://styled-icons.dev)**
- [Bootstrap](https://icons.getbootstrap.com/)
- [Boxicons](https://boxicons.com/)
- [Crypto Icons](http://cryptoicons.co)
- [Entypo](http://www.entypo.com/)
- [Eva Icons](https://akveo.github.io/eva-icons/)
- [Evil Icons](https://evil-icons.io)
- [Feather](https://feathericons.com/)
- [FluentUI System](https://github.com/microsoft/fluentui-system-icons)
- [Font Awesome](https://fontawesome.com/)
- [Foundation](https://zurb.com/playground/foundation-icon-fonts-3)
- [Heroicons](https://github.com/refactoringui/heroicons)
- [Icomoon](https://icomoon.io)
- [Ionicons](https://ionicons.com)
- [Material Design](https://material.io/icons/)
- [Octicons](https://octicons.github.com/)
- [Open Iconic](https://www.npmjs.com/package/open-iconic)
- [Remix](https://remixicon.com/)
- [Simple Icons](https://github.com/simple-icons/simple-icons)
- [Typicons](https://www.s-ings.com/typicons/)
- [Zondicons](https://www.zondicons.com/)
---
<p align="center"><strong>Do you use Emotion?</strong></p>
<p align="center">Check out <a href="https://github.com/emotion-icons/emotion-icons">👩🎤 Emotion Icons</a></p>
<p align="center"><strong>Would you prefer plain SVGs?</strong></p>
<p align="center">Check out <a href="https://github.com/svg-icons/svg-icons">🎛️ SVG Icons</a></p>
---
### Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Props](#props)
- [Icon Dimensions](#icon-dimensions)
- [Styled Components](#styled-components)
- [Base Icon Styles](#base-icon-styles)
- [Accessibility](#accessibility)
- [Tree Shaking](#tree-shaking)
- [TypeScript](#typescript)
- [Contributing](#contributing)
- [License](#license)
- [Contributors](#contributors)
## Installation
You can install all the icon packs simultaneously:
```
yarn add styled-icons
```
or
```
npm install styled-icons --save
```
Alternatively you can install only the icon packs you need:
```
yarn add -icons/bootstrap
yarn add -icons/boxicons-logos
yarn add -icons/boxicons-regular
yarn add -icons/boxicons-solid
yarn add -icons/crypto
yarn add -icons/entypo
yarn add -icons/entypo-social
yarn add -icons/evaicons-outline
yarn add -icons/evaicons-solid
yarn add -icons/evil
yarn add -icons/fa-brands
yarn add -icons/fa-regular
yarn add -icons/fa-solid
yarn add -icons/feather
yarn add -icons/fluentui-system-filled
yarn add -icons/fluentui-system-regular
yarn add -icons/foundation
yarn add -icons/heroicons-outline
yarn add -icons/heroicons-solid
yarn add -icons/icomoon
yarn add -icons/ionicons-sharp
yarn add -icons/ionicons-solid
yarn add -icons/ionicons-outline
yarn add -icons/material
yarn add -icons/material-outlined
yarn add -icons/material-rounded
yarn add -icons/material-twotone
yarn add -icons/material-sharp
yarn add -icons/octicons
yarn add -icons/open-iconic
yarn add -icons/remix-fill
yarn add -icons/remix-editor
yarn add -icons/remix-line
yarn add -icons/simple-icons
yarn add -icons/typicons
yarn add -icons/zondicons
```
Finally, you will need to have installed a version of `styled-components` at least version 4.1.0 or newer, as `styled-icons` depends on `styled-components` as a peer dependency.
## Usage
All icons are available for preview at the [Icon Explorer](https://styled-icons.dev).
The entire icon packs are available via the main import and sub-imports:
```javascript
import {material, octicons} from 'styled-icons'
import * as bootstrap from '-icons/bootstrap'
import * as boxiconsLogos from '-icons/boxicons-logos'
import * as boxiconsRegular from '-icons/boxicons-regular'
import * as boxiconsSolid from '-icons/boxicons-solid'
import * as crypto from '-icons/crypto'
import * as entypo from '-icons/entypo'
import * as entypoSocial from '-icons/entypo-social'
import * as evaiconsOutline from '-icons/evaicons-outline'
import * as evaiconsSolid from '-icons/evaicons-solid'
import * as evil from '-icons/evil'
import * as faBrands from '-icons/fa-brands'
import * as faRegular from '-icons/fa-regular'
import * as faSolid from '-icons/fa-solid'
import * as feather from '-icons/feather'
import * as fluentUISystemFilled from '-icons/fluentui-system-filled'
import * as fluentUISystemRegular from '-icons/fluentui-system-regular'
import * as foundation from '-icons/foundation'
import * as heroiconsOutline from '-icons/heroicons-outline'
import * as heroiconsSolid from '-icons/heroicons-solid'
import * as icomoon from '-icons/icomoon'
import * as ioniconsSharp from '-icons/ionicons-sharp'
import * as ioniconsSolid from '-icons/ionicons-solid'
import * as ioniconsOutline from '-icons/ionicons-outline'
import * as material from '-icons/material'
import * as materialOutlined from '-icons/material-outlined'
import * as materialRounded from '-icons/material-rounded'
import * as materialSharp from '-icons/material-sharp'
import * as materialTwoTone from '-icons/material-twotone'
import * as octicons from '-icons/octicons'
import * as openIconic from '-icons/open-iconic'
import * as remixFill from '-icons/remix-fill'
import * as remixEditor from '-icons/remix-editor'
import * as remixLine from '-icons/remix-line'
import * as simpleIcons from '-icons/simple-icons'
import * as typicons from '-icons/typicons'
import * as zondicons from '-icons/zondicons'
```
You can also import just the icons you need:
```javascript
import React, {Fragment} from 'react'
import {AccountCircle, Lock} from '-icons/material'
const App = () => (
<Fragment>
<AccountCircle />
<Lock />
</Fragment>
)
```
For the individual icon pack packages (`-icons/PACK`), the icons are also importable individually - this is not possible with the uber-`styled-icons` package containing all the packs:
```javascript
import React from 'react'
import {Lock} from '-icons/material/Lock'
const App = () => <Lock />
```
### Props
Styled Icons accept all the valid props of an `<svg />` element, in addition to the following custom props:
| Prop | Required | Type | Description |
| ------- | -------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `size` | optional | string, number | This is a convenience for setting both `width` and `height` to the same value |
| `title` | optional | string | This sets the icon title and enables the standalone icon accessibility mode. See [accessibility](#accessibility) below for additional details |
**Example**
```javascript
import React from 'react'
import {Lock} from '-icons/material'
const App = () => <Lock size="48" title="Unlock account" />
```
### Icon Dimensions
Some icons natively have non-square dimensions - original dimensions are exported from the individual icon exports:
```javascript
import {LogoGithub, LogoGithubDimensions} from '-icons/octicons/LogoGithub'
const App = () => <LogoGithub />
console.log(LogoGithubDimension) // {height: 16, width: 45}
```
Dimension exports are not available on the icon pack or index exports:
```javascript
import * as octicons from '-icons/octicons'
import {octicons} from 'styled-icons'
// octicons contains only icon exports
```
### Styled Components
All icons are exported as [Styled Components](https://www.styled-components.com/), which means it is possible to utilize the Styled Components API:
```javascript
import styled from 'styled-components'
import {Lock} from '-icons/material'
export const RedLock = styled(Lock)`
color: red;
font-weight: ${(props) => (props.important ? 'bold' : 'normal')};
`
```
### Base Icon Styles
If you wish to style all icons at once, you can create a wrapper styled component that imparts a particular style to all icons contained within the wrapper by targeting the `StyledIconBase` component:
```javascript
import styled from 'styled-components'
import {StyledIconBase} from '-icons/styled-icon'
export const IconStyleWrapper = styled.div`
${StyledIconBase} {
color: red;
/* icon styles go here */
}
`
```
### Accessibility
Styled Icons have two different built-in "modes" for accessibility purposes. By default, icons are considered decorative, meaning the icon is just visual sugar and the surrounding content is sufficient for conveying meaning. This will set the `aria-hidden` attribute on the resulting HTML to hide the icon from screen readers.
```javascript
// this icon
<Lock />
// will result in
<svg aria-hidden="true">...</svg>
```
Alternatively the icon could be used in standalone mode, meaning the icon itself should convey meaning. This mode is enabled by setting a `title` prop - this is the text that will be read by a screen reader. This results in `role` being set to `img` and the addition of a `<title>` element.
```javascript
// this icon
<Lock title="Lock account" />
// will result in
<svg role="img"><title>Lock account</title> ...</svg>
```
Since Style Icons accept all `<svg>` element attributes as props, you are free to override these `aria-*` attributes if you have a more complex use-case.
As this library provides direct access to the `<svg>` element, you may wish to further wrap the icon for additional semantic meaning. For example, for a loading spinner:
```javascript
import styled from 'styled-components'
import {Spinner} from '-icons/fa-solid/Spinner'
const VisuallyHidden = styled.span`
border: 0 !important;
clip: rect(1px, 1px, 1px, 1px) !important;
height: 1px !important;
overflow: hidden !important;
padding-top: 0 !important;
padding-right: 0 !important;
padding-bottom: 0 !important;
padding-left: 0 !important;
position: absolute !important;
white-space: nowrap !important;
width: 1px !important;
`
<span title="Loading posts..." role="alert" aria-live="assertive">
<Spinner />
<VisuallyHidden>Loading posts...</VisuallyHidden>
</span>
```
### Tree Shaking
Styled Icons supports automatic tree-shaking via the `package.json` `module` property from any of the import paths (icon pack, individual icon, etc.). Tree shaking has been tested with Create React App v2, Next.js, Rollup, and Webpack v4.
### TypeScript
The icons of `styled-icons` are built using TypeScript and export type definitions. If you need a type to reference any styled icon, there is a `StyledIcon` type exported from the `-icons/styled-icon` package (recommended) or the `styled-icons/types` import:
```typescript
import styled from 'styled-components'
// Recommended:
import {StyledIcon} from '-icons/styled-icon'
// Alternatively:
import {StyledIcon} from 'styled-icons/types'
interface Props {
icon: StyledIcon
}
```
**NOTE:** you should ensure that the version of `/react` in your project is at least `16.8.14` or greater. That version of the React types package added support for ARIA attributes on SVG elements, which Styled Icons uses.
If you have any ideas for improvements to the TypeScript typing, please open an issue or PR!
## Contributing
Contributions are welcome! Feel free to open an issue or a pull request and participate at whatever level you would like.
## License
The MIT License - see `LICENSE`.
The Bootstrap icons are licensed under the [MIT License](https://github.com/twbs/icons/blob/main/LICENSE.md).
The Boxicons are licensed under the [CC BY 4.0 License](https://boxicons.com/get-started#license).
The Cryptocurrency icons are licensed under the [CC0 1.0 Universal License](https://github.com/atomiclabs/cryptocurrency-icons/blob/master/LICENSE.md).
The Entypo icons are licensed under the [CC BY-SA 4.0 License](http://www.entypo.com/).
The Eva Icons are licensed under the [MIT License](https://github.com/akveo/eva-icons/blob/master/LICENSE.txt).
The Evil Icons are licensed under the [MIT License](https://github.com/evil-icons/evil-icons/blob/master/LICENSE.txt).
The Font Awesome icons are licensed under the [CC BY 4.0 License](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt).
The Feather icons are licensed under the [MIT License](https://github.com/feathericons/feather/blob/master/LICENSE).
The FluentUI System icons are licensed under the [MIT License](https://github.com/microsoft/fluentui-system-icons/blob/master/LICENSE).
The Foundation icons are licensed under the [MIT License](https://github.com/thecreation/standard-icons/blob/master/modules/foundation-icons/LICENSE).
The Heroicons are licensed under the [MIT License](https://github.com/tailwindlabs/heroicons/blob/master/LICENSE).
The Icomoon icons are dual licensed under [GPL](http://www.gnu.org/licenses/gpl.html) / [CC BY 4.0 License](http://creativecommons.org/licenses/by/4.0/).
The Ionicons are licensed under the [MIT License](https://github.com/ionic-team/ionicons/blob/master/LICENSE).
The Material Design icons are licensed under the [Apache License Version 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE).
The Octicons are licensed under the [MIT License](https://github.com/primer/octicons/blob/master/LICENSE).
The Open Iconic icons are licensed under the [MIT License](https://github.com/iconic/open-iconic/blob/master/ICON-LICENSE).
The Remix icons are licensed under the [Apache License 2.0](https://github.com/Remix-Design/RemixIcon/blob/master/License).
The Simple Icons are licensed under the [CC0 1.0 Universal License](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md).
The Typicons are licensed under the [CC BY SA 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/).
The Zondicons are licensed under the [MIT License](https://github.com/dukestreetstudio/zondicons/blob/master/LICENSE).
## Contributors
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/styled-icons#backer)]
<a href="https://opencollective.com/styled-icons#backers" target="_blank"><img src="https://opencollective.com/styled-icons/backers.svg?width=890"></a>
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/styled-icons#sponsor)]
<a href="https://opencollective.com/styled-icons/sponsor/0/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/1/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/2/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/3/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/4/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/5/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/6/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/7/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/8/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/styled-icons/sponsor/9/website" target="_blank"><img src="https://opencollective.com/styled-icons/sponsor/9/avatar.svg"></a>