@tlglobal/icons 2.0.0 → 2.0.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.
- package/README.md +56 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# @tlglobal/icons
|
|
2
|
+
|
|
3
|
+
A curated, named re-export of [Lucide](https://lucide.dev) icons used across TuringLab products —
|
|
4
|
+
including [`@tlglobal/ui`](https://www.npmjs.com/package/@tlglobal/ui) itself. Import icons from
|
|
5
|
+
here rather than `lucide-react` directly, so the icon set can be swapped or extended later without
|
|
6
|
+
touching every consumer.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
pnpm add @tlglobal/icons
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
`react >=18` is a peer dependency.
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```jsx
|
|
19
|
+
import { Check, ChevronDown, Search } from "@tlglobal/icons";
|
|
20
|
+
|
|
21
|
+
<Check className="size-4 text-accent" />
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Each icon is a React component and accepts the same props as the underlying `lucide-react` icon
|
|
25
|
+
(`size`, `color`, `strokeWidth`, `className`, etc.).
|
|
26
|
+
|
|
27
|
+
## Available icons
|
|
28
|
+
|
|
29
|
+
Only the icons listed below are exported — this is a deliberately curated subset of Lucide's full
|
|
30
|
+
set, not all of it. If you need one that isn't here, add it to
|
|
31
|
+
[`src/index.js`](https://github.com/turinglabglobal/Atoms/blob/main/packages/icons/src/index.js)
|
|
32
|
+
upstream rather than importing from `lucide-react` directly.
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
X, Check, Circle, ChevronDown, ChevronUp, ChevronRight, ChevronLeft, Search, Info,
|
|
36
|
+
CheckCircle2, AlertCircle, XCircle, AlertTriangle, Loader2, Eye, EyeOff, Plus, Minus,
|
|
37
|
+
MoreHorizontal, MoreVertical, Settings, User, LogOut, Bell, ChevronsUpDown, Calendar,
|
|
38
|
+
PanelLeft, PanelRight
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## For AI agents (Claude, Cursor, etc.)
|
|
42
|
+
|
|
43
|
+
**Only the names listed above exist.** Do not import any other icon name from this package, and do
|
|
44
|
+
not import from `lucide-react` directly in product code — that bypasses the curation this package
|
|
45
|
+
exists for. If a needed icon is missing, say so rather than substituting a similarly-named one; it
|
|
46
|
+
needs to be added to the package first.
|
|
47
|
+
|
|
48
|
+
## Links
|
|
49
|
+
|
|
50
|
+
- [`@tlglobal/ui`](https://www.npmjs.com/package/@tlglobal/ui) — components that use this icon set
|
|
51
|
+
- [Lucide icon browser](https://lucide.dev/icons) — to check what an icon looks like before requesting it be added
|
|
52
|
+
- [Source](https://github.com/turinglabglobal/Atoms)
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
Apache-2.0
|