@kerfjs/ui 5.0.0-beta.104 → 5.0.0-beta.106
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 +155 -116
- package/ai/application-ui-profile.defaults.json +125 -4
- package/ai/compile-time-contracts-v1.json +11 -11
- package/ai/component-catalog.json +2606 -628
- package/ai/component-composition-rules.json +10 -10
- package/ai/component-composition.json +1688 -300
- package/ai/components/README.md +66 -48
- package/ai/components/application-tabs.md +4 -4
- package/ai/components/badge.md +1 -0
- package/ai/components/button.md +91 -0
- package/ai/components/checkbox.md +89 -0
- package/ai/components/choice-chips.md +9 -3
- package/ai/components/color-field.md +92 -0
- package/ai/components/color-picker.md +90 -0
- package/ai/components/color-swatches.md +82 -0
- package/ai/components/combobox.md +6 -4
- package/ai/components/content-item.md +5 -2
- package/ai/components/disclosure.md +83 -0
- package/ai/components/file-picker.md +1 -0
- package/ai/components/foundation.md +1 -1
- package/ai/components/list-action-row.md +3 -3
- package/ai/components/list-detail-dialog.md +90 -0
- package/ai/components/list.md +2 -0
- package/ai/components/lucide-icon.md +2 -0
- package/ai/components/{composer.md → message-composer.md} +17 -16
- package/ai/components/pane.md +3 -1
- package/ai/components/popup-menu.md +12 -9
- package/ai/components/progress-bar.md +82 -0
- package/ai/components/progress-ring.md +80 -0
- package/ai/components/radio-group.md +88 -0
- package/ai/components/recipe-list-detail-dialog.md +5 -5
- package/ai/components/{token-search-field.md → search-field.md} +23 -23
- package/ai/components/select.md +15 -13
- package/ai/components/slider.md +84 -0
- package/ai/components/surface-scaffold.md +16 -13
- package/ai/components/switch.md +81 -0
- package/ai/components/tab-bar.md +6 -6
- package/ai/components/tab-navigator.md +2 -2
- package/ai/components/tabs.md +7 -7
- package/ai/components/tag-field.md +86 -0
- package/ai/components/text-field.md +98 -0
- package/ai/components/text.md +1 -0
- package/ai/components/toast.md +85 -0
- package/ai/components/toolbar-control-group.md +3 -3
- package/ai/components/tooltip.md +81 -0
- package/ai/components/wa-accordion-item.md +11 -5
- package/ai/components/wa-accordion.md +11 -5
- package/ai/components/wa-animated-image.md +2 -1
- package/ai/components/wa-animation.md +1 -0
- package/ai/components/wa-avatar.md +1 -0
- package/ai/components/wa-badge.md +10 -3
- package/ai/components/wa-breadcrumb-item.md +1 -0
- package/ai/components/wa-breadcrumb.md +1 -0
- package/ai/components/wa-button-group.md +6 -4
- package/ai/components/wa-button.md +7 -5
- package/ai/components/wa-callout.md +7 -5
- package/ai/components/wa-card.md +12 -4
- package/ai/components/wa-carousel-item.md +1 -0
- package/ai/components/wa-carousel.md +1 -0
- package/ai/components/wa-checkbox-group.md +11 -4
- package/ai/components/wa-checkbox.md +10 -4
- package/ai/components/wa-color-picker.md +13 -5
- package/ai/components/wa-comparison.md +2 -1
- package/ai/components/wa-copy-button.md +1 -0
- package/ai/components/wa-details.md +11 -5
- package/ai/components/wa-dialog.md +10 -4
- package/ai/components/wa-divider.md +1 -0
- package/ai/components/wa-drawer.md +12 -5
- package/ai/components/wa-dropdown-item.md +8 -6
- package/ai/components/wa-dropdown.md +8 -6
- package/ai/components/wa-format-bytes.md +1 -0
- package/ai/components/wa-format-date.md +1 -0
- package/ai/components/wa-format-number.md +1 -0
- package/ai/components/wa-icon.md +2 -1
- package/ai/components/wa-include.md +6 -4
- package/ai/components/wa-input.md +9 -6
- package/ai/components/wa-intersection-observer.md +1 -0
- package/ai/components/wa-known-date.md +1 -0
- package/ai/components/wa-markdown.md +1 -0
- package/ai/components/wa-mutation-observer.md +1 -0
- package/ai/components/wa-number-input.md +1 -0
- package/ai/components/wa-option.md +7 -5
- package/ai/components/wa-otp-input.md +1 -0
- package/ai/components/wa-page.md +13 -4
- package/ai/components/wa-pagination.md +1 -0
- package/ai/components/wa-popover.md +11 -5
- package/ai/components/wa-popup.md +11 -4
- package/ai/components/wa-progress-bar.md +11 -4
- package/ai/components/wa-progress-ring.md +11 -4
- package/ai/components/wa-qr-code.md +1 -0
- package/ai/components/wa-radio-group.md +12 -4
- package/ai/components/wa-radio.md +10 -4
- package/ai/components/wa-random-content.md +1 -0
- package/ai/components/wa-rating.md +1 -0
- package/ai/components/wa-relative-time.md +1 -0
- package/ai/components/wa-resize-observer.md +1 -0
- package/ai/components/wa-scroller.md +12 -4
- package/ai/components/wa-select.md +7 -5
- package/ai/components/wa-skeleton.md +10 -3
- package/ai/components/wa-slider.md +11 -5
- package/ai/components/wa-spinner.md +7 -5
- package/ai/components/wa-split-panel.md +7 -5
- package/ai/components/wa-step.md +56 -0
- package/ai/components/wa-stepper.md +56 -0
- package/ai/components/wa-switch.md +10 -3
- package/ai/components/wa-tab-group.md +8 -6
- package/ai/components/wa-tab-panel.md +7 -5
- package/ai/components/wa-tab.md +8 -6
- package/ai/components/wa-tag-input.md +62 -0
- package/ai/components/wa-tag.md +9 -6
- package/ai/components/wa-textarea.md +10 -3
- package/ai/components/wa-time-input.md +1 -0
- package/ai/components/wa-toast-item.md +9 -7
- package/ai/components/wa-toast.md +9 -7
- package/ai/components/wa-tooltip.md +11 -5
- package/ai/components/wa-tree-item.md +2 -1
- package/ai/components/wa-tree.md +2 -1
- package/ai/components/wa-zoomable-frame.md +2 -1
- package/ai/components/workbench-dialog.md +90 -0
- package/ai/public-api-signatures-v1.md +1579 -247
- package/ai/skill.md +83 -50
- package/ai/webawesome-jsx-signatures-v1.md +4 -1
- package/dist/badge.d.ts +9 -1
- package/dist/badge.js +1 -1
- package/dist/browser/button.js +5 -0
- package/dist/browser/catalog.js +3 -2
- package/dist/browser/{icon-button.js → checkbox.js} +2 -2
- package/dist/browser/color-field.js +4 -0
- package/dist/browser/color-picker.js +5 -0
- package/dist/browser/color-swatches.js +3 -0
- package/dist/browser/disclosure.js +5 -0
- package/dist/browser/list-action-row.js +1 -0
- package/dist/browser/list-detail-dialog.js +14 -0
- package/dist/browser/message-composer.js +5 -0
- package/dist/browser/popup-menu.js +1 -0
- package/dist/browser/progress-bar.js +3 -0
- package/dist/browser/progress-ring.js +3 -0
- package/dist/browser/radio-group.js +3 -0
- package/dist/browser/search-field.js +4 -0
- package/dist/browser/slider.js +3 -0
- package/dist/browser/surface-scaffold.js +1 -0
- package/dist/browser/switch.js +3 -0
- package/dist/browser/tab-bar-item.js +4 -0
- package/dist/browser/tag-field.js +5 -0
- package/dist/browser/text-field.js +4 -0
- package/dist/browser/workbench-dialog.js +15 -0
- package/dist/button.d.ts +108 -0
- package/dist/button.js +7 -0
- package/dist/button.js.map +1 -0
- package/dist/catalog-resources.d.ts +1 -1
- package/dist/catalog.d.ts +3 -3
- package/dist/catalog.js +57 -27
- package/dist/catalog.js.map +1 -1
- package/dist/checkbox.d.ts +45 -0
- package/dist/checkbox.js +6 -0
- package/dist/checkbox.js.map +1 -0
- package/dist/choice-chips.d.ts +49 -15
- package/dist/choice-chips.js +1 -1
- package/dist/chunk-23PPPNH6.js +93 -0
- package/dist/chunk-23PPPNH6.js.map +1 -0
- package/dist/{chunk-FNZQOUZ5.js → chunk-2FW7D4IG.js} +2 -2
- package/dist/{chunk-FNZQOUZ5.js.map → chunk-2FW7D4IG.js.map} +1 -1
- package/dist/{chunk-ZYU5WRC3.js → chunk-3GLYIIFR.js} +2 -2
- package/dist/{chunk-ZYU5WRC3.js.map → chunk-3GLYIIFR.js.map} +1 -1
- package/dist/{chunk-5NQF35VO.js → chunk-4RECPEHI.js} +2 -2
- package/dist/{chunk-5NQF35VO.js.map → chunk-4RECPEHI.js.map} +1 -1
- package/dist/{chunk-7IUEBNCO.js → chunk-5USKCWGL.js} +8 -3
- package/dist/chunk-5USKCWGL.js.map +1 -0
- package/dist/chunk-6VVIW7VB.js +69 -0
- package/dist/chunk-6VVIW7VB.js.map +1 -0
- package/dist/{chunk-LL45C7BB.js → chunk-7K6U6FCN.js} +1 -1
- package/dist/chunk-7K6U6FCN.js.map +1 -0
- package/dist/{chunk-HQZYKJ56.js → chunk-7W3GKMN4.js} +110 -74
- package/dist/chunk-7W3GKMN4.js.map +1 -0
- package/dist/chunk-ACUKTVS3.js +371 -0
- package/dist/chunk-ACUKTVS3.js.map +1 -0
- package/dist/{chunk-YQ2AC4E2.js → chunk-AMIHGFLP.js} +2 -2
- package/dist/{chunk-YQ2AC4E2.js.map → chunk-AMIHGFLP.js.map} +1 -1
- package/dist/chunk-ATGAJVZ6.js +268 -0
- package/dist/chunk-ATGAJVZ6.js.map +1 -0
- package/dist/chunk-AYPGXR2E.js +20 -0
- package/dist/chunk-AYPGXR2E.js.map +1 -0
- package/dist/{chunk-ETCWQLJV.js → chunk-BKUMG2KB.js} +38 -28
- package/dist/chunk-BKUMG2KB.js.map +1 -0
- package/dist/chunk-C26Q6P4Q.js +76 -0
- package/dist/chunk-C26Q6P4Q.js.map +1 -0
- package/dist/chunk-C3RLKKFQ.js +452 -0
- package/dist/chunk-C3RLKKFQ.js.map +1 -0
- package/dist/{chunk-T5BJBMW7.js → chunk-CIAUILRR.js} +5 -5
- package/dist/chunk-CIAUILRR.js.map +1 -0
- package/dist/chunk-CNM6ZWP2.js +38 -0
- package/dist/chunk-CNM6ZWP2.js.map +1 -0
- package/dist/{chunk-LPHU44S3.js → chunk-CTQUDCY5.js} +3 -1
- package/dist/chunk-CTQUDCY5.js.map +1 -0
- package/dist/{chunk-MXNIVEVL.js → chunk-D4MXSAMI.js} +5 -3
- package/dist/chunk-D4MXSAMI.js.map +1 -0
- package/dist/{chunk-YBWQR2OK.js → chunk-DDSCVEO5.js} +10 -9
- package/dist/chunk-DDSCVEO5.js.map +1 -0
- package/dist/{chunk-SIW64V65.js → chunk-DF2YKGIX.js} +3 -3
- package/dist/{chunk-SIW64V65.js.map → chunk-DF2YKGIX.js.map} +1 -1
- package/dist/{chunk-3SKAEPPZ.js → chunk-ECFCAKWE.js} +4 -4
- package/dist/{chunk-3SKAEPPZ.js.map → chunk-ECFCAKWE.js.map} +1 -1
- package/dist/chunk-EKBMUXFV.js +298 -0
- package/dist/chunk-EKBMUXFV.js.map +1 -0
- package/dist/{chunk-IXLUZHGT.js → chunk-FG6U7KQQ.js} +5 -5
- package/dist/{chunk-IXLUZHGT.js.map → chunk-FG6U7KQQ.js.map} +1 -1
- package/dist/chunk-FKKJHGN5.js +147 -0
- package/dist/chunk-FKKJHGN5.js.map +1 -0
- package/dist/{chunk-FDZNYD4C.js → chunk-GCAK23PU.js} +34 -3
- package/dist/chunk-GCAK23PU.js.map +1 -0
- package/dist/chunk-GXSX6Q6O.js +42 -0
- package/dist/chunk-GXSX6Q6O.js.map +1 -0
- package/dist/{chunk-LOSRXZAH.js → chunk-HJXVVFBT.js} +14 -6
- package/dist/chunk-HJXVVFBT.js.map +1 -0
- package/dist/{chunk-M5KZ26VV.js → chunk-HQZG3OFL.js} +11 -1
- package/dist/chunk-HQZG3OFL.js.map +1 -0
- package/dist/{chunk-ELCMSQNJ.js → chunk-HTERKONR.js} +8 -8
- package/dist/chunk-HTERKONR.js.map +1 -0
- package/dist/chunk-HYORKKYP.js +8 -0
- package/dist/chunk-HYORKKYP.js.map +1 -0
- package/dist/chunk-IO27YTL3.js +73 -0
- package/dist/chunk-IO27YTL3.js.map +1 -0
- package/dist/chunk-ITUQC4FW.js +163 -0
- package/dist/chunk-ITUQC4FW.js.map +1 -0
- package/dist/chunk-K57NINLH.js +137 -0
- package/dist/chunk-K57NINLH.js.map +1 -0
- package/dist/chunk-KC6WUSNS.js +34 -0
- package/dist/chunk-KC6WUSNS.js.map +1 -0
- package/dist/{chunk-W4IK7AWD.js → chunk-KDQZ3E5C.js} +3 -1
- package/dist/chunk-KDQZ3E5C.js.map +1 -0
- package/dist/{chunk-2MSPNRWJ.js → chunk-KK3S5OTW.js} +27 -11
- package/dist/chunk-KK3S5OTW.js.map +1 -0
- package/dist/chunk-LTBVP6VN.js +59 -0
- package/dist/chunk-LTBVP6VN.js.map +1 -0
- package/dist/chunk-OHPYT2BH.js +82 -0
- package/dist/chunk-OHPYT2BH.js.map +1 -0
- package/dist/{chunk-HZPHCSCS.js → chunk-OY2MXIBB.js} +8 -2
- package/dist/chunk-OY2MXIBB.js.map +1 -0
- package/dist/chunk-PE2KPZDW.js +85 -0
- package/dist/chunk-PE2KPZDW.js.map +1 -0
- package/dist/{chunk-QTSMHH5J.js → chunk-QPTJ5DOO.js} +5 -3
- package/dist/chunk-QPTJ5DOO.js.map +1 -0
- package/dist/{chunk-JOR5LGYE.js → chunk-RFLW4FPL.js} +1 -1
- package/dist/chunk-RFLW4FPL.js.map +1 -0
- package/dist/{chunk-U6QYTMDB.js → chunk-RMWNO6BA.js} +6 -2
- package/dist/chunk-RMWNO6BA.js.map +1 -0
- package/dist/{chunk-TDMHA7C3.js → chunk-SQ2Q3OQI.js} +112 -63
- package/dist/chunk-SQ2Q3OQI.js.map +1 -0
- package/dist/{chunk-K4AT3V3J.js → chunk-T74YB76U.js} +13 -11
- package/dist/chunk-T74YB76U.js.map +1 -0
- package/dist/{chunk-BYFTHA4I.js → chunk-TAHR457X.js} +53 -6
- package/dist/chunk-TAHR457X.js.map +1 -0
- package/dist/{chunk-3VXDSIBJ.js → chunk-TKNVL53O.js} +2 -2
- package/dist/{chunk-3VXDSIBJ.js.map → chunk-TKNVL53O.js.map} +1 -1
- package/dist/chunk-TNJLNLVE.js +115 -0
- package/dist/chunk-TNJLNLVE.js.map +1 -0
- package/dist/chunk-TUID42UE.js +15 -0
- package/dist/chunk-TUID42UE.js.map +1 -0
- package/dist/{chunk-CR5U5FV6.js → chunk-UMNHJSIO.js} +93 -80
- package/dist/chunk-UMNHJSIO.js.map +1 -0
- package/dist/chunk-UTCAOOXU.js +116 -0
- package/dist/chunk-UTCAOOXU.js.map +1 -0
- package/dist/{chunk-ZJC5ND3M.js → chunk-VEME3D7K.js} +35 -35
- package/dist/chunk-VEME3D7K.js.map +1 -0
- package/dist/{chunk-HLDRH23D.js → chunk-WJKHLOP5.js} +2 -2
- package/dist/{chunk-HLDRH23D.js.map → chunk-WJKHLOP5.js.map} +1 -1
- package/dist/chunk-WU57BYYM.js +115 -0
- package/dist/chunk-WU57BYYM.js.map +1 -0
- package/dist/{chunk-TGLUDQP2.js → chunk-ZCDRLN3B.js} +11 -11
- package/dist/chunk-ZCDRLN3B.js.map +1 -0
- package/dist/chunk-ZX2QQJXD.js +249 -0
- package/dist/chunk-ZX2QQJXD.js.map +1 -0
- package/dist/{chunk-6E2H2E5A.js → chunk-ZXZAECHZ.js} +6 -6
- package/dist/{chunk-6E2H2E5A.js.map → chunk-ZXZAECHZ.js.map} +1 -1
- package/dist/collapsible-panel.js +3 -3
- package/dist/color-field.d.ts +51 -0
- package/dist/color-field.js +92 -0
- package/dist/color-field.js.map +1 -0
- package/dist/color-picker.d.ts +88 -0
- package/dist/color-picker.js +8 -0
- package/dist/color-picker.js.map +1 -0
- package/dist/color-swatches.d.ts +56 -0
- package/dist/color-swatches.js +4 -0
- package/dist/color-swatches.js.map +1 -0
- package/dist/combobox.js +1 -1
- package/dist/content-item.d.ts +13 -1
- package/dist/content-item.js +1 -1
- package/dist/disclosure-arrow.js +1 -1
- package/dist/disclosure.d.ts +57 -0
- package/dist/disclosure.js +51 -0
- package/dist/disclosure.js.map +1 -0
- package/dist/file-picker.d.ts +7 -0
- package/dist/file-picker.js +1 -1
- package/dist/help-tags-register.d.ts +8 -8
- package/dist/help-tags-register.js +3 -2
- package/dist/help-tags-register.js.map +1 -1
- package/dist/index.d.ts +16 -9
- package/dist/index.js +58 -46
- package/dist/list-action-row.js +4 -1
- package/dist/list-detail-dialog.d.ts +117 -0
- package/dist/list-detail-dialog.js +165 -0
- package/dist/list-detail-dialog.js.map +1 -0
- package/dist/list-header.js +1 -1
- package/dist/list-item.js +1 -1
- package/dist/list.d.ts +17 -2
- package/dist/list.js +1 -1
- package/dist/lucide-icon.d.ts +9 -1
- package/dist/lucide-icon.js +1 -1
- package/dist/{composer.d.ts → message-composer.d.ts} +20 -12
- package/dist/message-composer.js +6 -0
- package/dist/message-composer.js.map +1 -0
- package/dist/nav-stack.js +1 -1
- package/dist/pane.d.ts +36 -3
- package/dist/pane.js +1 -1
- package/dist/popup-menu-register.d.ts +6 -5
- package/dist/popup-menu-register.js +3 -326
- package/dist/popup-menu-register.js.map +1 -1
- package/dist/popup-menu.d.ts +41 -23
- package/dist/popup-menu.js +5 -1
- package/dist/progress-bar.d.ts +52 -0
- package/dist/progress-bar.js +68 -0
- package/dist/progress-bar.js.map +1 -0
- package/dist/progress-ring.d.ts +44 -0
- package/dist/progress-ring.js +73 -0
- package/dist/progress-ring.js.map +1 -0
- package/dist/radio-group.d.ts +62 -0
- package/dist/radio-group.js +4 -0
- package/dist/radio-group.js.map +1 -0
- package/dist/row.js +1 -1
- package/dist/{token-search-model-JA1i8z4D.d.ts → search-field-CrGTN5sa.d.ts} +45 -45
- package/dist/search-field-model.d.ts +3 -0
- package/dist/search-field-model.js +3 -0
- package/dist/search-field-model.js.map +1 -0
- package/dist/search-field.d.ts +3 -0
- package/dist/search-field.js +5 -0
- package/dist/search-field.js.map +1 -0
- package/dist/select-register.d.ts +6 -3
- package/dist/select-register.js +383 -241
- package/dist/select-register.js.map +1 -1
- package/dist/select.d.ts +30 -6
- package/dist/select.js +3 -1
- package/dist/selection.d.ts +54 -0
- package/dist/selection.js +3 -0
- package/dist/selection.js.map +1 -0
- package/dist/slider.d.ts +74 -0
- package/dist/slider.js +103 -0
- package/dist/slider.js.map +1 -0
- package/dist/split-button.js +1 -1
- package/dist/split-view.d.ts +5 -2
- package/dist/split-view.js +18 -159
- package/dist/split-view.js.map +1 -1
- package/dist/state-banner.js +1 -1
- package/dist/styles/badge.css +18 -6
- package/dist/styles/button.css +230 -0
- package/dist/styles/catalog/components/catalog-example.css +13 -4
- package/dist/styles/checkbox.css +121 -0
- package/dist/styles/choice-chips.css +58 -7
- package/dist/styles/color-field.css +125 -0
- package/dist/styles/color-picker.css +331 -0
- package/dist/styles/color-swatches.css +122 -0
- package/dist/styles/combobox.css +7 -5
- package/dist/styles/components/actions/button/button.css +230 -0
- package/dist/styles/components/actions/popup-menu/popup-menu.css +326 -198
- package/dist/styles/components/actions/toolbar/toolbar.css +10 -3
- package/dist/styles/components/actions/toolbar-control-group/toolbar-control-group.css +67 -104
- package/dist/styles/components/actions/toolbar-text/toolbar-text.css +5 -18
- package/dist/styles/components/collections/list/list.css +37 -0
- package/dist/styles/components/feedback/badge/badge.css +18 -6
- package/dist/styles/components/feedback/progress-bar/progress-bar.css +168 -0
- package/dist/styles/components/feedback/progress-ring/progress-ring.css +91 -0
- package/dist/styles/components/feedback/state-banner/state-banner.css +18 -3
- package/dist/styles/components/forms/checkbox/checkbox.css +121 -0
- package/dist/styles/components/forms/choice-chips/choice-chips.css +58 -7
- package/dist/styles/components/forms/color-field/color-field.css +125 -0
- package/dist/styles/components/forms/color-picker/color-picker.css +331 -0
- package/dist/styles/components/forms/color-swatches/color-swatches.css +122 -0
- package/dist/styles/components/forms/combobox/combobox.css +7 -5
- package/dist/styles/components/forms/{composer/composer.css → message-composer/message-composer.css} +17 -33
- package/dist/styles/components/forms/radio-group/radio-group.css +156 -0
- package/dist/styles/{token-search-field.css → components/forms/search-field/search-field.css} +111 -102
- package/dist/styles/components/forms/select/select.css +370 -249
- package/dist/styles/components/forms/slider/slider.css +241 -0
- package/dist/styles/components/forms/switch/switch.css +132 -0
- package/dist/styles/components/forms/tag-field/tag-field.css +8 -0
- package/dist/styles/components/forms/text-field/text-field.css +193 -0
- package/dist/styles/components/layout/pane/pane.css +254 -0
- package/dist/styles/components/layout/resizable-region/resizable-region.css +3 -2
- package/dist/styles/components/layout/row/row.css +11 -0
- package/dist/styles/components/layout/split-view/split-view.css +25 -0
- package/dist/styles/components/layout/workbench/workbench.css +12 -4
- package/dist/styles/components/navigation/disclosure-arrow/disclosure-arrow.css +20 -0
- package/dist/styles/components/navigation/tab-bar/tab-bar.css +7 -7
- package/dist/styles/components/navigation/{app-tab/app-tab.css → tab-bar-item/tab-bar-item.css} +95 -90
- package/dist/styles/components/surfaces/disclosure/disclosure.css +98 -0
- package/dist/styles/components/surfaces/surface-scaffold/surface-scaffold.css +263 -116
- package/dist/styles/components/typography/text/text.css +14 -12
- package/dist/styles/disclosure-arrow.css +20 -0
- package/dist/styles/disclosure.css +98 -0
- package/dist/styles/foundation.css +6 -4
- package/dist/styles/list-detail-dialog.css +11 -0
- package/dist/styles/list.css +37 -0
- package/dist/styles/{composer.css → message-composer.css} +17 -33
- package/dist/styles/overlay-toast.css +149 -0
- package/dist/styles/overlay-tooltip.css +55 -0
- package/dist/styles/pane.css +254 -0
- package/dist/styles/popup-menu.css +326 -198
- package/dist/styles/progress-bar.css +168 -0
- package/dist/styles/progress-ring.css +91 -0
- package/dist/styles/radio-group.css +156 -0
- package/dist/styles/resizable-region.css +3 -2
- package/dist/styles/row.css +11 -0
- package/dist/styles/{components/forms/token-search-field/token-search-field.css → search-field.css} +111 -102
- package/dist/styles/select.css +370 -249
- package/dist/styles/slider.css +241 -0
- package/dist/styles/split-view.css +25 -0
- package/dist/styles/state-banner.css +18 -3
- package/dist/styles/styles.css +16 -5
- package/dist/styles/surface-scaffold.css +263 -116
- package/dist/styles/switch.css +132 -0
- package/dist/styles/{app-tab.css → tab-bar-item.css} +95 -90
- package/dist/styles/tab-bar.css +7 -7
- package/dist/styles/tag-field.css +8 -0
- package/dist/styles/text-field.css +193 -0
- package/dist/styles/text.css +14 -12
- package/dist/styles/toolbar-control-group.css +67 -104
- package/dist/styles/toolbar-text.css +5 -18
- package/dist/styles/toolbar.css +10 -3
- package/dist/styles/webawesome.css +9 -0
- package/dist/styles/workbench-dialog.css +10 -0
- package/dist/styles/workbench.css +12 -4
- package/dist/surface-scaffold-register.d.ts +7 -5
- package/dist/surface-scaffold-register.js +2 -246
- package/dist/surface-scaffold-register.js.map +1 -1
- package/dist/surface-scaffold.d.ts +70 -7
- package/dist/surface-scaffold.js +5 -1
- package/dist/switch.d.ts +38 -0
- package/dist/switch.js +4 -0
- package/dist/switch.js.map +1 -0
- package/dist/{app-tab.d.ts → tab-bar-item.d.ts} +11 -11
- package/dist/tab-bar-item.js +6 -0
- package/dist/tab-bar-item.js.map +1 -0
- package/dist/tab-bar.d.ts +3 -3
- package/dist/tab-bar.js +1 -1
- package/dist/tab-navigator.js +1 -1
- package/dist/tag-field.d.ts +52 -0
- package/dist/tag-field.js +6 -0
- package/dist/tag-field.js.map +1 -0
- package/dist/text-field.d.ts +83 -0
- package/dist/text-field.js +6 -0
- package/dist/text-field.js.map +1 -0
- package/dist/text.d.ts +6 -1
- package/dist/text.js +1 -1
- package/dist/{types-CVgIwSdq.d.ts → types-DmHWkSd6.d.ts} +19 -1
- package/dist/webawesome.d.ts +3 -0
- package/dist/wire-catalog.d.ts +8 -2
- package/dist/wire-catalog.js +16 -4
- package/dist/wire-catalog.js.map +1 -1
- package/dist/wire-checkboxes.d.ts +10 -0
- package/dist/wire-checkboxes.js +3 -0
- package/dist/{wire-composers.js.map → wire-checkboxes.js.map} +1 -1
- package/dist/wire-choice-chips.d.ts +17 -0
- package/dist/wire-choice-chips.js +4 -0
- package/dist/{wire-token-search-fields.js.map → wire-choice-chips.js.map} +1 -1
- package/dist/wire-color-fields.d.ts +33 -0
- package/dist/wire-color-fields.js +82 -0
- package/dist/wire-color-fields.js.map +1 -0
- package/dist/wire-color-pickers.d.ts +34 -0
- package/dist/wire-color-pickers.js +9 -0
- package/dist/wire-color-pickers.js.map +1 -0
- package/dist/wire-comboboxes.js +2 -1
- package/dist/wire-content-items.d.ts +5 -1
- package/dist/wire-content-items.js +84 -15
- package/dist/wire-content-items.js.map +1 -1
- package/dist/wire-file-pickers.d.ts +3 -2
- package/dist/wire-file-pickers.js +1 -1
- package/dist/{wire-composers.d.ts → wire-message-composers.d.ts} +5 -4
- package/dist/wire-message-composers.js +3 -0
- package/dist/wire-message-composers.js.map +1 -0
- package/dist/wire-overlay-sheets.js +1 -1
- package/dist/wire-pane-chrome.d.ts +21 -0
- package/dist/wire-pane-chrome.js +67 -0
- package/dist/wire-pane-chrome.js.map +1 -0
- package/dist/{wire-token-search-fields.d.ts → wire-search-fields.d.ts} +25 -25
- package/dist/wire-search-fields.js +6 -0
- package/dist/wire-search-fields.js.map +1 -0
- package/dist/wire-sliders.d.ts +12 -0
- package/dist/wire-sliders.js +31 -0
- package/dist/wire-sliders.js.map +1 -0
- package/dist/wire-tab-bars.js +1 -1
- package/dist/wire-tag-fields.d.ts +41 -0
- package/dist/wire-tag-fields.js +258 -0
- package/dist/wire-tag-fields.js.map +1 -0
- package/dist/wire-text-fields.d.ts +12 -0
- package/dist/wire-text-fields.js +3 -0
- package/dist/wire-text-fields.js.map +1 -0
- package/dist/workbench-dialog.d.ts +97 -0
- package/dist/workbench-dialog.js +124 -0
- package/dist/workbench-dialog.js.map +1 -0
- package/dist/workbench.d.ts +5 -0
- package/dist/workbench.js +1 -1
- package/docs/accessibility.md +181 -97
- package/docs/anchored-surface.md +8 -7
- package/docs/app-layouts.md +28 -0
- package/docs/catalog.md +14 -5
- package/docs/color-field.md +65 -0
- package/docs/color-picker.md +71 -0
- package/docs/color-swatches.md +46 -0
- package/docs/component-contract.md +31 -32
- package/docs/component-selection.md +228 -164
- package/docs/design/templates/button/emphasis-dark.svg +1 -0
- package/docs/design/templates/button/emphasis.svg +1 -0
- package/docs/design/templates/button/icons-dark.svg +1 -0
- package/docs/design/templates/button/icons.svg +1 -0
- package/docs/design/templates/button/pill-dark.svg +1 -0
- package/docs/design/templates/button/pill.svg +1 -0
- package/docs/design/templates/button/states-dark.svg +1 -0
- package/docs/design/templates/button/states.svg +1 -0
- package/docs/design/templates/button/toggles-dark.svg +1 -0
- package/docs/design/templates/button/toggles.svg +1 -0
- package/docs/design/templates/button/tones-dark.svg +1 -0
- package/docs/design/templates/button/tones.svg +1 -0
- package/docs/design/templates/button-dark.svg +1 -0
- package/docs/design/templates/button.svg +1 -0
- package/docs/design/templates/checkbox/compact-dark.svg +1 -0
- package/docs/design/templates/checkbox/compact.svg +1 -0
- package/docs/design/templates/checkbox/error-dark.svg +1 -0
- package/docs/design/templates/checkbox/error.svg +1 -0
- package/docs/design/templates/checkbox/mixed-dark.svg +1 -0
- package/docs/design/templates/checkbox/mixed.svg +1 -0
- package/docs/design/templates/checkbox/states-dark.svg +1 -0
- package/docs/design/templates/checkbox/states.svg +1 -0
- package/docs/design/templates/checkbox-dark.svg +1 -0
- package/docs/design/templates/checkbox.svg +1 -0
- package/docs/design/templates/choice-chips/color-palette-dark.svg +1 -1
- package/docs/design/templates/choice-chips/color-palette.svg +1 -1
- package/docs/design/templates/choice-chips/compact-icons-dark.svg +1 -1
- package/docs/design/templates/choice-chips/compact-icons.svg +1 -1
- package/docs/design/templates/choice-chips/multiple-dark.svg +1 -1
- package/docs/design/templates/choice-chips/multiple.svg +1 -1
- package/docs/design/templates/choice-chips-dark.svg +1 -1
- package/docs/design/templates/choice-chips.svg +1 -1
- package/docs/design/templates/color-field/compact-dark.svg +1 -0
- package/docs/design/templates/color-field/compact.svg +1 -0
- package/docs/design/templates/color-field/error-dark.svg +1 -0
- package/docs/design/templates/color-field/error.svg +1 -0
- package/docs/design/templates/color-field/hint-dark.svg +1 -0
- package/docs/design/templates/color-field/hint.svg +1 -0
- package/docs/design/templates/color-field-dark.svg +1 -0
- package/docs/design/templates/color-field.svg +1 -0
- package/docs/design/templates/color-picker/gray-dark.svg +1 -0
- package/docs/design/templates/color-picker/gray.svg +1 -0
- package/docs/design/templates/color-picker/rgb-dark.svg +1 -0
- package/docs/design/templates/color-picker/rgb.svg +1 -0
- package/docs/design/templates/color-picker-dark.svg +1 -0
- package/docs/design/templates/color-picker.svg +1 -0
- package/docs/design/templates/color-swatches/palette-dark.svg +1 -0
- package/docs/design/templates/color-swatches/palette.svg +1 -0
- package/docs/design/templates/color-swatches-dark.svg +1 -0
- package/docs/design/templates/color-swatches.svg +1 -0
- package/docs/design/templates/disclosure/framed-sunken-dark.svg +1 -0
- package/docs/design/templates/disclosure/framed-sunken.svg +1 -0
- package/docs/design/templates/disclosure/plain-dark.svg +1 -0
- package/docs/design/templates/disclosure/plain.svg +1 -0
- package/docs/design/templates/disclosure-dark.svg +1 -0
- package/docs/design/templates/disclosure.svg +1 -0
- package/docs/design/templates/list-header/size-l-dark.svg +1 -1
- package/docs/design/templates/list-header/size-l.svg +1 -1
- package/docs/design/templates/list-header/size-m-dark.svg +1 -1
- package/docs/design/templates/list-header/size-m.svg +1 -1
- package/docs/design/templates/list-header/size-xl-dark.svg +1 -1
- package/docs/design/templates/list-header/size-xl.svg +1 -1
- package/docs/design/templates/list-header-dark.svg +1 -1
- package/docs/design/templates/list-header.svg +1 -1
- package/docs/design/templates/message-composer/chat-dark.svg +1 -0
- package/docs/design/templates/message-composer/chat.svg +1 -0
- package/docs/design/templates/{composer → message-composer}/prompt-dark.svg +1 -1
- package/docs/design/templates/{composer → message-composer}/prompt.svg +1 -1
- package/docs/design/templates/message-composer-dark.svg +1 -0
- package/docs/design/templates/message-composer.svg +1 -0
- package/docs/design/templates/progress-bar/determinate-dark.svg +1 -0
- package/docs/design/templates/progress-bar/determinate.svg +1 -0
- package/docs/design/templates/progress-bar/tones-dark.svg +1 -0
- package/docs/design/templates/progress-bar/tones.svg +1 -0
- package/docs/design/templates/progress-bar-dark.svg +1 -0
- package/docs/design/templates/progress-bar.svg +1 -0
- package/docs/design/templates/progress-ring/sizes-dark.svg +1 -0
- package/docs/design/templates/progress-ring/sizes.svg +1 -0
- package/docs/design/templates/progress-ring/tones-dark.svg +1 -0
- package/docs/design/templates/progress-ring/tones.svg +1 -0
- package/docs/design/templates/progress-ring-dark.svg +1 -0
- package/docs/design/templates/progress-ring.svg +1 -0
- package/docs/design/templates/radio-group/horizontal-dark.svg +1 -0
- package/docs/design/templates/radio-group/horizontal.svg +1 -0
- package/docs/design/templates/radio-group/vertical-dark.svg +1 -0
- package/docs/design/templates/radio-group/vertical.svg +1 -0
- package/docs/design/templates/radio-group-dark.svg +1 -0
- package/docs/design/templates/radio-group.svg +1 -0
- package/docs/design/templates/segmented-control/equal-dark.svg +1 -1
- package/docs/design/templates/segmented-control/equal.svg +1 -1
- package/docs/design/templates/segmented-control/pill-small-dark.svg +1 -1
- package/docs/design/templates/segmented-control/pill-small.svg +1 -1
- package/docs/design/templates/segmented-control-dark.svg +1 -1
- package/docs/design/templates/segmented-control.svg +1 -1
- package/docs/design/templates/select/compact-dark.svg +1 -0
- package/docs/design/templates/select/compact.svg +1 -0
- package/docs/design/templates/select/form-dark.svg +1 -0
- package/docs/design/templates/select/form.svg +1 -0
- package/docs/design/templates/select/icons-dark.svg +1 -0
- package/docs/design/templates/select/icons.svg +1 -0
- package/docs/design/templates/select-dark.svg +1 -0
- package/docs/design/templates/select.svg +1 -0
- package/docs/design/templates/slider/compact-dark.svg +1 -0
- package/docs/design/templates/slider/compact.svg +1 -0
- package/docs/design/templates/slider/readout-dark.svg +1 -0
- package/docs/design/templates/slider/readout.svg +1 -0
- package/docs/design/templates/slider/ticks-dark.svg +1 -0
- package/docs/design/templates/slider/ticks.svg +1 -0
- package/docs/design/templates/slider-dark.svg +1 -0
- package/docs/design/templates/slider.svg +1 -0
- package/docs/design/templates/switch/compact-dark.svg +1 -0
- package/docs/design/templates/switch/compact.svg +1 -0
- package/docs/design/templates/switch/states-dark.svg +1 -0
- package/docs/design/templates/switch/states.svg +1 -0
- package/docs/design/templates/switch-dark.svg +1 -0
- package/docs/design/templates/switch.svg +1 -0
- package/docs/design/templates/tag-field/error-dark.svg +1 -0
- package/docs/design/templates/tag-field/error.svg +1 -0
- package/docs/design/templates/tag-field/tags-dark.svg +1 -0
- package/docs/design/templates/tag-field/tags.svg +1 -0
- package/docs/design/templates/tag-field-dark.svg +1 -0
- package/docs/design/templates/tag-field.svg +1 -0
- package/docs/design/templates/text-field/compact-dark.svg +1 -0
- package/docs/design/templates/text-field/compact.svg +1 -0
- package/docs/design/templates/text-field/error-dark.svg +1 -0
- package/docs/design/templates/text-field/error.svg +1 -0
- package/docs/design/templates/text-field/labeled-dark.svg +1 -0
- package/docs/design/templates/text-field/labeled.svg +1 -0
- package/docs/design/templates/text-field/multiline-dark.svg +1 -0
- package/docs/design/templates/text-field/multiline.svg +1 -0
- package/docs/design/templates/text-field/search-dark.svg +1 -0
- package/docs/design/templates/text-field/search.svg +1 -0
- package/docs/design/templates/text-field-dark.svg +1 -0
- package/docs/design/templates/text-field.svg +1 -0
- package/docs/design/templates/toolbar/title-and-actions-dark.svg +1 -1
- package/docs/design/templates/toolbar/title-and-actions.svg +1 -1
- package/docs/design/templates/toolbar/width-visibility-320-dark.svg +1 -1
- package/docs/design/templates/toolbar/width-visibility-320.svg +1 -1
- package/docs/design/templates/toolbar/width-visibility-600-dark.svg +1 -1
- package/docs/design/templates/toolbar/width-visibility-600.svg +1 -1
- package/docs/design/templates/toolbar-dark.svg +1 -1
- package/docs/design/templates/toolbar.svg +1 -1
- package/docs/design/templates/value-table/details-dark.svg +1 -1
- package/docs/design/templates/value-table/details.svg +1 -1
- package/docs/design/templates/value-table-dark.svg +1 -1
- package/docs/design/templates/value-table.svg +1 -1
- package/docs/design/templates.md +19 -6
- package/docs/design-philosophy.md +6 -6
- package/docs/disclosure.md +63 -0
- package/docs/examples/component-catalog-extension.json +2 -2
- package/docs/layout.md +16 -7
- package/docs/list-detail-dialog.md +96 -0
- package/docs/manual-test-plan.md +1 -1
- package/docs/{composer.md → message-composer.md} +41 -28
- package/docs/overlay-toast.md +62 -0
- package/docs/overlay-tooltip.md +53 -0
- package/docs/progress.md +62 -0
- package/docs/recipes.md +15 -21
- package/docs/slider.md +64 -0
- package/docs/surface-scaffold.md +155 -88
- package/docs/tag-field.md +66 -0
- package/docs/type-contracts.md +8 -8
- package/docs/ui-analyzer.md +1 -1
- package/docs/ui-doctor.md +11 -6
- package/docs/ux-demo.md +6 -6
- package/docs/webawesome-migration.md +80 -0
- package/docs/webawesome-theme.md +57 -35
- package/docs/workbench-dialog.md +85 -0
- package/docs/workbench.md +10 -6
- package/docs/writing.md +10 -8
- package/doctor/copy-capitalization-checks.mjs +18 -9
- package/llms.txt +127 -57
- package/package.json +156 -39
- package/ux-demo/recipes/composer-form.tsx +18 -19
- package/ux-demo/recipes/list-detail-dialog.tsx +55 -162
- package/ux-demo/recipes/mount-recipe.ts +7 -6
- package/ux-demo/recipes/types.ts +1 -0
- package/ai/components/icon-button.md +0 -82
- package/ai/components/icon-toggle-button.md +0 -80
- package/dist/app-tab.js +0 -6
- package/dist/app-tab.js.map +0 -1
- package/dist/browser/app-tab.js +0 -4
- package/dist/browser/composer.js +0 -4
- package/dist/browser/icon-toggle-button.js +0 -4
- package/dist/browser/token-search-field.js +0 -4
- package/dist/chunk-2MSPNRWJ.js.map +0 -1
- package/dist/chunk-7IUEBNCO.js.map +0 -1
- package/dist/chunk-AV7CPAPT.js +0 -82
- package/dist/chunk-AV7CPAPT.js.map +0 -1
- package/dist/chunk-BYFTHA4I.js.map +0 -1
- package/dist/chunk-CA7LNX3J.js +0 -44
- package/dist/chunk-CA7LNX3J.js.map +0 -1
- package/dist/chunk-CR5U5FV6.js.map +0 -1
- package/dist/chunk-ELCMSQNJ.js.map +0 -1
- package/dist/chunk-ETCWQLJV.js.map +0 -1
- package/dist/chunk-FDZNYD4C.js.map +0 -1
- package/dist/chunk-FR76ZJQC.js +0 -90
- package/dist/chunk-FR76ZJQC.js.map +0 -1
- package/dist/chunk-HQZYKJ56.js.map +0 -1
- package/dist/chunk-HZPHCSCS.js.map +0 -1
- package/dist/chunk-JOR5LGYE.js.map +0 -1
- package/dist/chunk-K4AT3V3J.js.map +0 -1
- package/dist/chunk-LL45C7BB.js.map +0 -1
- package/dist/chunk-LOSRXZAH.js.map +0 -1
- package/dist/chunk-LPHU44S3.js.map +0 -1
- package/dist/chunk-M5KZ26VV.js.map +0 -1
- package/dist/chunk-MXNIVEVL.js.map +0 -1
- package/dist/chunk-NS762OVM.js +0 -222
- package/dist/chunk-NS762OVM.js.map +0 -1
- package/dist/chunk-QTSMHH5J.js.map +0 -1
- package/dist/chunk-T5BJBMW7.js.map +0 -1
- package/dist/chunk-TDMHA7C3.js.map +0 -1
- package/dist/chunk-TGLUDQP2.js.map +0 -1
- package/dist/chunk-U6QYTMDB.js.map +0 -1
- package/dist/chunk-VFYO3UGZ.js +0 -45
- package/dist/chunk-VFYO3UGZ.js.map +0 -1
- package/dist/chunk-W4IK7AWD.js.map +0 -1
- package/dist/chunk-YBWQR2OK.js.map +0 -1
- package/dist/chunk-ZJC5ND3M.js.map +0 -1
- package/dist/composer.js +0 -5
- package/dist/composer.js.map +0 -1
- package/dist/icon-button.d.ts +0 -46
- package/dist/icon-button.js +0 -6
- package/dist/icon-button.js.map +0 -1
- package/dist/icon-toggle-button.d.ts +0 -42
- package/dist/icon-toggle-button.js +0 -6
- package/dist/icon-toggle-button.js.map +0 -1
- package/dist/styles/components/actions/icon-button/icon-button.css +0 -22
- package/dist/styles/components/actions/icon-toggle-button/icon-toggle-button.css +0 -83
- package/dist/styles/icon-button.css +0 -22
- package/dist/styles/icon-toggle-button.css +0 -83
- package/dist/token-search-field.d.ts +0 -3
- package/dist/token-search-field.js +0 -5
- package/dist/token-search-field.js.map +0 -1
- package/dist/token-search-model.d.ts +0 -3
- package/dist/token-search-model.js +0 -3
- package/dist/token-search-model.js.map +0 -1
- package/dist/wire-composers.js +0 -3
- package/dist/wire-token-search-fields.js +0 -6
- package/docs/design/templates/composer/chat-dark.svg +0 -1
- package/docs/design/templates/composer/chat.svg +0 -1
- package/docs/design/templates/composer-dark.svg +0 -1
- package/docs/design/templates/composer.svg +0 -1
- /package/docs/design/templates/{token-search-field → search-field}/empty-dark.svg +0 -0
- /package/docs/design/templates/{token-search-field → search-field}/empty.svg +0 -0
- /package/docs/design/templates/{token-search-field → search-field}/tokens-dark.svg +0 -0
- /package/docs/design/templates/{token-search-field → search-field}/tokens.svg +0 -0
- /package/docs/design/templates/{token-search-field-dark.svg → search-field-dark.svg} +0 -0
- /package/docs/design/templates/{token-search-field.svg → search-field.svg} +0 -0
|
@@ -5,7 +5,7 @@ Use the shipped [`component-catalog.json`](../ai/component-catalog.json) when a
|
|
|
5
5
|
tool needs exhaustive structured facts; this page remains the concise human
|
|
6
6
|
decision procedure.
|
|
7
7
|
|
|
8
|
-
1. Search the [Kerf UX catalog](./ux-demo.md)
|
|
8
|
+
1. Search the [Kerf UX catalog](./ux-demo.md). Prefer a Kerf UI component, then a native HTML element, using each naturally for what it is good at. When neither fits and the need recurs, file a component gap. Web Awesome is an optional integration: an application that has adopted it (see [Web Awesome integration](#web-awesome-integration)) may also use its remaining supported elements, but never one a Kerf component replaces.
|
|
9
9
|
2. Reuse a primitive when its purpose, anatomy, state, and interaction match.
|
|
10
10
|
3. Compose primitives for recurring layout through public props and tokens. Do not select one component from another component's stylesheet.
|
|
11
11
|
4. Add a thin application adapter for product copy, domain mapping, actions, routing, persistence, permissions, and transport.
|
|
@@ -26,7 +26,7 @@ mockup or another application:
|
|
|
26
26
|
silhouette. For example, use `ContentItem` for an owned content surface,
|
|
27
27
|
`List` for vertical rhythm, `Grid` for equal responsive tracks,
|
|
28
28
|
`Toolbar`/`ToolbarText` for a heading with actions, and `PopupMenu` for a
|
|
29
|
-
command menu. `
|
|
29
|
+
command menu. `SearchField` is for text plus filter chips; an ordinary
|
|
30
30
|
search input does not gain tokens just to use that component.
|
|
31
31
|
2. **Reuse, compose, then extend.** If a component already owns the job,
|
|
32
32
|
configure it. If several primitives form the job, compose them and keep
|
|
@@ -221,63 +221,76 @@ themed Web Awesome form-control label. Put it in `ListInsetControl sides="trl"`
|
|
|
221
221
|
beside a `ContentItem` value, and connect its id to the preview group's
|
|
222
222
|
`aria-labelledby`; see [Field labels](./layout.md#text).
|
|
223
223
|
|
|
224
|
-
| Interface need
|
|
225
|
-
|
|
|
226
|
-
| Icon — `LucideIcon`
|
|
227
|
-
| Compact metadata — `Badge`
|
|
228
|
-
| Disclosure indicator — `DisclosureArrow`
|
|
229
|
-
| Application toolbar or heading — `Toolbar`
|
|
230
|
-
| Toolbar control cluster — `ToolbarControlGroup`, `ToolbarActionLink`
|
|
231
|
-
| Floating controls over content — `FloatingToolbar`
|
|
232
|
-
| Toolbar identity text — `ToolbarText`
|
|
233
|
-
| Semantic block or inline text — `Text`
|
|
234
|
-
| Vertical stack — `List`
|
|
235
|
-
| Equal-width columns — `Grid`
|
|
236
|
-
| Board of columns — `ColumnTrack`
|
|
237
|
-
| Two contents swapped in place — `ContentSwap`
|
|
238
|
-
| Navigation row — `ListItem`
|
|
239
|
-
| Navigation row with trailing action — `ListActionRow`
|
|
240
|
-
| Navigation section heading — `ListHeader`
|
|
241
|
-
| Inset self-bordered control — `ListInsetControl`
|
|
242
|
-
| Inset bare text — `ListInsetText`
|
|
243
|
-
| Self-contained content child — `ContentItem`
|
|
244
|
-
| Application column — `Pane`
|
|
245
|
-
| Scroll dividers — `wireScrollDividers`
|
|
246
|
-
| Keyboard focus scroll in scrollable Lists — `wireListFocusScroll`
|
|
247
|
-
| One-pane navigation — `NavStack`
|
|
248
|
-
| Responsive list-detail — `SplitView`
|
|
249
|
-
| Compact top-level destinations — `TabNavigator`
|
|
250
|
-
| Desktop multi-panel workspace — `Workbench`
|
|
251
|
-
| Standalone rail or drawer — `CollapsiblePanel`
|
|
252
|
-
| Lowered content surface — `SunkenPanel`
|
|
253
|
-
| Scrolling view's hero image — `BackdropImage`
|
|
254
|
-
| Menu composition
|
|
255
|
-
| Resizable application pane — `ResizableRegion`, `clampRegionSize`, `resizeRegionFromPointer`
|
|
256
|
-
| One application tab — `
|
|
257
|
-
| Application tab strip — `TabBar`, `wireTabBars`, `reorderTabs`
|
|
258
|
-
| Panel, dialog, or page heading — `Toolbar` + `ToolbarText`
|
|
259
|
-
|
|
|
260
|
-
|
|
|
261
|
-
|
|
|
262
|
-
|
|
|
263
|
-
|
|
|
264
|
-
|
|
|
265
|
-
|
|
|
266
|
-
|
|
|
267
|
-
|
|
|
268
|
-
|
|
|
269
|
-
|
|
|
270
|
-
|
|
|
271
|
-
| Value
|
|
272
|
-
|
|
|
273
|
-
|
|
|
274
|
-
|
|
|
275
|
-
|
|
|
276
|
-
|
|
|
277
|
-
|
|
|
278
|
-
|
|
|
279
|
-
|
|
|
280
|
-
|
|
|
224
|
+
| Interface need | Use when | Do not use when; nearest alternative | Required wiring | Application owns | Import | Recipe |
|
|
225
|
+
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
|
|
226
|
+
| Icon — `LucideIcon` | A decorative or explicitly labeled Lucide-compatible icon belongs in app UI. | Do not use an icon as the only name of an unfamiliar action; add visible or accessible text. Prefer it over Web Awesome `wa-icon`. | None. | Icon choice and meaningful label. | `@kerfjs/ui/lucide-icon` | [Accessibility](./accessibility.md#shared-rules) |
|
|
227
|
+
| Compact metadata — `Badge` | A short status, count, category, or metadata label needs self-owned visual treatment configured by semantic props. | Do not use it as a button, link, or removable chip. Do not restyle consuming-component descendants to create a badge. | Choose `tone`, `appearance`, `shape`, and `size`; supply `label` for abbreviated content or `ariaHidden` when a surrounding component already owns the same accessible text. For new content without a count use the text-free `size="dot"`, which requires `label` or `ariaHidden`. Set `maxWidth` to truncate long app-supplied text with an ellipsis and a hover `title`. | Metadata text, semantic tone mapping, and abbreviated-content labeling. | `@kerfjs/ui/badge` | [Component ownership](./component-contract.md#ownership-boundaries) |
|
|
228
|
+
| Disclosure indicator — `DisclosureArrow` | A control needs one animated 18px root-scaled visual for open and closed state, including configurable directions or a replacement icon. | Do not use it as the interactive control or accessible name; place it inside the button or control that exposes expanded state. | Pass the controlled `open` state, render it inside the owning control, author replacement icon content facing right before transforms, and override `--kui-disclosure-arrow-size` only when another visual size is required. Direction changes use the shortest rotation path, with counterclockwise chosen for a 180-degree closed-to-open tie. | Open state, interaction, accessible name, size override, replacement glyph, direction choices, and shortest-path rotation. | `@kerfjs/ui/disclosure-arrow` | [Component ownership](./component-contract.md#ownership-boundaries) |
|
|
229
|
+
| Application toolbar or heading — `Toolbar` | Leading identity, optional centered content, and trailing controls form one horizontal app bar or a page/panel/dialog heading. | Do not add bespoke heading geometry or a private wrapper; use the same zone contract everywhere. | Put identity/title text directly in a zone as `ToolbarText`; group controls and icon tiles in `ToolbarControlGroup`. | Actions, command availability, responsive relocation, state, and supporting copy below a heading. | `@kerfjs/ui/toolbar` | [Toolbar composition](../README.md#component-subpaths) |
|
|
230
|
+
| Toolbar control cluster — `ToolbarControlGroup`, `ToolbarActionLink` | Related toolbar buttons, semantic links, compact/tight controls, avatar actions, or a dropdown trigger/menu surface need one configured chrome contract. | Do not use it merely to align unrelated controls. Do not restyle anchors or dropdown parts in application CSS; use `ToolbarActionLink`, `overflow`, and `menuInset`. Web Awesome `wa-button-group` is only for an exceptional grouped-action contract. | Delegate child actions; use `ToolbarActionLink` for native navigation, `overflow="scroll"` for bounded action rows, and `menuInset` for dropdown surface padding. Use `avatarImage` instead of inserting an `img`; use `SegmentedControl` for an exclusive choice. | Actions, destinations, pressed/expanded state, content, and policy. | `@kerfjs/ui/toolbar-control-group` | [Component ownership](./component-contract.md#ownership-boundaries) |
|
|
231
|
+
| Floating controls over content — `FloatingToolbar` | A small cluster of controls (e.g. a drawer restore) must float over scrolling content — distinct and forced-dark — inside a positioned container. | Do not use it for a primary page or panel toolbar (use `Toolbar`), or for anything that must sit above dialogs/overlays — it is not top-layer. | Compose `ToolbarControlGroup`s and delegate their actions; the app owns visibility and position. | Controls, visibility, and position. | `@kerfjs/ui/floating-toolbar` | [Component subpaths](../README.md#component-subpaths) |
|
|
232
|
+
| Toolbar identity text — `ToolbarText` | A toolbar needs extra-large (page/panel title), large, default, or compact textual identity. | Plain text is not a heading by default; when a title needs heading semantics pass `headingLevel`. Sizes below `xlarge` are intentionally quiet identity text in default tone — do not use them as a normal-color subsection title; use `Text` with an `h2`–`h6` variant, or `ListHeader` for a list section. | Optional `headingLevel` for `role="heading"` + `aria-level`. Defaults to one line, ellipsized when it does not fit; `wrap` flows onto multiple lines, `ellipsis` toggles the trailing …, and `maxLines` caps a wrap. | Text, heading level, overflow behavior, and responsive priority. | `@kerfjs/ui/toolbar-text` | [Toolbar composition](../README.md#component-subpaths) |
|
|
233
|
+
| Semantic block or inline text — `Text` | Ordinary application copy needs native `h1`–`h6` or `p` semantics plus standard geometry, or inline secondary copy needs a native `span` without box geometry. | Do not choose heading levels for appearance alone or recreate muted, error, small, or code utility classes. Use `ToolbarText` for toolbar identity/title content and `ListInsetText` when list-aligned prose needs full margin/border/padding geometry. | Omit `variant` for the default `p`, choose `h1`–`h6` from the document outline, or choose `span` inside a row, label, or table cell. Independently compose `tone="quiet | danger"`, `size="compact"`, and `font="monospace"`; ordinary native global, `data-_`, and `aria-_` attributes pass through. | Copy, localization, semantic variant, presentation roles, and document heading hierarchy. | `@kerfjs/ui/text` | [Text](./layout.md#text) |
|
|
234
|
+
| Vertical stack — `List` | Rows, sections, or arbitrary components need a consistent vertical stretch layout, optional standard/custom gap, flex growth, one vertical scroll owner, or edge dividers. | It is layout-only and does not provide `ul`/`ol` semantics. Do not nest scroll owners or use it when a horizontal layout is required. | Choose `gap`, `flex`, `scrollable`, and canonical `dividerSides` (`t`, `r`, `b`, `l` combinations in that order); bound the block size when scrolling. | Child semantics/content, containing height, and which optional layout behaviors apply. | `@kerfjs/ui/list` | [Pane geometry](../README.md#pane-and-content-geometry) |
|
|
235
|
+
| Equal-width columns — `Grid` | Equal-width sibling columns need a fixed count or should collapse as their container narrows, while preserving equal tracks despite intrinsic child widths. | Do not use it for intrinsic, asymmetric, spanning, or masonry tracks; use application-owned CSS grid. Do not use it for a user-operable separator; use `ResizableRegion`. | Choose fixed `columns` or typed `minColumnWidth`, plus typed `gap`, optional `flex`, and physical-side `textInsets` / `controlInsets` when the track group needs a standard text or control inset; text wins on overlap. | Child semantics/content, outer width, fixed count or minimum width, and typed gap/flex/inset choices. | `@kerfjs/ui/grid` | [Grid](./layout.md#grid) |
|
|
236
|
+
| Board of columns — `ColumnTrack` | A board shows parallel columns (kanban lanes) that must keep a readable width and scroll sideways, or page one at a time on a phone. | Do not use it for a wrapping responsive grid; use `Grid`. Do not use it for two resizable panes; use `SplitView`. Do not re-track a `Grid` from app CSS. | Pass columns as children (each owns its inset and vertical scroll); set `minColumnWidth` (default 250px) or `layout="paged"` with an optional `peek` for phones. Name it with `rootAttributes`. | Columns, their content, the layout choice per device, and drag and drop. | `@kerfjs/ui/column-track` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
237
|
+
| Two contents swapped in place — `ContentSwap` | A region swaps between two contents in place, such as a dialog's two steps or a footer's changing actions, and the change should read as motion. | Do not use it for full views with toolbars; use `NavStack`. Do not hand-roll stacked cells, inert handling, or push keyframes. | Set `active` to `a` or `b`, `transition` (`push`, `crossfade`, `none`) and the push `direction`; pass `label` to name it and `slot`/`fill` for a dialog label or footer. | The active side, the direction, both contents, and the region name. | `@kerfjs/ui/content-swap` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
238
|
+
| Navigation row — `ListItem` | A pane or navigation area needs a selectable, disabled, dormant-trailing, or multiline action row. | Do not put a control in `trailing`; use `ListActionRow` when the trailing region must be independently interactive. Use an `<a>` for navigation that must retain link behavior, a native `<button>` for an ordinary action, or implement the complete ARIA menu widget. | Delegate its `data-action`; compose inside a `.kui-content` section. Put domain event/drop metadata in `rootAttributes` rather than adding wrapper markup. The rounded root clips overflowing descendants; set `multiline` when the primary label should wrap. | Routing, selection, permissions, copy, action handling, and domain `data-*` values. | `@kerfjs/ui/list-item` | [Pane geometry](../README.md#pane-and-content-geometry) |
|
|
239
|
+
| Navigation row with trailing action — `ListActionRow` | A full-width row needs a selectable primary action and an independently focusable trailing action. | Use `ListItem` when trailing content is dormant metadata. Do not put controls inside the row's `label`, `icon`, or `trailingActionIcon` SafeHtml slots. Do not use `TabBarItem` outside tablist semantics or `ToolbarControlGroup` outside a toolbar. | Delegate both action strings; update controlled selection and any popover/context-menu state in the app. | Routing, selection, both action policies, domain metadata, and popover/context-menu behavior. | `@kerfjs/ui/list-action-row` | [Accessibility](./accessibility.md#listactionrow) |
|
|
240
|
+
| Navigation section heading — `ListHeader` | A menu section needs a full-width label, semantic count, non-count badge, logical-end action, or real disclosure state. | Do not concatenate counts into `label` or put numeric content in `badge`; use `count` with the localized full phrase in `countLabel`. Do not add a disclosure arrow to navigation that reveals nothing. Keep its 44px hit target; do not resize its 36px square. Do not use it as a page, panel, or dialog title; use a heading `Toolbar`. | Delegate its optional action; the app controls expanded state and revealed content. Toggle mode supplies `DisclosureArrow` unless `actionIcon` replaces it. Use `triggerAttributes` only for domain `data-*` or a native popover relationship. | Section organization, valid count and localized count label, disclosure state and content, non-count badge content, popover target behavior, and policy. | `@kerfjs/ui/list-header` | [Pane geometry](../README.md#pane-and-content-geometry) |
|
|
241
|
+
| Inset self-bordered control — `ListInsetControl` | A control that owns its own border and padding but no outer margin (a search input, a `SegmentedControl`) must line up inside a `.kui-content` list with the standard 8px inline margins and stretch to fill the row. | Do not wrap a `.kui-content-item` or a `ListItem`/`ListHeader` that already owns its inline margin — that double-insets it. Do not add ad-hoc `margin`/`padding` around a bare control to align it; use this instead. | Place the self-bordered control(s) as children; they stretch to fill. It applies only the inline margin, flex stretch, and 8px gap — the child owns its own border and padding. | The control(s), their state, and action wiring. | `@kerfjs/ui/list-inset-control` | [Pane geometry](../README.md#component-subpaths) |
|
|
242
|
+
| Inset bare text — `ListInsetText` | A plain string or inline content with no margin, border, or padding of its own must sit in a `.kui-content` list with its text edge aligned to the bordered items around it. | Do not use it to wrap a component that already owns content-item geometry (`ListItem`, `StateBanner`, a `.kui-content-item`) — that double-insets it. Do not hand-roll the 8px margin / 1px border / 8px padding. | Pass the text or inline `SafeHtml` as children; it supplies the 8px inline margin, 1px transparent border, and 8px padding so the text edge lands at the standard 17px inset. Pass `sides="rl"` to keep that horizontal inset but drop the vertical margin, border, and padding for tight text layout. | The text, copy, and localization. | `@kerfjs/ui/list-inset-text` | [Pane geometry](../README.md#component-subpaths) |
|
|
243
|
+
| Self-contained content child — `ContentItem` | An ordinary surface-like child of a `Pane` or `.kui-content` stack needs the shared 8px margin / 1px border / 8px padding geometry; pass `frame="framed"` only when it marks a real distinction, `appearance="surface"` or a semantic appearance for coordinated surface colors, and `shape="pill"` for the 22px radius. | Do not wrap a component that already owns content-item geometry (`ListItem`, `ListHeader`, `StateBanner`, `Toolbar`, `ValueTable`) or pad around it — that double-insets. Do not frame an item only to make it look contained. Use `SunkenPanel` for a lowered inset stack and `ListInsetText` for bare text that only needs to align. | Pass the item content as children; choose `appearance` (`transparent` default, `surface`, or a semantic status), `frame`, and `shape` instead of writing CSS. Put safe `data-*` metadata in `rootAttributes`; `ariaLabel` names a distinct region and `focusTarget` makes it a programmatic focus target. | The content, surface or status appearance, and whether it marks a distinction worth a visible frame. | `@kerfjs/ui/content-item` | [Content items](./layout.md#content-items) |
|
|
244
|
+
| Application column — `Pane` | A sidebar, main area, inspector, or dialog needs shared vertical header/content/footer organization, one scroll owner, and optional edge separators. | Do not pad the pane shell, wrap child-owned geometry in competing insets, invent unrelated centered measures, or leave an icon-only rail for a hidden pane. | Import `Pane`, use `children` for its homogeneous primary content and the named `SafeHtml` prop slots `header`/`footer` for optional fixed chrome, then opt into only the needed logical-edge separators; add `ContentItem` children as needed. On compact devices set `compactChrome` (`scroll` or `overlay`) through the container's `pane` configuration, and call `wirePaneChrome(root, { header, footer })` from `@kerfjs/ui/wire-pane-chrome` so open overlay chrome closes on Escape or an outside press. A visible pane owns collapse in its toolbar; move a hidden inline-start pane's restore control to the main toolbar leading edge and an inline-end pane's restore control to its trailing edge. | Layout hierarchy, reading width, responsive relocation, pane visibility state, slot semantics, labels, and separator placement. | `@kerfjs/ui/pane` | [Pane anatomy](./layout.md#anatomy) |
|
|
245
|
+
| Scroll dividers — `wireScrollDividers` | Pinned chrome (a `Pane` header or footer, a `NavStack` top chrome or bottom toolbar, a `TabNavigator` bar, the sides of a `TabBar` strip, or app-owned chrome around a scroller) needs a divider only while content is scrolled away beneath it. | Do not keep a static toolbar divider to fake it or write a border onto another component; each component draws its own line from the wiring's state. | Call `wireScrollDividers` once at the app root and retain the disposer; it covers every `Pane`, `NavStack`, `TabNavigator`, and `TabBar` below it. Name app-owned arrangements in `targets` by id; a `Toolbar` or `List` named as chrome draws its facing side. Configure a pane with `chromeDividers` (`scroll` default, `always`, `none`). | Which panes follow the scroll, app-owned targets, and the disposer. | `@kerfjs/ui/wire-scroll-dividers` | [Scroll dividers](./layout.md#scroll-dividers) |
|
|
246
|
+
| Keyboard focus scroll in scrollable Lists — `wireListFocusScroll` | Rows of a `scrollable` List are reached by keyboard (Tab, or the app's own arrow-key focus moves) and must come fully into view, focus ring included, in Firefox and Safari too: their `focus()` leaves a partly hidden row clipped. | Do not call `scrollIntoView` from app focus handlers or style the List; do not wire it for pointer-only lists. | Call `wireListFocusScroll(root)` once at the app root and retain the disposer. On keyboard (`:focus-visible`) focus inside a `scrollable` List it scrolls the focused element into view only when its ring crosses the clip; pointer focus is left alone. | The disposer. | `@kerfjs/ui/wire-list-focus-scroll` | [Framed result pickers](./layout.md#framed-result-pickers) |
|
|
247
|
+
| One-pane navigation — `NavStack` | A compact flow pushes into details while keeping earlier views mounted, or a single-pane screen needs the same stable layout contract. | Do not use it when list and detail should remain visible together; use `SplitView`. Do not use it alone for co-equal top-level destinations; use one stack per `TabNavigator` tab. | Keep the ordered view array controlled, put view-specific bottom chrome on each view (or use the component fallback), import its CSS explicitly, and call `wireNavStack` for back delegation, content-slide/chrome-cross-fade transitions, and focus move/restore. Mark a preferred initial target with `data-nav-focus` when DOM order is insufficient. | View keys/content/titles, push and pop actions, preferred initial focus targets, and per-view or persistent bottom toolbar content. | `@kerfjs/ui/nav-stack` | [App-layout decision matrix](./app-layouts.md#decision-matrix) |
|
|
248
|
+
| Responsive list-detail — `SplitView` | A primary list and related detail belong together on roomy devices but become a one-pane drill-down on compact devices. | Do not use it for a single linear flow or a multi-panel editor shell. | Provide controlled selection/detail state and device class; opt into resize wiring only when the separator is user adjustable. | Selection, detail content, compact back action, device policy, and optional persisted width. | `@kerfjs/ui/split-view` | [App-layout decision matrix](./app-layouts.md#decision-matrix) |
|
|
249
|
+
| Compact top-level destinations — `TabNavigator` | A handset or portrait-tablet app has two to five co-equal destinations whose scenes and nested navigation must remain mounted across switches. | Do not use it for document tabs, reorderable work items, or a desktop navigation rail. | Keep the active id controlled, import its CSS explicitly, and call `wireTabNavigator`; commonly place one `NavStack` in each tab scene. | Destination definitions, active id, routing, persistence, and roomy-device replacement. | `@kerfjs/ui/tab-navigator` | [App-layout decision matrix](./app-layouts.md#decision-matrix) |
|
|
250
|
+
| Desktop multi-panel workspace — `Workbench` | A desktop-class tool needs a central work area plus independently collapsible navigator, inspector, or console regions. | Do not shrink the full shell onto compact devices or use it for one standalone panel. | Render only the required rails/drawer, keep collapse state controlled, and replace peripheral regions with stacks or overlays below desktop sizes. Opt a panel into drag/keyboard resizing with `resizable` and call `wireWorkbench` with its size signal. | Panel presence/content, collapsed states, sizes, persistence, responsive replacement, and controls. | `@kerfjs/ui/workbench` | [Workbench](./workbench.md) |
|
|
251
|
+
| Standalone rail or drawer — `CollapsiblePanel` | One left/right rail or bottom drawer needs controlled collapse without adopting the complete `Workbench` shell. | Do not use it for several coordinated workspace panels or retain an empty icon-only rail while collapsed. | Pair it with `CollapsiblePanelToggle`; call `wireSidebar` for focus transfer, Escape/backdrop dismissal, compact overlay trapping, and persistence integration. | Panel content/size, collapsed state, toggle placement, persistence, and compact policy. | `@kerfjs/ui/collapsible-panel` | [App-layout decision matrix](./app-layouts.md#decision-matrix) |
|
|
252
|
+
| Lowered content surface — `SunkenPanel` | A main work area or nested content group needs one visually lowered surface with a compact inset and vertical stack. | Do not use it merely to add padding, as a replacement for `Pane` anatomy, or around children that already own the same outer surface. | Compose the application-owned content as children, choose the default `rounded` shape or `square` for a flush edge-to-edge area, and pass `ariaLabel` only when the surface is a distinct named region. Every sunken surface carries a fine grain texture, generated once per page by the first one that renders; call `ensureSunkenTexture` only when the page paints Web Awesome `appearance="sunken"` without any Kerf sunken component, and set `--kui-sunken-texture: none` at `:root` for a flat surface. | Region semantics, accessible name, shape, scroll ownership, child ordering, and content. | `@kerfjs/ui/sunken-panel` | [SunkenPanel](./sunken-panel.md) |
|
|
253
|
+
| Scrolling view's hero image — `BackdropImage` | A scrolling `Pane` or `NavStack` view opens with a mood or identity image (an artist, album, or place page) that should lag the scroll, dissolve into a color, and read as one surface with the content below. | Do not use it for inline content images, thumbnails, or avatars. Do not hand-roll scroll listeners, `background-attachment: fixed`, or mask gradients. Do not use it outside a vertical scroller; parallax needs one. | Place it first in the scrolling content. Pass `src`, `alt` (`""` for decoration), optional `srcset`/`sizes`, `fit`/`position` or a tiled `repeat`, a typed `height`, `parallax` (`none`, `subtle`, or a 0 to 1 factor), `blur` (`radius`, `blurredSrc`, `dim`) for a progressive blur, a typed `fadeTo` color that also paints below, a `scrim` for overlay text, `overlay` content over its block end, and `children` below. Kerf owns the scroll-driven, compositor-only parallax and its static fallbacks. | The image and alt text, the fade color, overlay content and its contrast, and the content below. | `@kerfjs/ui/backdrop-image` | [BackdropImage](./backdrop-image.md) |
|
|
254
|
+
| Menu composition | Navigation sections need full-size rows and the same content-item geometry as every other pane. | Do not add sidebar-specific wrapper padding, shrink targets to icon size, nest an interactive trailing control in `ListItem`, or use a chevron on a row that does not disclose content. Use ordinary links for a different navigation contract. | Compose `ListHeader`, `ListItem`, and `ListActionRow` in `.kui-content`; use `ListHeader` toggle mode with real controlled content, and use `ContentItem` for other surfaces plus a pane footer for toolbar actions. | Information architecture, disclosure content and state, responsive drawer/shell behavior, and token overrides. | `@kerfjs/ui/layout.css` | [Pane geometry](../README.md#pane-and-content-geometry) |
|
|
255
|
+
| Resizable application pane — `ResizableRegion`, `clampRegionSize`, `resizeRegionFromPointer` | A controlled split pane needs the Kerf separator, collapse state, pointer plus keyboard resizing, or a product-specific decorative grip. | Do not use it for static equal columns; use `Grid`. Use application CSS grid for static asymmetric or intrinsic tracks. Prefer it over Web Awesome `wa-split-panel` unless that component's distinct API is required. Keep `handleIcon` noninteractive. | Call `wireResizableRegions` from `@kerfjs/ui/wire-resizable-regions` once and retain its disposer. | Size signal, min/max policy, collapse policy, persistence, and optional decorative handle icon. | `@kerfjs/ui/resizable-region` | [ResizableRegion contract](./accessibility.md#resizableregion) |
|
|
256
|
+
| One application tab — `TabBarItem` | A controlled app tab needs selection, close, drag, leading/trailing anatomy, compact/segmented/icon-only presentation, label truncation, safe domain metadata, or a product-specific close glyph. | Do not render it alone or use it for a small settings choice; compose in `TabBar`, or use `SegmentedControl`. Keep `closeIcon` noninteractive. | Compose in `TabBar`; let `wireTabBars` manage interaction. Put only domain `data-*` values in `rootAttributes`; use typed appearance props instead of descendant CSS. | Tab identity, order, selection, close policy, content, domain metadata values, and outer placement. | `@kerfjs/ui/tab-bar-item` | [Tabs contract](./accessibility.md#tabs) |
|
|
257
|
+
| Application tab strip — `TabBar`, `wireTabBars`, `reorderTabs` | Tabs switch page regions and may overflow, close, reorder, fill a segmented inspector strip, sit beside a trailing action, or keep that adjacent action distinct from a far-edge end action. | Do not use it for a compact local view toggle; use `SegmentedControl`. Do not use it for a long choice list; use `Select`. Prefer it over Web Awesome `wa-tab-group`, `wa-tab`, and `wa-tab-panel` for Kerf app tabs. | Call `wireTabBars` once, retain the disposer, and apply `onReorder` synchronously; `reorderTabs` is the default array helper. Combine `trailingPlacement="adjacent"` with `end` for split actions; TabBar owns the shrinking/scrolling tab geometry and keeps both actions visible. Choose typed presentation/allocation props while the parent owns outer placement. | Ordered tabs, selection, panels, routing, closing, persistence, action content, and outer placement. | `@kerfjs/ui/tab-bar` plus `@kerfjs/ui/wire-tab-bars` | [Tabs contract](./accessibility.md#tabs) |
|
|
258
|
+
| Panel, dialog, or page heading — `Toolbar` + `ToolbarText` | A panel, dialog, or page needs an extra-large title, optional icon, grouped trailing actions, and optional supporting copy. | Do not add a private heading wrapper or bespoke layout. The toolbar supplies structure, not modal behavior; use `DialogSurface` or a `kerfjs/overlay` dialog for that behavior. In a narrow peripheral rail or drawer, where xlarge would truncate at the panel's minimum size, use the default `ToolbarText` size as pane identity. | Connect title/supporting-copy ids to the host, group controls, and delegate actions. **For a page or view title set `headingLevel` (usually `1`)** on `ToolbarText`; omit it for a dialog title referenced by `aria-labelledby`. | Open state, focus lifecycle, dismissal, controls, ids, copy, and heading level. | `@kerfjs/ui/toolbar` + `@kerfjs/ui/toolbar-text` | [Toolbar headings](./accessibility.md#toolbar-headings) |
|
|
259
|
+
| Modal dialog, dialog or popup geometry — `DialogSurface`, `openDialog`, `closeDialog`, `PopoverDialogSurface`, `PopupSurface` | A task must block the page in a modal dialog with standard sizes/presentations/body/footer insets, typed modal viewport bounds, a definite height, or a body one child fills; a dialog must stay non-modal and light-dismiss; or a raw dropdown menu needs list-compatible inset ownership. | Do not use these surfaces as generic layout. Do not toggle a `DialogSurface`'s `open` attribute (that opens it non-modally), avoid consumer `::part()` or descendant overrides, and do not stack a dialog body inset around list-owned child geometry. | Render `DialogSurface` with a `label` (or `labelledBy` plus a `heading`), the body as children, and its buttons as `footer`; open it with `openDialog()` and close it with `closeDialog()`, its close button, or a `data-dialog-close` element, and cancel `kui-request-close` to keep it open. Compose a dialog body as a `List` by default, use `bodyInset="none"` when its children own list geometry, and wrap bare prose in `ListInsetText`. Set `height` with `bodyLayout="fill"` when one `SplitView` or `Pane` should fill the body. For a non-modal, light-dismiss dialog render `PopoverDialogSurface` (native `popover="auto"`, opened by a `popoverTarget` control or `showPopover()`), never a hand-built popover with app chrome CSS; `presentation="embedded"` shows it in flow. Wrap a raw `wa-dropdown` in `PopupSurface` for its menu inset. | Open state, whether a close may proceed, dismissal policy, names, content, and outer placement. | `@kerfjs/ui/surface-scaffold` | [Surface scaffolds](./surface-scaffold.md) |
|
|
260
|
+
| Modal list-detail — `ListDetailDialog` | A modal task picks one record from a list and shows its detail beside it, with the dialog's title, actions, and close control belonging to the detail. | Do not use it for a single-pane dialog; use `DialogSurface`. Do not wrap a `SplitView` in a `DialogSurface` by hand for this layout: the surface header spans both columns and stops the divider below it. | Pass `list` (`title`, `toolbar`, `content`, `footer`, `width`) and `detail` (`title`, `description`, `actions`, `content`, `footer`); open it with `openDialog()`; pass `compact` from `deviceClass()` and `detailActive` for the compact drill-down, and pop on `nav-back`. | Open state, selection, the pushed detail, device policy, content, and record actions. | `@kerfjs/ui/list-detail-dialog` | [ListDetailDialog](./list-detail-dialog.md) |
|
|
261
|
+
| Modal workbench — `WorkbenchDialog` | A modal editing task needs a work area with side panels (layers, an inspector) whose rails overlay the work area on compact devices. |
|
|
262
|
+
| Show and hide content — `Disclosure` | Optional or advanced content should stay one press away under a summary (advanced settings, a build log), or several sections should open one at a time. | Do not use it to switch peer views (use `SegmentedControl` or `TabBar`) or for a collapsible rail (use `CollapsiblePanel`). Do not hand-build a details element with its own marker CSS. | Render `Disclosure` with a `title`, an optional `detail`, and content that draws no inset of its own; give Disclosures the same `name` for an accordion; pick `appearance` `plain`, `framed`, or `sunken`. The open state is native: close it from code with `element.open = false`, and listen for the captured `toggle` event through `toggleAction`. | Title, content, initial open state, group name, and toggle handling. | `@kerfjs/ui/disclosure` | [Disclosure](./disclosure.md) |
|
|
263
|
+
| Core overlay bottom sheet — `@kerfjs/ui/overlay-sheet.css`, `wireOverlaySheets` | A `kerfjs/overlay` `overlay()`, `confirm()`, `prompt()`, `form()`, or `choice()` opened with `presentation: 'bottom-sheet'` should look like a `DialogSurface` sheet, and optionally be resizable by the person. | Do not hand-style `.kerf-overlay` or build a grabber; prefer a `DialogSurface` `presentation="bottom-sheet"` when the dialog is a Kerf `DialogSurface` rather than a core overlay. | Import `@kerfjs/ui/overlay-sheet.css` once. Pass `exitClass: 'kui-overlay-sheet-exit'` for the slide out. For a resizable sheet, add the `kui-overlay-sheet-resizable` class (`className: 'kerf-overlay kui-overlay-sheet-resizable'`) and call `wireOverlaySheets()` once per container sheets open in (`document.body` by default). | Opening, results, content, and which sheets are resizable. | `@kerfjs/ui/overlay-sheet.css`, `@kerfjs/ui/wire-overlay-sheets` | [Core overlay bottom sheets](./surface-scaffold.md#core-dialogs-as-bottom-sheets) |
|
|
264
|
+
| Key/value facts — `ValueTable`, `ValueTableRow` | Read-only labels and values form a semantic definition list, optionally with a leading icon. | Do not use it for editable form fields or a row/column data grid; use native form or table semantics. | Compose typed `ValueTableRow` entries; pass `icon` when a 24px leading icon adds useful context. Set `labelWidth` for a minimum label column, `presentation="stacked"` to put each value under its label, or `stackBelow` (`compact` 512px, `narrow` 576px) to stack only while the table is that narrow; never override `--kui-value-table-row-columns` for these. | Values, formatting, icon meaning, and empty/loading policy. | `@kerfjs/ui/value-table` | [Component ownership](./component-contract.md#ownership-boundaries) |
|
|
265
|
+
| Framed rows of arbitrary content — `FramedList`, `FramedListRow` | Settings rows, account or source cards, or a shortcut list group several rows of copy and controls in one rounded frame with dividers between them. | Do not use it for read-only label/value facts; use `ValueTable`. Do not use it for selectable navigation rows or a bounded result picker; use `List` with `ListItem` (a picker adds `frame`, `scrollable`, and `maxHeight`). Do not pad or border rows from application CSS. | Compose any row content (a `Row` of copy, a keycap, icon-only `Button`s) in each `FramedListRow`; mark the row being edited `highlighted`. Name the list with `label` when no heading does. | Row content, controls, which row is highlighted, and the list's name. | `@kerfjs/ui/framed-list` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
266
|
+
| Selectable item summaries — `SummaryRow` | A list or board shows many items as dense, selectable summaries: an identifier and title, a timestamp, and a metadata line (tickets, tasks). | Do not use it for navigation rows; use `ListItem`. Do not use it for free-form selectable tiles; use `ContentItem`. Do not hand-roll row chrome. | Pass `title`, optional `leading`, `trailingMeta`, and `metadata`; choose `presentation` (`row` or `card`), `rail`, `selected`, `dimmed`, `listEdge`, and `titleLines`. Put rows in a labeled `role="listbox"` and own selection and arrow-key focus in the app. | The listbox, selection, keyboard movement, content, rail tone, and dimming. | `@kerfjs/ui/summary-row` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
267
|
+
| Color from a fixed palette — `ColorSwatches` | A setting takes one color from a small curated palette (a label, calendar, or command color), or no color. | Do not use it when any color is allowed, or for choices that are not colors (use `ChoiceChips` or `RadioGroup`). | Render `ColorSwatches` with `name`, a `label`, `swatches` (`{ value, label, color }`, `'transparent'` for no color), and `value`; read the choice on `change` through `action`. | The palette and color names, and the chosen value. | `@kerfjs/ui/color-swatches` | [ColorSwatches](./color-swatches.md) |
|
|
268
|
+
| Any color — `ColorPicker`, `wireColorPickers` | Any color is allowed and the person may need precision (a fill, stroke, or brand color), optionally with presets or saved samples. | Do not use it for a small curated palette (use `ColorSwatches`). | Render `ColorPicker` with `id`, `label`, `value`, and `mode`; call `wireColorPickers(root, { onChange })` once and re-render with the reported `value` and `mode`; add `presets`, `samples`, and `addSampleAction` as needed. | The value and model, presets and samples. | `@kerfjs/ui/color-picker`, `@kerfjs/ui/wire-color-pickers` | [ColorPicker](./color-picker.md) |
|
|
269
|
+
| A color in a form — `ColorField`, `wireColorFields` | A form or inspector row sets one color (a fill, border, or theme color) and opens a picker only while it is being changed. |
|
|
270
|
+
| List of short values — `TagField`, `wireTagFields` | A form collects several short values of one kind (labels, recipients, keywords), each submitted as its own value. | Do not use it for search filters (use `SearchField`) or to pick from a short known set (use `ChoiceChips`). | Render `TagField` with `id`, `label`, `tags`, and `name`; call `wireTagFields(root, { onChange })` once and re-render with the reported list; add `max` and a `normalize` for validation, and show `onReject`'s reason as `error`. | The tag list, validation, and error text. | `@kerfjs/ui/tag-field`, `@kerfjs/ui/wire-tag-fields` | [TagField](./tag-field.md) |
|
|
271
|
+
| Value on a range — `Slider`, `wireSliders` | A setting is a value in a known range where position matters more than the exact number (volume, zoom, opacity), optionally with named stops. | Do not use it when the exact number matters (use a numeric `TextField`), for on or off (use `Switch`), or for a few named options (use `SegmentedControl`). | Render `Slider` with `id`, `min`/`max`/`step`, `value`, and a `label`; add `showValue` and `unit` for a readout and `ticks` for stops; listen for `input`/`change` through `action`, and call `wireSliders(root)` once so the fill and readout follow a drag. | The value, range, labels, and re-rendering with the value. | `@kerfjs/ui/slider`, `@kerfjs/ui/wire-sliders` | [Slider](./slider.md) |
|
|
272
|
+
| Measurable progress — `ProgressBar`, `ProgressRing` | A task reports how far it has gone (an upload, a migration, a quota), or work of unknown size is under way. | Do not use them for a brief busy glyph inside a control (use `LoadingSpinner`) or for a scale reading that is not progress (use a native `<meter>`). | `ProgressBar` with `value`/`max`, a `label` (or `ariaLabel`), and `showValue` or `valueText`; omit `value` for the indeterminate sweep. `ProgressRing` (`small`, `medium`, `large`) where a bar does not fit, named by `label`. Pick a `tone` for a status. | Value, max, labels, tone, and size. | `@kerfjs/ui/progress-bar`, `@kerfjs/ui/progress-ring` | [Progress](./progress.md) |
|
|
273
|
+
| Indeterminate activity — `LoadingSpinner` | A Kerf surface needs compact, labeled or decorative indeterminate progress. | Do not use it for known progress; use a native `<progress>` element, or `wa-progress-bar` / `wa-progress-ring` in an application using the Web Awesome integration. Do not mix spinner systems within one surface. | Pass a label when the spinner conveys status; use size for a named icon step or positive pixel size. | Loading lifecycle and adjacent status copy. | `@kerfjs/ui/loading-spinner` | [Accessibility](./accessibility.md#shared-rules) |
|
|
274
|
+
| Loading placeholder — `Skeleton` + a component's `placeholder` prop | A value or a whole component is still loading and should hold its space as a subtle, unanimated block, keeping the layout stable — an inspector or detail view rendering its real chrome with per-record values absent. | Do not use it for known progress (use `LoadingSpinner`), do not animate it, and do not hand-rebuild a component's empty state — set `placeholder` on the component instead. Prefer it over `wa-skeleton`. | Set `placeholder` on a value-bearing component (`Select`, `ListHeader`, `ListItem`, `ValueTableRow`, `SegmentedControl`, `StateBanner`, `TabBarItem`, `ToolbarText`, `ListActionRow`) to render skeletons in its value slots with interactivity disabled; use the standalone `Skeleton` for a custom slot. | Loading lifecycle, which slots are unknown, and announcing the loading region. | `@kerfjs/ui/skeleton` | [Accessibility](./accessibility.md#shared-rules) |
|
|
275
|
+
| Command menu — `PopupMenu` | A short list of commands sits behind one trigger, such as a toolbar sort or More menu, optionally grouped under headings and dividers with item icons. | Do not use it to choose a persistent value; use `Select`. Do not hand-write `wa-dropdown`/`wa-dropdown-item` markup for an action menu. | Import `@kerfjs/ui/popup-menu/register` once. Place it in a `single` `ToolbarControlGroup` with `nestedDropdown` and a `menuInset`, or wrap it in `PopupSurface` outside a toolbar. Handle item `action`s by delegation. | Commands, enabled state, and reactions to opening or closing. | `@kerfjs/ui/popup-menu` | [Toolbar composition](#toolbar-composition) |
|
|
276
|
+
| Standalone action — `Button` | A dialog footer, a form, or content needs an action button with visible text: `tone="brand"` for the main action, `tone="danger"` for a destructive one, and `emphasis="secondary"` or `"plain"` for the quieter actions beside it. A link that looks like a button takes `href`. | Do not use it inside a `ToolbarControlGroup`; give the group plain `<button>`s. For an icon-only action give it an `icon` and `ariaLabel` and no label, and for an on/off toggle set `pressed`; a menu trigger is a `PopupMenu`. | Pass the label as children and delegate its `action`; a form button sets `type="submit"` or `"reset"` (the default `button` never submits) with `name`, `value`, and `form`. `loading` shows a spinner and `aria-busy`; the app decides what a press does meanwhile. `size="compact"` is 33px. In a `Toolbar` trailing zone or a `TabBar` action zone it keeps the control band. | The label, delegated action, and form ownership. | `@kerfjs/ui/button` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
277
|
+
| Icon-only action — `Button` with `icon` and `ariaLabel` | One action is clear from its icon alone and stands by itself or beside a form field, such as Browse next to a path input: give `Button` an `icon` and an `ariaLabel` and no label. |
|
|
278
|
+
| Standalone toggle — `Button` with `pressed` | An on/off control (show a panel or a conversation), icon-only or labeled, sits in content or a pane footer outside any Toolbar: `pressed` reports `aria-pressed` and draws the pressed look on top of the tone and emphasis; `shape="pill"` rounds it. |
|
|
279
|
+
| Primary action with options — `SplitButton` | A prominent primary action has a closely related set of options chosen from an attached trigger, such as Drive with a provider menu. | Do not use it for a plain action; use `Button`. Do not use it for a toolbar command menu; use `PopupMenu`. Do not assemble one from `wa-button-group`, whose hosts do not forward names or `aria-expanded`. | Pass the primary `label` and `action`, the options trigger's `optionsLabel`, `optionsAction`, and `optionsExpanded`; pick a loud `tone`, `fill` for full width, `busy` while work runs, and `disabled`/`optionsDisabled`. | Both actions, the options menu and its open state, the running state and tone switch, and copy. | `@kerfjs/ui/split-button` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
280
|
+
| Choosing or dropping files — `FilePickerTrigger`, `FileDropZone`, `wireFilePickers` | People attach or import files by browsing or by dropping them onto a target. | Do not style a native file input or its label from app CSS. Do not make the drop zone the only way in; it also opens the chooser. | Use `FilePickerTrigger` for a compact Add control and `FileDropZone` for a dashed target; set `accept`, `multiple`, `name`, and `pickerId`. Call `wireFilePickers(root, { onFiles })` once: it reports browsed and dropped files (drops filtered by `accept`, the same check `fileMatchesAccept` exposes) and marks the zone while dragging. | What happens to the files, the chosen-file list, copy, and accepted types. | `@kerfjs/ui/file-picker`, `@kerfjs/ui/wire-file-pickers` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
281
|
+
| Value selection — `Select` | A controlled form, toolbar, or compact navigation value comes from a moderate or long choice list, possibly grouped, icon-bearing, icon-only when closed, or truncating. Set `multiple` with an array `value` when the person may choose any number of them; add `selectedPresentation="icon-only"` and a fixed `triggerIcon` for a toolbar filter menu. | Do not use it for commands; use `PopupMenu`. Do not use it for a small visible choice set; use `SegmentedControl`. Prefer it over direct `wa-select`, `wa-option`, or value-like `wa-dropdown`/`wa-dropdown-item` composition. | Import `@kerfjs/ui/select/register` once for registration and current-request animation ownership; listen for standard input/change events. Do not add consumer popup timing or positioning repairs. Use typed presentation props rather than consumer `::part()` overrides; let the parent own placement. | Controlled value, validation, choices, domain mapping, and outer placement. | `@kerfjs/ui/select` | [Web Awesome integration](../README.md#web-awesome-theme) |
|
|
282
|
+
| Free text — `TextField`, `wireTextFields` | A form or dialog collects a line of free text (a name, an address, a title) or a longer note: `label` names it (or `ariaLabel` when nearby content already does), `hint` explains it, and `error` reports a validation problem. `multiline` with `rows` (and `maxRows` to grow) takes a longer note; `maxLength` with `showCount` shows the remaining budget; `icon` and `clearable` suit a filter field. | Do not use it when only existing values are allowed; use `Select`. Do not use it to pick among suggestions or create tags; use `Combobox`. Do not use it for search text with removable filter tokens (`SearchField`) or a message with a send action (`MessageComposer`). Prefer it over `wa-input` and `wa-textarea`. | Call `wireTextFields(root)` once when a field is `clearable` or `showCount`. Read the value from the native `input` or `change` event. | Value, validation and error copy, hint copy, and what a cleared field means. | `@kerfjs/ui/text-field` | [TextField contract](./accessibility.md#textfield) |
|
|
283
|
+
| On/off option — `Checkbox`, `wireCheckboxes`, `Switch` | A form or settings list has an independent yes/no option: `Checkbox` when a form submits it (with `indeterminate` for a parent of partly checked children), `Switch` when the setting applies the moment it changes. | Do not use a `Switch` for an option a form submits later, or a `Checkbox` for an immediate setting. Do not use either for one choice among several (`RadioGroup`). Prefer them over `wa-checkbox` and `wa-switch`. | Call `wireCheckboxes(root)` once when a `Checkbox` is `indeterminate`. Read `checked` from the native `change` event. | Checked and mixed state, validation copy, and what a change does. | `@kerfjs/ui/checkbox`, `@kerfjs/ui/switch` | [Checkbox, RadioGroup, and Switch contract](./accessibility.md#checkbox-radiogroup-and-switch) |
|
|
284
|
+
| One of a few labeled options — `RadioGroup` | A form asks for one of two to about six options that people should compare at a glance, each with a readable label and an optional hint. | Do not use it for a long list (`Select`), a view switch (`SegmentedControl`), or pill or color choices (`ChoiceChips`). Prefer it over `wa-radio-group`. | Read the value from the native `change` event and render `value`. | Value, choices and their copy, and validation. | `@kerfjs/ui/radio-group` | [Checkbox, RadioGroup, and Switch contract](./accessibility.md#checkbox-radiogroup-and-switch) |
|
|
285
|
+
| Pick or create a value by typing — `Combobox`, `wireComboboxes` | People type to find an existing value among many or create a new one (tags, labels, recipients). | Do not use it when only existing values are allowed; use `Select`. Do not use it for search text with removable filter tokens; use `SearchField`. Do not style a native input with a datalist. | Pass `id`, `label`, and `suggestions` (strings or `{ value, label }`), plus `placeholder`, `hint`, and `createLabel` (or `false` for suggestions only). Call `wireComboboxes(root, { onCommit })` once; it filters, moves the active option with the arrows, and reports `{ id, value, created, input }` on Enter, a comma, or a click. | Suggestions, committed values, normalization, and clearing the field. | `@kerfjs/ui/combobox`, `@kerfjs/ui/wire-comboboxes` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
286
|
+
| Small exclusive choice — `SegmentedControl` | A few visible choices switch a compact view or setting, with toolbar, rounded, or pill presentation. | Do not use it for tabpanel semantics; use `TabBar`. Do not use it for many choices; use `ChoiceChips` when they stay visible and wrap, or `Select` for a long list. Prefer it over `wa-button-group` when the controls select one value. | Delegate its action, read `data-segment-value`, update `value`, and rerender. | Controlled value, labels, action, and persistence. | `@kerfjs/ui/segmented-control` | [SegmentedControl contract](./accessibility.md#segmentedcontrol) |
|
|
287
|
+
| Wrapping visible choice — `ChoiceChips` | Several visible options, too many for one segmented track, must wrap onto more rows — a labeled color palette with swatches, a tag color, a category. Set `multiple` with an array `value` when any number may be on, such as label filters or annotation intents. | Do not use it for a few compact choices on one track; use `SegmentedControl`. Do not use it for a long list or tight space; use `Select`. Do not use it for removable tags (`Chip`). Prefer it over `wa-radio-group` with `appearance="button"` radios, which wrap as a ragged joined group. | Pass a form `name`, a `label` or `labelledBy`, and the controlled `value`; delegate the `action` on `change`, read the radio `value` (or, with `multiple`, the checked boxes under `name`), and rerender. Place it in a dark appearance scope for inverse chrome rather than restyling it. Lead choices with a `swatch` (`CssColor` or `'transparent'`) or an `icon`. | Controlled value, choices, swatch colors, change handling, and form submission. | `@kerfjs/ui/choice-chips` | [ChoiceChips contract](./accessibility.md#choicechips) |
|
|
288
|
+
| Chat or prompt composer — `MessageComposer`, `wireMessageComposers` | A chat message, assistant prompt, or reply is written in a raised frame and sent with a trailing action, often in a `DialogSurface` floating footer over a transcript. | Do not use it for an ordinary form field submitted with the rest of a form; use a `multiline` `TextField`. Do not wrap it in another framed `ContentItem` or card; it owns its frame, padding, and shadow. Prefer it over a textarea and a button in app-styled chrome. | Pass a `name`, a title-style `label`, an `id` when it has a `hint`, and the trailing `actions` (a brand Send `Button`). Bound the growing field with `minRows` and `maxRows`. Read and clear the textarea from the send action. For Enter-to-send, set `submitOnEnter` and call `wireMessageComposers(root)` once; Enter clicks the first trailing action, Shift+Enter is a newline, and IME commits never send. | Value, sending, shortcuts beyond the opt-in Enter-to-send, and the disabled or busy state of its actions. | `@kerfjs/ui/message-composer`, `@kerfjs/ui/wire-message-composers` | [MessageComposer](./message-composer.md) |
|
|
289
|
+
| Structured search editor — `SearchField`, `readSearchField`, `placeSearchFieldCaret`, `wireSearchFields` | Free text and ordered, editable, removable filter tokens share one searchbox; enable `collapsible` when an empty, unfocused field should reduce to one iconic action, standalone or in a toolbar group. | Do not use it for ordinary text entry; use `TextField`. Do not use it when filters belong in separate form controls. | Read DOM-owned text on input, empty `textContent` on clear, and use `placeSearchFieldCaret` after explicit controlled focus changes. Call `wireSearchFields` from `@kerfjs/ui/wire-search-fields` once so Enter submits without adding a line break and keyboard chip deletion restores focus plus the text-relative caret after controlled replacement. In `collapsible` mode it also manages the transient expand/collapse/focus by default (activate to reveal + focus, Escape or empty blur to collapse); bind the field's `expanded` to the signal on the returned handle (`handle.expanded(id)`) or adopt your own via `collapsible.signals`, and opt out per behavior only when the app must own it. | Parsing, suggestions, tokens, query execution, results, announcements, and — only if overriding the default — the collapsible `expanded` signal. | `@kerfjs/ui/search-field` | [SearchField contract](./accessibility.md#searchfield) |
|
|
290
|
+
| Persistent inline status — `StateBanner` | A neutral, info, pop, success, warning, or danger message belongs next to the affected work; pop highlights featured or novel content without implying status. | Do not use pop as a success, warning, or danger substitute. Do not use StateBanner for a no-content screen; use `EmptyState`. Do not use it for transient confirmation; use a toast. In an application using the Web Awesome integration, `wa-callout` is the alternative for Web Awesome-owned content. | Delegate an optional action; choose alert urgency only for attention-requiring failure. Use the optional tone-tinted `badge` for a terse count or status beside the title, not as the only expression of meaning. | State mapping, message lifetime, retry/action behavior, badge content, and copy. | `@kerfjs/ui/state-banner` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
291
|
+
| App-level progress in a corner — `CornerStatus`, `wireCornerStatus` | Ongoing app-wide work, such as "Loading…" or "Updating Tickets… 3 of 12", needs a non-dismissible status that has no better home beside the affected work. | Do not use it for transient, dismissible confirmation; use a toast. Do not use it for status that belongs beside the affected work; place a `StateBanner` there. Do not position a `StateBanner` with fixed-position application CSS. | Compose one or more `StateBanner`s with `urgency="status"`; they stack. Call `wireCornerStatus` once so each overlay host opens in the top layer as renders insert it. It never takes focus and has no close button, light dismiss, or Escape. | Status lifetime (render while the work runs, remove when it ends), banner copy and progress, and corner placement. | `@kerfjs/ui/corner-status`, `@kerfjs/ui/wire-corner-status` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
292
|
+
| Ambient edge activity — `EdgeActivityIndicator` | App-wide background activity (server work, sync) should be visible along the top edge without a modal, a banner, or a layout shift. | Do not use it for progress the user waits on or must read; use `CornerStatus`. Do not use it for known progress; use a progress bar. Do not make it the only record of important state. | Drive `busy`; pass an optional `message` for a polite status pill and a `tone`. It sits below the top safe area (or flush with `inset="none"`), takes no pointer, and only fades under reduced motion. | The busy state, message, and tone. | `@kerfjs/ui/edge-activity-indicator` | [Feedback accessibility](./accessibility.md#shared-rules) |
|
|
293
|
+
| Empty or busy content area — `EmptyState` | A content region has no items, cannot proceed, or is loading and needs explanation plus an optional action. | Do not use it for an inline status update; use `StateBanner`. Do not use it for transient success; use `toast()` from `kerfjs/overlay` or the application's toast system. | Delegate its optional action; it composes `LoadingSpinner` when busy. | Empty/busy policy, recovery action, illustration, and copy. | `@kerfjs/ui/empty-state` | [Feedback ownership](./component-contract.md#extracted-versus-application-specific) |
|
|
281
294
|
|
|
282
295
|
## Ambiguous choices
|
|
283
296
|
|
|
@@ -287,8 +300,10 @@ the scroll viewport. Use `SunkenPanel` for a padded content group that does
|
|
|
287
300
|
not introduce scrolling. See [Lowered work surfaces](./layout.md#lowered-work-surfaces).
|
|
288
301
|
|
|
289
302
|
Set `ResizableRegion`'s `--kui-resizable-region-background` for an inline
|
|
290
|
-
surface.
|
|
291
|
-
|
|
303
|
+
surface. A `PopupMenu` opens in the browser top layer, so the region keeps
|
|
304
|
+
clipping its own content while the menu shows in full; an open raw Web Awesome
|
|
305
|
+
dropdown inside it automatically releases clipping and raises the region on
|
|
306
|
+
its public popup layer instead. Set
|
|
292
307
|
`contentOverflow="visible"` for other anchored content that must escape the
|
|
293
308
|
region. A collapsed region can place `restoreControl` in a top or bottom corner with
|
|
294
309
|
`restorePosition`, set its typed `restoreInset`, or use
|
|
@@ -384,22 +399,22 @@ and `--kui-value-table-row-gap` tokens support a specific metadata layout.
|
|
|
384
399
|
Use `ToolbarText size="xsmall"` for a dense rail heading. Use
|
|
385
400
|
`size="xlarge-fixed"` for a toolbar heading at the fixed 20px step; `xlarge`
|
|
386
401
|
retains the responsive page-title clamp. Pass `headingLevel` when the text is
|
|
387
|
-
a section landmark. A `
|
|
388
|
-
group; set `--kui-
|
|
402
|
+
a section landmark. A `SearchField` editor can shrink to zero minimum width inside a narrow
|
|
403
|
+
group; set `--kui-search-field-editor-min-width` only when a wider editor is
|
|
389
404
|
required.
|
|
390
405
|
|
|
391
406
|
- `Toolbar` serves persistent app chrome and headings; the zone contents and accessible naming distinguish the purpose.
|
|
392
|
-
- `TabBar` changes tabpanels and supports overflow/reorder; `SegmentedControl` chooses among a few compact views; `ChoiceChips` keeps a larger exclusive set (or, with `multiple`, any-number set) visible as wrapping pills; `Select` handles a longer value list.
|
|
407
|
+
- `TabBar` changes tabpanels and supports overflow/reorder; `SegmentedControl` chooses among a few compact views; `ChoiceChips` keeps a larger exclusive set (or, with `multiple`, an any-number set) visible as wrapping pills; `Select` handles a longer value list.
|
|
393
408
|
|
|
394
|
-
Use `
|
|
409
|
+
Use `TabBarItem presentation="icon-only"` with its `name` kept as the accessible
|
|
395
410
|
tab name. For segmented tabs that should show names in a wide reader and icons
|
|
396
411
|
in a narrower container, set `TabBar iconOnlyAt="wide"` (832px), `"narrow"`
|
|
397
|
-
(704px), or `"compact"` (448px), and give each segmented `
|
|
412
|
+
(704px), or `"compact"` (448px), and give each segmented `TabBarItem` a leading
|
|
398
413
|
icon. The tablist's own width controls the switch; the visually hidden name
|
|
399
414
|
remains its accessible name. Use `labelMaxWidth` for an ellipsized visible name. Set `attention`
|
|
400
|
-
to color a tab's name with `--kui-
|
|
415
|
+
to color a tab's name with `--kui-tab-bar-item-attention-color`. Set `dropTarget`
|
|
401
416
|
while an app drag is over a tab's content; the tab keeps its selection semantics
|
|
402
|
-
and uses the `--kui-
|
|
417
|
+
and uses the `--kui-tab-bar-item-drop-target-*` tokens for its highlight. Set
|
|
403
418
|
`nameOverflow="visible"` when an inline loading treatment needs the full name
|
|
404
419
|
instead of the default ellipsis. A `TabBar` owns its
|
|
405
420
|
scrolling strip; its public `--kui-tab-bar-strip-*` tokens configure strip
|
|
@@ -408,9 +423,9 @@ its internal classes. `--kui-tab-bar-trailing-flex` controls the trailing zone.
|
|
|
408
423
|
For a distinct application action, use `end` to pin it at the far edge; use
|
|
409
424
|
`trailingPlacement="adjacent"` to keep a tab-local `trailing` action beside the
|
|
410
425
|
strip. Each zone accepts one `ToolbarControlGroup` or one standalone
|
|
411
|
-
`
|
|
426
|
+
`Button` for a primary action with its own chrome. Avoid wrappers and
|
|
412
427
|
application flex overrides.
|
|
413
|
-
Set `pinned` on the first `
|
|
428
|
+
Set `pinned` on the first `TabBarItem` when that tab must remain visible as peers
|
|
414
429
|
scroll. It stays inside the tablist and keyboard order. Set the `TabBar`
|
|
415
430
|
`snapTabs` prop when scrolling peers should settle at whole-tab starts
|
|
416
431
|
beside that pinned tab. `wireTabBars` measures the pinned inset and provides
|
|
@@ -421,7 +436,7 @@ without styling its strip or tab internals. With `snapTabs`, keep the trailing
|
|
|
421
436
|
zone non-shrinking (the default `--kui-tab-bar-trailing-flex`): the reserved
|
|
422
437
|
end room counts toward the strip's share when both zones shrink.
|
|
423
438
|
Set the public
|
|
424
|
-
`--kui-
|
|
439
|
+
`--kui-tab-bar-item-pinned-background` token if the surrounding surface differs from
|
|
425
440
|
the default; the pinned tab must cover peers as they scroll beneath it. Its
|
|
426
441
|
background also covers the strip's inline padding and border so scrolled labels
|
|
427
442
|
cannot paint beside the pinned edge, including in right-to-left strips. The
|
|
@@ -430,7 +445,7 @@ and shadow whole beside the overflow divider. Call
|
|
|
430
445
|
`wireTabBars` for keyboard selection and reorder behavior and its WebKit RTL
|
|
431
446
|
scroll correction.
|
|
432
447
|
|
|
433
|
-
- `StateBanner` persists beside affected work; `EmptyState` replaces absent content;
|
|
448
|
+
- `StateBanner` persists beside affected work; `EmptyState` replaces absent content; a `kerfjs/overlay` `toast()` is transient and must not carry the only copy of important state. With the Web Awesome integration, `wa-callout` is contextual ecosystem content and `wa-toast` is the transient equivalent.
|
|
434
449
|
|
|
435
450
|
For a banner with multi-line supporting copy, use `copyLayout="stacked"` to put
|
|
436
451
|
the detail below the title and badge. The default `actionPlacement="trailing"`
|
|
@@ -464,7 +479,8 @@ be reached or announced either way. When the dialog's task depends on that
|
|
|
464
479
|
progress, show it inside the dialog.
|
|
465
480
|
|
|
466
481
|
For a compact `Select`, set `triggerWidth` to `"fit-content"`, `"max-content"`,
|
|
467
|
-
or `"fill"
|
|
482
|
+
or `"fill"`, and bound it with `maxTriggerWidth` / `minTriggerWidth` (under any
|
|
483
|
+
presentation; the value or `renderSelected` content ellipsizes before the caret).
|
|
468
484
|
For a round icon-only toolbar trigger, set `selectedPresentation="icon-only"`
|
|
469
485
|
and `caret={false}`. The control keeps its accessible name, current choice help
|
|
470
486
|
tag, and keyboard-operated listbox; the selected icon stays centered even when
|
|
@@ -512,23 +528,22 @@ still owns the controlled `value` and localized action labels.
|
|
|
512
528
|
without a device-class check.
|
|
513
529
|
`wireSidebar` also accepts a
|
|
514
530
|
hidden compact replacement and keeps compact overlays exclusive by default.
|
|
515
|
-
- `
|
|
531
|
+
- `SearchField` is a structured editor. A `TextField` is the right answer for ordinary text.
|
|
516
532
|
|
|
517
|
-
For common structured search, use `
|
|
533
|
+
For common structured search, use `createSearchFieldModel` from `@kerfjs/ui/search-field-model`, pass the model to `SearchField`, and register it under the field id in `wireSearchFields(root, { models })`. Rules parse `name:value` expressions and provide suggestions; the model owns chips, selection, removal, clear, and an optional evaluation result. The field subscribes only to `model.structure`, so typing plain text does not re-run the host render; read `model.state.peek()` in the host's render and bind `model.result` as a signal hole instead of reading `model.state.value`. Omit `model` and `models` for full manual control.
|
|
518
534
|
|
|
519
|
-
In a form, use `
|
|
535
|
+
In a form, use `SearchField presentation="form-field"` with its `label`,
|
|
520
536
|
optional `hint`, and `required` state. It renders a full-width control beside
|
|
521
|
-
`
|
|
537
|
+
`TextField` without a Toolbar or extra inline inset. The app validates required
|
|
522
538
|
search content before saving.
|
|
523
|
-
The form-field corners
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
`--kui-
|
|
528
|
-
`--kui-token-search-token-foreground`) inherit from an app ancestor or the
|
|
539
|
+
The form-field corners follow the same `--kui-layout-rounded-radius` as a
|
|
540
|
+
neighboring `TextField`.
|
|
541
|
+
The four public color tokens (`--kui-search-field-background`,
|
|
542
|
+
`--kui-search-field-border`, `--kui-search-field-token-background`, and
|
|
543
|
+
`--kui-search-field-token-foreground`) inherit from an app ancestor or the
|
|
529
544
|
field's root. `className` marks that root, including the outer wrapper in
|
|
530
545
|
`form-field` presentation, so one app class can configure either form.
|
|
531
|
-
`
|
|
546
|
+
`SearchFieldRule.suggest(input, state)` receives the unfinished value and current committed tokens, so a rule can omit values already selected. Existing one-argument suggestion callbacks continue to work.
|
|
532
547
|
For a sibling date picker or other app helper, call `model.commit(value)` while a `name:` prefix is active. It parses and commits that value for the active rule even when it is absent from suggestions, replacing the unfinished prefix text. Invalid values and calls without an active prefix leave the query unchanged; `choose(value)` remains restricted to suggested tokens.
|
|
533
548
|
To apply a saved search or restore a query programmatically, call `model.replace({ query, tokens })`. It publishes parsed state and rebuilds the DOM-owned editor text even when no chip changed. For a field without a model, change the field's `revision` prop when setting `query` yourself.
|
|
534
549
|
When one root contains both kinds of field, a registered model enables chip keyboard behavior only for its own field. Other fields keep native editing unless the root opts into `keyboard` with an application removal callback.
|
|
@@ -541,11 +556,11 @@ an on/off toggle, set `pressed`. The open or pressed state keeps the hover fill.
|
|
|
541
556
|
Put domain `data-*` metadata in `attributes`. Never style your own button into
|
|
542
557
|
the `trailing` slot; reserve `trailing` for passive content such as a shortcut
|
|
543
558
|
hint.
|
|
544
|
-
Set `fill` on a collapsible `
|
|
559
|
+
Set `fill` on a collapsible `SearchField` in a stretched Toolbar center to
|
|
545
560
|
use the available width when expanded; the field and its search group retain
|
|
546
561
|
their compact widths when collapsed.
|
|
547
562
|
When the expanded toolbar field has focus, its inset surface uses
|
|
548
|
-
`--kui-
|
|
563
|
+
`--kui-search-field-background` or the default surface color if that token is
|
|
549
564
|
unset.
|
|
550
565
|
|
|
551
566
|
`ToolbarControlGroup.tileTone` selects `neutral`, `brand`, `success`, `warning`, or `danger` quiet fill, matching quiet border, and on-quiet foreground for a non-interactive icon tile. Compose a contained `single` group whose only child is a direct decorative LucideIcon (`aria-hidden="true"`). Omission preserves the normal group palette. The prop does not recolor interactive, mixed, multi-control, or borderless groups; keep real actions in controls with their existing focus/hover/pressed treatments.
|
|
@@ -572,8 +587,8 @@ A `Toolbar` has three zones — `leading`, `center`, and `trailing`. Each accept
|
|
|
572
587
|
`KerfUiContent` directly, including a status `Chip`, a native control, or
|
|
573
588
|
application markup. `ToolbarText` is the standard identity/title; use
|
|
574
589
|
`ToolbarControlGroup` when related controls should share its chrome, sizing,
|
|
575
|
-
hover treatment, or overflow behavior. A standalone primary `
|
|
576
|
-
its own
|
|
590
|
+
hover treatment, or overflow behavior. A standalone primary `Button` keeps
|
|
591
|
+
its own chrome and fits naturally in the trailing zone. Bare
|
|
577
592
|
controls retain their own styling and accessibility responsibilities; the
|
|
578
593
|
toolbar only positions them within the zone. A toolbar with a single zone (only
|
|
579
594
|
`leading`, only `trailing`, or only `center`) gives that zone the whole content
|
|
@@ -585,7 +600,7 @@ ellipsizes before an adjacent status chip when the leading zone narrows. The
|
|
|
585
600
|
application handles the delegated action and replaces it with its own input
|
|
586
601
|
while editing. Use a separate heading landmark if the view needs one.
|
|
587
602
|
For a search or cluster that needs shared toolbar geometry, place
|
|
588
|
-
`SegmentedControl`, `Select`, or `
|
|
603
|
+
`SegmentedControl`, `Select`, or `SearchField` inside a
|
|
589
604
|
`ToolbarControlGroup`. The ToolbarText catalog's actionable-title example
|
|
590
605
|
places its status `Chip` directly beside the title while the search uses a
|
|
591
606
|
group. `TabBar` also accepts a `ToolbarControlGroup` in its `leading`,
|
|
@@ -620,20 +635,22 @@ The position changes the HTML element without changing zones or geometry.
|
|
|
620
635
|
|
|
621
636
|
Common toolbar patterns:
|
|
622
637
|
|
|
623
|
-
For a long-running
|
|
638
|
+
For a long-running action, set `busy` on its single-control
|
|
624
639
|
`ToolbarControlGroup` and supply a descriptive `busyLabel`. The group preserves
|
|
625
|
-
the control's dimensions, shows `LoadingSpinner` in its
|
|
626
|
-
`aria-busy`, and makes the control inert until the app clears `busy`.
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
|
631
|
-
|
|
|
632
|
-
|
|
|
633
|
-
|
|
|
634
|
-
|
|
|
635
|
-
|
|
|
636
|
-
| A
|
|
640
|
+
the control's dimensions, shows `LoadingSpinner` in its place, sets
|
|
641
|
+
`aria-busy`, and makes the control inert until the app clears `busy`. An icon
|
|
642
|
+
group hides only the glyph; a `content="text"` or `"mixed"` group hides the
|
|
643
|
+
whole control, label included, so the spinner never draws over text.
|
|
644
|
+
|
|
645
|
+
| Want | Put in the zone | Notes |
|
|
646
|
+
| ------------------------------ | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
647
|
+
| Identity or title text | `<ToolbarText text="…" size="large" />` (or `xlarge` for a page/panel title that fits) | Wrap in a `single` borderless group only when it must align with adjacent control pills |
|
|
648
|
+
| One or more icon/text buttons | `<ToolbarControlGroup>{buttons}</ToolbarControlGroup>` | Use `buttonAppearance="push"` for toggle buttons with `aria-pressed`; `single` for a lone control |
|
|
649
|
+
| One primary application action | `trailing={<Button tone="brand">New Ticket…</Button>}` | The standalone button keeps its own chrome; use `tone="danger"` when the action is destructive |
|
|
650
|
+
| An exclusive view switch | `<ToolbarControlGroup><SegmentedControl … /></ToolbarControlGroup>` | Not `TabBar`, which switches tabpanels |
|
|
651
|
+
| A value list | `<ToolbarControlGroup><Select … /></ToolbarControlGroup>` | Register `@kerfjs/ui/select/register` once; use `focusRingOwner="group"` so focus follows the group's geometry |
|
|
652
|
+
| A command menu | `<ToolbarControlGroup single nestedDropdown><PopupMenu … /></ToolbarControlGroup>` | Register `@kerfjs/ui/popup-menu/register` once; set `menuInset` on the group |
|
|
653
|
+
| A collapsible search box | `<ToolbarControlGroup single><SearchField collapsible … /></ToolbarControlGroup>` | The group animates the iconic ↔ expanded states; `wireSearchFields` manages expand/collapse/focus by default |
|
|
637
654
|
|
|
638
655
|
### Room for an expanded search
|
|
639
656
|
|
|
@@ -642,7 +659,7 @@ that room is too small, the siblings wrap onto a new row partway through the
|
|
|
642
659
|
opening, and the toolbar grows a row taller. Kerf does not hide or move your
|
|
643
660
|
other controls; plan for it instead:
|
|
644
661
|
|
|
645
|
-
- Size the expanded search to what fits: `--kui-
|
|
662
|
+
- Size the expanded search to what fits: `--kui-search-field-expanded-width`
|
|
646
663
|
for a plain search group, or `sizing="grow"` with a `growBasis` that fits
|
|
647
664
|
beside the siblings.
|
|
648
665
|
- If a useful search cannot fit beside the other controls, set those controls
|
|
@@ -662,14 +679,14 @@ and collapsed searches keep their existing overflow rules.
|
|
|
662
679
|
|
|
663
680
|
```tsx
|
|
664
681
|
<ToolbarControlGroup content="search" expanded={open} expandedOverflow="visible">
|
|
665
|
-
<
|
|
666
|
-
{open ? <AppDatePicker data-
|
|
682
|
+
<SearchField id="ticket-search" label="Search tickets" presentation="toolbar-group" collapsible expanded={open} />
|
|
683
|
+
{open ? <AppDatePicker data-search-field-keep-open /> : null}
|
|
667
684
|
</ToolbarControlGroup>
|
|
668
685
|
```
|
|
669
686
|
|
|
670
687
|
The application owns placement (for example absolute positioning below the
|
|
671
688
|
group), stacking, dismissal, and hiding/removing its surface on collapse. Mark
|
|
672
|
-
focusable floating content `data-
|
|
689
|
+
focusable floating content `data-search-field-keep-open`, or configure
|
|
673
690
|
`collapsible.keepOpenOn`, to keep an empty field open when focus enters it.
|
|
674
691
|
This prop does not escape clipping imposed by an ancestor or create a top-layer
|
|
675
692
|
popover. Do not override the group's position, height, or overflow in app CSS.
|
|
@@ -678,11 +695,13 @@ popover. Do not override the group's position, height, or overflow in app CSS.
|
|
|
678
695
|
|
|
679
696
|
A **popup menu in a toolbar** is a `PopupMenu` (`@kerfjs/ui/popup-menu`) in a
|
|
680
697
|
`single` `ToolbarControlGroup` with `nestedDropdown`; the group sizes the trigger
|
|
681
|
-
as a toolbar button and `menuInset` sets the menu's inset. `PopupMenu` renders
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
menu
|
|
698
|
+
as a toolbar button and `menuInset` sets the menu's inset. `PopupMenu` renders
|
|
699
|
+
its own native trigger button and a `role="menu"` panel of typed items
|
|
700
|
+
(commands, headings, and dividers) that opens in the browser top layer, and
|
|
701
|
+
keeps the open menu's state out of the morph. Register
|
|
702
|
+
`@kerfjs/ui/popup-menu/register` once; it wires opening, keyboard navigation,
|
|
703
|
+
submenus, and dismissal for every PopupMenu in the document. Do not hand-write
|
|
704
|
+
`wa-dropdown` or menu markup for a menu.
|
|
686
705
|
|
|
687
706
|
```tsx
|
|
688
707
|
<ToolbarControlGroup single nestedDropdown menuInset="compact">
|
|
@@ -700,8 +719,8 @@ menu.
|
|
|
700
719
|
Nested decisions use an item with `submenu`. Children keep their own actions,
|
|
701
720
|
`attributes` metadata, icons, `checked` state, disabled state and
|
|
702
721
|
`disabledReason` tooltip. Nested `heading` and `divider` entries group those
|
|
703
|
-
commands without entering keyboard navigation. `tone: 'danger'`
|
|
704
|
-
|
|
722
|
+
commands without entering keyboard navigation. `tone: 'danger'` draws a
|
|
723
|
+
destructive command. A parent can sit among ordinary commands and dividers, so the same
|
|
705
724
|
items shape covers single-line and batch actions; compute each batch child's
|
|
706
725
|
`disabled` state from the current selection.
|
|
707
726
|
|
|
@@ -730,9 +749,12 @@ Items with `checked: true` or `checked: false` reserve checkmark space, and so
|
|
|
730
749
|
does every plain command in a menu level (the top menu or one submenu) that
|
|
731
750
|
holds such an item, so icons and labels line up across the level; a level
|
|
732
751
|
without a choice keeps the compact start. Omit `checked` for a plain command,
|
|
733
|
-
including one beside checkbox items.
|
|
734
|
-
|
|
735
|
-
|
|
752
|
+
including one beside checkbox items. The application owns each choice's state:
|
|
753
|
+
choosing one reports the state it asks for (`detail.checked`) in the root's
|
|
754
|
+
bubbling, cancelable `kui-menu-select` event, alongside `detail.item` and its
|
|
755
|
+
`detail.value`, and the menu shows the new checkmark once the application
|
|
756
|
+
renders it. Commands still dispatch their own `data-action` once on pointer and
|
|
757
|
+
keyboard selection; canceling `kui-menu-select` keeps the menu open.
|
|
736
758
|
|
|
737
759
|
For a row opened by right-click, render `PopupMenu` with `context`, `label`,
|
|
738
760
|
`anchor`, and a stable root `data-*` marker. Its trigger is an invisible anchor
|
|
@@ -746,18 +768,19 @@ or a `z-index` (the open menu is in the browser top layer). In the app's
|
|
|
746
768
|
`anchor`, and call `openPopupMenu` with the menu. Because the point is part of the
|
|
747
769
|
menu's own template, it survives re-renders and a rebuilt menu, so the app
|
|
748
770
|
never re-applies it. `openPopupMenuAt` still opens a menu rendered without `anchor` at a given
|
|
749
|
-
point. Call `closePopupMenu` for programmatic dismissal.
|
|
750
|
-
|
|
751
|
-
navigation, and outside/Escape dismissal.
|
|
771
|
+
point. Call `closePopupMenu` for programmatic dismissal. A pointer-anchored menu
|
|
772
|
+
keeps the same collision placement, focus management, submenu keyboard
|
|
773
|
+
navigation, and outside/Escape dismissal as a trigger-anchored one.
|
|
752
774
|
|
|
753
|
-
The
|
|
754
|
-
|
|
775
|
+
The menu opens in the browser top layer, flips and shifts at viewport edges,
|
|
776
|
+
and limits its height to the available space, scrolling past it. The app
|
|
755
777
|
supplies pointer coordinates and command policy; it does not need to calculate
|
|
756
|
-
menu offsets. For other anchored content, use
|
|
757
|
-
`
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
778
|
+
menu offsets. For other anchored content, use `AnchoredSurface` for help or
|
|
779
|
+
popup content, a native `title` for a plain-text hint, or `kerfjs/overlay`'s
|
|
780
|
+
`positionAnchored()` when only placement is needed. An application using the
|
|
781
|
+
Web Awesome integration may use `wa-tooltip` for a rich hover tooltip until
|
|
782
|
+
Kerf ships a styled one; `wa-popover` and `wa-popup` are `Discouraged`. These
|
|
783
|
+
are distinct interaction contracts: a command menu still uses `PopupMenu`.
|
|
761
784
|
|
|
762
785
|
## Configuring recurring list rows
|
|
763
786
|
|
|
@@ -849,7 +872,14 @@ hover, focus, and disabled paint in its reserved 1px frame (see
|
|
|
849
872
|
For a multi-select card containing its own controls, place
|
|
850
873
|
`selectionMode="multiple"` ContentItems inside a labeled
|
|
851
874
|
`List selectionMode="multiple"`; the app supplies each card's `selected`
|
|
852
|
-
state
|
|
875
|
+
state. Resolve each card activation with `applySelection` and
|
|
876
|
+
`selectionGesture` from `@kerfjs/ui/selection`, which implement the same
|
|
877
|
+
platform-normalized replace, Cmd/Ctrl-toggle, and Shift-range model as
|
|
878
|
+
`ChoiceChips` `multiple` (`isApplePlatform` decides between Cmd and Ctrl); `wireContentItems` forwards those modifiers from
|
|
879
|
+
Enter and Space, and keeps the grid one Tab stop. Put content that is not
|
|
880
|
+
selectable between those rows (an activity group, a "messages skipped"
|
|
881
|
+
divider) in a `ContentItem gridRow`, never a hand-written `role="row"`
|
|
882
|
+
wrapper.
|
|
853
883
|
For wrapped document tiles, use `Grid minColumnWidth={px(160)}` with
|
|
854
884
|
`selectionMode="multiple"` and `ariaLabel`. The same ContentItem row/gridcell
|
|
855
885
|
contract applies, while `wireContentItems` follows the rendered tile layout
|
|
@@ -977,7 +1007,7 @@ must wrap onto several rows and still read well at phone width. Each choice is
|
|
|
977
1007
|
a separate pill backed by a native radio, so the group is one Tab stop, arrow
|
|
978
1008
|
keys move the selection, and the checked radio is the form value under `name`.
|
|
979
1009
|
The pills wrap with the standard 8px control gap; never wrap a
|
|
980
|
-
`SegmentedControl` or button
|
|
1010
|
+
`SegmentedControl` or a joined button group instead — their joined
|
|
981
1011
|
borders turn ragged across rows.
|
|
982
1012
|
|
|
983
1013
|
Lead a choice with `swatch` for a color (a `CssColor` from `uiColor()`,
|
|
@@ -1005,14 +1035,28 @@ visible `FieldLabel`.
|
|
|
1005
1035
|
|
|
1006
1036
|
### Wrapping multiple choices
|
|
1007
1037
|
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
`
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1038
|
+
When the person may turn any number of the visible options on, `value`
|
|
1039
|
+
becomes a `readonly Value[]` (the type rejects a single value, and a single
|
|
1040
|
+
group rejects an array) and `multiple` picks the model:
|
|
1041
|
+
|
|
1042
|
+
- `multiple: 'toggle'` — each pill toggles alone, as label filters or the
|
|
1043
|
+
intents an annotation carries do. The pills are native checkboxes in a
|
|
1044
|
+
`role="group"`: each pill is a Tab stop, a click or Space toggles it, and
|
|
1045
|
+
every checked value submits under `name`. Delegate the `action` on `change`
|
|
1046
|
+
and read the checked boxes by `name`, which lists them in choice order.
|
|
1047
|
+
- `multiple: true` — the desktop multi-select, for picking a working set
|
|
1048
|
+
where a plain click should mean "just this one". The group is an
|
|
1049
|
+
`aria-multiselectable` listbox: a click selects one chip, Cmd (Apple
|
|
1050
|
+
platforms) or Ctrl (elsewhere) toggles one, and Shift extends a range from
|
|
1051
|
+
the last plain or toggled chip. It is one Tab stop; arrows, Home, and End
|
|
1052
|
+
move the selection, Shift with them extends it, Cmd/Ctrl with them moves
|
|
1053
|
+
focus alone, Space toggles, and Cmd/Ctrl+A selects all. Wire it once with
|
|
1054
|
+
`wireChoiceChips` from `@kerfjs/ui/wire-choice-chips`; it fires
|
|
1055
|
+
`change` on the group (which carries the `action`), and `readChoiceChips`
|
|
1056
|
+
returns the new set. Hidden inputs submit each selected value under `name`.
|
|
1057
|
+
|
|
1058
|
+
A multiple group takes no `required`. Prefer a multiple `Select` when the
|
|
1059
|
+
option list is long or space is tight.
|
|
1016
1060
|
|
|
1017
1061
|
On dark inverse chrome, such as a media viewer, put the chips inside a dark
|
|
1018
1062
|
appearance scope (`.wa-dark`, or any `color-scheme: dark` ancestor) rather
|
|
@@ -1022,7 +1066,7 @@ than restyling them: every chip color is a theme token that follows the scope.
|
|
|
1022
1066
|
<ChoiceChips
|
|
1023
1067
|
name="intents"
|
|
1024
1068
|
label="Annotation Intents"
|
|
1025
|
-
multiple
|
|
1069
|
+
multiple="toggle"
|
|
1026
1070
|
value={annotation.intents}
|
|
1027
1071
|
action="toggle-annotation-intent"
|
|
1028
1072
|
choices={[
|
|
@@ -1045,35 +1089,55 @@ delegateActions(root, 'change', {
|
|
|
1045
1089
|
});
|
|
1046
1090
|
```
|
|
1047
1091
|
|
|
1048
|
-
## Web Awesome
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
|
1066
|
-
|
|
|
1067
|
-
| `wa-
|
|
1068
|
-
| `wa-
|
|
1069
|
-
| `wa-
|
|
1070
|
-
| `wa-
|
|
1071
|
-
| `wa-
|
|
1072
|
-
| `wa-
|
|
1073
|
-
| `wa-
|
|
1092
|
+
## Web Awesome integration
|
|
1093
|
+
|
|
1094
|
+
Kerf UI does not need Web Awesome. Every Kerf component renders native
|
|
1095
|
+
elements, reads only `--kui-*` tokens, and ships no Web Awesome code, so a
|
|
1096
|
+
Kerf-only application installs nothing else. Web Awesome is an optional
|
|
1097
|
+
integration for applications that already use it or need one of its
|
|
1098
|
+
specialized elements: import the CSS-only `@kerfjs/ui/webawesome.css` theme
|
|
1099
|
+
bridge, `@kerfjs/ui/webawesome` for Kerf JSX types, and each element's
|
|
1100
|
+
registration module. See the [Web Awesome theme contract](./webawesome-theme.md)
|
|
1101
|
+
and the [migration guide](./webawesome-migration.md).
|
|
1102
|
+
|
|
1103
|
+
Integration coverage means supported and themed, not preferred. The UX catalog
|
|
1104
|
+
lists those elements in its collapsed Web Awesome Integration section and tags
|
|
1105
|
+
every element a Kerf component replaces `Discouraged`. Never render a
|
|
1106
|
+
`Discouraged` element in application, demo, or recipe markup; use the Kerf
|
|
1107
|
+
component below, and file a component gap rather than dropping to the raw tag.
|
|
1108
|
+
|
|
1109
|
+
| Web Awesome element | Kerf choice |
|
|
1110
|
+
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
1111
|
+
| `wa-button`, `wa-dropdown`, `wa-dropdown-item` | Use `Button` (icon-only with `icon` and `ariaLabel`, or a toggle with `pressed`) for actions and `PopupMenu` for a command menu. Use `ListItem` for a navigation row and `Select` for a value. |
|
|
1112
|
+
| `wa-button-group` | Use `ToolbarControlGroup` or `SplitButton` for grouped actions and `SegmentedControl` for one-of-many selection. |
|
|
1113
|
+
| `wa-input`, `wa-textarea`, `wa-tag` | Use `TextField` for free text (`multiline` for a textarea) and `Chip` for removable or disabled tags; use `SearchField` only when text and ordered filter tokens form one editor. |
|
|
1114
|
+
| `wa-checkbox`, `wa-checkbox-group`, `wa-switch` | Use `Checkbox` for a submitted option (a group of them in a `List`, or `ChoiceChips` `multiple: 'toggle'` for wrapping pills) and `Switch` for a setting that applies immediately. |
|
|
1115
|
+
| `wa-radio-group`, `wa-radio` | Use `RadioGroup` for a few labeled options, `ChoiceChips` for wrapping pills, and `SegmentedControl` for a view switch. |
|
|
1116
|
+
| `wa-select`, `wa-option` | Use `Select`, which owns Kerf spacing, controlled rendering, and form participation. |
|
|
1117
|
+
| `wa-dialog`, `wa-drawer` | Use `DialogSurface` with `openDialog` / `closeDialog` (`presentation="side-sheet"` or `"bottom-sheet"` for a drawer), or a `kerfjs/overlay` dialog. Use `CollapsiblePanel` for a rail that overlays content on compact devices. |
|
|
1118
|
+
| `wa-tab-group`, `wa-tab`, `wa-tab-panel` | Use `TabBar`/`TabBarItem` for application tabs or `SegmentedControl` for compact local views. |
|
|
1119
|
+
| `wa-icon` | Use `LucideIcon`. |
|
|
1120
|
+
| `wa-badge`, `wa-spinner`, `wa-skeleton` | Use `Badge`, `LoadingSpinner`, and `Skeleton`. |
|
|
1121
|
+
| `wa-split-panel` | Use `ResizableRegion` for application panes. |
|
|
1122
|
+
| `wa-progress-bar`, `wa-progress-ring` | Use `ProgressBar` (`@kerfjs/ui/progress-bar`, a native progress element) or, where a bar does not fit, `ProgressRing` (`@kerfjs/ui/progress-ring`). |
|
|
1123
|
+
| `wa-callout` | Use `StateBanner` for persistent inline status, alerts, and emphasized messages, and `EmptyState` for absent content. |
|
|
1124
|
+
| `wa-popover`, `wa-popup` | Use `AnchoredSurface` (`openAnchoredSurface` / `openAnchoredSurfaceAt`) for anchored help or popup content; place any other element with `positionAnchored()` or `autoReposition()` from `kerfjs/overlay`. |
|
|
1125
|
+
| `wa-card` | Use `ContentItem` (`appearance="surface"` with `frame="framed"` for a raised card) to contain related content, or `SunkenPanel` for a lowered region. |
|
|
1126
|
+
| `wa-page` | Compose the shell from `Workbench`, `SplitView`, `NavStack`, or `TabNavigator`. |
|
|
1127
|
+
| `wa-tooltip` | Call `tooltip()` from `kerfjs/overlay` with `@kerfjs/ui/overlay-tooltip.css` imported (pass `exitClass: 'kui-tooltip-exit'`, `exitDuration: 100`). Icon-only toolbar and popup controls already get help tags; a native `title` remains fine for a plain-text hint. |
|
|
1128
|
+
| `wa-toast`, `wa-toast-item` | Call `toast()` from `kerfjs/overlay` with `@kerfjs/ui/overlay-toast.css` imported (pass `exitClass: 'kui-toast-exit'`, `exitDuration: 200`); use a `StateBanner` in place for a persistent status. |
|
|
1129
|
+
| `wa-details`, `wa-accordion`, `wa-accordion-item` | Use `Disclosure` (`@kerfjs/ui/disclosure`), a native details element; Disclosures sharing a `name` form an accordion. |
|
|
1130
|
+
| `wa-slider` | Use `Slider` (`@kerfjs/ui/slider`), a native range input, with `wireSliders` for its live readout. |
|
|
1131
|
+
| `wa-tag-input` | Use `TagField` (`@kerfjs/ui/tag-field`) with `wireTagFields` for tags submitted as form values, or `SearchField` for search filters. |
|
|
1132
|
+
| `wa-color-picker` | Use `ColorField` (`@kerfjs/ui/color-field`) with `wireColorFields` for a color in a form, an inline `ColorPicker` when the color is the main task, or `ColorSwatches` for a fixed palette. |
|
|
1133
|
+
| `wa-include` | Fetch remote content with `resource()` from `kerfjs/async` and render it as Kerf content; never inject fetched markup, which bypasses kerf's `SafeHtml` escaping. |
|
|
1134
|
+
| `wa-scroller` | Let a `Pane` own vertical scrolling with its scroll edges (`wireScrollDividers`), or use `ColumnTrack` for a horizontal track. |
|
|
1135
|
+
| `wa-tree`, `wa-tree-item`, `wa-animated-image`, `wa-comparison` | Use only in an integration application, for the specialized behavior named by the component. |
|
|
1136
|
+
| `wa-zoomable-frame` | Avoid for application UI; keep embedded-media behavior application-owned. |
|
|
1074
1137
|
|
|
1075
1138
|
All other entries in the [Web Awesome theme contract](./webawesome-theme.md#coverage)
|
|
1076
|
-
remain supported when their native semantic
|
|
1139
|
+
remain supported in an integration application when their native semantic
|
|
1140
|
+
contract matches the product need.
|
|
1077
1141
|
|
|
1078
1142
|
### Toolbar width visibility
|
|
1079
1143
|
|