@central-icons-react/round-filled-radius-0-stroke-1 0.0.33 → 0.0.36

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 CHANGED
@@ -1,35 +1,39 @@
1
1
  # @central-icons-react/round-filled-radius-0-stroke-1
2
2
 
3
- A collection of **1,748 round filled React icons** with 0px radius and 1px stroke width, designed for use in React applications.
3
+ A collection of round filled React icons with 0px radius and 1px stroke width, designed for use in React applications.
4
4
 
5
- ## 📋 Table of Contents
5
+ ## Table of Contents
6
6
 
7
- - [🚀 Quick Start](#quick-start)
8
- - [📦 Installation](#installation)
9
- - [⚙️ Requirements](#requirements)
10
- - [💡 Usage Examples](#usage-examples)
11
- - [🎨 Icon Properties](#icon-properties)
12
- - [Accessibility](#accessibility)
13
- - [🔍 Icon Discovery](#icon-discovery)
14
- - [📚 Available Packages](#available-packages)
15
- - [📖 Complete Icons List](#complete-icons-list)
16
- - [📄 License](#license)
17
- - [🔧 Troubleshooting](#troubleshooting)
7
+ - [Quick Start](#quick-start)
8
+ - [Installation](#installation)
9
+ - [Requirements](#requirements)
10
+ - [Usage](#usage)
11
+ - [Icon Properties](#icon-properties)
12
+ - [Accessibility](#accessibility)
13
+ - [Available Packages](#available-packages)
14
+ - [Icons List](#icons)
15
+ - [License](#license)
16
+ - [Troubleshooting](#troubleshooting)
18
17
 
19
- ## 🚀 Quick Start
18
+ ## Quick Start
19
+
20
+ ```bash
21
+ # Set your license key first
22
+ export CENTRAL_LICENSE_KEY=your_license_key
23
+
24
+ # Install with alias 'central-icons'
25
+ npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1
26
+ ```
20
27
 
21
28
  ```jsx
22
- import { IconHome } from "@central-icons-react/round-filled-radius-0-stroke-1/IconHome";
29
+ import { IconHome } from "central-icons/IconHome";
23
30
 
24
- function App() {
25
- return <IconHome size={24} color="#007AFF" />;
31
+ function MyComponent() {
32
+ return <IconHome />;
26
33
  }
27
34
  ```
28
35
 
29
- **Style:** Round filled icons with sharp corners (0px radius) and 1px stroke width
30
- **Total Icons:** 1,748 icons across 34 categories
31
-
32
- ## 📦 Installation
36
+ ## Installation
33
37
 
34
38
  This package is private and can be installed via your organization's private npm registry. Make sure you have the required license key set up before installation.
35
39
 
@@ -45,78 +49,70 @@ yarn add @central-icons-react/round-filled-radius-0-stroke-1
45
49
  pnpm add @central-icons-react/round-filled-radius-0-stroke-1
46
50
  ```
47
51
 
48
- ## ⚙️ Requirements
52
+ ## Requirements
49
53
 
50
54
  - React 14.0.0 or higher
51
55
  - Valid license key (set as environment variable)
52
56
 
53
- ## 💡 Usage Examples
57
+ ## Usage
54
58
 
55
59
  ### Individual Imports (Recommended)
56
60
 
57
- Import icons individually to keep your bundle size minimal:
61
+ Icons can be imported individually to keep your bundle size minimal:
58
62
 
59
63
  ```jsx
60
64
  import { IconHome } from "@central-icons-react/round-filled-radius-0-stroke-1/IconHome";
61
65
 
62
66
  function MyComponent() {
63
- return <IconHome size={24} color="#007AFF" />;
67
+ return <IconHome />;
64
68
  }
65
69
  ```
66
70
 
67
- ### Central Icon Component
71
+ ### Import alias
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)
68
75
 
69
- Import from the main entry point (not recommended for production, loads all icons):
76
+ `npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1`
70
77
 
71
78
  ```jsx
72
- import { CentralIcon } from "@central-icons-react/round-filled-radius-0-stroke-1";
79
+ import { IconHome } from "central-icons/IconHome";
73
80
 
74
81
  function MyComponent() {
75
- return <CentralIcon name="IconHome" size={24} color="#007AFF" />;
82
+ return <IconHome />;
76
83
  }
77
84
  ```
78
85
 
79
- ### Import Aliases
80
-
81
- For cleaner imports (requires npm v6.9.0+ or yarn):
86
+ ### Central Icon Component
82
87
 
83
- ```bash
84
- npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1
85
- ```
88
+ Or you can import from the main entry point (not recommended to be used in production, loads all icons):
86
89
 
87
90
  ```jsx
88
- import { IconHome } from "central-icons/IconHome";
91
+ import { CentralIcon } from "@central-icons-react/round-filled-radius-0-stroke-1";
89
92
 
90
93
  function MyComponent() {
91
- return <IconHome size={24} color="#007AFF" />;
94
+ return <CentralIcon name="IconName" />;
92
95
  }
93
96
  ```
94
97
 
95
- ## 🎨 Icon Properties
98
+ ## Icon Properties
96
99
 
97
100
  All icons accept the following properties:
98
101
 
99
- | Prop | Type | Default | Description |
100
- | ------------ | -------------------------- | -------------- | -------------------------------------------------------------------------- |
101
- | `size` | `number \| string` | `24` | Sets both width and height of the icon |
102
- | `color` | `string` | `currentColor` | Sets the icon color |
103
- | `ariaHidden` | `boolean` | `true` | Controls icon accessibility attributes |
104
- | `iconJoin` | `"round" \| "square"` | `"round"` | Controls the icon's corner style |
105
- | `iconFill` | `"filled" \| "outlined"` | `"filled"` | Sets the icon's fill style |
106
- | `iconStroke` | `"1" \| "1.5" \| "2"` | `"1"` | Controls the stroke width |
107
- | `iconRadius` | `"0" \| "1" \| "2" \| "3"` | `"0"` | Sets the corner radius |
108
- | `name` | `string` | none | Defines which icon should be used - see [Icons List](#complete-icons-list) |
102
+ | Prop | Type | Default | Description |
103
+ | ------------ | -------------------------- | -------------- | ------------------------------------------------------------ |
104
+ | `size` | `number \| string` | `24` | Sets both width and height of the icon |
105
+ | `color` | `string` | `currentColor` | Sets the icon color |
106
+ | `ariaHidden` | `boolean` | `true` | Controls icon accessibility attributes |
107
+ | `iconJoin` | `"round" \| "square"` | `"round"` | Controls the icon's corner style |
108
+ | `iconFill` | `"filled" \| "outlined"` | `"filled"` | Sets the icon's fill style |
109
+ | `iconStroke` | `"1" \| "1.5" \| "2"` | `"1"` | Controls the stroke width |
110
+ | `iconRadius` | `"0" \| "1" \| "2" \| "3"` | `"1"` | Sets the corner radius |
111
+ | `name` | `string` | none | Defines which icon should be used - see [Icons List](#icons) |
109
112
 
110
113
  Additionally, all standard SVG and HTML attributes are supported.
111
114
 
112
- ### Style Properties for This Package
113
-
114
- - **iconJoin:** `"round"` (fixed)
115
- - **iconFill:** `"filled"` (fixed)
116
- - **iconStroke:** `"1"` (fixed)
117
- - **iconRadius:** `"0"` (fixed)
118
-
119
- ## ♿ Accessibility
115
+ ## Accessibility
120
116
 
121
117
  Icons are aria-hidden by default for decorative purposes. When using icons that convey meaning, you should disable aria-hidden:
122
118
 
@@ -137,38 +133,7 @@ When `ariaHidden` is `false`:
137
133
  - The element gets `role="img"` attribute
138
134
  - Screen readers will announce the icon's title
139
135
 
140
- ## 🔍 Icon Discovery
141
-
142
- ### Quick Search by Category
143
-
144
- Find icons by browsing categories:
145
-
146
- - **🔧 Interface:** Settings, navigation, buttons, forms
147
- - **📱 Devices:** Phones, computers, tablets, accessories
148
- - **🎨 Design:** Tools, colors, editing, creative
149
- - **💼 Business:** Finance, shopping, communication
150
- - **🎮 Entertainment:** Gaming, media, social platforms
151
- - **🏠 Home:** Building, furniture, household items
152
- - **🚗 Transport:** Vehicles, travel, location
153
- - **⚡ Technology:** Code, development, AI, crypto
154
- - **🎯 Activities:** Sports, food, weather, time
155
-
156
- ### Common Icon Searches
157
-
158
- - **Navigation:** `IconArrow`, `IconChevron`, `IconHome`, `IconBack`
159
- - **Actions:** `IconPlus`, `IconMinus`, `IconCheck`, `IconClose`
160
- - **Communication:** `IconEmail`, `IconCall`, `IconMessage`, `IconShare`
161
- - **Settings:** `IconSettings`, `IconFilter`, `IconSearch`, `IconMenu`
162
- - **Files:** `IconFile`, `IconFolder`, `IconDownload`, `IconUpload`
163
- - **Media:** `IconPlay`, `IconPause`, `IconCamera`, `IconVideo`
164
-
165
- ### AI-Friendly Resources
166
-
167
- - **Complete Index:** See `icons-index.json` for structured data
168
- - **Category Overview:** Browse icons by category below
169
- - **Search Terms:** Use common terms to find related icons
170
-
171
- ## 📚 Available Packages
136
+ ## Available Packages
172
137
 
173
138
  For optimal bundle size, consider using our specific bundles instead of the full package:
174
139
 
@@ -203,9 +168,9 @@ https://npmjs.com/package/@central-icons-react/round-filled-radius-2-stroke-1
203
168
  https://npmjs.com/package/@central-icons-react/round-outlined-radius-3-stroke-1
204
169
  https://npmjs.com/package/@central-icons-react/round-filled-radius-3-stroke-1
205
170
 
206
- ## 📖 Complete Icons List
171
+ ## Icons
207
172
 
208
- Below is a complete list of available icons organized by category:
173
+ Below is a complete list of available icons:
209
174
 
210
175
  ### Accessibility
211
176
 
@@ -1780,14 +1745,14 @@ Below is a complete list of available icons organized by category:
1780
1745
  - IconThunder
1781
1746
  - IconWind
1782
1747
 
1783
- ## 📄 License
1748
+ ## License
1784
1749
 
1785
1750
  This is a private package with all rights reserved. Unauthorized copying or distribution is prohibited.
1786
1751
 
1787
1752
  - Licenses can be purchased at: https://iconists.co/central
1788
1753
  - License key must be present as an environment variable during installation
1789
1754
 
1790
- ## 🔧 Troubleshooting
1755
+ ## Troubleshooting
1791
1756
 
1792
1757
  Common issues and solutions:
1793
1758
 
@@ -1803,11 +1768,5 @@ Common issues and solutions:
1803
1768
  - Ensure React version meets requirements
1804
1769
 
1805
1770
  3. **Bundle size concerns**
1806
-
1807
1771
  - Use specific imports instead of the main entry point
1808
1772
  - Use a build tool supporting tree shaking
1809
-
1810
- 4. **Finding the right icon**
1811
- - Browse categories in the [Complete Icons List](#complete-icons-list)
1812
- - Use the search index in `icons-index.json`
1813
- - Check common search terms in the [Icon Discovery](#icon-discovery) section