@cascivo/icons 0.1.0 → 0.1.1

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.
Files changed (3) hide show
  1. package/README.md +42 -5
  2. package/package.json +5 -5
  3. package/readme.body.md +26 -1
package/README.md CHANGED
@@ -1,12 +1,47 @@
1
1
  <!-- generated by scripts/readme/generate.ts — edit readme.body.md, not this file -->
2
2
 
3
- # @cascivo/icons
3
+ <div align="center">
4
+ <a href="https://cascivo.com"><img src="https://cascivo.com/favicon.svg" width="72" height="72" alt="cascivo logo"></a>
5
+ <h1>@cascivo/icons</h1>
6
+ <p><strong>Optional SVG icon components</strong></p>
4
7
 
5
- > Optional SVG icon components
8
+ [![npm](https://img.shields.io/npm/v/%40cascivo%2Ficons?style=flat-square&color=0079bf)](https://www.npmjs.com/package/@cascivo/icons)
9
+ [![downloads](https://img.shields.io/npm/dm/%40cascivo%2Ficons?style=flat-square&color=0079bf)](https://www.npmjs.com/package/@cascivo/icons)
10
+ [![license](https://img.shields.io/npm/l/%40cascivo%2Ficons?style=flat-square&color=0079bf)](https://github.com/cascivo/cascivo/blob/main/LICENSE)
11
+ ![types](https://img.shields.io/badge/types-included-0079bf?style=flat-square&logo=typescript&logoColor=white)
6
12
 
7
- [cascivo.com](https://cascivo.com) · [Docs](https://docs.cascivo.com) · [Storybook](https://storybook.cascivo.com) · [GitHub](https://github.com/urbanisierung/cascivo)
13
+ [npm](https://www.npmjs.com/package/@cascivo/icons) · [cascivo.com](https://cascivo.com) · [Docs](https://docs.cascivo.com) · [Storybook](https://storybook.cascivo.com) · [GitHub](https://github.com/cascivo/cascivo)
8
14
 
9
- Optional SVG icon components for cascade — a curated set of React SVG icons that follow the cascade token system. Import individually to keep bundle size minimal.
15
+ </div>
16
+
17
+ ---
18
+
19
+ A curated set of React SVG icon components that inherit the cascivo token system — `currentColor` fills, token-driven sizing, and tree-shakeable named exports.
20
+
21
+ ## Usage
22
+
23
+ ```tsx
24
+ import { ChevronDown, Search, Check } from '@cascivo/icons'
25
+
26
+ export function Field() {
27
+ return (
28
+ <button>
29
+ <Search />
30
+ Search
31
+ </button>
32
+ )
33
+ }
34
+ ```
35
+
36
+ Each icon is a plain `<svg>` that reads `1em` sizing and `currentColor`, so it scales with font size and adopts the surrounding text color automatically:
37
+
38
+ ```css
39
+ button svg {
40
+ inline-size: var(--cascivo-icon-size, 1.25em);
41
+ }
42
+ ```
43
+
44
+ Import only the icons you use — named exports are individually tree-shakeable, so bundle cost scales with usage, not catalog size.
10
45
 
11
46
  ## Install
12
47
 
@@ -16,4 +51,6 @@ pnpm add @cascivo/icons
16
51
 
17
52
  ---
18
53
 
19
- [cascivo.com](https://cascivo.com) · [Docs](https://docs.cascivo.com) · [Storybook](https://storybook.cascivo.com) · [GitHub](https://github.com/urbanisierung/cascivo) · AI agents: use [`@cascivo/mcp`](https://github.com/urbanisierung/cascivo/tree/main/packages/mcp) and [`registry.json`](https://github.com/urbanisierung/cascivo/blob/main/registry.json) · MIT
54
+ [cascivo.com](https://cascivo.com) · [Docs](https://docs.cascivo.com) · [Storybook](https://storybook.cascivo.com) · [GitHub](https://github.com/cascivo/cascivo) · AI agents: use [`@cascivo/mcp`](https://github.com/cascivo/cascivo/tree/main/packages/mcp) and [`registry.json`](https://github.com/cascivo/cascivo/blob/main/registry.json) · MIT
55
+
56
+ <div align="center"><a href="https://cascivo.com"><img src="https://cascivo.com/favicon.svg" width="28" height="28" alt="cascivo"></a></div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cascivo/icons",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "private": false,
5
5
  "description": "Optional SVG icon components",
6
6
  "keywords": [
@@ -12,13 +12,13 @@
12
12
  "signals",
13
13
  "svg"
14
14
  ],
15
- "homepage": "https://github.com/urbanisierung/cascivo/tree/main/packages/icons#readme",
16
- "bugs": "https://github.com/urbanisierung/cascivo/issues",
15
+ "homepage": "https://github.com/cascivo/cascivo/tree/main/packages/icons#readme",
16
+ "bugs": "https://github.com/cascivo/cascivo/issues",
17
17
  "license": "MIT",
18
18
  "author": "urbanisierung",
19
19
  "repository": {
20
20
  "type": "git",
21
- "url": "git+https://github.com/urbanisierung/cascivo.git",
21
+ "url": "git+https://github.com/cascivo/cascivo.git",
22
22
  "directory": "packages/icons"
23
23
  },
24
24
  "files": [
@@ -47,7 +47,7 @@
47
47
  "react": "^19.2.7",
48
48
  "react-dom": "^19.2.7",
49
49
  "typescript": "^5",
50
- "vite-plus": "^0.1.24"
50
+ "vite-plus": "^0.2.1"
51
51
  },
52
52
  "peerDependencies": {
53
53
  "react": ">=18.0.0"
package/readme.body.md CHANGED
@@ -1 +1,26 @@
1
- Optional SVG icon components for cascade — a curated set of React SVG icons that follow the cascade token system. Import individually to keep bundle size minimal.
1
+ A curated set of React SVG icon components that inherit the cascivo token system — `currentColor` fills, token-driven sizing, and tree-shakeable named exports.
2
+
3
+ ## Usage
4
+
5
+ ```tsx
6
+ import { ChevronDown, Search, Check } from '@cascivo/icons'
7
+
8
+ export function Field() {
9
+ return (
10
+ <button>
11
+ <Search />
12
+ Search
13
+ </button>
14
+ )
15
+ }
16
+ ```
17
+
18
+ Each icon is a plain `<svg>` that reads `1em` sizing and `currentColor`, so it scales with font size and adopts the surrounding text color automatically:
19
+
20
+ ```css
21
+ button svg {
22
+ inline-size: var(--cascivo-icon-size, 1.25em);
23
+ }
24
+ ```
25
+
26
+ Import only the icons you use — named exports are individually tree-shakeable, so bundle cost scales with usage, not catalog size.