UNPKG

1.7 kBMarkdownView Raw
1![Figicons](https://raw.githubusercontent.com/Figicons/Homepage/master/src/assets/Github-cover.png)
2
3## About Figicons
4
5Figicons is an open-source SVG icon set containing over 150+ icons designed on a 24px grid in Figma. Custom icons that are designed in Figma can also be used. Figicons provides the right tooling to easily fetch, parse & optimize such icons in minutes.
6
7[View all 150+ icons](https://figicons.com)
8
9## Designed in Figma
10
11The Figicons source is open in Figma, [check them out](https://www.figma.com/file/eIOdDEWeiHETuccK5xpfNhEc/Icons) and feel free to create issues for suggestions on the default icons.
12
13###### Figicons is not affiliated with Figma in any way
14
15## Building your own custom icons
16
17Figicons was built from the ground up with support for your own Figma-designed custom icons. In just a few steps you can create your own React & Web components.
18
19[Check the full documentation](https://figicons.com/building-icons)
20
21## Installation
22#### CDN
23
24To use the **React Component**, import:
25
26```
27https://unpkg.com/figicons/umd/ReactComponent.js
28```
29
30Or to use the **Web Component**, import:
31
32```
33https://unpkg.com/figicon/umd/WebComponent.js
34```
35
36## Usage
37To use the **React Component**, use the `Figicon` React element like so:
38
39```jsx
40<Figicon name="heart"/>
41```
42
43Or to use the **Web Component**, use the `fig-icon` Web Component like so:
44
45```html
46<fig-icon name="heart"></fig-icon>
47```
48
49[Check the full documentation on Usage](https://figicons.com/usage)
50
51## Contributing guidelines
52
53If you wish to contribute to the Figicons project please check out the ![contributing guidelines](CODE_OF_CONDUCT.md).
54
55## License
56
57Figicons is licensed under the ![MIT License](LICENSE)