@leta-io/icons 0.1.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/README.md +29 -0
- package/dist/index.d.ts +1087 -0
- package/dist/index.js +1109 -0
- package/package.json +47 -0
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @leta-io/icons
|
|
2
|
+
|
|
3
|
+
Material Symbols-backed icon registry for the LETA design system. Every icon
|
|
4
|
+
ships both a filled and an outlined variant; outlined is the default.
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
npm install @leta-io/icons
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
```tsx
|
|
11
|
+
import { Icon } from '@leta-io/icons';
|
|
12
|
+
|
|
13
|
+
<Icon name="Dashboard" size={20} />
|
|
14
|
+
<Icon name="Check-Circle" outlined={false} />
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Notes
|
|
18
|
+
|
|
19
|
+
- `IconName` is exported as a union of all available names, so the set is
|
|
20
|
+
typo-proof at compile time.
|
|
21
|
+
- The registry is a single module containing every icon, so importing one
|
|
22
|
+
currently pulls in all of them. Fine for an app; something to be aware of if
|
|
23
|
+
you are optimising a small bundle.
|
|
24
|
+
|
|
25
|
+
Part of the LETA design system, alongside
|
|
26
|
+
[`@leta-io/components`](https://www.npmjs.com/package/@leta-io/components) and
|
|
27
|
+
[`@leta-io/design-tokens`](https://www.npmjs.com/package/@leta-io/design-tokens).
|
|
28
|
+
The source repository is private; these packages are published for use across
|
|
29
|
+
Leta's products.
|