@totakit/icons 1.0.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/CHANGELOG.md +17 -0
- package/LICENSE +21 -0
- package/README.md +160 -0
- package/package.json +139 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@totakit/icons` will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Initial package structure with exports map for 6 styles
|
|
13
|
+
- React component contract: `forwardRef`, `SVGProps`, `size`/`color`/`strokeWidth` props
|
|
14
|
+
- SVG subpath exports for raw SVG access
|
|
15
|
+
- Metadata subpath exports for `icons.json`, `categories.json`, `aliases.json`
|
|
16
|
+
- CSS subpath exports for CSS-only usage
|
|
17
|
+
- MIT license
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 totakit
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
<h1 align="center">@totakit/icons</h1>
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<strong>Open-source icons with optical precision — 6 styles, one definition.</strong><br/>
|
|
5
|
+
<em>Stroke-compensated. Weight-normalized. Pixel-hinted.</em>
|
|
6
|
+
</p>
|
|
7
|
+
|
|
8
|
+
<p align="center">
|
|
9
|
+
<a href="https://www.npmjs.com/package/@totakit/icons"><img src="https://img.shields.io/npm/v/@totakit/icons?style=flat-square&label=npm" alt="npm"></a>
|
|
10
|
+
<a href="https://github.com/totakit/icons/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/totakit/icons/ci.yml?style=flat-square&label=CI" alt="CI"></a>
|
|
11
|
+
<a href="https://github.com/totakit/icons/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-green?style=flat-square" alt="License"></a>
|
|
12
|
+
<a href="https://icons.totakit.com"><img src="https://img.shields.io/badge/Browse-icons.totakit.com-6366f1?style=flat-square" alt="Browse"></a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install @totakit/icons
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pnpm add @totakit/icons
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
yarn add @totakit/icons
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Usage
|
|
32
|
+
|
|
33
|
+
```tsx
|
|
34
|
+
import { ArrowRight, Check, Plus, X, Minus } from '@totakit/icons'
|
|
35
|
+
|
|
36
|
+
function App() {
|
|
37
|
+
return (
|
|
38
|
+
<nav>
|
|
39
|
+
<ArrowRight size={20} />
|
|
40
|
+
<Check size={20} color="green" />
|
|
41
|
+
<X size={20} color="red" />
|
|
42
|
+
<Plus />
|
|
43
|
+
<Minus />
|
|
44
|
+
</nav>
|
|
45
|
+
)
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Every icon is a React component with `forwardRef`, full TypeScript types, and all standard `SVGProps<SVGSVGElement>`.
|
|
50
|
+
|
|
51
|
+
## Styles
|
|
52
|
+
|
|
53
|
+
Each icon ships in 6 styles. Import from the style subpath — tree-shaking ensures you only bundle what you use.
|
|
54
|
+
|
|
55
|
+
```tsx
|
|
56
|
+
import { ArrowRight } from '@totakit/icons' // outline (default)
|
|
57
|
+
import { ArrowRight } from '@totakit/icons/solid'
|
|
58
|
+
import { ArrowRight } from '@totakit/icons/duotone'
|
|
59
|
+
import { ArrowRight } from '@totakit/icons/thin'
|
|
60
|
+
import { ArrowRight } from '@totakit/icons/bold'
|
|
61
|
+
import { ArrowRight } from '@totakit/icons/micro'
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
| Style | Stroke | Use case |
|
|
65
|
+
|-------|--------|----------|
|
|
66
|
+
| Outline | 1.5px | Default UI, navigation, toolbars |
|
|
67
|
+
| Solid | Filled | Buttons, active states, emphasis |
|
|
68
|
+
| Duotone | Two-tone | Dashboards, illustrations |
|
|
69
|
+
| Thin | 1.0px | Elegant interfaces, large sizes |
|
|
70
|
+
| Bold | 2.0px | Small sizes, dark backgrounds |
|
|
71
|
+
| Micro | 2.0px simplified | 12–16px rendering, favicons, badges |
|
|
72
|
+
|
|
73
|
+
## Props
|
|
74
|
+
|
|
75
|
+
| Prop | Type | Default | Description |
|
|
76
|
+
|------|------|---------|-------------|
|
|
77
|
+
| `size` | `number` | `24` | Width and height in pixels |
|
|
78
|
+
| `color` | `string` | `'currentColor'` | Stroke/fill color |
|
|
79
|
+
| `strokeWidth` | `number` | Style-dependent | Override stroke width |
|
|
80
|
+
|
|
81
|
+
All `SVGProps<SVGSVGElement>` are also accepted — `className`, `style`, `onClick`, `aria-label`, etc.
|
|
82
|
+
|
|
83
|
+
## Raw SVG
|
|
84
|
+
|
|
85
|
+
For non-React usage, import SVG strings directly:
|
|
86
|
+
|
|
87
|
+
```js
|
|
88
|
+
import svg from '@totakit/icons/svg/outline/arrow-right.svg?raw'
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Metadata
|
|
92
|
+
|
|
93
|
+
Icon metadata is available as JSON for tooling and search:
|
|
94
|
+
|
|
95
|
+
```js
|
|
96
|
+
import icons from '@totakit/icons/meta/icons.json'
|
|
97
|
+
import categories from '@totakit/icons/meta/categories.json'
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## CDN
|
|
101
|
+
|
|
102
|
+
Use icons without a build step:
|
|
103
|
+
|
|
104
|
+
```html
|
|
105
|
+
<img src="https://icons.totakit.com/svg/arrow-right.svg" alt="" />
|
|
106
|
+
<img src="https://icons.totakit.com/svg/check.svg?style=solid&size=32" alt="" />
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Served from Cloudflare edge. Cached immutably.
|
|
110
|
+
|
|
111
|
+
## Package Structure
|
|
112
|
+
|
|
113
|
+
```
|
|
114
|
+
@totakit/icons/
|
|
115
|
+
├── dist/
|
|
116
|
+
│ ├── index.js ← Barrel (re-exports outline/*)
|
|
117
|
+
│ ├── outline/ ← Default style
|
|
118
|
+
│ ├── solid/
|
|
119
|
+
│ ├── duotone/
|
|
120
|
+
│ ├── thin/
|
|
121
|
+
│ ├── bold/
|
|
122
|
+
│ ├── micro/
|
|
123
|
+
│ ├── svg/ ← Raw SVG files
|
|
124
|
+
│ │ ├── outline/
|
|
125
|
+
│ │ ├── solid/
|
|
126
|
+
│ │ └── ...
|
|
127
|
+
│ └── meta/ ← Metadata JSON
|
|
128
|
+
│ ├── icons.json
|
|
129
|
+
│ ├── categories.json
|
|
130
|
+
│ └── aliases.json
|
|
131
|
+
├── package.json
|
|
132
|
+
├── README.md
|
|
133
|
+
├── CHANGELOG.md
|
|
134
|
+
└── LICENSE
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Related
|
|
138
|
+
|
|
139
|
+
| Repository | Description |
|
|
140
|
+
|------------|-------------|
|
|
141
|
+
| [icons.totakit.com](https://icons.totakit.com) | Browse, search, and preview icons |
|
|
142
|
+
| [`@totakit/cli`](https://github.com/totakit/cli) | Command-line interface |
|
|
143
|
+
| [`@totakit/mcp-server`](https://github.com/totakit/mcp-server) | AI agent tool layer (MCP) |
|
|
144
|
+
| [`@totakit/sdk`](https://github.com/totakit/sdk) | JavaScript/TypeScript SDK |
|
|
145
|
+
|
|
146
|
+
## Contributing
|
|
147
|
+
|
|
148
|
+
We welcome contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
149
|
+
|
|
150
|
+
Icon requests: [icons.totakit.com/request](https://icons.totakit.com/request)
|
|
151
|
+
|
|
152
|
+
## License
|
|
153
|
+
|
|
154
|
+
MIT © [totakit](https://totakit.com)
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
<p align="center">
|
|
159
|
+
<sub>© 2026 totakit · <a href="https://totakit.com">totakit.com</a></sub>
|
|
160
|
+
</p>
|
package/package.json
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@totakit/icons",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Open-source icons with optical precision — 6 styles, one definition",
|
|
5
|
+
"author": "totakit <hello@totakit.com>",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"homepage": "https://icons.totakit.com",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/totakit/icons.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/totakit/icons/issues"
|
|
14
|
+
},
|
|
15
|
+
"funding": [
|
|
16
|
+
{
|
|
17
|
+
"type": "github",
|
|
18
|
+
"url": "https://github.com/sponsors/nkr-ops"
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"type": "custom",
|
|
22
|
+
"url": "https://totakit.com/pricing"
|
|
23
|
+
}
|
|
24
|
+
],
|
|
25
|
+
"keywords": [
|
|
26
|
+
"icons",
|
|
27
|
+
"svg",
|
|
28
|
+
"react",
|
|
29
|
+
"react-icons",
|
|
30
|
+
"icon-library",
|
|
31
|
+
"icon-set",
|
|
32
|
+
"svg-icons",
|
|
33
|
+
"duotone",
|
|
34
|
+
"outline",
|
|
35
|
+
"solid",
|
|
36
|
+
"thin",
|
|
37
|
+
"bold",
|
|
38
|
+
"micro",
|
|
39
|
+
"totakit",
|
|
40
|
+
"design-system",
|
|
41
|
+
"ui-components",
|
|
42
|
+
"pixel-hinting",
|
|
43
|
+
"optical-precision",
|
|
44
|
+
"tree-shakeable",
|
|
45
|
+
"typescript"
|
|
46
|
+
],
|
|
47
|
+
"type": "module",
|
|
48
|
+
"sideEffects": false,
|
|
49
|
+
"main": "dist/index.js",
|
|
50
|
+
"module": "dist/index.js",
|
|
51
|
+
"types": "dist/index.d.ts",
|
|
52
|
+
"exports": {
|
|
53
|
+
".": {
|
|
54
|
+
"types": "./dist/index.d.ts",
|
|
55
|
+
"import": "./dist/index.js"
|
|
56
|
+
},
|
|
57
|
+
"./outline": {
|
|
58
|
+
"types": "./dist/outline/index.d.ts",
|
|
59
|
+
"import": "./dist/outline/index.js"
|
|
60
|
+
},
|
|
61
|
+
"./outline/*": {
|
|
62
|
+
"types": "./dist/outline/*.d.ts",
|
|
63
|
+
"import": "./dist/outline/*.js"
|
|
64
|
+
},
|
|
65
|
+
"./solid": {
|
|
66
|
+
"types": "./dist/solid/index.d.ts",
|
|
67
|
+
"import": "./dist/solid/index.js"
|
|
68
|
+
},
|
|
69
|
+
"./solid/*": {
|
|
70
|
+
"types": "./dist/solid/*.d.ts",
|
|
71
|
+
"import": "./dist/solid/*.js"
|
|
72
|
+
},
|
|
73
|
+
"./duotone": {
|
|
74
|
+
"types": "./dist/duotone/index.d.ts",
|
|
75
|
+
"import": "./dist/duotone/index.js"
|
|
76
|
+
},
|
|
77
|
+
"./duotone/*": {
|
|
78
|
+
"types": "./dist/duotone/*.d.ts",
|
|
79
|
+
"import": "./dist/duotone/*.js"
|
|
80
|
+
},
|
|
81
|
+
"./thin": {
|
|
82
|
+
"types": "./dist/thin/index.d.ts",
|
|
83
|
+
"import": "./dist/thin/index.js"
|
|
84
|
+
},
|
|
85
|
+
"./thin/*": {
|
|
86
|
+
"types": "./dist/thin/*.d.ts",
|
|
87
|
+
"import": "./dist/thin/*.js"
|
|
88
|
+
},
|
|
89
|
+
"./bold": {
|
|
90
|
+
"types": "./dist/bold/index.d.ts",
|
|
91
|
+
"import": "./dist/bold/index.js"
|
|
92
|
+
},
|
|
93
|
+
"./bold/*": {
|
|
94
|
+
"types": "./dist/bold/*.d.ts",
|
|
95
|
+
"import": "./dist/bold/*.js"
|
|
96
|
+
},
|
|
97
|
+
"./micro": {
|
|
98
|
+
"types": "./dist/micro/index.d.ts",
|
|
99
|
+
"import": "./dist/micro/index.js"
|
|
100
|
+
},
|
|
101
|
+
"./micro/*": {
|
|
102
|
+
"types": "./dist/micro/*.d.ts",
|
|
103
|
+
"import": "./dist/micro/*.js"
|
|
104
|
+
},
|
|
105
|
+
"./svg/*": "./dist/svg/*",
|
|
106
|
+
"./meta/*": "./dist/meta/*",
|
|
107
|
+
"./css/*": "./dist/css/*",
|
|
108
|
+
"./package.json": "./package.json"
|
|
109
|
+
},
|
|
110
|
+
"files": [
|
|
111
|
+
"dist",
|
|
112
|
+
"LICENSE",
|
|
113
|
+
"README.md",
|
|
114
|
+
"CHANGELOG.md"
|
|
115
|
+
],
|
|
116
|
+
"scripts": {
|
|
117
|
+
"clean": "rm -rf dist *.tsbuildinfo",
|
|
118
|
+
"typecheck": "tsc --noEmit",
|
|
119
|
+
"prepublishOnly": "npm run clean"
|
|
120
|
+
},
|
|
121
|
+
"peerDependencies": {
|
|
122
|
+
"react": ">=18"
|
|
123
|
+
},
|
|
124
|
+
"peerDependenciesMeta": {
|
|
125
|
+
"react": {
|
|
126
|
+
"optional": true
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
"devDependencies": {
|
|
130
|
+
"typescript": "^5.8.0"
|
|
131
|
+
},
|
|
132
|
+
"publishConfig": {
|
|
133
|
+
"access": "public",
|
|
134
|
+
"registry": "https://registry.npmjs.org"
|
|
135
|
+
},
|
|
136
|
+
"engines": {
|
|
137
|
+
"node": ">=18.0.0"
|
|
138
|
+
}
|
|
139
|
+
}
|