@central-icons-react/round-filled-radius-3-stroke-1 1.0.8 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -19
- package/icons-index.json +1 -1
- package/index.d.ts +4229 -11
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/license-check.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,7 +26,7 @@ npm install central-icons@npm:@central-icons-react/round-filled-radius-3-stroke-
|
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
```jsx
|
|
29
|
-
import { IconHome } from "central-icons
|
|
29
|
+
import { IconHome } from "central-icons";
|
|
30
30
|
|
|
31
31
|
function MyComponent() {
|
|
32
32
|
return <IconHome />;
|
|
@@ -56,29 +56,38 @@ pnpm add @central-icons-react/round-filled-radius-3-stroke-1
|
|
|
56
56
|
|
|
57
57
|
## Usage
|
|
58
58
|
|
|
59
|
-
###
|
|
59
|
+
### Direct Import (Recommended)
|
|
60
60
|
|
|
61
|
-
Icons can be imported
|
|
61
|
+
Icons can be imported directly from the package root for convenience:
|
|
62
62
|
|
|
63
63
|
```jsx
|
|
64
|
-
import { IconHome } from "@central-icons-react/round-filled-radius-3-stroke-1
|
|
64
|
+
import { IconHome } from "@central-icons-react/round-filled-radius-3-stroke-1";
|
|
65
65
|
|
|
66
66
|
function MyComponent() {
|
|
67
67
|
return <IconHome />;
|
|
68
68
|
}
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
|
|
74
|
-
(Requires npm at least v6.9.0 or yarn)
|
|
71
|
+
Or with an alias for cleaner imports:
|
|
75
72
|
|
|
76
73
|
```bash
|
|
77
74
|
npm install central-icons@npm:@central-icons-react/round-filled-radius-3-stroke-1
|
|
78
75
|
```
|
|
79
76
|
|
|
80
77
|
```jsx
|
|
81
|
-
import { IconHome } from "central-icons
|
|
78
|
+
import { IconHome } from "central-icons";
|
|
79
|
+
|
|
80
|
+
function MyComponent() {
|
|
81
|
+
return <IconHome />;
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Individual Path Imports
|
|
86
|
+
|
|
87
|
+
For advanced tree-shaking or when you prefer explicit paths:
|
|
88
|
+
|
|
89
|
+
```jsx
|
|
90
|
+
import { IconHome } from "@central-icons-react/round-filled-radius-3-stroke-1/IconHome";
|
|
82
91
|
|
|
83
92
|
function MyComponent() {
|
|
84
93
|
return <IconHome />;
|
|
@@ -101,16 +110,11 @@ function MyComponent() {
|
|
|
101
110
|
|
|
102
111
|
All icons accept the following properties:
|
|
103
112
|
|
|
104
|
-
| Prop | Type
|
|
105
|
-
| ------------ |
|
|
106
|
-
| `size` | `number \| string`
|
|
107
|
-
| `color` | `string`
|
|
108
|
-
| `ariaHidden` | `boolean`
|
|
109
|
-
| `iconJoin` | `"round" \| "square"` | `"round"` | Controls the icon's corner style |
|
|
110
|
-
| `iconFill` | `"filled" \| "outlined"` | `"filled"` | Sets the icon's fill style |
|
|
111
|
-
| `iconStroke` | `"1" \| "1.5" \| "2"` | `"1"` | Controls the stroke width |
|
|
112
|
-
| `iconRadius` | `"0" \| "1" \| "2" \| "3"` | `"1"` | Sets the corner radius |
|
|
113
|
-
| `name` | `string` | none | Defines which icon should be used - see [Icons List](#icons) |
|
|
113
|
+
| Prop | Type | Default | Description |
|
|
114
|
+
| ------------ | ------------------ | -------------- | -------------------------------------- |
|
|
115
|
+
| `size` | `number \| string` | `24` | Sets both width and height of the icon |
|
|
116
|
+
| `color` | `string` | `currentColor` | Sets the icon color |
|
|
117
|
+
| `ariaHidden` | `boolean` | `true` | Controls icon accessibility attributes |
|
|
114
118
|
|
|
115
119
|
Additionally, all standard SVG and HTML attributes are supported.
|
|
116
120
|
|
package/icons-index.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"package": "@central-icons-react/round-filled-radius-3-stroke-1",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"style": "round-filled-radius-3-stroke-1",
|
|
5
5
|
"importExamples": {
|
|
6
6
|
"individual": "import { IconHome } from '@central-icons-react/round-filled-radius-3-stroke-1/IconHome';",
|