@tectra-ng/icons 0.0.0-stage → 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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Tectra contributors
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,29 @@
1
- # Temporary Holding Version
1
+ # @tectra-ng/icons
2
2
 
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.
3
+ 334 outline icons drawn for tectra on a 24 × 24 grid: round caps and joins, one stroke width, filled variants where the name says `-fill`. Names follow the PrimeIcons naming (`check`, `times`, `pencil`, `chevron-down`, `sort-amount-up-alt`…) so `pi pi-<name>` moves over by dropping the prefix. The drawings are original — no PrimeIcons artwork is used. Brand logos are not part of the set.
4
+
5
+ ```html
6
+ <tx-icon [name]="'trash'" />
7
+ ```
8
+
9
+ `TX_ICONS` is generated by `tools/icons/build-icons.mjs` from `tools/icons/defs/*.mjs` — edit the definitions there, never `icons.ts`.
10
+
11
+ ## Inputs
12
+ | Name | Description |
13
+ |---|---|
14
+ | name | Icon name — one of the 334 tectra icons or any icon registered with `provideTxIcons` |
15
+
16
+ ## More icons
17
+ `provideTxIcons(set)` in `app.config` adds icons to the registry, so `<tx-icon>` and every `[icon]` input (button, toggle-button) can use them by name. A set is `{ name: paths[] }` on the 24 × 24 grid; a path is a `d` string (stroked) or `{ d, fill: true, stroke: false, transform }`. Brand logos ship this way in `@tectra-ng/brand-icons`; your own logo goes the same way:
18
+
19
+ ```ts
20
+ provideTxIcons({ 'my-logo': [{ d: 'M…', fill: true, stroke: false }] })
21
+ ```
22
+
23
+ `TxIconRegistry` (`register`, `get`, `has`) is the registry itself.
24
+
25
+ ## Design tokens
26
+ | Token | Description |
27
+ |---|---|
28
+ | `--tx-icon-size` | Width and height, `1em` by default — the icon follows the font size |
29
+ | `--tx-icon-stroke-width` | Line thickness on the 24 px grid, `1.75` by default |