Skip to content

Commit a58e725

Browse files
committed
docs: add icon documentation
1 parent c143705 commit a58e725

File tree

3 files changed

+222
-0
lines changed

3 files changed

+222
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
```jsx
3+
import { CIcon } from '@coreui/react'
4+
// or
5+
import CIcon from '@coreui/react/src/components/icon/CIcon'
6+
```
7+
8+
| Property | Description | Type | Default |
9+
| --- | --- | --- | --- |
10+
| **className** | A string of all className you want applied to the component. | `string` | - |
11+
| **content** | Use `icon={...}` instead of<br/>@deprecated since version 3.0 | `string` \| `string[]` | - |
12+
| **customClassName** | Use for replacing default CIcon component classes. Prop is overriding the 'size' prop. | `string` \| `object` \| `string[]` | - |
13+
| **height** | The height attribute defines the vertical length of an icon. | `number` | - |
14+
| **icon** | Name of the icon placed in React object or SVG content. | `string` \| `string[]` | - |
15+
| **name** | Use `icon="..."` instead of<br/>@deprecated since version 3.0 | `string` | - |
16+
| **size** | Size of the icon. Available sizes: 'sm', 'lg', 'xl', 'xxl', '3xl...9xl', 'custom', 'custom-size'. | `'custom-size'` \| `'sm'` \| `'lg'` \| `'xl'` \| `'xxl'` \| `'3xl'` \| `'4xl'` \| `'5xl'` \| `'6xl'` \| `'7xl'` \| `'8xl'` \| `'9xl'` | - |
17+
| **title** | Title tag content. | `string` | - |
18+
| **use** | If defined component will be rendered using 'use' tag. | `string` | - |
19+
| **width** | The width attribute defines the horizontal length of an icon. | `number` | - |

0 commit comments

Comments
 (0)