@behivetech/atoms.icon 0.3.2 → 0.3.4
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 +2 -8
- package/docs.json +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
A hand-authored, stroke-based SVG icon set behind a single `Icon` component — the same idea as `@ant-design/icons`/`@mui/icons-material`, but self-contained (no new dependency). Icons use `stroke="currentColor"`, so they inherit color from whatever text color is in scope.
|
|
4
4
|
|
|
5
|
+
Docs: https://bht-galaxy.vercel.app/behivetech/atoms/icon
|
|
6
|
+
|
|
5
7
|
## Usage
|
|
6
8
|
|
|
7
9
|
```jsx
|
|
@@ -18,11 +20,3 @@ import { Icon } from '@behivetech/atoms.icon';
|
|
|
18
20
|
Note that `box` is the 3D carton glyph; `rectangle` is the flat shape primitive that pairs with `ellipse`.
|
|
19
21
|
|
|
20
22
|
Add new icons by adding a module under `icons/` that calls `createIcon` with geometry in a `0 0 24 24` viewBox, stroke-based to match the existing set, then registering it in `icons/index.ts` and `icons/registry.ts`.
|
|
21
|
-
|
|
22
|
-
## Props
|
|
23
|
-
|
|
24
|
-
| Prop | Type | Default | Description |
|
|
25
|
-
| ----------- | ---------------------- | ------- | ------------------------------- |
|
|
26
|
-
| `name` | `IconName` | — | Which icon to render (required) |
|
|
27
|
-
| `size` | `sm \| md \| lg \| xl` | `md` | Icon width/height |
|
|
28
|
-
| `className` | `string` | — | Additional class names |
|
package/docs.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@behivetech/atoms.icon",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"license": "MIT",
|
|
5
|
+
"description": "A hand-authored, stroke-based SVG icon set behind a single `Icon` component — the same idea as `@ant-design/icons`/`@mui/icons-material`, but self-contained (no new dependency). Icons use `stroke=\"currentColor\"`, so they inherit color from whatever text color is in scope.",
|
|
5
6
|
"type": "module",
|
|
6
7
|
"private": false,
|
|
7
8
|
"exports": {
|
|
@@ -48,6 +49,7 @@
|
|
|
48
49
|
"url": "https://github.com/behivetech/bht-galaxy.git",
|
|
49
50
|
"directory": "registry/behivetech/atoms/icon"
|
|
50
51
|
},
|
|
52
|
+
"homepage": "https://bht-galaxy.vercel.app/behivetech/atoms/icon",
|
|
51
53
|
"publishConfig": {
|
|
52
54
|
"registry": "https://registry.npmjs.org",
|
|
53
55
|
"access": "public",
|