@btndprojects/loam-icons 0.0.0-stage → 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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Nuszpl Botond
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 CHANGED
@@ -1,3 +1,66 @@
1
- # Temporary Holding Version
1
+ <p align="center">
2
+ <a href="https://loam.btndprojects.com"><img src="https://loam.btndprojects.com/apple-touch-icon.png" width="64" height="64" alt="Loam"></a>
3
+ </p>
2
4
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
5
+ <h1 align="center">@btndprojects/loam-icons</h1>
6
+
7
+ <p align="center">The Loam icon set — framework-agnostic SVG data, shared by the web and native renderers.</p>
8
+
9
+ <p align="center">
10
+ <a href="https://www.npmjs.com/package/@btndprojects/loam-icons"><img src="https://img.shields.io/npm/v/@btndprojects/loam-icons?color=c0563a&label=npm" alt="npm version"></a>
11
+ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-3d7a48" alt="MIT license"></a>
12
+ <a href="https://loam.btndprojects.com"><img src="https://img.shields.io/badge/docs-loam.btndprojects.com-8c3a25" alt="Documentation"></a>
13
+ </p>
14
+
15
+ One outline set on a 24px grid with a 2px stroke and round caps and joins. Icons are stored as plain data, not components, so the same set renders on the web, on React Native, or anywhere else you can draw SVG.
16
+
17
+ ## Install
18
+
19
+ ```sh
20
+ npm install @btndprojects/loam-icons
21
+ ```
22
+
23
+ With Loam's component libraries you don't need to touch this package: use their `Icon` component (`<Icon name="check" />`).
24
+
25
+ ## Usage
26
+
27
+ Render an icon with your own renderer:
28
+
29
+ ```tsx
30
+ import { icons, ICON_VIEWBOX, type IconName } from '@btndprojects/loam-icons';
31
+
32
+ export function Icon({ name, size = 20 }: { name: IconName; size?: number }) {
33
+ return (
34
+ <svg width={size} height={size} viewBox={ICON_VIEWBOX} fill="none" stroke="currentColor"
35
+ strokeWidth={2} strokeLinecap="round" strokeLinejoin="round" aria-hidden>
36
+ {icons[name].map((p, i) => {
37
+ switch (p.t) {
38
+ case 'path': return <path key={i} d={p.d} />;
39
+ case 'circle': return <circle key={i} cx={p.cx} cy={p.cy} r={p.r} fill={p.fill ? 'currentColor' : undefined} />;
40
+ case 'line': return <line key={i} x1={p.x1} y1={p.y1} x2={p.x2} y2={p.y2} />;
41
+ case 'rect': return <rect key={i} x={p.x} y={p.y} width={p.width} height={p.height} rx={p.rx} ry={p.ry} />;
42
+ case 'polyline': return <polyline key={i} points={p.points} />;
43
+ case 'polygon': return <polygon key={i} points={p.points} />;
44
+ }
45
+ })}
46
+ </svg>
47
+ );
48
+ }
49
+ ```
50
+
51
+ ## Credits
52
+
53
+ The icon artwork comes from [Lucide](https://lucide.dev) (ISC), which itself builds on [Feather](https://feathericons.com) (MIT). See [`THIRD-PARTY-NOTICES`](./THIRD-PARTY-NOTICES).
54
+
55
+ ## Documentation
56
+
57
+ Guides, live examples and the full API are on **[loam.btndprojects.com](https://loam.btndprojects.com)** — start with [Iconography](https://loam.btndprojects.com/#/foundations/icons).
58
+
59
+ ## Related packages
60
+
61
+ - [`@btndprojects/loam-ui-web`](https://www.npmjs.com/package/@btndprojects/loam-ui-web) — renders these icons on the web
62
+ - [`@btndprojects/loam-ui-native`](https://www.npmjs.com/package/@btndprojects/loam-ui-native) — renders these icons on React Native
63
+
64
+ ## License
65
+
66
+ MIT © Nuszpl Botond
@@ -0,0 +1,48 @@
1
+ Loam's icon geometry is transcribed from Lucide (lucide-static). Lucide's license
2
+ and the Feather license it carries are reproduced below, as they require.
3
+
4
+ -------------------------------------------------------------------------------
5
+
6
+ ISC License
7
+
8
+ Copyright (c) 2026 Lucide Icons and Contributors
9
+
10
+ Permission to use, copy, modify, and/or distribute this software for any
11
+ purpose with or without fee is hereby granted, provided that the above
12
+ copyright notice and this permission notice appear in all copies.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
15
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
16
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
17
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
19
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21
+
22
+ ---
23
+
24
+ The following Lucide icons are derived from the Feather project:
25
+
26
+ airplay, alert-circle, alert-octagon, alert-triangle, aperture, arrow-down-circle, arrow-down-left, arrow-down-right, arrow-down, arrow-left-circle, arrow-left, arrow-right-circle, arrow-right, arrow-up-circle, arrow-up-left, arrow-up-right, arrow-up, at-sign, calendar, cast, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down, chevrons-left, chevrons-right, chevrons-up, circle, clipboard, clock, code, columns, command, compass, corner-down-left, corner-down-right, corner-left-down, corner-left-up, corner-right-down, corner-right-up, corner-up-left, corner-up-right, crosshair, database, divide-circle, divide-square, dollar-sign, download, external-link, feather, frown, hash, headphones, help-circle, info, italic, key, layout, life-buoy, link-2, link, loader, lock, log-in, log-out, maximize, meh, minimize, minimize-2, minus-circle, minus-square, minus, monitor, moon, more-horizontal, more-vertical, move, music, navigation-2, navigation, octagon, pause-circle, percent, plus-circle, plus-square, plus, power, radio, rss, search, server, share, shopping-bag, sidebar, smartphone, smile, square, table-2, tablet, target, terminal, trash-2, trash, triangle, tv, type, upload, x-circle, x-octagon, x-square, x, zoom-in, zoom-out
27
+
28
+ The MIT License (MIT) (for the icons listed above)
29
+
30
+ Copyright (c) 2013-present Cole Bemis
31
+
32
+ Permission is hereby granted, free of charge, to any person obtaining a copy
33
+ of this software and associated documentation files (the "Software"), to deal
34
+ in the Software without restriction, including without limitation the rights
35
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
36
+ copies of the Software, and to permit persons to whom the Software is
37
+ furnished to do so, subject to the following conditions:
38
+
39
+ The above copyright notice and this permission notice shall be included in all
40
+ copies or substantial portions of the Software.
41
+
42
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
45
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
47
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
48
+ SOFTWARE.