UNPKG

1.03 kBMarkdownView Raw
1# quill-icons
2
3> Editor icons extract from quill editor, with React component wrapper, support 65+ icons!
4
5## Installation
6
7```sh
8$ npm install --save quill-icons
9```
10
11## Usage
12
13```js
14var quillIcons = require("quill-icons");
15
16// icons options see ./src/icons
17// USAGE:
18
19<quillIcons.AlignCenter />; // React element
20```
21
22Icons support: [Complete list](https://canner.github.io/canner-slate-editor/?selectedKind=Quill%20icons)
23
24## Props
25
26You could customized stroke, fill, etc... class names, just pass as props.
27
28```js
29export default {
30 strokeClassName: "ql-stroke",
31 fillClassName: "ql-fill",
32 evenClassName: "ql-even",
33 colorLabelClassName: "ql-color-label",
34 transparentClassName: "ql-transparent",
35 strokeMitterClassName: "ql-stroke-mitter",
36 thinClassName: "ql-thin",
37 width: "18px",
38 height: "18px"
39};
40```
41
42## License
43
44BSD-3-Clause © [Canner](https://github.com/Canner)
45
46Big thanks to [Quilljs](https://github.com/quilljs)
47
48Icons license see [Quill License](https://github.com/quilljs/quill/blob/develop/LICENSE)