tyrell-components 1.0.0-TC8 → 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 +42 -18
- package/lib/components/button.js +318 -235
- 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 +122 -0
- package/lib/components/file-upload.js +451 -0
- 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 +17 -55
- package/lib/components/tag.js +235 -308
- 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 +15 -4
- package/lib/index.js +28 -38
- package/lib/styles/button.d.ts +24 -7
- package/lib/styles/button.js +298 -417
- package/lib/styles/calendar-month.d.ts +7 -6
- package/lib/styles/calendar-month.js +157 -179
- package/lib/styles/calendar-navigation.d.ts +2 -6
- package/lib/styles/calendar-navigation.js +108 -109
- 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 +320 -352
- 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 -0
- package/lib/styles/file-upload.js +196 -0
- 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 +170 -359
- 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 +34 -0
- package/lib/utils/loader-registry.js +11 -0
- 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 +66 -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 -402
- package/lib/components/dropdown.d.ts.map +0 -1
- package/lib/components/dropdown.js +0 -1564
- package/lib/components/dropdown.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 -397
- package/lib/components/multiselect.d.ts.map +0 -1
- package/lib/components/multiselect.js +0 -1580
- 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 -983
- package/lib/styles/dropdown.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 -774
- 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/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
package/AGENTS.md
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Tyrell — rules for coding agents
|
|
2
|
+
|
|
3
|
+
For apps that **use** Tyrell (`tyrell-components`, `tyrell-react`, `dev.gersak/tyrell`). Version: 1.0.0-rc.21. Not for editing Tyrell's own source.
|
|
4
|
+
|
|
5
|
+
Your training data barely knows Tyrell; Tailwind/shadcn/Bootstrap habits are wrong here, and these rules win. The full docs for this version (`guides/`, `CHANGELOG.md`) ship next to this file: grep them before guessing.
|
|
6
|
+
|
|
7
|
+
## 1. If Tyrell has a component, use it
|
|
8
|
+
|
|
9
|
+
Never hand-roll a control: no `.btn`, `.pill`, `.badge`, `.chip`, `.seg`, `.toggle`, `.drawer`, `.dropdown` or `.tabs` CSS, and no native `<button>`, `<select>`, `<input>`, `<textarea>` or `<dialog>` in app markup.
|
|
10
|
+
|
|
11
|
+
| Need | Use |
|
|
12
|
+
|---|---|
|
|
13
|
+
| Any action (submit, open, delete, icon) | `ty-button` |
|
|
14
|
+
| Status, category, count, filter chip | `ty-tag` (§4) |
|
|
15
|
+
| Pick one or many from a list | `ty-select` + `ty-option`; `multiple` + `ty-selected-options` for chips |
|
|
16
|
+
| A few choices (up to 7) instead of a segmented control | `ty-select` with `slot="trigger"` (§6) |
|
|
17
|
+
| Switch views or sections | `ty-tabs` + `ty-tab` (scrolls by default; `fixed` for 2–5 short labels) |
|
|
18
|
+
| Steps | `ty-wizard` + `ty-step` |
|
|
19
|
+
| On/off | `ty-switch`; in a form list `ty-checkbox` |
|
|
20
|
+
| One of several, all visible | `ty-radio-group` + `ty-radio` |
|
|
21
|
+
| Text, number, money, percent, big numbers | `ty-input` (`type="currency"`, `"percent"`, `"compact"`) |
|
|
22
|
+
| Multi-line text | `ty-textarea` |
|
|
23
|
+
| Date or date-time | `ty-date-picker`; month grid `ty-calendar` |
|
|
24
|
+
| Dialog, drawer, bottom sheet | `ty-modal` (`sheet`: full screen, slides up below 768px) |
|
|
25
|
+
| Anchored panel or menu | `ty-popup` |
|
|
26
|
+
| Hint on hover/focus | `ty-tooltip`, not `title=` |
|
|
27
|
+
| Copyable value | `ty-copy` |
|
|
28
|
+
| File drop/pick | `ty-file-upload` |
|
|
29
|
+
| Reorder, kanban | `ty-sortable` |
|
|
30
|
+
| Scroll area with edge shadows | `ty-scroll-container` |
|
|
31
|
+
| Icon | `ty-icon` |
|
|
32
|
+
| Field label, error text | the `label` / `error` attribute on the component |
|
|
33
|
+
|
|
34
|
+
Plain HTML with Tyrell color classes and Tailwind is right for layout, cards and panels, tables, sidebars and nav, headings and text, KPI/stat blocks, empty states and links.
|
|
35
|
+
|
|
36
|
+
## 2. A prototype sets the look, Tyrell sets the widgets
|
|
37
|
+
|
|
38
|
+
Given an HTML or Figma prototype, keep its layout, spacing, typography and palette, and build every control from §1: `.btn` → `ty-button`, `.pill`/`.badge` → `ty-tag`, `.seg` → `ty-select` trigger or `ty-tabs`, `.drawer` → `ty-modal`. Bring its palette in through the theme (§7). "Match the prototype" never means copying its component CSS or its hex colors.
|
|
39
|
+
|
|
40
|
+
## 3. Sizes (px)
|
|
41
|
+
|
|
42
|
+
| | xs | sm (default) | md | lg | xl |
|
|
43
|
+
|---|---|---|---|---|---|
|
|
44
|
+
| Field: `ty-input`, `ty-select`, `ty-date-picker`, `ty-copy` | 28 | 32 | 36 | 40 | 44 |
|
|
45
|
+
| `ty-button` | 24 | 28 | 32 | 36 | 40 |
|
|
46
|
+
| `ty-tag` | 20 | 24 | 28 | 32 | 36 |
|
|
47
|
+
|
|
48
|
+
Below 640px fields drop `lg` to 36 and `xl` to 40 (below 480px `xl` to 36). Buttons and tags don't change.
|
|
49
|
+
|
|
50
|
+
- **Field and button in one row: field `md` + button `lg`** (both 36). It lines up at every width. Smaller row: field `sm` + button `md` (32). Avoid field `lg` + button `xl`: it breaks below 640px.
|
|
51
|
+
- Button inside a field's `end` slot: the field's size name.
|
|
52
|
+
- The defaults never line up (field 32, button 28): in a row, set `size` on both.
|
|
53
|
+
- Tag beside a button or field: match heights (tag `lg` = button `md` = field `sm`; tag `xl` = button `lg` = field `md`). In tables and dense lists: `sm`.
|
|
54
|
+
- Fields are `width: 100%`: in a flex row the field takes the free space, the button keeps its label width.
|
|
55
|
+
- A `ty-button` that is a direct child of a flex column stretches; add `self-start`.
|
|
56
|
+
|
|
57
|
+
## 4. Tags
|
|
58
|
+
|
|
59
|
+
- For status (semantic flavor), category or type (neutral), counts, filter chips (`clickable`, `dismissible`) and picked values (`ty-selected-options` renders them for `ty-select multiple`).
|
|
60
|
+
- Not for decoration, headings, navigation, actions (`ty-button`) or sentences.
|
|
61
|
+
- The label says what it is: "Overdue", "Retail", "3 units". If a reader can't tell what a tag means, remove it. No unexplained tags in top bars.
|
|
62
|
+
- `neutral` by default. A semantic flavor only for state, with one meaning per flavor across the app: `success` ok/active, `warning` needs attention, `danger` problem, `primary` selected/emphasis.
|
|
63
|
+
- Tags hug their content. Don't stretch them to full width.
|
|
64
|
+
|
|
65
|
+
## 5. Surfaces
|
|
66
|
+
|
|
67
|
+
- From the back: `ty-canvas` (app background) → `ty-content` (main area) → `ty-elevated` (cards, panels, sidebars) → `ty-floating` (modals, popovers, menus). `ty-input` is the background of form controls.
|
|
68
|
+
- `ty-modal` and `ty-popup` are transparent: put a `ty-floating` panel inside, with your own padding and radius.
|
|
69
|
+
- Dividers between rows inside a surface: `ty-divide-y` / `ty-divide-x`, not Tailwind's `divide-*`.
|
|
70
|
+
- `ty-bg-*` is for small accents (a callout box, a highlighted row, a status dot). Never for cards, and never to fake a button or badge.
|
|
71
|
+
|
|
72
|
+
## 6. Dropdowns (`ty-select`)
|
|
73
|
+
|
|
74
|
+
- Options are `ty-option` (not `<option>` or `ty-tag`). The selection is the select's `value`; `<ty-option selected>` selects nothing, so server-rendered HTML carries `value="…"`.
|
|
75
|
+
- **Up to 7 options: give it a trigger** (`slot="trigger"`). The search row only appears above 7 options, so a short list doesn't need a form field. In toolbars and filter bars, `compact` is the plain alternative.
|
|
76
|
+
- More options, or typed search: the default field. `external-search` for remote lists, `allow-create` for a tags input.
|
|
77
|
+
- A slotted trigger keeps the value, form submit, ARIA, keyboard and the error line. The select takes the click and the keys, so don't add `clickable` to a trigger tag. You render the trigger: show the current value in it and update it on `change`. No × button; call `clear()`.
|
|
78
|
+
- The list is at least 320px wide, or as wide as the trigger; `--ty-select-popup-width` sets it.
|
|
79
|
+
- **Status picker:** the trigger is a `ty-tag` in the current option's flavor, with a chevron.
|
|
80
|
+
|
|
81
|
+
```html
|
|
82
|
+
<ty-select name="status" value="active">
|
|
83
|
+
<ty-tag slot="trigger" flavor="success">Active <ty-icon slot="end" name="chevron-down"></ty-icon></ty-tag>
|
|
84
|
+
<ty-option value="active">Active</ty-option>
|
|
85
|
+
<ty-option value="paused">Paused</ty-option>
|
|
86
|
+
</ty-select>
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
- **Sort, view or filter switch:** the trigger is a `ty-button` sized for its row: icon, current label, chevron.
|
|
90
|
+
|
|
91
|
+
```html
|
|
92
|
+
<ty-select name="sort" value="newest">
|
|
93
|
+
<ty-button slot="trigger" size="lg"><ty-icon slot="start" name="arrow-down-up"></ty-icon> Newest <ty-icon slot="end" name="chevron-down"></ty-icon></ty-button>
|
|
94
|
+
<ty-option value="newest">Newest</ty-option>
|
|
95
|
+
<ty-option value="oldest">Oldest</ty-option>
|
|
96
|
+
</ty-select>
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## 7. Colors and theme
|
|
100
|
+
|
|
101
|
+
- Colors come only from Tyrell classes; layout, spacing and type from Tailwind. Never `bg-blue-500`, `text-gray-900` or hex colors in markup.
|
|
102
|
+
- Text: `ty-text++`, `ty-text+`, `ty-text`, `ty-text-`, `ty-text--`. Semantic: `ty-text-{flavor}`, `ty-bg-{flavor}` (`+` stronger, `-` softer), `ty-border-{flavor}`.
|
|
103
|
+
- Flavors: `primary`, `success`, `danger`, `warning`, `neutral`. There is no `info`, `secondary` or `accent`. For a project flavor `X`, define `--ty-color-X`, `--ty-bg-X`, `--ty-border-X` (and `--ty-solid-X` for solid buttons), then use `flavor="X"`.
|
|
104
|
+
- Brand: load `tyrell-theme.css` after `tyrell.css` and set `--ty-primary-seed: oklch(0.5 <chroma> <hue>)` on `:root`. Not just `--ty-primary-hue`/`--ty-primary-chroma` on `:root`: dark mode re-declares them and the brand vanishes there.
|
|
105
|
+
|
|
106
|
+
## 8. Events, properties, icons, SSR
|
|
107
|
+
|
|
108
|
+
- The payload is on `event.detail`: `.value` (`.values` for `multiple`), `.checked` for checkbox and switch. Never `event.value`. `ty-tabs` fires `ty-tab-change` with `detail.activeId`.
|
|
109
|
+
- Booleans, arrays and objects are properties; strings can be attributes. React: props via `tyrell-react`. Vue: `:prop`. Svelte: `prop:`. Reagent `:>` and Helix `$` need camelCase props; UIx translates kebab-case.
|
|
110
|
+
- `<ty-icon name="chevron-down">` needs registering first, and the key is the name: `registerIcons({ 'chevron-down': chevronDown })`, named imports from `tyrell-components/icons/lucide` (never `import *`). CLJS: `(tyrell.icons/register! {...})`. Server-rendered apps can slot an inline `<svg>` (`currentColor`) into `<ty-icon>` instead.
|
|
111
|
+
- `customElements.define` needs a browser: import Tyrell only in client code (`'use client'`, `.client.ts`, `if (browser)`).
|
|
112
|
+
|
|
113
|
+
## 9. Your stack
|
|
114
|
+
|
|
115
|
+
- React: `tyrell-react` (`TyButton`, `TySelect`, …). ClojureScript: `dev.gersak/tyrell`, which installs this npm package; UIx, Reagent, Helix via `tyrell.react`, Replicant and vanilla as raw `<ty-*>` hiccup. Server-rendered (HTMX, Datastar, templates): plain `<ty-*>` markup; fields post like native ones.
|
|
116
|
+
- Guides: `TY_GUIDE.md` (every attribute, slot, event), `CSS_GUIDE.md` (colors, surfaces, sizing), `js/` (React, Vue, Svelte, HTMX), `clj/`, `DATASTAR_TY_GUIDE.md`.
|
|
117
|
+
|
|
118
|
+
## 10. Before you say done
|
|
119
|
+
|
|
120
|
+
- Search your markup and CSS for `.btn`, `.pill`, `.chip`, `.badge`, `.seg`, `.drawer`, `<button`, `<select`, `<dialog`, hex colors and Tailwind color classes. Each hit needs a reason or a Tyrell replacement.
|
|
121
|
+
- Check every row where a field and a button sit together (§3).
|
|
122
|
+
- Look at the result in a real browser, with the real data flow running.
|