@emberkit/icons 0.1.2-alpha.0 → 0.1.2
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 +69 -0
- package/package.json +4 -4
package/README.md
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# @emberkit/icons
|
|
2
|
+
|
|
3
|
+
SVG icon library for EmberKit. Tree-shakeable, lightweight, and built with JSX.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @emberkit/icons
|
|
9
|
+
# or
|
|
10
|
+
pnpm add @emberkit/icons
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { IconMenu, IconX, IconSearch } from '@emberkit/icons';
|
|
17
|
+
|
|
18
|
+
function Header() {
|
|
19
|
+
return (
|
|
20
|
+
<nav>
|
|
21
|
+
<IconMenu size={24} />
|
|
22
|
+
<IconX size={24} color="#f97316" />
|
|
23
|
+
<IconSearch size={20} className="search-icon" />
|
|
24
|
+
</nav>
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Available Icons
|
|
30
|
+
|
|
31
|
+
| Category | Icons |
|
|
32
|
+
|----------|-------|
|
|
33
|
+
| Navigation | `IconMenu`, `IconX`, `IconChevronDown`, `IconChevronRight`, `IconChevronLeft` |
|
|
34
|
+
| Arrows | `IconArrowRight`, `IconArrowUp`, `IconArrowDown` |
|
|
35
|
+
| Media | `IconPlay`, `IconPause`, `IconImage` |
|
|
36
|
+
| Code | `IconCode`, `IconTerminal` |
|
|
37
|
+
| UI | `IconSearch`, `IconCopy`, `IconCheck`, `IconPlus`, `IconMinus`, `IconExternalLink` |
|
|
38
|
+
| Files | `IconFile`, `IconFolder`, `IconEdit`, `IconTrash`, `IconDownload`, `IconUpload` |
|
|
39
|
+
| Shapes | `IconHeart`, `IconStar`, `IconShield`, `IconCloud`, `IconGlobe` |
|
|
40
|
+
| People | `IconUser`, `IconUsers`, `IconLock`, `IconMail` |
|
|
41
|
+
| Time | `IconCalendar`, `IconClock` |
|
|
42
|
+
| Layout | `IconHome`, `IconGrid`, `IconLayers`, `IconSettings` |
|
|
43
|
+
| Brand | `IconGithub` |
|
|
44
|
+
| Alerts | `IconAlertCircle` |
|
|
45
|
+
| Other | `IconBook`, `IconZap`, `IconPackage`, `IconTarget`, `IconType`, `IconSun`, `IconMoon`, `IconLink`, `IconRefresh`, `IconMapPin` |
|
|
46
|
+
|
|
47
|
+
## Props
|
|
48
|
+
|
|
49
|
+
All icons accept the same props:
|
|
50
|
+
|
|
51
|
+
| Prop | Type | Default | Description |
|
|
52
|
+
|------|------|---------|-------------|
|
|
53
|
+
| `size` | `number` | `24` | Width and height in pixels |
|
|
54
|
+
| `color` | `string` | `currentColor` | Stroke or fill color |
|
|
55
|
+
| `className` | `string` | — | CSS class name |
|
|
56
|
+
|
|
57
|
+
## Default Import
|
|
58
|
+
|
|
59
|
+
You can also import all icons as an object:
|
|
60
|
+
|
|
61
|
+
```tsx
|
|
62
|
+
import Icons from '@emberkit/icons';
|
|
63
|
+
|
|
64
|
+
<Icons.Menu size={24} />
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@emberkit/icons",
|
|
3
|
-
"version": "0.1.2
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "SVG icon library for EmberKit",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -30,11 +30,11 @@
|
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {},
|
|
32
32
|
"peerDependencies": {
|
|
33
|
-
"@emberkit/core": "0.1.2
|
|
33
|
+
"@emberkit/core": "0.1.2"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
|
-
"@emberkit/tsconfig": "0.1.2
|
|
37
|
-
"@emberkit/core": "0.1.2
|
|
36
|
+
"@emberkit/tsconfig": "0.1.2",
|
|
37
|
+
"@emberkit/core": "0.1.2"
|
|
38
38
|
},
|
|
39
39
|
"scripts": {
|
|
40
40
|
"build": "tsc",
|