tyrell-components 1.0.0-TC9 → 1.0.0-rc.21
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/AGENTS.md +122 -0
- package/CHANGELOG.md +1531 -0
- package/README.md +71 -53
- package/css/tyrell-colors-static.css +1 -0
- package/css/tyrell-theme.css +1 -0
- package/css/tyrell.css +1 -1783
- package/dist/tyrell-colors-static.css +1 -0
- package/dist/tyrell-theme.css +1 -0
- package/dist/tyrell.css +1 -1783
- package/dist/tyrell.js +1 -1
- package/guides/AGENT_INSTRUCTIONS.md +124 -0
- package/guides/AI_GUIDE.md +53 -0
- package/guides/CSS_GUIDE.md +1016 -0
- package/guides/DATASTAR_TY_GUIDE.md +657 -0
- package/guides/ICONS_GUIDE.md +212 -0
- package/guides/TY_GUIDE.md +935 -0
- package/guides/clj/CLOJURESCRIPT_GUIDE.md +300 -0
- package/guides/clj/CODE_SPLITTING.md +279 -0
- package/guides/clj/COMPONENT_GUIDE.md +391 -0
- package/guides/clj/HELIX_TY_GUIDE.md +428 -0
- package/guides/clj/I18N_GUIDE.md +478 -0
- package/guides/clj/LAYOUT_GUIDE.md +273 -0
- package/guides/clj/QUICKSTART.md +266 -0
- package/guides/clj/REAGENT_TY_GUIDE.md +408 -0
- package/guides/clj/REPLICANT_TY_GUIDE.md +623 -0
- package/guides/clj/ROUTING_GUIDE.md +346 -0
- package/guides/clj/UIX_TY_GUIDE.md +319 -0
- package/guides/js/HTMX_TY_GUIDE.md +252 -0
- package/guides/js/JAVASCRIPT_GUIDE.md +388 -0
- package/guides/js/REACT_TY_GUIDE.md +983 -0
- package/guides/js/SVELTE_TY_GUIDE.md +682 -0
- package/guides/js/TYCOMPONENT_GUIDE.md +962 -0
- package/guides/js/VUE_TY_GUIDE.md +738 -0
- package/lib/base/ty-component.d.ts +57 -13
- package/lib/base/ty-component.js +266 -292
- package/lib/components/button.d.ts +33 -18
- package/lib/components/button.js +317 -267
- package/lib/components/calendar-month.d.ts +30 -47
- package/lib/components/calendar-month.js +455 -429
- package/lib/components/calendar-navigation.d.ts +41 -49
- package/lib/components/calendar-navigation.js +287 -346
- package/lib/components/calendar.d.ts +73 -83
- package/lib/components/calendar.js +837 -762
- package/lib/components/checkbox.d.ts +26 -75
- package/lib/components/checkbox.js +298 -391
- package/lib/components/copy.d.ts +20 -60
- package/lib/components/copy.js +276 -380
- package/lib/components/date-picker.d.ts +100 -183
- package/lib/components/date-picker.js +1155 -1570
- package/lib/components/file-upload.d.ts +16 -15
- package/lib/components/file-upload.js +436 -426
- package/lib/components/icon.d.ts +3 -24
- package/lib/components/icon.js +141 -230
- package/lib/components/input.d.ts +93 -108
- package/lib/components/input.js +734 -710
- package/lib/components/modal.d.ts +39 -29
- package/lib/components/modal.js +419 -438
- package/lib/components/option.d.ts +20 -35
- package/lib/components/option.js +184 -309
- package/lib/components/popup.d.ts +2 -17
- package/lib/components/popup.js +353 -347
- package/lib/components/radio.d.ts +33 -25
- package/lib/components/radio.js +433 -422
- package/lib/components/resize-observer.d.ts +3 -30
- package/lib/components/resize-observer.js +71 -103
- package/lib/components/scroll-container.d.ts +21 -14
- package/lib/components/scroll-container.js +292 -234
- package/lib/components/select.d.ts +446 -0
- package/lib/components/select.js +1381 -0
- package/lib/components/selected-tags.d.ts +60 -0
- package/lib/components/selected-tags.js +225 -0
- package/lib/components/sortable.d.ts +175 -0
- package/lib/components/sortable.js +1844 -0
- package/lib/components/step.d.ts +1 -6
- package/lib/components/step.js +62 -68
- package/lib/components/switch.d.ts +15 -15
- package/lib/components/switch.js +237 -231
- package/lib/components/tab.d.ts +50 -7
- package/lib/components/tab.js +203 -69
- package/lib/components/tabs.d.ts +19 -64
- package/lib/components/tabs.js +600 -618
- package/lib/components/tag.d.ts +14 -52
- package/lib/components/tag.js +231 -306
- package/lib/components/textarea.d.ts +58 -89
- package/lib/components/textarea.js +523 -573
- package/lib/components/tooltip.d.ts +8 -13
- package/lib/components/tooltip.js +322 -409
- package/lib/components/wizard.d.ts +7 -54
- package/lib/components/wizard.js +376 -606
- package/lib/icons/fontawesome/brands.d.ts +0 -1
- package/lib/icons/fontawesome/brands.js +0 -8
- package/lib/icons/fontawesome/regular.d.ts +0 -1
- package/lib/icons/fontawesome/regular.js +0 -8
- package/lib/icons/fontawesome/solid.d.ts +0 -1
- package/lib/icons/fontawesome/solid.js +0 -8
- package/lib/icons/heroicons/micro.d.ts +0 -1
- package/lib/icons/heroicons/micro.js +392 -400
- package/lib/icons/heroicons/mini.d.ts +0 -1
- package/lib/icons/heroicons/mini.js +382 -390
- package/lib/icons/heroicons/outline.d.ts +0 -1
- package/lib/icons/heroicons/outline.js +337 -345
- package/lib/icons/heroicons/solid.d.ts +0 -1
- package/lib/icons/heroicons/solid.js +407 -415
- package/lib/icons/lucide.d.ts +0 -1
- package/lib/icons/lucide.js +24479 -26351
- package/lib/icons/material/filled.d.ts +0 -1
- package/lib/icons/material/filled.js +9653 -9663
- package/lib/icons/material/outlined.d.ts +0 -1
- package/lib/icons/material/outlined.js +10271 -10281
- package/lib/icons/material/round.d.ts +0 -1
- package/lib/icons/material/round.js +10495 -10505
- package/lib/icons/material/sharp.d.ts +0 -1
- package/lib/icons/material/sharp.js +9905 -9915
- package/lib/icons/material/two-tone.d.ts +0 -1
- package/lib/icons/material/two-tone.js +12792 -12802
- package/lib/index.d.ts +7 -4
- package/lib/index.js +26 -39
- package/lib/styles/button.d.ts +24 -7
- package/lib/styles/button.js +285 -445
- package/lib/styles/calendar-month.d.ts +7 -6
- package/lib/styles/calendar-month.js +158 -226
- package/lib/styles/calendar-navigation.d.ts +2 -6
- package/lib/styles/calendar-navigation.js +108 -127
- package/lib/styles/calendar.d.ts +3 -3
- package/lib/styles/calendar.js +87 -23
- package/lib/styles/checkbox.d.ts +7 -6
- package/lib/styles/checkbox.js +101 -15
- package/lib/styles/copy.d.ts +3 -2
- package/lib/styles/copy.js +91 -71
- package/lib/styles/custom-scrollbar.d.ts +1 -2
- package/lib/styles/custom-scrollbar.js +80 -115
- package/lib/styles/date-picker.d.ts +4 -6
- package/lib/styles/date-picker.js +321 -388
- package/lib/styles/field-size.d.ts +6 -0
- package/lib/styles/field-size.js +91 -0
- package/lib/styles/file-upload.d.ts +1 -2
- package/lib/styles/file-upload.js +143 -188
- package/lib/styles/icon.d.ts +2 -6
- package/lib/styles/icon.js +92 -170
- package/lib/styles/input.d.ts +4 -7
- package/lib/styles/input.js +148 -643
- package/lib/styles/modal.d.ts +1 -2
- package/lib/styles/modal.js +127 -108
- package/lib/styles/option.d.ts +2 -6
- package/lib/styles/option.js +53 -96
- package/lib/styles/popup.d.ts +1 -2
- package/lib/styles/popup.js +47 -77
- package/lib/styles/radio.d.ts +3 -2
- package/lib/styles/radio.js +90 -116
- package/lib/styles/resize-observer.d.ts +1 -2
- package/lib/styles/resize-observer.js +2 -12
- package/lib/styles/scroll-container.d.ts +1 -2
- package/lib/styles/scroll-container.js +103 -146
- package/lib/styles/select-base.d.ts +8 -0
- package/lib/styles/select-base.js +747 -0
- package/lib/styles/select.d.ts +11 -0
- package/lib/styles/select.js +229 -0
- package/lib/styles/sortable.d.ts +16 -0
- package/lib/styles/sortable.js +85 -0
- package/lib/styles/step.d.ts +1 -2
- package/lib/styles/step.js +15 -34
- package/lib/styles/switch.d.ts +3 -2
- package/lib/styles/switch.js +52 -68
- package/lib/styles/tab.d.ts +1 -2
- package/lib/styles/tab.js +86 -34
- package/lib/styles/tabs.d.ts +3 -11
- package/lib/styles/tabs.js +204 -162
- package/lib/styles/tag.d.ts +2 -6
- package/lib/styles/tag.js +168 -362
- package/lib/styles/textarea.d.ts +1 -2
- package/lib/styles/textarea.js +238 -306
- package/lib/styles/tooltip.d.ts +4 -3
- package/lib/styles/tooltip.js +3 -131
- package/lib/styles/wizard.d.ts +8 -20
- package/lib/styles/wizard.js +306 -295
- package/lib/types/common.d.ts +9 -8
- package/lib/types/common.js +8 -5
- package/lib/utils/calendar-utils.d.ts +49 -65
- package/lib/utils/calendar-utils.js +158 -343
- package/lib/utils/custom-scrollbar.d.ts +6 -20
- package/lib/utils/custom-scrollbar.js +273 -317
- package/lib/utils/flavor-sheet.d.ts +31 -0
- package/lib/utils/flavor-sheet.js +17 -0
- package/lib/utils/icon-registry.d.ts +0 -15
- package/lib/utils/icon-registry.js +138 -279
- package/lib/utils/icons.d.ts +9 -0
- package/lib/utils/icons.js +1 -0
- package/lib/utils/loader-registry.d.ts +2 -3
- package/lib/utils/loader-registry.js +3 -35
- package/lib/utils/locale.d.ts +2 -80
- package/lib/utils/locale.js +30 -205
- package/lib/utils/mobile.d.ts +0 -1
- package/lib/utils/mobile.js +1 -18
- package/lib/utils/number-format.d.ts +6 -24
- package/lib/utils/number-format.js +53 -136
- package/lib/utils/positioning.d.ts +72 -22
- package/lib/utils/positioning.js +224 -298
- package/lib/utils/property-capture.d.ts +5 -27
- package/lib/utils/property-capture.js +36 -144
- package/lib/utils/property-manager.d.ts +6 -6
- package/lib/utils/property-manager.js +127 -196
- package/lib/utils/resize-observer.d.ts +0 -1
- package/lib/utils/resize-observer.js +23 -59
- package/lib/utils/scroll-lock.d.ts +10 -11
- package/lib/utils/scroll-lock.js +165 -173
- package/lib/utils/styles.d.ts +0 -6
- package/lib/utils/styles.js +17 -48
- package/lib/utils/upgrade-properties.d.ts +21 -0
- package/lib/utils/upgrade-properties.js +47 -0
- package/lib/utils/validity.d.ts +122 -0
- package/lib/utils/validity.js +289 -0
- package/lib/version.d.ts +1 -2
- package/lib/version.js +1 -11
- package/package.json +62 -18
- package/lib/base/ty-component.d.ts.map +0 -1
- package/lib/base/ty-component.js.map +0 -1
- package/lib/components/button.d.ts.map +0 -1
- package/lib/components/button.js.map +0 -1
- package/lib/components/calendar-month.d.ts.map +0 -1
- package/lib/components/calendar-month.js.map +0 -1
- package/lib/components/calendar-navigation.d.ts.map +0 -1
- package/lib/components/calendar-navigation.js.map +0 -1
- package/lib/components/calendar.d.ts.map +0 -1
- package/lib/components/calendar.js.map +0 -1
- package/lib/components/checkbox.d.ts.map +0 -1
- package/lib/components/checkbox.js.map +0 -1
- package/lib/components/copy.d.ts.map +0 -1
- package/lib/components/copy.js.map +0 -1
- package/lib/components/date-picker.d.ts.map +0 -1
- package/lib/components/date-picker.js.map +0 -1
- package/lib/components/dropdown.d.ts +0 -404
- package/lib/components/dropdown.d.ts.map +0 -1
- package/lib/components/dropdown.js +0 -1563
- package/lib/components/dropdown.js.map +0 -1
- package/lib/components/file-upload.d.ts.map +0 -1
- package/lib/components/file-upload.js.map +0 -1
- package/lib/components/icon.d.ts.map +0 -1
- package/lib/components/icon.js.map +0 -1
- package/lib/components/input.d.ts.map +0 -1
- package/lib/components/input.js.map +0 -1
- package/lib/components/modal.d.ts.map +0 -1
- package/lib/components/modal.js.map +0 -1
- package/lib/components/multiselect.d.ts +0 -408
- package/lib/components/multiselect.d.ts.map +0 -1
- package/lib/components/multiselect.js +0 -1611
- package/lib/components/multiselect.js.map +0 -1
- package/lib/components/option.d.ts.map +0 -1
- package/lib/components/option.js.map +0 -1
- package/lib/components/popup.d.ts.map +0 -1
- package/lib/components/popup.js.map +0 -1
- package/lib/components/radio.d.ts.map +0 -1
- package/lib/components/radio.js.map +0 -1
- package/lib/components/resize-observer.d.ts.map +0 -1
- package/lib/components/resize-observer.js.map +0 -1
- package/lib/components/scroll-container.d.ts.map +0 -1
- package/lib/components/scroll-container.js.map +0 -1
- package/lib/components/step.d.ts.map +0 -1
- package/lib/components/step.js.map +0 -1
- package/lib/components/switch.d.ts.map +0 -1
- package/lib/components/switch.js.map +0 -1
- package/lib/components/tab.d.ts.map +0 -1
- package/lib/components/tab.js.map +0 -1
- package/lib/components/tabs.d.ts.map +0 -1
- package/lib/components/tabs.js.map +0 -1
- package/lib/components/tag.d.ts.map +0 -1
- package/lib/components/tag.js.map +0 -1
- package/lib/components/textarea.d.ts.map +0 -1
- package/lib/components/textarea.js.map +0 -1
- package/lib/components/tooltip.d.ts.map +0 -1
- package/lib/components/tooltip.js.map +0 -1
- package/lib/components/wizard.d.ts.map +0 -1
- package/lib/components/wizard.js.map +0 -1
- package/lib/icons/fontawesome/brands.d.ts.map +0 -1
- package/lib/icons/fontawesome/brands.js.map +0 -1
- package/lib/icons/fontawesome/regular.d.ts.map +0 -1
- package/lib/icons/fontawesome/regular.js.map +0 -1
- package/lib/icons/fontawesome/solid.d.ts.map +0 -1
- package/lib/icons/fontawesome/solid.js.map +0 -1
- package/lib/icons/heroicons/micro.d.ts.map +0 -1
- package/lib/icons/heroicons/micro.js.map +0 -1
- package/lib/icons/heroicons/mini.d.ts.map +0 -1
- package/lib/icons/heroicons/mini.js.map +0 -1
- package/lib/icons/heroicons/outline.d.ts.map +0 -1
- package/lib/icons/heroicons/outline.js.map +0 -1
- package/lib/icons/heroicons/solid.d.ts.map +0 -1
- package/lib/icons/heroicons/solid.js.map +0 -1
- package/lib/icons/lucide.d.ts.map +0 -1
- package/lib/icons/lucide.js.map +0 -1
- package/lib/icons/material/filled.d.ts.map +0 -1
- package/lib/icons/material/filled.js.map +0 -1
- package/lib/icons/material/outlined.d.ts.map +0 -1
- package/lib/icons/material/outlined.js.map +0 -1
- package/lib/icons/material/round.d.ts.map +0 -1
- package/lib/icons/material/round.js.map +0 -1
- package/lib/icons/material/sharp.d.ts.map +0 -1
- package/lib/icons/material/sharp.js.map +0 -1
- package/lib/icons/material/two-tone.d.ts.map +0 -1
- package/lib/icons/material/two-tone.js.map +0 -1
- package/lib/index.d.ts.map +0 -1
- package/lib/index.js.map +0 -1
- package/lib/styles/button.d.ts.map +0 -1
- package/lib/styles/button.js.map +0 -1
- package/lib/styles/calendar-month.d.ts.map +0 -1
- package/lib/styles/calendar-month.js.map +0 -1
- package/lib/styles/calendar-navigation.d.ts.map +0 -1
- package/lib/styles/calendar-navigation.js.map +0 -1
- package/lib/styles/calendar.d.ts.map +0 -1
- package/lib/styles/calendar.js.map +0 -1
- package/lib/styles/checkbox.d.ts.map +0 -1
- package/lib/styles/checkbox.js.map +0 -1
- package/lib/styles/copy.d.ts.map +0 -1
- package/lib/styles/copy.js.map +0 -1
- package/lib/styles/custom-scrollbar.d.ts.map +0 -1
- package/lib/styles/custom-scrollbar.js.map +0 -1
- package/lib/styles/date-picker.d.ts.map +0 -1
- package/lib/styles/date-picker.js.map +0 -1
- package/lib/styles/dropdown.d.ts +0 -12
- package/lib/styles/dropdown.d.ts.map +0 -1
- package/lib/styles/dropdown.js +0 -1048
- package/lib/styles/dropdown.js.map +0 -1
- package/lib/styles/file-upload.d.ts.map +0 -1
- package/lib/styles/file-upload.js.map +0 -1
- package/lib/styles/icon.d.ts.map +0 -1
- package/lib/styles/icon.js.map +0 -1
- package/lib/styles/input.d.ts.map +0 -1
- package/lib/styles/input.js.map +0 -1
- package/lib/styles/modal.d.ts.map +0 -1
- package/lib/styles/modal.js.map +0 -1
- package/lib/styles/multiselect.d.ts +0 -6
- package/lib/styles/multiselect.d.ts.map +0 -1
- package/lib/styles/multiselect.js +0 -837
- package/lib/styles/multiselect.js.map +0 -1
- package/lib/styles/option.d.ts.map +0 -1
- package/lib/styles/option.js.map +0 -1
- package/lib/styles/popup.d.ts.map +0 -1
- package/lib/styles/popup.js.map +0 -1
- package/lib/styles/radio.d.ts.map +0 -1
- package/lib/styles/radio.js.map +0 -1
- package/lib/styles/resize-observer.d.ts.map +0 -1
- package/lib/styles/resize-observer.js.map +0 -1
- package/lib/styles/scroll-container.d.ts.map +0 -1
- package/lib/styles/scroll-container.js.map +0 -1
- package/lib/styles/step.d.ts.map +0 -1
- package/lib/styles/step.js.map +0 -1
- package/lib/styles/switch.d.ts.map +0 -1
- package/lib/styles/switch.js.map +0 -1
- package/lib/styles/tab.d.ts.map +0 -1
- package/lib/styles/tab.js.map +0 -1
- package/lib/styles/tabs.d.ts.map +0 -1
- package/lib/styles/tabs.js.map +0 -1
- package/lib/styles/tag.d.ts.map +0 -1
- package/lib/styles/tag.js.map +0 -1
- package/lib/styles/textarea.d.ts.map +0 -1
- package/lib/styles/textarea.js.map +0 -1
- package/lib/styles/tooltip.d.ts.map +0 -1
- package/lib/styles/tooltip.js.map +0 -1
- package/lib/styles/wizard.d.ts.map +0 -1
- package/lib/styles/wizard.js.map +0 -1
- package/lib/types/common.d.ts.map +0 -1
- package/lib/types/common.js.map +0 -1
- package/lib/utils/calendar-utils.d.ts.map +0 -1
- package/lib/utils/calendar-utils.js.map +0 -1
- package/lib/utils/custom-scrollbar.d.ts.map +0 -1
- package/lib/utils/custom-scrollbar.js.map +0 -1
- package/lib/utils/icon-registry.d.ts.map +0 -1
- package/lib/utils/icon-registry.js.map +0 -1
- package/lib/utils/loader-registry.d.ts.map +0 -1
- package/lib/utils/loader-registry.js.map +0 -1
- package/lib/utils/locale.d.ts.map +0 -1
- package/lib/utils/locale.js.map +0 -1
- package/lib/utils/mobile.d.ts.map +0 -1
- package/lib/utils/mobile.js.map +0 -1
- package/lib/utils/number-format.d.ts.map +0 -1
- package/lib/utils/number-format.js.map +0 -1
- package/lib/utils/parse-boolean.d.ts +0 -39
- package/lib/utils/parse-boolean.d.ts.map +0 -1
- package/lib/utils/parse-boolean.js +0 -58
- package/lib/utils/parse-boolean.js.map +0 -1
- package/lib/utils/positioning.d.ts.map +0 -1
- package/lib/utils/positioning.js.map +0 -1
- package/lib/utils/property-capture.d.ts.map +0 -1
- package/lib/utils/property-capture.js.map +0 -1
- package/lib/utils/property-manager.d.ts.map +0 -1
- package/lib/utils/property-manager.js.map +0 -1
- package/lib/utils/resize-observer.d.ts.map +0 -1
- package/lib/utils/resize-observer.js.map +0 -1
- package/lib/utils/scroll-lock.d.ts.map +0 -1
- package/lib/utils/scroll-lock.js.map +0 -1
- package/lib/utils/styles.d.ts.map +0 -1
- package/lib/utils/styles.js.map +0 -1
- package/lib/version.d.ts.map +0 -1
- package/lib/version.js.map +0 -1
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
# Icons
|
|
2
|
+
|
|
3
|
+
`<ty-icon name="mail">` looks the name up in a runtime registry. There are two ways to fill it:
|
|
4
|
+
|
|
5
|
+
- **By name.** Register SVG strings once at startup, then use `name="…"` anywhere.
|
|
6
|
+
- **By slot.** Put the `<svg>` inside the tag. No registry, no JavaScript.
|
|
7
|
+
|
|
8
|
+
Both work on the same page. Size, color, `spin`, `pulse` and `tempo` style the `<ty-icon>` element, so they apply either way.
|
|
9
|
+
|
|
10
|
+
## How the icon sets are built
|
|
11
|
+
|
|
12
|
+
Every set is generated from its upstream source into flat files of SVG strings: one export (JS) or one `def` (Clojure) per icon. Nothing is fetched at runtime. What you don't reference, the compiler drops.
|
|
13
|
+
|
|
14
|
+
| Set | JS import (`tyrell-components/…`) | Clojure namespace | Icons |
|
|
15
|
+
| --- | --- | --- | --- |
|
|
16
|
+
| Lucide | `icons/lucide` | `tyrell.lucide` | 1,861 |
|
|
17
|
+
| Heroicons outline | `icons/heroicons/outline` | `tyrell.heroicons.outline` | 324 |
|
|
18
|
+
| Heroicons solid | `icons/heroicons/solid` | `tyrell.heroicons.solid` | 324 |
|
|
19
|
+
| Heroicons mini | `icons/heroicons/mini` | `tyrell.heroicons.mini` | 324 |
|
|
20
|
+
| Heroicons micro | `icons/heroicons/micro` | `tyrell.heroicons.micro` | 316 |
|
|
21
|
+
| Material filled | `icons/material/filled` | `tyrell.material.filled` | 2,170 |
|
|
22
|
+
| Material outlined | `icons/material/outlined` | `tyrell.material.outlined` | 2,132 |
|
|
23
|
+
| Material round | `icons/material/round` | `tyrell.material.round` | 2,137 |
|
|
24
|
+
| Material sharp | `icons/material/sharp` | `tyrell.material.sharp` | 2,137 |
|
|
25
|
+
| Material two-tone | `icons/material/two-tone` | `tyrell.material.two-tone` | 2,175 |
|
|
26
|
+
| Font Awesome solid | `icons/fontawesome/solid` | `tyrell.fav6.solid` | 1,984 |
|
|
27
|
+
| Font Awesome regular | `icons/fontawesome/regular` | `tyrell.fav6.regular` | 273 |
|
|
28
|
+
| Font Awesome brands | `icons/fontawesome/brands` | `tyrell.fav6.brands` | 549 |
|
|
29
|
+
|
|
30
|
+
**You pick the names.** Registration maps a name to an SVG string, and `name="…"` uses that name. The set's identifier is only where the SVG comes from: JS exports are camelCase (`chevronDown`), Clojure defs are kebab-case (`chevron-down`), and neither has to match the name you register. Naming by role (`action-down`, `nav-back`) lets you swap the artwork later without touching templates.
|
|
31
|
+
|
|
32
|
+
## In Clojure
|
|
33
|
+
|
|
34
|
+
Icons ship as one Clojars jar per set: `dev.gersak/tyrell-icons-lucide`, `-heroicons`, `-material` and `-fontawesome`. `dev.gersak/tyrell` includes none of them: add the set jar you need, or `dev.gersak/tyrell-icons` for every set. There's no npm package for them. The files are `.cljc`, so the same defs work in ClojureScript and on the JVM.
|
|
35
|
+
|
|
36
|
+
```clojure
|
|
37
|
+
(ns app.icons
|
|
38
|
+
(:require [tyrell.icons :as icons]
|
|
39
|
+
[tyrell.lucide :as lucide]
|
|
40
|
+
[tyrell.heroicons.outline :as hero]
|
|
41
|
+
[tyrell.fav6.brands :as brands]))
|
|
42
|
+
|
|
43
|
+
(icons/register!
|
|
44
|
+
{:mail lucide/mail
|
|
45
|
+
:action-down lucide/chevron-down ; any name you like
|
|
46
|
+
:user hero/user-circle
|
|
47
|
+
:github brands/github})
|
|
48
|
+
|
|
49
|
+
[:ty-icon {:name "action-down"}]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`register!` takes keyword or string keys and writes to `window.tyIcons`, which `tyrell.components` sets up. Call it once at startup, before the first render. If `tyrell.js` comes from a `<script>` tag that may load after your code, use `icons/register-async!`: same map, retries until `window.tyIcons` exists.
|
|
53
|
+
|
|
54
|
+
Prefer the npm files? `(:require ["tyrell-components/icons/lucide" :refer [mail]])` works too and tree-shakes the same way. Pass them to `register!` like any string.
|
|
55
|
+
|
|
56
|
+
**Tree-shaking.** A release build (`:advanced`) keeps only the defs you reference. Two ways to lose that:
|
|
57
|
+
|
|
58
|
+
- Building names at runtime, such as `(symbol "lucide" name)`. The compiler can't see which defs you use.
|
|
59
|
+
- Registering a whole namespace, such as `(ns-publics 'tyrell.lucide)`. Every icon ships.
|
|
60
|
+
|
|
61
|
+
If the icons are dynamic, register every candidate up front.
|
|
62
|
+
|
|
63
|
+
**On the server.** Keep the name → SVG map in one namespace and let the extract tool (below) write it out as a static `icons.js`. Pages load that file once, cached, and templates use names like everywhere else:
|
|
64
|
+
|
|
65
|
+
```clojure
|
|
66
|
+
(ns app.icons
|
|
67
|
+
(:require [tyrell.lucide :as lucide]
|
|
68
|
+
[tyrell.heroicons.outline :as hero]))
|
|
69
|
+
|
|
70
|
+
(def registry
|
|
71
|
+
{:mail lucide/mail
|
|
72
|
+
:action-down lucide/chevron-down
|
|
73
|
+
:user hero/user-circle})
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
```clojure
|
|
77
|
+
[:script {:src "https://cdn…/tyrell.js"}]
|
|
78
|
+
[:script {:src "/icons.js" :defer true}] ; right after tyrell.js
|
|
79
|
+
…
|
|
80
|
+
[:ty-icon {:name "action-down"}]
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Or inline the def into the tag and skip the registry. Nothing to load first, but every page repeats the SVG:
|
|
84
|
+
|
|
85
|
+
```clojure
|
|
86
|
+
[:ty-icon {:size "lg"} (h/raw lucide/mail)]
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Ship only what you use on the JVM.** The JVM has no `:advanced` pass, so an uberjar carries every def of every set you depend on (Material alone is 6.6 MB). `tyrell.icons.build/extract` does the trimming ahead of time: clj-kondo's analysis finds the icon vars your code uses (`lucide/mail`, referred names, `require` calls, the `:clj` side of `.cljc`; not strings or comments), and the tool writes trimmed copies of the same namespaces. Your code doesn't change; only the classpath does.
|
|
90
|
+
|
|
91
|
+
```clojure
|
|
92
|
+
;; deps.edn
|
|
93
|
+
{:paths ["src" "resources"]
|
|
94
|
+
:aliases
|
|
95
|
+
{:dev {:extra-deps {dev.gersak/tyrell-icons {:mvn/version "…"}}} ; every icon while you work
|
|
96
|
+
:prod {:extra-paths ["gen-icons"]} ; only the used ones
|
|
97
|
+
:icons {:extra-deps {dev.gersak/tyrell-icons {:mvn/version "…"}
|
|
98
|
+
clj-kondo/clj-kondo {:mvn/version "2026.08.04"}}
|
|
99
|
+
:exec-fn tyrell.icons.build/extract
|
|
100
|
+
:exec-args {:paths ["src"]
|
|
101
|
+
:out "gen-icons"
|
|
102
|
+
:registry app.icons/registry ; optional:
|
|
103
|
+
:js-out "resources/public/icons.js"}}}} ; write icons.js
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
clj -X:icons
|
|
108
|
+
# tyrell.heroicons.outline 1 icon 0.6 KB → gen-icons/tyrell/heroicons/outline.cljc
|
|
109
|
+
# tyrell.lucide 2 icons 0.9 KB → gen-icons/tyrell/lucide.cljc
|
|
110
|
+
# registration script 3 icons 1.2 KB → resources/public/icons.js
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Run it before building the uberjar (or commit `gen-icons/`). Keep `gen-icons` off the `:dev` classpath: the copies use the same namespace names, so whichever comes first wins. Names the scan can't see, such as ones built at runtime, go in `:include [tyrell.lucide/heart]`. `:svg-dir "resources/icons"` also writes each icon as `resources/icons/lucide/mail.svg` for template engines that include files. Unknown names are listed at the end, so a typo shows up there.
|
|
114
|
+
|
|
115
|
+
## In JavaScript
|
|
116
|
+
|
|
117
|
+
Named imports from a set, then `registerIcons` once at the entry point. Works the same for React, Vue, Svelte and vanilla.
|
|
118
|
+
|
|
119
|
+
```js
|
|
120
|
+
import { registerIcons } from 'tyrell-components/icons/registry'
|
|
121
|
+
import { mail, chevronDown } from 'tyrell-components/icons/lucide'
|
|
122
|
+
import { userCircle } from 'tyrell-components/icons/heroicons/outline'
|
|
123
|
+
import { github } from 'tyrell-components/icons/fontawesome/brands'
|
|
124
|
+
|
|
125
|
+
registerIcons({
|
|
126
|
+
mail,
|
|
127
|
+
'action-down': chevronDown, // the key is the name, pick any
|
|
128
|
+
user: userCircle,
|
|
129
|
+
github,
|
|
130
|
+
})
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
```html
|
|
134
|
+
<ty-icon name="action-down"></ty-icon>
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
The key is the name you use in `name="…"`. Shorthand `{ chevronDown }` registers the name `chevronDown`; nothing converts it to `chevron-down`.
|
|
138
|
+
|
|
139
|
+
**Tree-shaking.** Only named imports are kept. `import * as lucide from '…/icons/lucide'` followed by `registerIcons(lucide)` ships all 1,861.
|
|
140
|
+
|
|
141
|
+
**SSR.** Register in the same client-only place you import `tyrell-components` (a `'use client'` component, `onMount`, and so on).
|
|
142
|
+
|
|
143
|
+
**CDN script plus npm icons.** If the components come from the CDN `<script>` but the icons from npm, register with `window.tyIcons.register(…)`. `registerIcons` from `…/icons/registry` would be a second copy of the registry that `<ty-icon>` never reads.
|
|
144
|
+
|
|
145
|
+
## In HTML
|
|
146
|
+
|
|
147
|
+
Server-rendered pages (Flask, Django, Go, Rails, HTMX, Datastar) with the components from the CDN script: build your icons into one small `icons.js` and serve it next to your other static files. The browser fetches it once and caches it, every page and every swapped-in fragment uses the names, and the bundler keeps only what you import.
|
|
148
|
+
|
|
149
|
+
```js
|
|
150
|
+
// icons.js
|
|
151
|
+
import { mail, chevronDown } from 'tyrell-components/icons/lucide'
|
|
152
|
+
import { userCircle } from 'tyrell-components/icons/heroicons/outline'
|
|
153
|
+
|
|
154
|
+
await customElements.whenDefined('ty-icon')
|
|
155
|
+
window.tyIcons.register({
|
|
156
|
+
mail,
|
|
157
|
+
'action-down': chevronDown,
|
|
158
|
+
user: userCircle,
|
|
159
|
+
})
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
npm i -D tyrell-components esbuild
|
|
164
|
+
npx esbuild icons.js --bundle --minify --format=esm --outfile=static/icons.js
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
```html
|
|
168
|
+
<script src="https://cdn…/tyrell.js"></script>
|
|
169
|
+
<script type="module" src="/static/icons.js"></script> <!-- right after tyrell.js -->
|
|
170
|
+
|
|
171
|
+
<ty-icon name="action-down"></ty-icon>
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Register through `window.tyIcons`, not `registerIcons`: the components come from the CDN script, and an imported registry would be a second copy `<ty-icon>` never reads. Until `icons.js` runs, names render as a faint placeholder; loading it in `<head>` right after `tyrell.js` keeps that to the first frames. Clojure backends get the same file without Node: see `:js-out` [above](#in-clojure).
|
|
175
|
+
|
|
176
|
+
**No build at all?** Slot the SVG straight from your template. `<ty-icon>` only sizes and colors it, so nothing has to load first, at the cost of repeating the SVG on every page:
|
|
177
|
+
|
|
178
|
+
```html
|
|
179
|
+
<ty-icon size="lg">{% include "icons/mail.svg" %}</ty-icon>
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Use `currentColor` for `fill` and `stroke` so `ty-text-*` classes tint the icon.
|
|
183
|
+
|
|
184
|
+
## Custom SVGs
|
|
185
|
+
|
|
186
|
+
The registry takes any SVG string:
|
|
187
|
+
|
|
188
|
+
```js
|
|
189
|
+
registerIcons({ 'company-logo': '<svg viewBox="0 0 24 24">…</svg>' })
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
```clojure
|
|
193
|
+
(icons/register! {:company-logo "<svg viewBox=\"0 0 24 24\">…</svg>"})
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## Size and motion
|
|
197
|
+
|
|
198
|
+
```html
|
|
199
|
+
<ty-icon name="loader" size="sm" spin></ty-icon>
|
|
200
|
+
<ty-icon name="heart" size="24" pulse tempo="slow"></ty-icon>
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
- `size`: `xs` `sm` `md` `lg` `xl` `2xl`, or pixels `12` `14` `16` `18` `20` `24` `32` `48` `64` `80` `96`.
|
|
204
|
+
- `spin`, `pulse`: animations. `tempo`: `slow` or `fast`.
|
|
205
|
+
|
|
206
|
+
## Why is my icon a faint circle?
|
|
207
|
+
|
|
208
|
+
An unknown name renders a faint placeholder circle, and nothing is logged. Check, in order:
|
|
209
|
+
|
|
210
|
+
1. **Registered?** In the console, `tyIcons.has('mail')`. `tyIcons.list()` shows every registered name.
|
|
211
|
+
2. **Same name?** Names match exactly: `chevronDown`, `chevron-down` and `action-down` are three different names.
|
|
212
|
+
3. **Registered before use?** Registering later works (icons update), but a typo in the key never will.
|