@ds-mo/ui 12.4.1 → 12.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist/.build-stamp +1 -1
- package/dist/agent-patterns.json +21 -12
- package/dist/agent.json +1541 -1426
- package/dist/angular/ds-bar-workflow.d.ts +1 -1
- package/dist/angular/ds-bar-workflow.js +3 -3
- package/dist/angular/ds-mobile-bar-nav.d.ts +18 -0
- package/dist/angular/{ds-shell-mobile-bar.js → ds-mobile-bar-nav.js} +15 -15
- package/dist/angular/ds-mobile-header.d.ts +23 -0
- package/dist/angular/ds-mobile-header.js +45 -0
- package/dist/angular/ds-mobile-section-switcher.d.ts +18 -0
- package/dist/angular/{ds-shell-mobile-section-nav.js → ds-mobile-section-switcher.js} +15 -15
- package/dist/angular/ds-mobile-sheet-nav.d.ts +20 -0
- package/dist/angular/{ds-shell-mobile-nav.js → ds-mobile-sheet-nav.js} +13 -16
- package/dist/angular/ds-shell-app.d.ts +1 -1
- package/dist/angular/ds-shell-app.js +3 -3
- package/dist/angular/ds-shell-page.d.ts +1 -1
- package/dist/angular/ds-shell-page.js +3 -3
- package/dist/angular/index.d.ts +1 -1
- package/dist/angular/index.js +4 -3
- package/dist/angular/proxies.d.ts +4 -3
- package/dist/angular/proxies.js +4 -3
- package/dist/components/ds-agent-activity.js +1 -1
- package/dist/components/ds-agent-response.js +1 -1
- package/dist/components/ds-agent-tool-call.js +1 -1
- package/dist/components/ds-avatar.js +1 -1
- package/dist/components/ds-avatar.js.map +1 -1
- package/dist/components/ds-badge.js +1 -1
- package/dist/components/ds-bar-nav.js +1 -1
- package/dist/components/ds-bar-nav.js.map +1 -1
- package/dist/components/ds-bar-title.js +1 -1
- package/dist/components/ds-bar-title.js.map +1 -1
- package/dist/components/ds-bar-workflow.js +1 -1
- package/dist/components/ds-bar-workflow.js.map +1 -1
- package/dist/components/ds-breadcrumb.js +1 -1
- package/dist/components/ds-button-filled.js +1 -1
- package/dist/components/ds-button-unfilled.js +1 -1
- package/dist/components/ds-card-data-viz-bar.js +1 -1
- package/dist/components/ds-card-data-viz-donut.js +1 -1
- package/dist/components/ds-card-data-viz-line.js +1 -1
- package/dist/components/ds-card-setting.js +1 -1
- package/dist/components/ds-chart-bar.js +1 -1
- package/dist/components/ds-chart-donut.js +1 -1
- package/dist/components/ds-chart-legend.js +1 -1
- package/dist/components/ds-chart-legend.js.map +1 -1
- package/dist/components/ds-chart-line.js +1 -1
- package/dist/components/ds-checkbox.js +1 -1
- package/dist/components/ds-chip.js +1 -1
- package/dist/components/ds-chip.js.map +1 -1
- package/dist/components/ds-code-block.js +1 -1
- package/dist/components/ds-conversation-list-item.js +1 -1
- package/dist/components/ds-conversation-list-item.js.map +1 -1
- package/dist/components/ds-conversation-list-section.js +1 -1
- package/dist/components/ds-conversation-list.js +1 -1
- package/dist/components/ds-conversation-list.js.map +1 -1
- package/dist/components/ds-empty-state.js +1 -1
- package/dist/components/ds-field.js +1 -1
- package/dist/components/ds-input.js +1 -1
- package/dist/components/ds-input.js.map +1 -1
- package/dist/components/ds-loader.js +1 -1
- package/dist/components/ds-markdown.js +1 -1
- package/dist/components/ds-menu.js +1 -1
- package/dist/components/ds-message-composer.js +1 -1
- package/dist/components/ds-message-composer.js.map +1 -1
- package/dist/components/ds-message-scroller.js +1 -1
- package/dist/components/ds-message-scroller.js.map +1 -1
- package/dist/components/ds-message.js +1 -1
- package/dist/components/{ds-shell-mobile-nav.d.ts → ds-mobile-bar-nav.d.ts} +4 -4
- package/dist/components/ds-mobile-bar-nav.js +2 -0
- package/dist/components/ds-mobile-bar-nav.js.map +1 -0
- package/dist/components/ds-mobile-header.d.ts +11 -0
- package/dist/components/ds-mobile-header.js +2 -0
- package/dist/components/ds-mobile-header.js.map +1 -0
- package/dist/components/ds-mobile-section-switcher.d.ts +11 -0
- package/dist/components/ds-mobile-section-switcher.js +2 -0
- package/dist/components/ds-mobile-section-switcher.js.map +1 -0
- package/dist/components/{ds-shell-mobile-bar.d.ts → ds-mobile-sheet-nav.d.ts} +4 -4
- package/dist/components/ds-mobile-sheet-nav.js +2 -0
- package/dist/components/ds-mobile-sheet-nav.js.map +1 -0
- package/dist/components/ds-modal.js +1 -1
- package/dist/components/ds-modal.js.map +1 -1
- package/dist/components/ds-panel-nav.js +1 -1
- package/dist/components/ds-panel-nav.js.map +1 -1
- package/dist/components/ds-panel-sub-nav.js +1 -1
- package/dist/components/ds-panel-sub-nav.js.map +1 -1
- package/dist/components/ds-panel-tool-header.js +1 -1
- package/dist/components/ds-panel-tool-search.js +1 -1
- package/dist/components/ds-panel-tool-search.js.map +1 -1
- package/dist/components/ds-panel-tools.js +1 -1
- package/dist/components/ds-radio.js +1 -1
- package/dist/components/ds-radio.js.map +1 -1
- package/dist/components/ds-select-multi.js +1 -1
- package/dist/components/ds-select-multi.js.map +1 -1
- package/dist/components/ds-select.js +1 -1
- package/dist/components/ds-select.js.map +1 -1
- package/dist/components/ds-shell-app.js +1 -1
- package/dist/components/ds-shell-app.js.map +1 -1
- package/dist/components/ds-shell-gradient-picker.js +1 -1
- package/dist/components/ds-shell-gradient-picker.js.map +1 -1
- package/dist/components/ds-shell-gradient-swatch.js +1 -1
- package/dist/components/ds-shell-page.js +1 -1
- package/dist/components/ds-shell-page.js.map +1 -1
- package/dist/components/ds-shell-tools.js +1 -1
- package/dist/components/ds-shell-tools.js.map +1 -1
- package/dist/components/ds-skeleton.js +1 -1
- package/dist/components/ds-skeleton.js.map +1 -1
- package/dist/components/ds-swatch-picker.js +1 -1
- package/dist/components/ds-switch.js +1 -1
- package/dist/components/ds-tab-group.js +1 -1
- package/dist/components/ds-tag.js +1 -1
- package/dist/components/ds-tag.js.map +1 -1
- package/dist/components/ds-toast.js +1 -1
- package/dist/components/ds-toast.js.map +1 -1
- package/dist/components/ds-tooltip-data-viz.js +1 -1
- package/dist/components/ds-tooltip.js +1 -1
- package/dist/components/ds-typing-indicator.js +1 -1
- package/dist/components/p--bSkr_yn.js +2 -0
- package/dist/components/p--bSkr_yn.js.map +1 -0
- package/dist/components/p-46nk9-RO.js +2 -0
- package/dist/components/p-46nk9-RO.js.map +1 -0
- package/dist/components/{p-9dQQSgwT.js → p-BHYrsGBw.js} +2 -2
- package/dist/components/p-BY0PzkUp.js +2 -0
- package/dist/components/p-BgGP65Nn.js +2 -0
- package/dist/components/p-BgGP65Nn.js.map +1 -0
- package/dist/components/p-BkAMkjIR.js +2 -0
- package/dist/components/{p-Co8hD3P-.js.map → p-BkAMkjIR.js.map} +1 -1
- package/dist/components/p-BrusnEYP.js.map +1 -1
- package/dist/components/p-C2ym_Ich.js +2 -0
- package/dist/components/{p-Biz6xo-z.js → p-CFpWrYAH.js} +2 -2
- package/dist/components/p-CICGtu7H.js +2 -0
- package/dist/components/{p-CtD24EyI.js.map → p-CICGtu7H.js.map} +1 -1
- package/dist/components/p-CLzlL3G4.js +2 -0
- package/dist/components/p-CLzlL3G4.js.map +1 -0
- package/dist/components/p-CXcjwduV.js +2 -0
- package/dist/components/{p-BhxwpOH8.js.map → p-CXcjwduV.js.map} +1 -1
- package/dist/components/p-Ca-I2UnB.js +2 -0
- package/dist/components/p-Ca-I2UnB.js.map +1 -0
- package/dist/components/p-CaRyxTMz.js +2 -0
- package/dist/components/p-CaRyxTMz.js.map +1 -0
- package/dist/components/{p-g40DTeV8.js → p-CvKKmZJj.js} +2 -2
- package/dist/components/p-D4o2D1hk.js +2 -0
- package/dist/components/p-D4o2D1hk.js.map +1 -0
- package/dist/components/{p-DXnFhmZF.js → p-D9iN80yX.js} +2 -2
- package/dist/components/p-DD1Lgs7O.js +2 -0
- package/dist/components/p-DD1Lgs7O.js.map +1 -0
- package/dist/components/{p-DjPZxzIG.js → p-DQDpDYyF.js} +2 -2
- package/dist/components/p-DTea1Du7.js +2 -0
- package/dist/components/p-DTea1Du7.js.map +1 -0
- package/dist/components/p-DWdRSOBV.js +2 -0
- package/dist/components/{p-BPS9VExm.js.map → p-DWdRSOBV.js.map} +1 -1
- package/dist/components/p-DcFfilOX.js +2 -0
- package/dist/components/p-DcFfilOX.js.map +1 -0
- package/dist/components/p-Dg3xLna0.js +2 -0
- package/dist/components/{p-C_0Q8Cnp.js.map → p-Dg3xLna0.js.map} +1 -1
- package/dist/components/p-DvVW0hxm.js +2 -0
- package/dist/components/p-DvVW0hxm.js.map +1 -0
- package/dist/components/p-YtgcuJYx.js +2 -0
- package/dist/components/{p-PZ6R_nGI.js.map → p-YtgcuJYx.js.map} +1 -1
- package/dist/components/p-loq_--ce.js +2 -0
- package/dist/components/{p-NUNsefU1.js.map → p-loq_--ce.js.map} +1 -1
- package/dist/docs/components.json +3586 -3064
- package/dist/lib/shell/index.d.ts +1 -1
- package/dist/lib/shell/index.js +2 -1
- package/dist/lib/shell/index.js.map +2 -2
- package/dist/lib/shell/shell-responsive.d.ts +3 -3
- package/dist/lib/utils/index.d.ts +1 -0
- package/dist/lib/utils/index.js +8 -0
- package/dist/lib/utils/index.js.map +3 -3
- package/dist/lib/utils/required-validity.d.ts +14 -0
- package/dist/mcp-data/registry/agent-activity.json +2 -2
- package/dist/mcp-data/registry/badge.json +2 -2
- package/dist/mcp-data/registry/bar-nav.json +2 -2
- package/dist/mcp-data/registry/bar-title.json +2 -2
- package/dist/mcp-data/registry/bar-workflow.json +25 -4
- package/dist/mcp-data/registry/breadcrumb.json +2 -2
- package/dist/mcp-data/registry/button-unfilled.json +3 -3
- package/dist/mcp-data/registry/chart-legend.json +1 -1
- package/dist/mcp-data/registry/checkbox.json +1 -1
- package/dist/mcp-data/registry/conversation-list-item.json +4 -3
- package/dist/mcp-data/registry/conversation-list.json +4 -3
- package/dist/mcp-data/registry/input.json +1 -1
- package/dist/mcp-data/registry/loader.json +2 -2
- package/dist/mcp-data/registry/message-scroller.json +3 -2
- package/dist/mcp-data/registry/mobile-bar-nav.json +333 -0
- package/dist/mcp-data/registry/mobile-header.json +351 -0
- package/dist/mcp-data/registry/mobile-section-switcher.json +210 -0
- package/dist/mcp-data/registry/mobile-sheet-nav.json +317 -0
- package/dist/mcp-data/registry/panel-nav.json +2 -2
- package/dist/mcp-data/registry/panel-tools.json +2 -2
- package/dist/mcp-data/registry/radio.json +1 -1
- package/dist/mcp-data/registry/registry.json +1549 -1431
- package/dist/mcp-data/registry/select-multi.json +1 -1
- package/dist/mcp-data/registry/select.json +2 -2
- package/dist/mcp-data/registry/shell-app.json +17 -17
- package/dist/mcp-data/registry/shell-page.json +26 -7
- package/dist/mcp-data/registry/shell-tools.json +10 -7
- package/dist/mcp-data/registry/switch.json +1 -1
- package/dist/mcp-data/registry/toast.json +2 -2
- package/dist/react/components.d.ts +4 -3
- package/dist/react/components.js +4 -3
- package/dist/react/ds-mobile-bar-nav.d.ts +13 -0
- package/dist/react/ds-mobile-bar-nav.js +15 -0
- package/dist/react/ds-mobile-header.d.ts +13 -0
- package/dist/react/ds-mobile-header.js +15 -0
- package/dist/react/ds-mobile-section-switcher.d.ts +12 -0
- package/dist/react/ds-mobile-section-switcher.js +12 -0
- package/dist/react/ds-mobile-sheet-nav.d.ts +14 -0
- package/dist/react/ds-mobile-sheet-nav.js +16 -0
- package/dist/styles/control-elevation.css +40 -0
- package/dist/types/components/BarWorkflow/BarWorkflow.d.ts +6 -0
- package/dist/types/components/ButtonUnfilled/ButtonUnfilled.d.ts +1 -1
- package/dist/types/components/MobileBarNav/MobileBarNav.d.ts +26 -0
- package/dist/types/components/MobileBarNav/index.d.ts +4 -0
- package/dist/types/components/MobileBarNav/mobile-bar-nav-types.d.ts +5 -0
- package/dist/types/components/MobileHeader/MobileHeader.d.ts +39 -0
- package/dist/types/components/MobileHeader/index.d.ts +2 -0
- package/dist/types/components/MobileHeader/mobile-header-types.d.ts +5 -0
- package/dist/types/components/MobileSectionSwitcher/MobileSectionSwitcher.d.ts +35 -0
- package/dist/types/components/MobileSectionSwitcher/index.d.ts +3 -0
- package/dist/types/components/MobileSectionSwitcher/mobile-section-switcher-types.d.ts +4 -0
- package/dist/types/components/MobileSectionSwitcher/mobile-section-switcher-utils.d.ts +10 -0
- package/dist/types/components/{ShellMobileNav/ShellMobileNav.d.ts → MobileSheetNav/MobileSheetNav.d.ts} +5 -7
- package/dist/types/components/MobileSheetNav/index.d.ts +1 -0
- package/dist/types/components/ShellApp/ShellApp.d.ts +4 -4
- package/dist/types/components/ShellPage/ShellPage.d.ts +4 -0
- package/dist/types/components.d.ts +530 -381
- package/dist/types/shell/index.d.ts +1 -1
- package/dist/types/shell/shell-responsive.d.ts +3 -3
- package/dist/types/utils/index.d.ts +1 -0
- package/dist/types/utils/required-validity.d.ts +15 -0
- package/package.json +2 -1
- package/dist/angular/ds-shell-mobile-bar.d.ts +0 -18
- package/dist/angular/ds-shell-mobile-nav.d.ts +0 -23
- package/dist/angular/ds-shell-mobile-section-nav.d.ts +0 -18
- package/dist/components/ds-shell-mobile-bar.js +0 -2
- package/dist/components/ds-shell-mobile-bar.js.map +0 -1
- package/dist/components/ds-shell-mobile-nav.js +0 -2
- package/dist/components/ds-shell-mobile-nav.js.map +0 -1
- package/dist/components/ds-shell-mobile-section-nav.d.ts +0 -11
- package/dist/components/ds-shell-mobile-section-nav.js +0 -2
- package/dist/components/ds-shell-mobile-section-nav.js.map +0 -1
- package/dist/components/p-B6Vuayt6.js +0 -2
- package/dist/components/p-B6Vuayt6.js.map +0 -1
- package/dist/components/p-BPS9VExm.js +0 -2
- package/dist/components/p-BVV_rlIP.js +0 -2
- package/dist/components/p-BVV_rlIP.js.map +0 -1
- package/dist/components/p-BhxwpOH8.js +0 -2
- package/dist/components/p-BtEjlcB9.js +0 -2
- package/dist/components/p-BtEjlcB9.js.map +0 -1
- package/dist/components/p-CH6cNXXF.js +0 -2
- package/dist/components/p-CH6cNXXF.js.map +0 -1
- package/dist/components/p-C_0Q8Cnp.js +0 -2
- package/dist/components/p-Ce52yVXF.js +0 -2
- package/dist/components/p-Ce52yVXF.js.map +0 -1
- package/dist/components/p-CgHTNfC1.js +0 -2
- package/dist/components/p-CgHTNfC1.js.map +0 -1
- package/dist/components/p-Co8hD3P-.js +0 -2
- package/dist/components/p-CoYFJD-w.js +0 -2
- package/dist/components/p-CoYFJD-w.js.map +0 -1
- package/dist/components/p-Cpr3K41-.js +0 -2
- package/dist/components/p-Cpr3K41-.js.map +0 -1
- package/dist/components/p-CtD24EyI.js +0 -2
- package/dist/components/p-DYqReipj.js +0 -2
- package/dist/components/p-DYqReipj.js.map +0 -1
- package/dist/components/p-NUNsefU1.js +0 -2
- package/dist/components/p-PZ6R_nGI.js +0 -2
- package/dist/components/p-jCWtxthA.js +0 -2
- package/dist/components/p-yhj1lIPx.js +0 -2
- package/dist/mcp-data/registry/shell-mobile-bar.json +0 -314
- package/dist/mcp-data/registry/shell-mobile-nav.json +0 -348
- package/dist/mcp-data/registry/shell-mobile-section-nav.json +0 -267
- package/dist/react/ds-shell-mobile-bar.d.ts +0 -13
- package/dist/react/ds-shell-mobile-bar.js +0 -15
- package/dist/react/ds-shell-mobile-nav.d.ts +0 -15
- package/dist/react/ds-shell-mobile-nav.js +0 -17
- package/dist/react/ds-shell-mobile-section-nav.d.ts +0 -12
- package/dist/react/ds-shell-mobile-section-nav.js +0 -12
- package/dist/types/components/ShellMobileBar/ShellMobileBar.d.ts +0 -25
- package/dist/types/components/ShellMobileBar/index.d.ts +0 -4
- package/dist/types/components/ShellMobileBar/shell-mobile-bar-types.d.ts +0 -5
- package/dist/types/components/ShellMobileNav/index.d.ts +0 -2
- package/dist/types/components/ShellMobileNav/shell-mobile-nav-types.d.ts +0 -6
- package/dist/types/components/ShellMobileSectionNav/ShellMobileSectionNav.d.ts +0 -30
- package/dist/types/components/ShellMobileSectionNav/index.d.ts +0 -2
- /package/dist/components/{p-9dQQSgwT.js.map → p-BHYrsGBw.js.map} +0 -0
- /package/dist/components/{p-jCWtxthA.js.map → p-BY0PzkUp.js.map} +0 -0
- /package/dist/components/{p-yhj1lIPx.js.map → p-C2ym_Ich.js.map} +0 -0
- /package/dist/components/{p-Biz6xo-z.js.map → p-CFpWrYAH.js.map} +0 -0
- /package/dist/components/{p-g40DTeV8.js.map → p-CvKKmZJj.js.map} +0 -0
- /package/dist/components/{p-DXnFhmZF.js.map → p-D9iN80yX.js.map} +0 -0
- /package/dist/components/{p-DjPZxzIG.js.map → p-DQDpDYyF.js.map} +0 -0
|
@@ -1057,6 +1057,7 @@
|
|
|
1057
1057
|
],
|
|
1058
1058
|
"commonlyComposedWith": [
|
|
1059
1059
|
"component:ds-shell-page",
|
|
1060
|
+
"component:ds-mobile-header",
|
|
1060
1061
|
"component:ds-button-filled",
|
|
1061
1062
|
"component:ds-button-unfilled",
|
|
1062
1063
|
"component:ds-text",
|
|
@@ -1071,7 +1072,7 @@
|
|
|
1071
1072
|
"Use submitAction.type=submit inside a form so the final action preserves native submission semantics."
|
|
1072
1073
|
],
|
|
1073
1074
|
"states": [
|
|
1074
|
-
"BarWorkflow always renders compact 48px bold-brand chrome
|
|
1075
|
+
"BarWorkflow always renders compact 48px bold-brand chrome; responsiveMode changes only the action geometry, never workflow state or hierarchy.",
|
|
1075
1076
|
"An unrecognized value resolves navigation from the first step without mutating the controlled value.",
|
|
1076
1077
|
"The first step omits Previous. Intermediate steps show Previous and Next. The last step replaces Next with the Check Save or Submit action.",
|
|
1077
1078
|
"The default empty steps array is a single-step flow with the plain heading, no Previous control, and the final action visible. An explicit one-step array behaves the same way.",
|
|
@@ -1079,7 +1080,8 @@
|
|
|
1079
1080
|
"submitAction owns the final label, native button type, inactive state, and loading state."
|
|
1080
1081
|
],
|
|
1081
1082
|
"responsiveBehavior": [
|
|
1082
|
-
"
|
|
1083
|
+
"Desktop and tablet keep the established left-aligned identity and trailing actions.",
|
|
1084
|
+
"Mobile uses symmetric MobileHeader geometry with Exit leading, the title and step count centered, and Previous plus Next or Submit trailing.",
|
|
1083
1085
|
"The heading truncates before Exit, Previous, and Next or Submit lose their complete hit targets.",
|
|
1084
1086
|
"When slotted into ShellPage, BarWorkflow remains compact while ShellPage continues to provide sticky placement."
|
|
1085
1087
|
],
|
|
@@ -1133,6 +1135,10 @@
|
|
|
1133
1135
|
"type": "string",
|
|
1134
1136
|
"required": false
|
|
1135
1137
|
},
|
|
1138
|
+
"responsiveMode": {
|
|
1139
|
+
"type": "ShellResponsiveMode",
|
|
1140
|
+
"required": false
|
|
1141
|
+
},
|
|
1136
1142
|
"steps": {
|
|
1137
1143
|
"type": "BarWorkflowStep[]",
|
|
1138
1144
|
"required": false
|
|
@@ -1174,6 +1180,7 @@
|
|
|
1174
1180
|
"registryDependencies": [
|
|
1175
1181
|
"button-filled",
|
|
1176
1182
|
"button-unfilled",
|
|
1183
|
+
"mobile-header",
|
|
1177
1184
|
"text",
|
|
1178
1185
|
"tooltip"
|
|
1179
1186
|
]
|
|
@@ -3294,7 +3301,8 @@
|
|
|
3294
3301
|
"The default floating action stays at the lower end corner.",
|
|
3295
3302
|
"actionLayout footer stretches a long action between 8px side and bottom insets.",
|
|
3296
3303
|
"Both action layouts share the always-active scroll-overlay fade controller, reserve measured end clearance, and begin fading 8px before the visible action.",
|
|
3297
|
-
"ConversationList paints its measured fade on a separate surface-aware layer so contextual row actions retain a real backdrop for blur; hovered, focused, and menu-open rows rise above that decorative fade."
|
|
3304
|
+
"ConversationList paints its measured fade on a separate surface-aware layer so contextual row actions retain a real backdrop for blur; hovered, focused, and menu-open rows rise above that decorative fade.",
|
|
3305
|
+
"The persistent action wrapper splits its md outer shadow from a top inset-highlight overlay so opaque filled actions keep the complete TokoMo elevation; slotted controls must disable optional resting borders."
|
|
3298
3306
|
],
|
|
3299
3307
|
"responsiveBehavior": [
|
|
3300
3308
|
"The list fills its owner, scrolls independently, and keeps its persistent action above scrolling rows."
|
|
@@ -3367,7 +3375,8 @@
|
|
|
3367
3375
|
"Any positive unreadCount renders one dot on the title row rather than a visible counter; the accessible row name may still announce the exact unread quantity.",
|
|
3368
3376
|
"Hover and press use the shared interaction hover and pressed overlays. Only the selected conversation uses the persistent active fill.",
|
|
3369
3377
|
"The title uses body-medium, not title-small, and the body-small preview truncates after one line. Unread titles use emphasis with primary foreground; read titles use regular weight with secondary foreground.",
|
|
3370
|
-
"The actions slot overlays the row at an 8px right inset without changing title or preview measure, and paints above the row interaction wash while that wash remains active."
|
|
3378
|
+
"The actions slot overlays the row at an 8px right inset without changing title or preview measure, and paints above the row interaction wash while that wash remains active.",
|
|
3379
|
+
"Contextual actions use the shared md control-elevation wrapper so their transparent backdrop blur is unchanged while the split inset highlight remains above the borderless slotted action."
|
|
3371
3380
|
],
|
|
3372
3381
|
"responsiveBehavior": [
|
|
3373
3382
|
"Long titles and previews truncate without displacing trailing status."
|
|
@@ -4899,6 +4908,7 @@
|
|
|
4899
4908
|
"Selection and transcript interaction release automatic following.",
|
|
4900
4909
|
"Opening saved history, message jumps, and prepended history preserve deliberate position.",
|
|
4901
4910
|
"The scroll-to-latest action is absent at the live edge, appears only after the reader moves away, and disappears again after returning to the newest message.",
|
|
4911
|
+
"Scroll to latest uses the shared md control-elevation wrapper with a pointer-transparent top highlight, preserving its transparent backdrop blur and borderless unfilled action.",
|
|
4902
4912
|
"Place a composer container with 8px padding on every side in the overlay slot so messages scroll behind it; the shared scroll-overlay controller tracks every composer growth step, reserves matching transcript clearance, begins the fade 8px before the visible composer, and keeps scroll-to-latest above it."
|
|
4903
4913
|
],
|
|
4904
4914
|
"responsiveBehavior": [
|
|
@@ -4954,497 +4964,312 @@
|
|
|
4954
4964
|
]
|
|
4955
4965
|
},
|
|
4956
4966
|
{
|
|
4957
|
-
"name": "
|
|
4958
|
-
"title": "
|
|
4959
|
-
"description": "
|
|
4967
|
+
"name": "mobile-bar-nav",
|
|
4968
|
+
"title": "MobileBarNav",
|
|
4969
|
+
"description": "Persistent mobile shell navigation for Menu, the router-derived current area, Search, Agents, and Inbox.",
|
|
4960
4970
|
"type": "registry:ui",
|
|
4961
4971
|
"meta": {
|
|
4962
4972
|
"library": "@ds-mo/ui",
|
|
4963
4973
|
"distribution": "npm",
|
|
4964
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
4965
|
-
"source": "src/wc/components/
|
|
4974
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/mobile-bar-nav",
|
|
4975
|
+
"source": "src/wc/components/MobileBarNav/MobileBarNav.tsx",
|
|
4966
4976
|
"intentStatus": "complete",
|
|
4967
4977
|
"intent": {
|
|
4968
|
-
"audience": "
|
|
4969
|
-
"status": "
|
|
4970
|
-
"summary": "
|
|
4978
|
+
"audience": "specialized",
|
|
4979
|
+
"status": "experimental",
|
|
4980
|
+
"summary": "Persistent mobile shell navigation for Menu, the router-derived current area, Search, Agents, and Inbox.",
|
|
4971
4981
|
"useWhen": [
|
|
4972
|
-
"
|
|
4973
|
-
"A short blocking task or compact form needs dialog semantics, focus containment, and explicit completion actions.",
|
|
4974
|
-
"The content can be safely dismissed through Close, Escape, or the backdrop."
|
|
4982
|
+
"ShellApp is rendering its dedicated below-768px application composition."
|
|
4975
4983
|
],
|
|
4976
4984
|
"avoidWhen": [
|
|
4977
|
-
"
|
|
4978
|
-
"
|
|
4979
|
-
"The workflow is multi-step, long-form, or requires substantial navigation.",
|
|
4980
|
-
"Dismissal would lose work or leave an irreversible operation in an unsafe state.",
|
|
4981
|
-
"A second modal would be opened over an existing modal."
|
|
4982
|
-
],
|
|
4983
|
-
"alternatives": [
|
|
4984
|
-
{
|
|
4985
|
-
"when": "The user needs non-blocking feedback or a transient status message.",
|
|
4986
|
-
"component": "component:ds-toast",
|
|
4987
|
-
"reason": "Toast communicates transient status without trapping focus or blocking the page."
|
|
4988
|
-
},
|
|
4989
|
-
{
|
|
4990
|
-
"when": "A trigger reveals a short contextual list of commands.",
|
|
4991
|
-
"component": "component:ds-menu",
|
|
4992
|
-
"reason": "Menu provides anchored command semantics without creating a blocking dialog."
|
|
4993
|
-
},
|
|
4994
|
-
{
|
|
4995
|
-
"when": "Editable settings should remain visible without blocking the rest of the interface.",
|
|
4996
|
-
"component": "component:ds-card-setting",
|
|
4997
|
-
"reason": "CardSetting provides a persistent controlled settings workflow without modal focus containment."
|
|
4998
|
-
}
|
|
4985
|
+
"Rendering desktop or tablet shell chrome.",
|
|
4986
|
+
"An arbitrary set of product tabs is required."
|
|
4999
4987
|
],
|
|
5000
4988
|
"commonlyComposedWith": [
|
|
5001
|
-
"component:ds-
|
|
5002
|
-
|
|
5003
|
-
|
|
5004
|
-
"
|
|
4989
|
+
"component:ds-shell-app"
|
|
4990
|
+
],
|
|
4991
|
+
"patterns": [
|
|
4992
|
+
"pattern:application-shell"
|
|
5005
4993
|
],
|
|
5006
4994
|
"accessibility": [
|
|
5007
|
-
"
|
|
5008
|
-
"
|
|
5009
|
-
"Opening the native modal dialog moves focus to the header Close action, whose visible tooltip matches its accessible name, traps Tab navigation inside the top layer, and makes outside content inert.",
|
|
5010
|
-
"Close, Escape, and backdrop activation emit dsClose with close-button, escape, or backdrop reason before beginning dismissal; use the component only when every dismissal path is safe.",
|
|
5011
|
-
"After exit motion completes, the native dialog leaves the top layer, focus returns to the previously focused element, and dsAfterClose emits.",
|
|
5012
|
-
"Use visible label-only footer buttons. Keep at most two actions: one bold filled primary action followed by one bordered unfilled action, or two bordered unfilled actions.",
|
|
5013
|
-
"Use negative intent for a filled destructive action and state the irreversible consequence in the content.",
|
|
5014
|
-
"Do not open a modal from another modal; keep one blocking decision in focus at a time."
|
|
4995
|
+
"Every icon-only item keeps a localized accessible name.",
|
|
4996
|
+
"Only the active destination exposes aria-current; Menu exposes its controlled pane through aria-expanded."
|
|
5015
4997
|
],
|
|
5016
4998
|
"states": [
|
|
5017
|
-
"The
|
|
5018
|
-
"
|
|
5019
|
-
"
|
|
5020
|
-
"
|
|
5021
|
-
"The owner performs save, delete, cancel, and other product consequences before or while closing the modal."
|
|
4999
|
+
"The fixed groups are Menu plus current area, followed by Search, Inbox, and Agents.",
|
|
5000
|
+
"Selection promotes foreground to primary without painting a selected fill; unselected destinations use tertiary foreground.",
|
|
5001
|
+
"Opening Mobile Sheet Nav replaces the Menu glyph with Cross while preserving its accessible name.",
|
|
5002
|
+
"Reselecting an active destination does not reset its nested state."
|
|
5022
5003
|
],
|
|
5023
5004
|
"responsiveBehavior": [
|
|
5024
|
-
"
|
|
5025
|
-
"
|
|
5026
|
-
"Avoid layouts whose minimum content width exceeds the narrow viewport clamp.",
|
|
5027
|
-
"The native top layer escapes transformed ancestors, clipping containers, and application stacking contexts without moving slotted content."
|
|
5005
|
+
"Render only below the mobile breakpoint and preserve safe-area clearance.",
|
|
5006
|
+
"The two icon-only control groups remain centered with fixed 40px targets and a divider between Menu and current area."
|
|
5028
5007
|
],
|
|
5029
|
-
"frameworkCaveats": {
|
|
5030
|
-
"customElements": [
|
|
5031
|
-
"Set open as a JavaScript property when controlling the modal; inspect dsClose.detail.reason and use dsAfterClose for cleanup that must wait for exit motion and focus restoration.",
|
|
5032
|
-
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5033
|
-
"Footer actions are slotted application-owned controls and must implement their own product consequence."
|
|
5034
|
-
],
|
|
5035
|
-
"react": [
|
|
5036
|
-
"Pass open to DsModal, inspect onDsClose event detail, and use onDsAfterClose only for cleanup after exit motion and focus restoration.",
|
|
5037
|
-
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5038
|
-
"Assign footer controls with slot=\"footer\" and handle each action before updating open."
|
|
5039
|
-
],
|
|
5040
|
-
"angular": [
|
|
5041
|
-
"Bind [open], inspect $event.detail from (dsClose), and use (dsAfterClose) only for cleanup after exit motion and focus restoration.",
|
|
5042
|
-
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5043
|
-
"Assign footer controls with slot=\"footer\" and handle each action before updating open."
|
|
5044
|
-
]
|
|
5045
|
-
},
|
|
5046
5008
|
"references": [
|
|
5047
5009
|
{
|
|
5048
|
-
"label": "Storybook
|
|
5049
|
-
"path": "src/wc/components/
|
|
5050
|
-
},
|
|
5051
|
-
{
|
|
5052
|
-
"label": "Cross-browser focus, dismissal, geometry, and accessibility coverage",
|
|
5053
|
-
"path": "tests/e2e/accessibility-overlays.spec.ts"
|
|
5054
|
-
},
|
|
5055
|
-
{
|
|
5056
|
-
"label": "Reduced-motion overlay coverage",
|
|
5057
|
-
"path": "tests/e2e/reduced-motion.spec.ts"
|
|
5010
|
+
"label": "Storybook",
|
|
5011
|
+
"path": "src/wc/components/MobileBarNav/MobileBarNav.stories.ts"
|
|
5058
5012
|
}
|
|
5059
5013
|
]
|
|
5060
5014
|
},
|
|
5061
5015
|
"props": {
|
|
5062
|
-
"
|
|
5063
|
-
"type": "
|
|
5016
|
+
"activeDestination": {
|
|
5017
|
+
"type": "MobileDestination",
|
|
5064
5018
|
"required": false
|
|
5065
5019
|
},
|
|
5066
|
-
"
|
|
5020
|
+
"agentsDot": {
|
|
5021
|
+
"type": "boolean",
|
|
5022
|
+
"required": false
|
|
5023
|
+
},
|
|
5024
|
+
"agentsLabel": {
|
|
5067
5025
|
"type": "string",
|
|
5068
5026
|
"required": false
|
|
5069
5027
|
},
|
|
5070
|
-
"
|
|
5028
|
+
"currentArea": {
|
|
5029
|
+
"type": "PanelNavItem",
|
|
5030
|
+
"required": false
|
|
5031
|
+
},
|
|
5032
|
+
"helpLabel": {
|
|
5071
5033
|
"type": "string",
|
|
5072
|
-
"required":
|
|
5034
|
+
"required": false
|
|
5073
5035
|
},
|
|
5074
|
-
"
|
|
5075
|
-
"type": "
|
|
5036
|
+
"inboxDot": {
|
|
5037
|
+
"type": "boolean",
|
|
5076
5038
|
"required": false
|
|
5077
5039
|
},
|
|
5078
|
-
"
|
|
5040
|
+
"inboxLabel": {
|
|
5041
|
+
"type": "string",
|
|
5042
|
+
"required": false
|
|
5043
|
+
},
|
|
5044
|
+
"menuLabel": {
|
|
5045
|
+
"type": "string",
|
|
5046
|
+
"required": false
|
|
5047
|
+
},
|
|
5048
|
+
"searchDot": {
|
|
5049
|
+
"type": "boolean",
|
|
5050
|
+
"required": false
|
|
5051
|
+
},
|
|
5052
|
+
"searchLabel": {
|
|
5053
|
+
"type": "string",
|
|
5054
|
+
"required": false
|
|
5055
|
+
},
|
|
5056
|
+
"sheetNavExpanded": {
|
|
5079
5057
|
"type": "boolean",
|
|
5080
5058
|
"required": false
|
|
5081
5059
|
}
|
|
5082
5060
|
},
|
|
5083
5061
|
"events": [
|
|
5084
5062
|
{
|
|
5085
|
-
"name": "
|
|
5086
|
-
"detail": "
|
|
5063
|
+
"name": "dsDestinationChange",
|
|
5064
|
+
"detail": "MobileBarNavDestinationDetail"
|
|
5087
5065
|
},
|
|
5088
5066
|
{
|
|
5089
|
-
"name": "
|
|
5090
|
-
"detail": "
|
|
5067
|
+
"name": "dsSheetNavToggle",
|
|
5068
|
+
"detail": "boolean"
|
|
5091
5069
|
}
|
|
5092
5070
|
],
|
|
5093
5071
|
"slots": [],
|
|
5094
5072
|
"exports": {
|
|
5095
|
-
"customElement": "ds-
|
|
5096
|
-
"react": "
|
|
5097
|
-
"angular": "
|
|
5073
|
+
"customElement": "ds-mobile-bar-nav",
|
|
5074
|
+
"react": "DsMobileBarNav",
|
|
5075
|
+
"angular": "DsMobileBarNav"
|
|
5098
5076
|
}
|
|
5099
5077
|
},
|
|
5100
5078
|
"dependencies": [
|
|
5101
5079
|
"@ds-mo/ui",
|
|
5102
|
-
"@ds-mo/tokens"
|
|
5080
|
+
"@ds-mo/tokens",
|
|
5081
|
+
"@ds-mo/icons"
|
|
5103
5082
|
],
|
|
5104
5083
|
"registryDependencies": [
|
|
5105
|
-
"
|
|
5106
|
-
"
|
|
5107
|
-
"tooltip"
|
|
5084
|
+
"badge",
|
|
5085
|
+
"icon"
|
|
5108
5086
|
]
|
|
5109
5087
|
},
|
|
5110
5088
|
{
|
|
5111
|
-
"name": "
|
|
5112
|
-
"title": "
|
|
5113
|
-
"description": "
|
|
5089
|
+
"name": "mobile-header",
|
|
5090
|
+
"title": "MobileHeader",
|
|
5091
|
+
"description": "Consistent mobile top chrome with symmetric action lanes, a centered page identity or peer-section chooser, and an optional subordinate page-section row.",
|
|
5114
5092
|
"type": "registry:ui",
|
|
5115
5093
|
"meta": {
|
|
5116
5094
|
"library": "@ds-mo/ui",
|
|
5117
5095
|
"distribution": "npm",
|
|
5118
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
5119
|
-
"source": "src/wc/components/
|
|
5096
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/mobile-header",
|
|
5097
|
+
"source": "src/wc/components/MobileHeader/MobileHeader.tsx",
|
|
5120
5098
|
"intentStatus": "complete",
|
|
5121
5099
|
"intent": {
|
|
5122
5100
|
"audience": "specialized",
|
|
5123
|
-
"status": "
|
|
5124
|
-
"summary": "
|
|
5101
|
+
"status": "experimental",
|
|
5102
|
+
"summary": "Consistent mobile top chrome with symmetric action lanes, a centered page identity or peer-section chooser, and an optional subordinate page-section row.",
|
|
5125
5103
|
"useWhen": [
|
|
5126
|
-
"
|
|
5127
|
-
"Top-level destinations must remain consistently available while the application's page content changes.",
|
|
5128
|
-
"Primary destinations need visual grouping, icons, notification indicators, active-route state, and expanded or collapsed presentation."
|
|
5104
|
+
"A routed page, persistent tool, account surface, or workflow needs the canonical mobile header presentation."
|
|
5129
5105
|
],
|
|
5130
5106
|
"avoidWhen": [
|
|
5131
|
-
"
|
|
5132
|
-
"
|
|
5133
|
-
"The choices switch local content without changing the application's primary destination; use TabGroup instead.",
|
|
5134
|
-
"The interaction performs a command or presents temporary contextual choices; use a button or Menu instead.",
|
|
5135
|
-
"Building navigation below the mobile breakpoint; use the application's dedicated mobile navigation component instead."
|
|
5136
|
-
],
|
|
5137
|
-
"alternatives": [
|
|
5138
|
-
{
|
|
5139
|
-
"when": "The choices represent route sections within the active primary destination.",
|
|
5140
|
-
"component": "component:ds-bar-nav",
|
|
5141
|
-
"reason": "BarNav owns secondary section navigation within the destination selected by PanelNav."
|
|
5142
|
-
},
|
|
5143
|
-
{
|
|
5144
|
-
"when": "The choices switch local content without changing the application's primary destination.",
|
|
5145
|
-
"component": "component:ds-tab-group",
|
|
5146
|
-
"reason": "TabGroup owns local view selection and tab semantics."
|
|
5147
|
-
},
|
|
5148
|
-
{
|
|
5149
|
-
"when": "The choices are commands or temporary contextual actions.",
|
|
5150
|
-
"component": "component:ds-menu",
|
|
5151
|
-
"reason": "Menu owns transient action and option collections rather than persistent destinations."
|
|
5152
|
-
}
|
|
5107
|
+
"Rendering desktop BarTitle, BarNav, or PanelToolHeader.",
|
|
5108
|
+
"Rendering the Mobile Sheet Nav utility lane."
|
|
5153
5109
|
],
|
|
5154
5110
|
"commonlyComposedWith": [
|
|
5155
|
-
"component:ds-
|
|
5156
|
-
"component:ds-
|
|
5157
|
-
"component:ds-
|
|
5158
|
-
"component:ds-menu"
|
|
5111
|
+
"component:ds-mobile-section-switcher",
|
|
5112
|
+
"component:ds-shell-page",
|
|
5113
|
+
"component:ds-shell-tools"
|
|
5159
5114
|
],
|
|
5160
5115
|
"patterns": [
|
|
5161
5116
|
"pattern:application-shell"
|
|
5162
5117
|
],
|
|
5163
5118
|
"accessibility": [
|
|
5164
|
-
"
|
|
5165
|
-
"
|
|
5166
|
-
"
|
|
5167
|
-
"
|
|
5168
|
-
"When the destination body overflows, it becomes a localized keyboard-focusable scroll region in addition to the roving destination controls.",
|
|
5169
|
-
"Keep the standard dashboard/settings switch and user/account entry available in the footer."
|
|
5119
|
+
"Static screens render a real h1 or h2 according to headingLevel.",
|
|
5120
|
+
"Section-switching screens expose an equivalent semantic heading alongside the accessible popup trigger.",
|
|
5121
|
+
"Subsections use a separately named navigation landmark and never replace the semantic page identity.",
|
|
5122
|
+
"Leading and trailing slotted icon actions retain their own accessible names and tooltips."
|
|
5170
5123
|
],
|
|
5171
5124
|
"states": [
|
|
5172
|
-
"
|
|
5173
|
-
"
|
|
5174
|
-
"
|
|
5175
|
-
"
|
|
5176
|
-
"
|
|
5177
|
-
"The standard footer switches the entire destination collection and navStyle between Dashboard and Settings and exposes the user/account entry.",
|
|
5178
|
-
"The host owns the external user menu opened from dsNavUserAction.",
|
|
5179
|
-
"Item and header controls inherit the shared md control radius while local shell geometry continues to own collapsed layout and footer animation positioning.",
|
|
5180
|
-
"On desktop, allow user-controlled expand and collapse and persist the preference with storageKey when cross-session persistence is appropriate."
|
|
5125
|
+
"Without multiple sections the center renders heading.",
|
|
5126
|
+
"With multiple sections the center renders the controlled MobileSectionSwitcher.",
|
|
5127
|
+
"Optional subsections render in a second row and emit dsSubsectionChange without changing the primary section.",
|
|
5128
|
+
"Sections represent peer destinations at the current navigation level; subsections represent local views beneath the selected page or detail identity.",
|
|
5129
|
+
"Brand tone changes surface and foreground without changing geometry or interaction ownership."
|
|
5181
5130
|
],
|
|
5182
5131
|
"responsiveBehavior": [
|
|
5183
|
-
"
|
|
5184
|
-
"
|
|
5185
|
-
"Below 768px, the consuming application replaces PanelNav with a dedicated mobile navigation component; PanelNav does not own mobile navigation.",
|
|
5186
|
-
"ShellApp permanently owns responsive composition: it determines shell mode, enforces tablet collapse, and replaces PanelNav with future mobile navigation below 768px.",
|
|
5187
|
-
"When the viewport is below breakpoint, PanelNav locks collapsed, disables its header toggle affordance, and preserves the persisted desktop collapse preference.",
|
|
5188
|
-
"Collapsed presentation must preserve destination ordering, active state, notification status, and accessible names."
|
|
5132
|
+
"The primary 48px lane is dedicated to the below-768px presentation; optional subsections add one subordinate 48px lane.",
|
|
5133
|
+
"Equal flexible side lanes keep the center mathematically aligned when actions are asymmetric."
|
|
5189
5134
|
],
|
|
5190
|
-
"frameworkCaveats": {
|
|
5191
|
-
"customElements": [
|
|
5192
|
-
"Assign groups as a JavaScript property for structured data; a JSON string attribute is also supported.",
|
|
5193
|
-
"Set nav-style before the element connects when first-paint style must match the current route."
|
|
5194
|
-
],
|
|
5195
|
-
"react": [
|
|
5196
|
-
"Pass groups as an array through the generated React wrapper and synchronize currentUrl with the host router.",
|
|
5197
|
-
"ShellApp owns mobile replacement; PanelNav enforces its configured breakpoint expansion lock."
|
|
5198
|
-
],
|
|
5199
|
-
"angular": [
|
|
5200
|
-
"Import DsPanelNav from @ds-mo/ui/angular/ds-panel-nav and bind groups as a property.",
|
|
5201
|
-
"Bind both the nav-style attribute and navStyle property when first-paint route styling must be deterministic.",
|
|
5202
|
-
"ShellApp owns mobile replacement; PanelNav enforces its configured breakpoint expansion lock."
|
|
5203
|
-
]
|
|
5204
|
-
},
|
|
5205
5135
|
"references": [
|
|
5206
5136
|
{
|
|
5207
|
-
"label": "
|
|
5208
|
-
"path": "src/wc/components/
|
|
5209
|
-
},
|
|
5210
|
-
{
|
|
5211
|
-
"label": "Framework and routing integration",
|
|
5212
|
-
"path": "docs/framework-integration.md"
|
|
5213
|
-
},
|
|
5214
|
-
{
|
|
5215
|
-
"label": "Application shell composition",
|
|
5216
|
-
"path": "agent/patterns/application-shell/pattern.agent.json"
|
|
5137
|
+
"label": "Storybook",
|
|
5138
|
+
"path": "src/wc/components/MobileHeader/MobileHeader.stories.ts"
|
|
5217
5139
|
}
|
|
5218
5140
|
]
|
|
5219
5141
|
},
|
|
5220
5142
|
"props": {
|
|
5221
|
-
"
|
|
5143
|
+
"heading": {
|
|
5222
5144
|
"type": "string",
|
|
5223
5145
|
"required": false
|
|
5224
5146
|
},
|
|
5225
|
-
"
|
|
5226
|
-
"type": "
|
|
5147
|
+
"headingLevel": {
|
|
5148
|
+
"type": "MobileHeaderHeadingLevel",
|
|
5227
5149
|
"required": false
|
|
5228
5150
|
},
|
|
5229
|
-
"
|
|
5230
|
-
"type": "
|
|
5151
|
+
"sections": {
|
|
5152
|
+
"type": "TabItem[]",
|
|
5231
5153
|
"required": false
|
|
5232
5154
|
},
|
|
5233
|
-
"
|
|
5234
|
-
"type": "
|
|
5155
|
+
"sectionsAriaLabel": {
|
|
5156
|
+
"type": "string",
|
|
5235
5157
|
"required": false
|
|
5236
5158
|
},
|
|
5237
|
-
"
|
|
5159
|
+
"sectionsJson": {
|
|
5238
5160
|
"type": "string",
|
|
5239
5161
|
"required": false
|
|
5240
5162
|
},
|
|
5241
|
-
"
|
|
5242
|
-
"type": "
|
|
5163
|
+
"subsections": {
|
|
5164
|
+
"type": "TabItem[]",
|
|
5243
5165
|
"required": false
|
|
5244
5166
|
},
|
|
5245
|
-
"
|
|
5167
|
+
"subsectionsAriaLabel": {
|
|
5246
5168
|
"type": "string",
|
|
5247
5169
|
"required": false
|
|
5248
5170
|
},
|
|
5249
|
-
"
|
|
5171
|
+
"subsectionsJson": {
|
|
5250
5172
|
"type": "string",
|
|
5251
5173
|
"required": false
|
|
5252
5174
|
},
|
|
5253
|
-
"
|
|
5175
|
+
"subvalue": {
|
|
5254
5176
|
"type": "string",
|
|
5255
5177
|
"required": false
|
|
5256
5178
|
},
|
|
5257
|
-
"
|
|
5258
|
-
"type": "
|
|
5259
|
-
"required": false
|
|
5260
|
-
},
|
|
5261
|
-
"expandNavigationLabel": {
|
|
5262
|
-
"type": "string",
|
|
5263
|
-
"required": false
|
|
5264
|
-
},
|
|
5265
|
-
"groups": {
|
|
5266
|
-
"type": "string | PanelNavGroup[]",
|
|
5267
|
-
"required": false
|
|
5268
|
-
},
|
|
5269
|
-
"navStyle": {
|
|
5270
|
-
"type": "NavChromeStyle",
|
|
5271
|
-
"required": false
|
|
5272
|
-
},
|
|
5273
|
-
"navigationItemsLabel": {
|
|
5274
|
-
"type": "string",
|
|
5275
|
-
"required": false
|
|
5276
|
-
},
|
|
5277
|
-
"routerMode": {
|
|
5278
|
-
"type": "PanelNavRouterMode",
|
|
5279
|
-
"required": false
|
|
5280
|
-
},
|
|
5281
|
-
"settingsLabel": {
|
|
5282
|
-
"type": "string",
|
|
5283
|
-
"required": false
|
|
5284
|
-
},
|
|
5285
|
-
"settingsNavigationLabel": {
|
|
5286
|
-
"type": "string",
|
|
5287
|
-
"required": false
|
|
5288
|
-
},
|
|
5289
|
-
"storageKey": {
|
|
5290
|
-
"type": "string",
|
|
5291
|
-
"required": false
|
|
5292
|
-
},
|
|
5293
|
-
"userInitial": {
|
|
5294
|
-
"type": "string",
|
|
5179
|
+
"tone": {
|
|
5180
|
+
"type": "MobileHeaderTone",
|
|
5295
5181
|
"required": false
|
|
5296
5182
|
},
|
|
5297
|
-
"
|
|
5183
|
+
"value": {
|
|
5298
5184
|
"type": "string",
|
|
5299
5185
|
"required": false
|
|
5300
5186
|
}
|
|
5301
5187
|
},
|
|
5302
5188
|
"events": [
|
|
5303
5189
|
{
|
|
5304
|
-
"name": "
|
|
5305
|
-
"detail": "ChromeTransitionDetail"
|
|
5306
|
-
},
|
|
5307
|
-
{
|
|
5308
|
-
"name": "dsChromeTransitionStart",
|
|
5309
|
-
"detail": "ChromeTransitionDetail"
|
|
5310
|
-
},
|
|
5311
|
-
{
|
|
5312
|
-
"name": "dsNavFooterAction",
|
|
5313
|
-
"detail": "void"
|
|
5314
|
-
},
|
|
5315
|
-
{
|
|
5316
|
-
"name": "dsNavSelect",
|
|
5190
|
+
"name": "dsSectionChange",
|
|
5317
5191
|
"detail": "string"
|
|
5318
5192
|
},
|
|
5319
5193
|
{
|
|
5320
|
-
"name": "
|
|
5321
|
-
"detail": "
|
|
5322
|
-
},
|
|
5323
|
-
{
|
|
5324
|
-
"name": "dsNavUserAction",
|
|
5325
|
-
"detail": "PanelNavUserActionDetail"
|
|
5194
|
+
"name": "dsSubsectionChange",
|
|
5195
|
+
"detail": "string"
|
|
5326
5196
|
}
|
|
5327
5197
|
],
|
|
5328
5198
|
"slots": [],
|
|
5329
5199
|
"exports": {
|
|
5330
|
-
"customElement": "ds-
|
|
5331
|
-
"react": "
|
|
5332
|
-
"angular": "
|
|
5200
|
+
"customElement": "ds-mobile-header",
|
|
5201
|
+
"react": "DsMobileHeader",
|
|
5202
|
+
"angular": "DsMobileHeader"
|
|
5333
5203
|
}
|
|
5334
5204
|
},
|
|
5335
5205
|
"dependencies": [
|
|
5336
5206
|
"@ds-mo/ui",
|
|
5337
|
-
"@ds-mo/tokens"
|
|
5338
|
-
"@ds-mo/icons"
|
|
5207
|
+
"@ds-mo/tokens"
|
|
5339
5208
|
],
|
|
5340
5209
|
"registryDependencies": [
|
|
5341
|
-
"
|
|
5342
|
-
"
|
|
5343
|
-
"icon",
|
|
5344
|
-
"text",
|
|
5345
|
-
"tooltip"
|
|
5210
|
+
"mobile-section-switcher",
|
|
5211
|
+
"text"
|
|
5346
5212
|
]
|
|
5347
5213
|
},
|
|
5348
5214
|
{
|
|
5349
|
-
"name": "
|
|
5350
|
-
"title": "
|
|
5351
|
-
"description": "
|
|
5215
|
+
"name": "mobile-section-switcher",
|
|
5216
|
+
"title": "MobileSectionSwitcher",
|
|
5217
|
+
"description": "Controlled mobile section chooser showing the current section, adjacent-position hints, and a complete tap menu.",
|
|
5352
5218
|
"type": "registry:ui",
|
|
5353
5219
|
"meta": {
|
|
5354
5220
|
"library": "@ds-mo/ui",
|
|
5355
5221
|
"distribution": "npm",
|
|
5356
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
5357
|
-
"source": "src/wc/components/
|
|
5222
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/mobile-section-switcher",
|
|
5223
|
+
"source": "src/wc/components/MobileSectionSwitcher/MobileSectionSwitcher.tsx",
|
|
5358
5224
|
"intentStatus": "complete",
|
|
5359
5225
|
"intent": {
|
|
5360
|
-
"audience": "
|
|
5361
|
-
"status": "
|
|
5362
|
-
"summary": "
|
|
5226
|
+
"audience": "specialized",
|
|
5227
|
+
"status": "experimental",
|
|
5228
|
+
"summary": "Controlled mobile section chooser showing the current section, adjacent-position hints, and a complete tap menu.",
|
|
5363
5229
|
"useWhen": [
|
|
5364
|
-
"A
|
|
5365
|
-
"Each concise text label controls an immediately available tabpanel without changing application routes."
|
|
5230
|
+
"A mobile page or tool header must combine current-page identity with ordered peer-section navigation."
|
|
5366
5231
|
],
|
|
5367
5232
|
"avoidWhen": [
|
|
5368
|
-
"
|
|
5369
|
-
"
|
|
5370
|
-
"The choices navigate routes in application shell chrome; use PanelNav or BarNav instead.",
|
|
5371
|
-
"The choices are temporary commands or contextual options; use Menu instead.",
|
|
5372
|
-
"Rows need icons, subtext, notification dots, nested levels, or section headers."
|
|
5373
|
-
],
|
|
5374
|
-
"alternatives": [
|
|
5375
|
-
{
|
|
5376
|
-
"when": "Local panel choices fit a horizontal tab row.",
|
|
5377
|
-
"component": "component:ds-tab-group",
|
|
5378
|
-
"reason": "TabGroup is the horizontal local-view counterpart."
|
|
5379
|
-
},
|
|
5380
|
-
{
|
|
5381
|
-
"when": "The choices are primary application destinations.",
|
|
5382
|
-
"component": "component:ds-panel-nav",
|
|
5383
|
-
"reason": "PanelNav owns primary application navigation."
|
|
5384
|
-
},
|
|
5385
|
-
{
|
|
5386
|
-
"when": "The choices are secondary application routes.",
|
|
5387
|
-
"component": "component:ds-bar-nav",
|
|
5388
|
-
"reason": "BarNav owns route sections inside ShellApp."
|
|
5389
|
-
},
|
|
5390
|
-
{
|
|
5391
|
-
"when": "The choices are transient actions or options.",
|
|
5392
|
-
"component": "component:ds-menu",
|
|
5393
|
-
"reason": "Menu owns temporary popup collections."
|
|
5394
|
-
}
|
|
5233
|
+
"Rendering desktop BarNav.",
|
|
5234
|
+
"The destination collection is primary application navigation."
|
|
5395
5235
|
],
|
|
5396
5236
|
"commonlyComposedWith": [
|
|
5397
|
-
"component:ds-
|
|
5398
|
-
|
|
5237
|
+
"component:ds-mobile-header"
|
|
5238
|
+
],
|
|
5239
|
+
"patterns": [
|
|
5240
|
+
"pattern:application-shell"
|
|
5399
5241
|
],
|
|
5400
5242
|
"accessibility": [
|
|
5401
|
-
"
|
|
5402
|
-
"
|
|
5403
|
-
"
|
|
5404
|
-
"Always provide a valid selected item when enabled items exist so exactly one tab and panel are active.",
|
|
5405
|
-
"ArrowUp and ArrowDown move and activate selection; Home and End select the first and last available items.",
|
|
5406
|
-
"Do not use selected text weight as the selection cue; active fill and primary foreground communicate selection."
|
|
5243
|
+
"The trigger exposes the current section, popup relationship, and expanded state.",
|
|
5244
|
+
"Decorative previous and next position hints are hidden from assistive technology.",
|
|
5245
|
+
"The menu is always available so a future swipe gesture is never the only navigation mechanism."
|
|
5407
5246
|
],
|
|
5408
5247
|
"states": [
|
|
5409
|
-
"
|
|
5410
|
-
"
|
|
5411
|
-
"
|
|
5412
|
-
"Selection is singular and follows keyboard focus.",
|
|
5413
|
-
"The omitted default surface treatment is for primary and secondary parent surfaces and uses the brand-active selected fill; pass faint explicitly on faint surfaces to use the neutral active fill.",
|
|
5414
|
-
"Rows contain one text label only and do not express nested navigation or grouped hierarchy."
|
|
5248
|
+
"Selection is controlled and dsChange reports intent without mutating value.",
|
|
5249
|
+
"Dividers group menu items but never participate in previous or next resolution.",
|
|
5250
|
+
"The first and last selectable sections expose only the available neighboring direction."
|
|
5415
5251
|
],
|
|
5416
5252
|
"responsiveBehavior": [
|
|
5417
|
-
"
|
|
5418
|
-
"The consuming panel owns responsive adaptation and decides whether to reposition or replace the side rail."
|
|
5253
|
+
"Use only in the dedicated mobile header presentation."
|
|
5419
5254
|
],
|
|
5420
|
-
"
|
|
5421
|
-
|
|
5422
|
-
"
|
|
5423
|
-
"
|
|
5424
|
-
|
|
5425
|
-
|
|
5426
|
-
"Pass items as an array through the generated wrapper, keep value controlled, and use onDsChange to synchronize the visible panel."
|
|
5427
|
-
],
|
|
5428
|
-
"angular": [
|
|
5429
|
-
"Bind items and a valid value as properties, and handle dsChange to synchronize the visible panel."
|
|
5430
|
-
]
|
|
5431
|
-
}
|
|
5255
|
+
"references": [
|
|
5256
|
+
{
|
|
5257
|
+
"label": "Storybook",
|
|
5258
|
+
"path": "src/wc/components/MobileSectionSwitcher/MobileSectionSwitcher.stories.ts"
|
|
5259
|
+
}
|
|
5260
|
+
]
|
|
5432
5261
|
},
|
|
5433
5262
|
"props": {
|
|
5434
|
-
"
|
|
5435
|
-
"type": "string
|
|
5436
|
-
"required": false
|
|
5437
|
-
},
|
|
5438
|
-
"ariaLabelledby": {
|
|
5439
|
-
"type": "string | undefined",
|
|
5263
|
+
"navigationLabel": {
|
|
5264
|
+
"type": "string",
|
|
5440
5265
|
"required": false
|
|
5441
5266
|
},
|
|
5442
|
-
"
|
|
5443
|
-
"type": "
|
|
5267
|
+
"sections": {
|
|
5268
|
+
"type": "TabItem[]",
|
|
5444
5269
|
"required": false
|
|
5445
5270
|
},
|
|
5446
|
-
"
|
|
5447
|
-
"type": "
|
|
5271
|
+
"sectionsJson": {
|
|
5272
|
+
"type": "string",
|
|
5448
5273
|
"required": false
|
|
5449
5274
|
},
|
|
5450
5275
|
"value": {
|
|
@@ -5460,9 +5285,9 @@
|
|
|
5460
5285
|
],
|
|
5461
5286
|
"slots": [],
|
|
5462
5287
|
"exports": {
|
|
5463
|
-
"customElement": "ds-
|
|
5464
|
-
"react": "
|
|
5465
|
-
"angular": "
|
|
5288
|
+
"customElement": "ds-mobile-section-switcher",
|
|
5289
|
+
"react": "DsMobileSectionSwitcher",
|
|
5290
|
+
"angular": "DsMobileSectionSwitcher"
|
|
5466
5291
|
}
|
|
5467
5292
|
},
|
|
5468
5293
|
"dependencies": [
|
|
@@ -5470,388 +5295,391 @@
|
|
|
5470
5295
|
"@ds-mo/tokens"
|
|
5471
5296
|
],
|
|
5472
5297
|
"registryDependencies": [
|
|
5298
|
+
"menu",
|
|
5473
5299
|
"text"
|
|
5474
5300
|
]
|
|
5475
5301
|
},
|
|
5476
5302
|
{
|
|
5477
|
-
"name": "
|
|
5478
|
-
"title": "
|
|
5479
|
-
"description": "
|
|
5303
|
+
"name": "mobile-sheet-nav",
|
|
5304
|
+
"title": "MobileSheetNav",
|
|
5305
|
+
"description": "Full-height mobile navigation sheet with a single brand, context, and utility header above large primary destinations.",
|
|
5480
5306
|
"type": "registry:ui",
|
|
5481
5307
|
"meta": {
|
|
5482
5308
|
"library": "@ds-mo/ui",
|
|
5483
5309
|
"distribution": "npm",
|
|
5484
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
5485
|
-
"source": "src/wc/components/
|
|
5310
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/mobile-sheet-nav",
|
|
5311
|
+
"source": "src/wc/components/MobileSheetNav/MobileSheetNav.tsx",
|
|
5486
5312
|
"intentStatus": "complete",
|
|
5487
5313
|
"intent": {
|
|
5488
|
-
"audience": "
|
|
5314
|
+
"audience": "specialized",
|
|
5489
5315
|
"status": "experimental",
|
|
5490
|
-
"summary": "
|
|
5316
|
+
"summary": "Full-height mobile navigation sheet with a single brand, context, and utility header above large primary destinations.",
|
|
5491
5317
|
"useWhen": [
|
|
5492
|
-
"
|
|
5493
|
-
"A tool header needs a title with optional Back or Close navigation, menu, fullscreen, or other compact icon actions."
|
|
5318
|
+
"The mobile ShellApp Menu control needs to expose the complete primary navigation collection."
|
|
5494
5319
|
],
|
|
5495
5320
|
"avoidWhen": [
|
|
5496
|
-
"Rendering
|
|
5497
|
-
"
|
|
5321
|
+
"Rendering desktop PanelNav.",
|
|
5322
|
+
"Switching local page content."
|
|
5498
5323
|
],
|
|
5499
5324
|
"commonlyComposedWith": [
|
|
5500
|
-
"component:ds-
|
|
5325
|
+
"component:ds-shell-app",
|
|
5326
|
+
"component:ds-mobile-bar-nav"
|
|
5327
|
+
],
|
|
5328
|
+
"patterns": [
|
|
5329
|
+
"pattern:application-shell"
|
|
5501
5330
|
],
|
|
5502
5331
|
"accessibility": [
|
|
5503
|
-
"
|
|
5504
|
-
"
|
|
5332
|
+
"The sheet is a named navigation landmark and retains visible labels for every primary destination.",
|
|
5333
|
+
"Dashboard and Settings use icon-only tabs with localized accessible names; Help and Account use icon-only actions with matching tooltips.",
|
|
5334
|
+
"Escape requests dismissal and opening moves focus to the selected or first available area."
|
|
5505
5335
|
],
|
|
5506
5336
|
"states": [
|
|
5507
|
-
"
|
|
5508
|
-
"
|
|
5509
|
-
"Header chrome text is not selectable; actions remain keyboard focusable and interactive.",
|
|
5510
|
-
"Adjacent trailing actions keep the shared 4px control gap in drawer and fullscreen presentations.",
|
|
5511
|
-
"When fullscreen and overflow actions appear together, author fullscreen before overflow so Ellipses remains the rightmost action.",
|
|
5512
|
-
"PanelTools supplies application-owned actions and relays their ids through its shared dsHeaderAction event."
|
|
5337
|
+
"Dashboard and Settings change only the flat destination collection being browsed.",
|
|
5338
|
+
"Area, Help, and Account events express intent while the application owns navigation and product behavior."
|
|
5513
5339
|
],
|
|
5514
5340
|
"responsiveBehavior": [
|
|
5515
|
-
"The
|
|
5341
|
+
"The pane fills the mobile content stage while the bottom bar remains available."
|
|
5516
5342
|
],
|
|
5517
5343
|
"references": [
|
|
5518
5344
|
{
|
|
5519
|
-
"label": "
|
|
5520
|
-
"path": "src/wc/components/
|
|
5345
|
+
"label": "Storybook",
|
|
5346
|
+
"path": "src/wc/components/MobileSheetNav/MobileSheetNav.stories.ts"
|
|
5521
5347
|
}
|
|
5522
5348
|
]
|
|
5523
5349
|
},
|
|
5524
5350
|
"props": {
|
|
5525
|
-
"
|
|
5526
|
-
"type": "PanelToolsHeaderAction[]",
|
|
5527
|
-
"required": false
|
|
5528
|
-
},
|
|
5529
|
-
"backAriaLabel": {
|
|
5351
|
+
"accountLabel": {
|
|
5530
5352
|
"type": "string",
|
|
5531
5353
|
"required": false
|
|
5532
5354
|
},
|
|
5533
|
-
"
|
|
5534
|
-
"type": "
|
|
5355
|
+
"browseContext": {
|
|
5356
|
+
"type": "NavChromeStyle",
|
|
5535
5357
|
"required": false
|
|
5536
5358
|
},
|
|
5537
|
-
"
|
|
5359
|
+
"currentUrl": {
|
|
5538
5360
|
"type": "string",
|
|
5539
5361
|
"required": false
|
|
5540
5362
|
},
|
|
5541
|
-
"
|
|
5542
|
-
"type": "
|
|
5363
|
+
"dashboardGroups": {
|
|
5364
|
+
"type": "PanelNavGroup[]",
|
|
5543
5365
|
"required": false
|
|
5544
5366
|
},
|
|
5545
|
-
"
|
|
5546
|
-
"type": "string
|
|
5367
|
+
"dashboardLabel": {
|
|
5368
|
+
"type": "string",
|
|
5547
5369
|
"required": false
|
|
5548
5370
|
},
|
|
5549
|
-
"
|
|
5550
|
-
"type": "
|
|
5371
|
+
"helpLabel": {
|
|
5372
|
+
"type": "string",
|
|
5551
5373
|
"required": false
|
|
5552
5374
|
},
|
|
5553
|
-
"
|
|
5375
|
+
"navigationLabel": {
|
|
5554
5376
|
"type": "string",
|
|
5555
5377
|
"required": false
|
|
5556
5378
|
},
|
|
5557
|
-
"
|
|
5379
|
+
"open": {
|
|
5558
5380
|
"type": "boolean",
|
|
5559
5381
|
"required": false
|
|
5560
5382
|
},
|
|
5561
|
-
"
|
|
5562
|
-
"type": "
|
|
5383
|
+
"settingsGroups": {
|
|
5384
|
+
"type": "PanelNavGroup[]",
|
|
5385
|
+
"required": false
|
|
5386
|
+
},
|
|
5387
|
+
"settingsLabel": {
|
|
5388
|
+
"type": "string",
|
|
5563
5389
|
"required": false
|
|
5564
5390
|
}
|
|
5565
5391
|
},
|
|
5566
5392
|
"events": [
|
|
5567
5393
|
{
|
|
5568
|
-
"name": "
|
|
5569
|
-
"detail": "
|
|
5394
|
+
"name": "dsAreaSelect",
|
|
5395
|
+
"detail": "string"
|
|
5570
5396
|
},
|
|
5571
5397
|
{
|
|
5572
|
-
"name": "
|
|
5573
|
-
"detail": "
|
|
5398
|
+
"name": "dsBrowseContextChange",
|
|
5399
|
+
"detail": "NavChromeStyle"
|
|
5574
5400
|
},
|
|
5575
5401
|
{
|
|
5576
|
-
"name": "
|
|
5577
|
-
"detail": "
|
|
5402
|
+
"name": "dsClose",
|
|
5403
|
+
"detail": "void"
|
|
5578
5404
|
}
|
|
5579
5405
|
],
|
|
5580
5406
|
"slots": [],
|
|
5581
5407
|
"exports": {
|
|
5582
|
-
"customElement": "ds-
|
|
5583
|
-
"react": "
|
|
5584
|
-
"angular": "
|
|
5408
|
+
"customElement": "ds-mobile-sheet-nav",
|
|
5409
|
+
"react": "DsMobileSheetNav",
|
|
5410
|
+
"angular": "DsMobileSheetNav"
|
|
5585
5411
|
}
|
|
5586
5412
|
},
|
|
5587
5413
|
"dependencies": [
|
|
5588
5414
|
"@ds-mo/ui",
|
|
5589
|
-
"@ds-mo/tokens"
|
|
5415
|
+
"@ds-mo/tokens",
|
|
5416
|
+
"@ds-mo/icons"
|
|
5590
5417
|
],
|
|
5591
5418
|
"registryDependencies": [
|
|
5419
|
+
"badge",
|
|
5592
5420
|
"button-unfilled",
|
|
5421
|
+
"icon",
|
|
5422
|
+
"tab-group",
|
|
5593
5423
|
"text",
|
|
5594
5424
|
"tooltip"
|
|
5595
5425
|
]
|
|
5596
5426
|
},
|
|
5597
5427
|
{
|
|
5598
|
-
"name": "
|
|
5599
|
-
"title": "
|
|
5600
|
-
"description": "
|
|
5428
|
+
"name": "modal",
|
|
5429
|
+
"title": "Modal",
|
|
5430
|
+
"description": "Dismissible native top-layer dialog for a focused confirmation or short blocking task, with a fixed title-and-close header, composable content, and an optional two-action footer.",
|
|
5601
5431
|
"type": "registry:ui",
|
|
5602
5432
|
"meta": {
|
|
5603
5433
|
"library": "@ds-mo/ui",
|
|
5604
5434
|
"distribution": "npm",
|
|
5605
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
5606
|
-
"source": "src/wc/components/
|
|
5435
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/modal",
|
|
5436
|
+
"source": "src/wc/components/Modal/Modal.tsx",
|
|
5607
5437
|
"intentStatus": "complete",
|
|
5608
5438
|
"intent": {
|
|
5609
5439
|
"audience": "general",
|
|
5610
|
-
"status": "
|
|
5611
|
-
"summary": "
|
|
5440
|
+
"status": "stable",
|
|
5441
|
+
"summary": "Dismissible native top-layer dialog for a focused confirmation or short blocking task, with a fixed title-and-close header, composable content, and an optional two-action footer.",
|
|
5612
5442
|
"useWhen": [
|
|
5613
|
-
"
|
|
5614
|
-
"
|
|
5615
|
-
"The
|
|
5443
|
+
"The user must confirm or cancel one focused decision before returning to the underlying interface.",
|
|
5444
|
+
"A short blocking task or compact form needs dialog semantics, focus containment, and explicit completion actions.",
|
|
5445
|
+
"The content can be safely dismissed through Close, Escape, or the backdrop."
|
|
5616
5446
|
],
|
|
5617
5447
|
"avoidWhen": [
|
|
5618
|
-
"The
|
|
5619
|
-
"
|
|
5448
|
+
"The message is non-blocking feedback or a transient status update.",
|
|
5449
|
+
"The interaction is a contextual list of commands anchored to a trigger.",
|
|
5450
|
+
"The workflow is multi-step, long-form, or requires substantial navigation.",
|
|
5451
|
+
"Dismissal would lose work or leave an irreversible operation in an unsafe state.",
|
|
5452
|
+
"A second modal would be opened over an existing modal."
|
|
5453
|
+
],
|
|
5454
|
+
"alternatives": [
|
|
5455
|
+
{
|
|
5456
|
+
"when": "The user needs non-blocking feedback or a transient status message.",
|
|
5457
|
+
"component": "component:ds-toast",
|
|
5458
|
+
"reason": "Toast communicates transient status without trapping focus or blocking the page."
|
|
5459
|
+
},
|
|
5460
|
+
{
|
|
5461
|
+
"when": "A trigger reveals a short contextual list of commands.",
|
|
5462
|
+
"component": "component:ds-menu",
|
|
5463
|
+
"reason": "Menu provides anchored command semantics without creating a blocking dialog."
|
|
5464
|
+
},
|
|
5465
|
+
{
|
|
5466
|
+
"when": "Editable settings should remain visible without blocking the rest of the interface.",
|
|
5467
|
+
"component": "component:ds-card-setting",
|
|
5468
|
+
"reason": "CardSetting provides a persistent controlled settings workflow without modal focus containment."
|
|
5469
|
+
}
|
|
5620
5470
|
],
|
|
5621
5471
|
"commonlyComposedWith": [
|
|
5622
|
-
"component:ds-
|
|
5623
|
-
"component:ds-
|
|
5624
|
-
"component:ds-
|
|
5472
|
+
"component:ds-button-filled",
|
|
5473
|
+
"component:ds-button-unfilled",
|
|
5474
|
+
"component:ds-field",
|
|
5475
|
+
"component:ds-text"
|
|
5625
5476
|
],
|
|
5626
5477
|
"accessibility": [
|
|
5627
|
-
"Provide
|
|
5628
|
-
"
|
|
5629
|
-
"
|
|
5478
|
+
"Provide a concise visible heading; the component uses it as the dialog's accessible name.",
|
|
5479
|
+
"Give the primary explanatory copy a stable id and pass it through aria-describedby so assistive technology receives the decision context.",
|
|
5480
|
+
"Opening the native modal dialog moves focus to the header Close action, whose visible tooltip matches its accessible name, traps Tab navigation inside the top layer, and makes outside content inert.",
|
|
5481
|
+
"Close, Escape, and backdrop activation emit dsClose with close-button, escape, or backdrop reason before beginning dismissal; use the component only when every dismissal path is safe.",
|
|
5482
|
+
"After exit motion completes, the native dialog leaves the top layer, focus returns to the previously focused element, and dsAfterClose emits.",
|
|
5483
|
+
"Use visible label-only footer buttons. Keep at most two actions: one bold filled primary action followed by one bordered unfilled action, or two bordered unfilled actions.",
|
|
5484
|
+
"Use negative intent for a filled destructive action and state the irreversible consequence in the content.",
|
|
5485
|
+
"Do not open a modal from another modal; keep one blocking decision in focus at a time."
|
|
5630
5486
|
],
|
|
5631
5487
|
"states": [
|
|
5632
|
-
"The
|
|
5633
|
-
"The
|
|
5634
|
-
"The
|
|
5635
|
-
"
|
|
5636
|
-
"
|
|
5488
|
+
"The owner opens the modal through the open property and responds to the typed dsClose detail for application state synchronization or dismissal analytics.",
|
|
5489
|
+
"The component mutates open to false for Close, Escape, and backdrop dismissal while retaining its rendered surface through exit motion.",
|
|
5490
|
+
"The default slot owns task content; the named footer slot is optional and is hidden when no actions are assigned.",
|
|
5491
|
+
"Primary actions use a bold filled button with semantic intent. Secondary and cancel actions use bordered label-only unfilled buttons.",
|
|
5492
|
+
"The owner performs save, delete, cancel, and other product consequences before or while closing the modal."
|
|
5637
5493
|
],
|
|
5638
5494
|
"responsiveBehavior": [
|
|
5639
|
-
"
|
|
5495
|
+
"Choose the smallest sm, md, or lg width that fits the focused task; the top-layer dialog clamps to the viewport with token-based outer space.",
|
|
5496
|
+
"Content scrolls independently when needed while the 64px header and optional 64px footer remain fixed.",
|
|
5497
|
+
"Avoid layouts whose minimum content width exceeds the narrow viewport clamp.",
|
|
5498
|
+
"The native top layer escapes transformed ancestors, clipping containers, and application stacking contexts without moving slotted content."
|
|
5640
5499
|
],
|
|
5641
5500
|
"frameworkCaveats": {
|
|
5642
5501
|
"customElements": [
|
|
5643
|
-
"
|
|
5644
|
-
"
|
|
5502
|
+
"Set open as a JavaScript property when controlling the modal; inspect dsClose.detail.reason and use dsAfterClose for cleanup that must wait for exit motion and focus restoration.",
|
|
5503
|
+
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5504
|
+
"Footer actions are slotted application-owned controls and must implement their own product consequence."
|
|
5645
5505
|
],
|
|
5646
5506
|
"react": [
|
|
5647
|
-
"
|
|
5648
|
-
"
|
|
5507
|
+
"Pass open to DsModal, inspect onDsClose event detail, and use onDsAfterClose only for cleanup after exit motion and focus restoration.",
|
|
5508
|
+
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5509
|
+
"Assign footer controls with slot=\"footer\" and handle each action before updating open."
|
|
5649
5510
|
],
|
|
5650
5511
|
"angular": [
|
|
5651
|
-
"
|
|
5652
|
-
"
|
|
5512
|
+
"Bind [open], inspect $event.detail from (dsClose), and use (dsAfterClose) only for cleanup after exit motion and focus restoration.",
|
|
5513
|
+
"Connect the most relevant slotted explanatory text through aria-describedby.",
|
|
5514
|
+
"Assign footer controls with slot=\"footer\" and handle each action before updating open."
|
|
5653
5515
|
]
|
|
5654
5516
|
},
|
|
5655
5517
|
"references": [
|
|
5656
5518
|
{
|
|
5657
|
-
"label": "Storybook examples",
|
|
5658
|
-
"path": "src/wc/components/
|
|
5519
|
+
"label": "Storybook confirmation and footer examples",
|
|
5520
|
+
"path": "src/wc/components/Modal/Modal.stories.ts"
|
|
5521
|
+
},
|
|
5522
|
+
{
|
|
5523
|
+
"label": "Cross-browser focus, dismissal, geometry, and accessibility coverage",
|
|
5524
|
+
"path": "tests/e2e/accessibility-overlays.spec.ts"
|
|
5525
|
+
},
|
|
5526
|
+
{
|
|
5527
|
+
"label": "Reduced-motion overlay coverage",
|
|
5528
|
+
"path": "tests/e2e/reduced-motion.spec.ts"
|
|
5659
5529
|
}
|
|
5660
5530
|
]
|
|
5661
5531
|
},
|
|
5662
5532
|
"props": {
|
|
5663
|
-
"
|
|
5664
|
-
"type": "string",
|
|
5665
|
-
"required": false
|
|
5666
|
-
},
|
|
5667
|
-
"controls": {
|
|
5533
|
+
"ariaDescribedby": {
|
|
5668
5534
|
"type": "string | undefined",
|
|
5669
5535
|
"required": false
|
|
5670
5536
|
},
|
|
5671
|
-
"
|
|
5672
|
-
"type": "boolean",
|
|
5673
|
-
"required": false
|
|
5674
|
-
},
|
|
5675
|
-
"filterAriaLabel": {
|
|
5537
|
+
"closeAriaLabel": {
|
|
5676
5538
|
"type": "string",
|
|
5677
5539
|
"required": false
|
|
5678
5540
|
},
|
|
5679
|
-
"
|
|
5680
|
-
"type": "string | undefined",
|
|
5681
|
-
"required": false
|
|
5682
|
-
},
|
|
5683
|
-
"filterExpanded": {
|
|
5684
|
-
"type": "boolean",
|
|
5685
|
-
"required": false
|
|
5686
|
-
},
|
|
5687
|
-
"filterTriggerId": {
|
|
5541
|
+
"heading": {
|
|
5688
5542
|
"type": "string",
|
|
5689
|
-
"required":
|
|
5690
|
-
},
|
|
5691
|
-
"isInactive": {
|
|
5692
|
-
"type": "boolean",
|
|
5693
|
-
"required": false
|
|
5543
|
+
"required": true
|
|
5694
5544
|
},
|
|
5695
|
-
"
|
|
5696
|
-
"type": "string",
|
|
5545
|
+
"modalWidth": {
|
|
5546
|
+
"type": "ModalWidth | string",
|
|
5697
5547
|
"required": false
|
|
5698
5548
|
},
|
|
5699
|
-
"
|
|
5549
|
+
"open": {
|
|
5700
5550
|
"type": "boolean",
|
|
5701
5551
|
"required": false
|
|
5702
|
-
},
|
|
5703
|
-
"value": {
|
|
5704
|
-
"type": "string",
|
|
5705
|
-
"required": false
|
|
5706
5552
|
}
|
|
5707
5553
|
},
|
|
5708
5554
|
"events": [
|
|
5709
5555
|
{
|
|
5710
|
-
"name": "
|
|
5711
|
-
"detail": "string"
|
|
5712
|
-
},
|
|
5713
|
-
{
|
|
5714
|
-
"name": "dsClear",
|
|
5556
|
+
"name": "dsAfterClose",
|
|
5715
5557
|
"detail": "void"
|
|
5716
5558
|
},
|
|
5717
5559
|
{
|
|
5718
|
-
"name": "
|
|
5719
|
-
"detail": "
|
|
5560
|
+
"name": "dsClose",
|
|
5561
|
+
"detail": "ModalCloseDetail"
|
|
5720
5562
|
}
|
|
5721
5563
|
],
|
|
5722
5564
|
"slots": [],
|
|
5723
5565
|
"exports": {
|
|
5724
|
-
"customElement": "ds-
|
|
5725
|
-
"react": "
|
|
5726
|
-
"angular": "
|
|
5566
|
+
"customElement": "ds-modal",
|
|
5567
|
+
"react": "DsModal",
|
|
5568
|
+
"angular": "DsModal"
|
|
5727
5569
|
}
|
|
5728
5570
|
},
|
|
5729
5571
|
"dependencies": [
|
|
5730
5572
|
"@ds-mo/ui",
|
|
5731
|
-
"@ds-mo/tokens"
|
|
5732
|
-
"@ds-mo/icons"
|
|
5573
|
+
"@ds-mo/tokens"
|
|
5733
5574
|
],
|
|
5734
5575
|
"registryDependencies": [
|
|
5735
5576
|
"button-unfilled",
|
|
5736
|
-
"divider",
|
|
5737
|
-
"icon",
|
|
5738
5577
|
"text",
|
|
5739
5578
|
"tooltip"
|
|
5740
5579
|
]
|
|
5741
5580
|
},
|
|
5742
5581
|
{
|
|
5743
|
-
"name": "panel-
|
|
5744
|
-
"title": "
|
|
5745
|
-
"description": "
|
|
5582
|
+
"name": "panel-nav",
|
|
5583
|
+
"title": "PanelNav",
|
|
5584
|
+
"description": "The single persistent primary navigation for an application, providing grouped top-level destinations, active-route state, standard dashboard/settings switching, user access, and collapsible desktop and tablet presentation.",
|
|
5746
5585
|
"type": "registry:ui",
|
|
5747
5586
|
"meta": {
|
|
5748
5587
|
"library": "@ds-mo/ui",
|
|
5749
5588
|
"distribution": "npm",
|
|
5750
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-
|
|
5751
|
-
"source": "src/wc/components/
|
|
5589
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-nav",
|
|
5590
|
+
"source": "src/wc/components/PanelNav/PanelNav.tsx",
|
|
5752
5591
|
"intentStatus": "complete",
|
|
5753
5592
|
"intent": {
|
|
5754
5593
|
"audience": "specialized",
|
|
5755
5594
|
"status": "stable",
|
|
5756
|
-
"summary": "
|
|
5595
|
+
"summary": "The single persistent primary navigation for an application, providing grouped top-level destinations, active-route state, standard dashboard/settings switching, user access, and collapsible desktop and tablet presentation.",
|
|
5757
5596
|
"useWhen": [
|
|
5758
|
-
"
|
|
5759
|
-
"
|
|
5760
|
-
"
|
|
5597
|
+
"Building the one primary navigation surface for an application that uses the CompoMo system.",
|
|
5598
|
+
"Top-level destinations must remain consistently available while the application's page content changes.",
|
|
5599
|
+
"Primary destinations need visual grouping, icons, notification indicators, active-route state, and expanded or collapsed presentation."
|
|
5761
5600
|
],
|
|
5762
5601
|
"avoidWhen": [
|
|
5763
|
-
"
|
|
5764
|
-
"The
|
|
5765
|
-
"
|
|
5766
|
-
"
|
|
5767
|
-
"
|
|
5602
|
+
"A second navigation surface is needed within the same application; an application must have only one PanelNav.",
|
|
5603
|
+
"The choices represent sections within the active primary destination; use BarNav instead.",
|
|
5604
|
+
"The choices switch local content without changing the application's primary destination; use TabGroup instead.",
|
|
5605
|
+
"The interaction performs a command or presents temporary contextual choices; use a button or Menu instead.",
|
|
5606
|
+
"Building navigation below the mobile breakpoint; use the application's dedicated mobile navigation component instead."
|
|
5768
5607
|
],
|
|
5769
5608
|
"alternatives": [
|
|
5770
5609
|
{
|
|
5771
|
-
"when": "The
|
|
5772
|
-
"component": "component:ds-
|
|
5773
|
-
"reason": "
|
|
5610
|
+
"when": "The choices represent route sections within the active primary destination.",
|
|
5611
|
+
"component": "component:ds-bar-nav",
|
|
5612
|
+
"reason": "BarNav owns secondary section navigation within the destination selected by PanelNav."
|
|
5774
5613
|
},
|
|
5775
5614
|
{
|
|
5776
|
-
"when": "The
|
|
5777
|
-
"component": "component:ds-
|
|
5778
|
-
"reason": "
|
|
5615
|
+
"when": "The choices switch local content without changing the application's primary destination.",
|
|
5616
|
+
"component": "component:ds-tab-group",
|
|
5617
|
+
"reason": "TabGroup owns local view selection and tab semantics."
|
|
5779
5618
|
},
|
|
5780
5619
|
{
|
|
5781
|
-
"when": "
|
|
5620
|
+
"when": "The choices are commands or temporary contextual actions.",
|
|
5782
5621
|
"component": "component:ds-menu",
|
|
5783
|
-
"reason": "Menu owns transient
|
|
5622
|
+
"reason": "Menu owns transient action and option collections rather than persistent destinations."
|
|
5784
5623
|
}
|
|
5785
5624
|
],
|
|
5786
5625
|
"commonlyComposedWith": [
|
|
5787
5626
|
"component:ds-shell-app",
|
|
5788
|
-
"component:ds-
|
|
5789
|
-
"component:ds-
|
|
5627
|
+
"component:ds-bar-nav",
|
|
5628
|
+
"component:ds-panel-tools",
|
|
5629
|
+
"component:ds-menu"
|
|
5790
5630
|
],
|
|
5791
5631
|
"patterns": [
|
|
5792
5632
|
"pattern:application-shell"
|
|
5793
5633
|
],
|
|
5794
5634
|
"accessibility": [
|
|
5795
|
-
"
|
|
5796
|
-
"
|
|
5797
|
-
"
|
|
5798
|
-
"
|
|
5799
|
-
"
|
|
5800
|
-
"
|
|
5635
|
+
"Give every primary destination a concise visible label and an icon that supports rather than replaces that label.",
|
|
5636
|
+
"Provide localized dashboard, settings, account, navigation, collapse, and expand labels.",
|
|
5637
|
+
"Preserve accessible destination names when the panel is collapsed to icon-only presentation.",
|
|
5638
|
+
"Use notification dots as supplemental status and never as the only indication of important information.",
|
|
5639
|
+
"When the destination body overflows, it becomes a localized keyboard-focusable scroll region in addition to the roving destination controls.",
|
|
5640
|
+
"Keep the standard dashboard/settings switch and user/account entry available in the footer."
|
|
5801
5641
|
],
|
|
5802
5642
|
"states": [
|
|
5803
|
-
"
|
|
5804
|
-
"
|
|
5805
|
-
"
|
|
5806
|
-
"
|
|
5807
|
-
"
|
|
5808
|
-
"
|
|
5809
|
-
"The
|
|
5810
|
-
"
|
|
5811
|
-
"
|
|
5812
|
-
"Each tool supplies its current header title, base-versus-detail Back state, and right-side actions through the headers property. Base views omit Back; deeper views expose Back and update the same header in place.",
|
|
5813
|
-
"Header Back and action events express intent only; the owning tool changes product navigation, menus, and data state. PanelTools keeps the final header action exactly 8px from the drawer edge.",
|
|
5814
|
-
"Menus opened from a right-side header action use PANEL_TOOLS_HEADER_MENU_PLACEMENT: bottom/end choice-cell alignment and a 12px side offset, placing the popup 4px below the 48px header while aligning the final menu item edge with the trigger.",
|
|
5815
|
-
"Tool view roots stay transparent so ShellApp's chrome wash remains visible; only explicitly designed child surfaces introduce a fill.",
|
|
5816
|
-
"Tools with search compose ds-panel-tool-search immediately below the shared header. Its 48px row always contains the md search control and must not be reduced to sm or xs.",
|
|
5817
|
-
"If an active optional tool becomes unavailable, PanelTools closes the drawer, clears activeTool, and emits its deselection.",
|
|
5818
|
-
"Use isInactive only for a temporarily unavailable visible tool; omit tools the user is not authorized to access.",
|
|
5819
|
-
"The application owns slotted tool products and data while PanelTools owns rail ordering, drawer selection, open state, motion, and shell events.",
|
|
5820
|
-
"Opening and closing clip an already-rendered fixed-width surface. Header and tool content remain fully opaque and retained during width motion; transition completion is accepted only at the measured terminal clip width, after which the closed surface becomes inert and paint-skipped.",
|
|
5821
|
-
"Entering and exiting fullscreen snaps without borrowing the drawer open or close animation.",
|
|
5822
|
-
"When fullscreenHeaderMode is split, PanelTools suppresses only its fullscreen shared header. The application renders exactly two canonical ds-panel-tool-header instances: a tool-title/list-actions header over the 300px history pane and a chat-title/Exit-fullscreen/chat-actions header over the detail pane. The detail header omits Back because the list remains visible."
|
|
5643
|
+
"Render exactly one PanelNav per application; it owns primary application destinations and no other navigation role.",
|
|
5644
|
+
"The host router owns the current route; prefer currentUrl for active destination matching and use activeId only when route matching is unavailable.",
|
|
5645
|
+
"Use anchor mode for native links or routers that intercept anchors; use event mode when the host performs navigation from dsNavSelect.",
|
|
5646
|
+
"Groups visually organize top-level destinations only and must not be interpreted as nested or expandable navigation.",
|
|
5647
|
+
"Dashboard presents day-to-day operational destinations; Settings presents administrative and configuration destinations.",
|
|
5648
|
+
"The standard footer switches the entire destination collection and navStyle between Dashboard and Settings and exposes the user/account entry.",
|
|
5649
|
+
"The host owns the external user menu opened from dsNavUserAction.",
|
|
5650
|
+
"Item and header controls inherit the shared md control radius while local shell geometry continues to own collapsed layout and footer animation positioning.",
|
|
5651
|
+
"On desktop, allow user-controlled expand and collapse and persist the preference with storageKey when cross-session persistence is appropriate."
|
|
5823
5652
|
],
|
|
5824
5653
|
"responsiveBehavior": [
|
|
5825
|
-
"
|
|
5826
|
-
"
|
|
5827
|
-
"Below 768px,
|
|
5828
|
-
"
|
|
5829
|
-
"
|
|
5830
|
-
"
|
|
5654
|
+
"At 1200px and wider, default to expanded, allow the user to expand or collapse, and restore the locally persisted desktop preference when available.",
|
|
5655
|
+
"From 768px through 1199px, present PanelNav permanently collapsed and do not allow user expansion.",
|
|
5656
|
+
"Below 768px, the consuming application replaces PanelNav with a dedicated mobile navigation component; PanelNav does not own mobile navigation.",
|
|
5657
|
+
"ShellApp permanently owns responsive composition: it determines shell mode, enforces tablet collapse, and replaces PanelNav with future mobile navigation below 768px.",
|
|
5658
|
+
"When the viewport is below breakpoint, PanelNav locks collapsed, disables its header toggle affordance, and preserves the persisted desktop collapse preference.",
|
|
5659
|
+
"Collapsed presentation must preserve destination ordering, active state, notification status, and accessible names."
|
|
5831
5660
|
],
|
|
5832
5661
|
"frameworkCaveats": {
|
|
5833
5662
|
"customElements": [
|
|
5834
|
-
"Assign
|
|
5835
|
-
"
|
|
5836
|
-
"Keep PanelTools mounted at ShellApp scope across route changes and provide each product through its matching named slot."
|
|
5663
|
+
"Assign groups as a JavaScript property for structured data; a JSON string attribute is also supported.",
|
|
5664
|
+
"Set nav-style before the element connects when first-paint style must match the current route."
|
|
5837
5665
|
],
|
|
5838
5666
|
"react": [
|
|
5839
|
-
"Pass
|
|
5840
|
-
"
|
|
5667
|
+
"Pass groups as an array through the generated React wrapper and synchronize currentUrl with the host router.",
|
|
5668
|
+
"ShellApp owns mobile replacement; PanelNav enforces its configured breakpoint expansion lock."
|
|
5841
5669
|
],
|
|
5842
5670
|
"angular": [
|
|
5843
|
-
"Import
|
|
5844
|
-
"Bind
|
|
5845
|
-
"
|
|
5671
|
+
"Import DsPanelNav from @ds-mo/ui/angular/ds-panel-nav and bind groups as a property.",
|
|
5672
|
+
"Bind both the nav-style attribute and navStyle property when first-paint route styling must be deterministic.",
|
|
5673
|
+
"ShellApp owns mobile replacement; PanelNav enforces its configured breakpoint expansion lock."
|
|
5846
5674
|
]
|
|
5847
5675
|
},
|
|
5848
5676
|
"references": [
|
|
5849
5677
|
{
|
|
5850
5678
|
"label": "Executable Storybook examples",
|
|
5851
|
-
"path": "src/wc/components/
|
|
5679
|
+
"path": "src/wc/components/PanelNav/PanelNav.stories.ts"
|
|
5852
5680
|
},
|
|
5853
5681
|
{
|
|
5854
|
-
"label": "Framework and
|
|
5682
|
+
"label": "Framework and routing integration",
|
|
5855
5683
|
"path": "docs/framework-integration.md"
|
|
5856
5684
|
},
|
|
5857
5685
|
{
|
|
@@ -5861,47 +5689,83 @@
|
|
|
5861
5689
|
]
|
|
5862
5690
|
},
|
|
5863
5691
|
"props": {
|
|
5864
|
-
"
|
|
5865
|
-
"type": "
|
|
5692
|
+
"accountLabel": {
|
|
5693
|
+
"type": "string",
|
|
5866
5694
|
"required": false
|
|
5867
5695
|
},
|
|
5868
|
-
"
|
|
5869
|
-
"type": "
|
|
5696
|
+
"accountMenuExpanded": {
|
|
5697
|
+
"type": "boolean",
|
|
5870
5698
|
"required": false
|
|
5871
5699
|
},
|
|
5872
|
-
"
|
|
5873
|
-
"type": "
|
|
5700
|
+
"activeId": {
|
|
5701
|
+
"type": "string",
|
|
5874
5702
|
"required": false
|
|
5875
5703
|
},
|
|
5876
|
-
"
|
|
5704
|
+
"breakpoint": {
|
|
5705
|
+
"type": "number",
|
|
5706
|
+
"required": false
|
|
5707
|
+
},
|
|
5708
|
+
"collapseNavigationLabel": {
|
|
5877
5709
|
"type": "string",
|
|
5878
5710
|
"required": false
|
|
5879
5711
|
},
|
|
5880
|
-
"
|
|
5881
|
-
"type": "
|
|
5712
|
+
"collapsed": {
|
|
5713
|
+
"type": "boolean",
|
|
5882
5714
|
"required": false
|
|
5883
5715
|
},
|
|
5884
|
-
"
|
|
5716
|
+
"currentUrl": {
|
|
5885
5717
|
"type": "string",
|
|
5886
5718
|
"required": false
|
|
5887
5719
|
},
|
|
5888
|
-
"
|
|
5720
|
+
"dashboardLabel": {
|
|
5721
|
+
"type": "string",
|
|
5722
|
+
"required": false
|
|
5723
|
+
},
|
|
5724
|
+
"dashboardNavigationLabel": {
|
|
5725
|
+
"type": "string",
|
|
5726
|
+
"required": false
|
|
5727
|
+
},
|
|
5728
|
+
"disableViewTransition": {
|
|
5889
5729
|
"type": "boolean",
|
|
5890
5730
|
"required": false
|
|
5891
5731
|
},
|
|
5892
|
-
"
|
|
5893
|
-
"type": "
|
|
5732
|
+
"expandNavigationLabel": {
|
|
5733
|
+
"type": "string",
|
|
5734
|
+
"required": false
|
|
5735
|
+
},
|
|
5736
|
+
"groups": {
|
|
5737
|
+
"type": "string | PanelNavGroup[]",
|
|
5738
|
+
"required": false
|
|
5739
|
+
},
|
|
5740
|
+
"navStyle": {
|
|
5741
|
+
"type": "NavChromeStyle",
|
|
5742
|
+
"required": false
|
|
5743
|
+
},
|
|
5744
|
+
"navigationItemsLabel": {
|
|
5745
|
+
"type": "string",
|
|
5746
|
+
"required": false
|
|
5747
|
+
},
|
|
5748
|
+
"routerMode": {
|
|
5749
|
+
"type": "PanelNavRouterMode",
|
|
5750
|
+
"required": false
|
|
5751
|
+
},
|
|
5752
|
+
"settingsLabel": {
|
|
5753
|
+
"type": "string",
|
|
5754
|
+
"required": false
|
|
5755
|
+
},
|
|
5756
|
+
"settingsNavigationLabel": {
|
|
5757
|
+
"type": "string",
|
|
5894
5758
|
"required": false
|
|
5895
5759
|
},
|
|
5896
5760
|
"storageKey": {
|
|
5897
5761
|
"type": "string",
|
|
5898
5762
|
"required": false
|
|
5899
5763
|
},
|
|
5900
|
-
"
|
|
5764
|
+
"userInitial": {
|
|
5901
5765
|
"type": "string",
|
|
5902
5766
|
"required": false
|
|
5903
5767
|
},
|
|
5904
|
-
"
|
|
5768
|
+
"userName": {
|
|
5905
5769
|
"type": "string",
|
|
5906
5770
|
"required": false
|
|
5907
5771
|
}
|
|
@@ -5916,123 +5780,126 @@
|
|
|
5916
5780
|
"detail": "ChromeTransitionDetail"
|
|
5917
5781
|
},
|
|
5918
5782
|
{
|
|
5919
|
-
"name": "
|
|
5920
|
-
"detail": "
|
|
5783
|
+
"name": "dsNavFooterAction",
|
|
5784
|
+
"detail": "void"
|
|
5921
5785
|
},
|
|
5922
5786
|
{
|
|
5923
|
-
"name": "
|
|
5924
|
-
"detail": "
|
|
5787
|
+
"name": "dsNavSelect",
|
|
5788
|
+
"detail": "string"
|
|
5925
5789
|
},
|
|
5926
5790
|
{
|
|
5927
|
-
"name": "
|
|
5928
|
-
"detail": "
|
|
5791
|
+
"name": "dsNavToggle",
|
|
5792
|
+
"detail": "boolean"
|
|
5929
5793
|
},
|
|
5930
5794
|
{
|
|
5931
|
-
"name": "
|
|
5932
|
-
"detail": "
|
|
5795
|
+
"name": "dsNavUserAction",
|
|
5796
|
+
"detail": "PanelNavUserActionDetail"
|
|
5933
5797
|
}
|
|
5934
5798
|
],
|
|
5935
5799
|
"slots": [],
|
|
5936
5800
|
"exports": {
|
|
5937
|
-
"customElement": "ds-panel-
|
|
5938
|
-
"react": "
|
|
5939
|
-
"angular": "
|
|
5801
|
+
"customElement": "ds-panel-nav",
|
|
5802
|
+
"react": "DsPanelNav",
|
|
5803
|
+
"angular": "DsPanelNav"
|
|
5940
5804
|
}
|
|
5941
5805
|
},
|
|
5942
5806
|
"dependencies": [
|
|
5943
5807
|
"@ds-mo/ui",
|
|
5944
|
-
"@ds-mo/tokens"
|
|
5808
|
+
"@ds-mo/tokens",
|
|
5809
|
+
"@ds-mo/icons"
|
|
5945
5810
|
],
|
|
5946
5811
|
"registryDependencies": [
|
|
5812
|
+
"badge",
|
|
5947
5813
|
"button-unfilled",
|
|
5948
|
-
"
|
|
5814
|
+
"icon",
|
|
5815
|
+
"text",
|
|
5949
5816
|
"tooltip"
|
|
5950
5817
|
]
|
|
5951
5818
|
},
|
|
5952
5819
|
{
|
|
5953
|
-
"name": "
|
|
5954
|
-
"title": "
|
|
5955
|
-
"description": "
|
|
5820
|
+
"name": "panel-sub-nav",
|
|
5821
|
+
"title": "PanelSubNav",
|
|
5822
|
+
"description": "Persistent vertical tab navigation for a panel or card side rail, switching adjacent local content with menu-like selected fill and stable text weight.",
|
|
5956
5823
|
"type": "registry:ui",
|
|
5957
5824
|
"meta": {
|
|
5958
5825
|
"library": "@ds-mo/ui",
|
|
5959
5826
|
"distribution": "npm",
|
|
5960
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
5961
|
-
"source": "src/wc/components/
|
|
5827
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-sub-nav",
|
|
5828
|
+
"source": "src/wc/components/PanelSubNav/PanelSubNav.tsx",
|
|
5962
5829
|
"intentStatus": "complete",
|
|
5963
5830
|
"intent": {
|
|
5964
5831
|
"audience": "general",
|
|
5965
5832
|
"status": "stable",
|
|
5966
|
-
"summary": "
|
|
5833
|
+
"summary": "Persistent vertical tab navigation for a panel or card side rail, switching adjacent local content with menu-like selected fill and stable text weight.",
|
|
5967
5834
|
"useWhen": [
|
|
5968
|
-
"A
|
|
5969
|
-
"
|
|
5970
|
-
"A form needs one selected string value with native validation, reset, or external form association."
|
|
5835
|
+
"A panel or card side rail needs a persistent vertical list that switches adjacent local content.",
|
|
5836
|
+
"Each concise text label controls an immediately available tabpanel without changing application routes."
|
|
5971
5837
|
],
|
|
5972
5838
|
"avoidWhen": [
|
|
5973
|
-
"
|
|
5974
|
-
"
|
|
5975
|
-
"The
|
|
5839
|
+
"The navigation is not contained in a panel or card side rail.",
|
|
5840
|
+
"Local views should be arranged horizontally; use TabGroup instead.",
|
|
5841
|
+
"The choices navigate routes in application shell chrome; use PanelNav or BarNav instead.",
|
|
5842
|
+
"The choices are temporary commands or contextual options; use Menu instead.",
|
|
5843
|
+
"Rows need icons, subtext, notification dots, nested levels, or section headers."
|
|
5976
5844
|
],
|
|
5977
5845
|
"alternatives": [
|
|
5978
5846
|
{
|
|
5979
|
-
"when": "
|
|
5980
|
-
"component": "component:ds-
|
|
5981
|
-
"reason": "
|
|
5847
|
+
"when": "Local panel choices fit a horizontal tab row.",
|
|
5848
|
+
"component": "component:ds-tab-group",
|
|
5849
|
+
"reason": "TabGroup is the horizontal local-view counterpart."
|
|
5982
5850
|
},
|
|
5983
5851
|
{
|
|
5984
|
-
"when": "
|
|
5985
|
-
"component": "component:ds-
|
|
5986
|
-
"reason": "
|
|
5852
|
+
"when": "The choices are primary application destinations.",
|
|
5853
|
+
"component": "component:ds-panel-nav",
|
|
5854
|
+
"reason": "PanelNav owns primary application navigation."
|
|
5987
5855
|
},
|
|
5988
5856
|
{
|
|
5989
|
-
"when": "The
|
|
5990
|
-
"component": "component:ds-
|
|
5991
|
-
"reason": "
|
|
5857
|
+
"when": "The choices are secondary application routes.",
|
|
5858
|
+
"component": "component:ds-bar-nav",
|
|
5859
|
+
"reason": "BarNav owns route sections inside ShellApp."
|
|
5860
|
+
},
|
|
5861
|
+
{
|
|
5862
|
+
"when": "The choices are transient actions or options.",
|
|
5863
|
+
"component": "component:ds-menu",
|
|
5864
|
+
"reason": "Menu owns temporary popup collections."
|
|
5992
5865
|
}
|
|
5993
5866
|
],
|
|
5994
5867
|
"commonlyComposedWith": [
|
|
5995
|
-
"component:ds-
|
|
5868
|
+
"component:ds-card-setting",
|
|
5996
5869
|
"component:ds-text"
|
|
5997
5870
|
],
|
|
5998
5871
|
"accessibility": [
|
|
5999
|
-
"
|
|
6000
|
-
"
|
|
6001
|
-
"
|
|
6002
|
-
"
|
|
5872
|
+
"Provide an accessible name with aria-label or aria-labelledby.",
|
|
5873
|
+
"Give every item a unique id and the id of its controlled tabpanel.",
|
|
5874
|
+
"Keep each controlled tabpanel labelled by its matching item id.",
|
|
5875
|
+
"Always provide a valid selected item when enabled items exist so exactly one tab and panel are active.",
|
|
5876
|
+
"ArrowUp and ArrowDown move and activate selection; Home and End select the first and last available items.",
|
|
5877
|
+
"Do not use selected text weight as the selection cue; active fill and primary foreground communicate selection."
|
|
6003
5878
|
],
|
|
6004
5879
|
"states": [
|
|
6005
|
-
"
|
|
6006
|
-
"
|
|
6007
|
-
"
|
|
6008
|
-
"
|
|
5880
|
+
"The parent owns the canonical selected value and panel visibility, and should update both from dsChange.",
|
|
5881
|
+
"A missing, empty, or unknown selected value is invalid when enabled items exist; the component does not choose a fallback selection.",
|
|
5882
|
+
"Inactive items remain visible but cannot be focused or selected.",
|
|
5883
|
+
"Selection is singular and follows keyboard focus.",
|
|
5884
|
+
"The omitted default surface treatment is for primary and secondary parent surfaces and uses the brand-active selected fill; pass faint explicitly on faint surfaces to use the neutral active fill.",
|
|
5885
|
+
"Rows contain one text label only and do not express nested navigation or grouped hierarchy."
|
|
6009
5886
|
],
|
|
6010
5887
|
"responsiveBehavior": [
|
|
6011
|
-
"
|
|
6012
|
-
"
|
|
5888
|
+
"The component remains vertical at every width.",
|
|
5889
|
+
"The consuming panel owns responsive adaptation and decides whether to reposition or replace the side rail."
|
|
6013
5890
|
],
|
|
6014
5891
|
"frameworkCaveats": {
|
|
6015
5892
|
"customElements": [
|
|
6016
|
-
"Assign
|
|
6017
|
-
"
|
|
5893
|
+
"Assign items as a JavaScript property because structured arrays are not represented by HTML attributes.",
|
|
5894
|
+
"Keep value synchronized to a valid enabled item and update the controlled panel from dsChange."
|
|
6018
5895
|
],
|
|
6019
5896
|
"react": [
|
|
6020
|
-
"
|
|
5897
|
+
"Pass items as an array through the generated wrapper, keep value controlled, and use onDsChange to synchronize the visible panel."
|
|
6021
5898
|
],
|
|
6022
5899
|
"angular": [
|
|
6023
|
-
"
|
|
5900
|
+
"Bind items and a valid value as properties, and handle dsChange to synchronize the visible panel."
|
|
6024
5901
|
]
|
|
6025
|
-
}
|
|
6026
|
-
"references": [
|
|
6027
|
-
{
|
|
6028
|
-
"label": "Storybook examples",
|
|
6029
|
-
"path": "src/wc/components/Radio/Radio.stories.ts"
|
|
6030
|
-
},
|
|
6031
|
-
{
|
|
6032
|
-
"label": "Cross-browser form and accessibility coverage",
|
|
6033
|
-
"path": "tests/e2e/forms.spec.ts"
|
|
6034
|
-
}
|
|
6035
|
-
]
|
|
5902
|
+
}
|
|
6036
5903
|
},
|
|
6037
5904
|
"props": {
|
|
6038
5905
|
"ariaLabel": {
|
|
@@ -6043,40 +5910,12 @@
|
|
|
6043
5910
|
"type": "string | undefined",
|
|
6044
5911
|
"required": false
|
|
6045
5912
|
},
|
|
6046
|
-
"
|
|
6047
|
-
"type": "
|
|
6048
|
-
"required": false
|
|
6049
|
-
},
|
|
6050
|
-
"disabled": {
|
|
6051
|
-
"type": "boolean",
|
|
6052
|
-
"required": false
|
|
6053
|
-
},
|
|
6054
|
-
"form": {
|
|
6055
|
-
"type": "string | undefined",
|
|
6056
|
-
"required": false
|
|
6057
|
-
},
|
|
6058
|
-
"isInactive": {
|
|
6059
|
-
"type": "boolean",
|
|
6060
|
-
"required": false
|
|
6061
|
-
},
|
|
6062
|
-
"name": {
|
|
6063
|
-
"type": "string | undefined",
|
|
6064
|
-
"required": false
|
|
6065
|
-
},
|
|
6066
|
-
"options": {
|
|
6067
|
-
"type": "RadioOption[]",
|
|
6068
|
-
"required": false
|
|
6069
|
-
},
|
|
6070
|
-
"required": {
|
|
6071
|
-
"type": "boolean",
|
|
6072
|
-
"required": false
|
|
6073
|
-
},
|
|
6074
|
-
"requiredMessage": {
|
|
6075
|
-
"type": "string",
|
|
5913
|
+
"background": {
|
|
5914
|
+
"type": "PanelSubNavBackground | undefined",
|
|
6076
5915
|
"required": false
|
|
6077
5916
|
},
|
|
6078
|
-
"
|
|
6079
|
-
"type": "
|
|
5917
|
+
"items": {
|
|
5918
|
+
"type": "PanelSubNavItem[]",
|
|
6080
5919
|
"required": false
|
|
6081
5920
|
},
|
|
6082
5921
|
"value": {
|
|
@@ -6092,9 +5931,9 @@
|
|
|
6092
5931
|
],
|
|
6093
5932
|
"slots": [],
|
|
6094
5933
|
"exports": {
|
|
6095
|
-
"customElement": "ds-
|
|
6096
|
-
"react": "
|
|
6097
|
-
"angular": "
|
|
5934
|
+
"customElement": "ds-panel-sub-nav",
|
|
5935
|
+
"react": "DsPanelSubNav",
|
|
5936
|
+
"angular": "DsPanelSubNav"
|
|
6098
5937
|
}
|
|
6099
5938
|
},
|
|
6100
5939
|
"dependencies": [
|
|
@@ -6106,311 +5945,235 @@
|
|
|
6106
5945
|
]
|
|
6107
5946
|
},
|
|
6108
5947
|
{
|
|
6109
|
-
"name": "
|
|
6110
|
-
"title": "
|
|
6111
|
-
"description": "
|
|
5948
|
+
"name": "panel-tool-header",
|
|
5949
|
+
"title": "PanelToolHeader",
|
|
5950
|
+
"description": "Canonical left-aligned PanelTools header with an optional leading navigation or dismiss action and application-owned trailing icon actions.",
|
|
6112
5951
|
"type": "registry:ui",
|
|
6113
5952
|
"meta": {
|
|
6114
5953
|
"library": "@ds-mo/ui",
|
|
6115
5954
|
"distribution": "npm",
|
|
6116
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6117
|
-
"source": "src/wc/components/
|
|
5955
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-tool-header",
|
|
5956
|
+
"source": "src/wc/components/PanelToolHeader/PanelToolHeader.tsx",
|
|
6118
5957
|
"intentStatus": "complete",
|
|
6119
5958
|
"intent": {
|
|
6120
5959
|
"audience": "general",
|
|
6121
5960
|
"status": "experimental",
|
|
6122
|
-
"summary": "
|
|
5961
|
+
"summary": "Canonical left-aligned PanelTools header with an optional leading navigation or dismiss action and application-owned trailing icon actions.",
|
|
6123
5962
|
"useWhen": [
|
|
6124
|
-
"
|
|
6125
|
-
"
|
|
5963
|
+
"PanelTools needs its one shared root or detail header.",
|
|
5964
|
+
"A tool header needs a title with optional Back or Close navigation, menu, fullscreen, or other compact icon actions."
|
|
6126
5965
|
],
|
|
6127
5966
|
"avoidWhen": [
|
|
6128
|
-
"
|
|
6129
|
-
"
|
|
5967
|
+
"Rendering inside a PanelTools tool body; PanelTools already composes this canonical header above the body.",
|
|
5968
|
+
"The header belongs to page content."
|
|
6130
5969
|
],
|
|
6131
5970
|
"commonlyComposedWith": [
|
|
6132
|
-
"component:ds-button-
|
|
6133
|
-
"component:ds-message-composer"
|
|
5971
|
+
"component:ds-button-unfilled"
|
|
6134
5972
|
],
|
|
6135
5973
|
"accessibility": [
|
|
6136
|
-
"
|
|
6137
|
-
"
|
|
5974
|
+
"Leading navigation or dismiss actions and trailing icon actions require concise localized names; the header reuses each name as the action tooltip.",
|
|
5975
|
+
"The visible heading names the active panel or subview."
|
|
6138
5976
|
],
|
|
6139
5977
|
"states": [
|
|
6140
|
-
"The
|
|
6141
|
-
"
|
|
6142
|
-
"
|
|
5978
|
+
"The title remains left aligned whether the header has no actions, Back, one trailing action, or several trailing actions.",
|
|
5979
|
+
"Leading and trailing control zones never shrink; only the title consumes and truncates within the remaining width, with a fixed 4px gap between zones.",
|
|
5980
|
+
"Header chrome text is not selectable; actions remain keyboard focusable and interactive.",
|
|
5981
|
+
"Adjacent trailing actions keep the shared 4px control gap in drawer and fullscreen presentations.",
|
|
5982
|
+
"When fullscreen and overflow actions appear together, author fullscreen before overflow so Ellipses remains the rightmost action.",
|
|
5983
|
+
"PanelTools supplies application-owned actions and relays their ids through its shared dsHeaderAction event."
|
|
6143
5984
|
],
|
|
6144
5985
|
"responsiveBehavior": [
|
|
6145
|
-
"The
|
|
5986
|
+
"The title truncates between optional leading navigation and trailing action zones."
|
|
6146
5987
|
],
|
|
6147
|
-
"frameworkCaveats": {
|
|
6148
|
-
"customElements": [
|
|
6149
|
-
"Place scrollable content in the default slot and one footer wrapper in the overlay slot; use dsScroll only when the application needs position data."
|
|
6150
|
-
],
|
|
6151
|
-
"react": [
|
|
6152
|
-
"Use DsScrollOverlay with ordinary children plus an element carrying slot=\"overlay\"."
|
|
6153
|
-
],
|
|
6154
|
-
"angular": [
|
|
6155
|
-
"Import DsScrollOverlay and project the persistent footer wrapper with slot=\"overlay\"."
|
|
6156
|
-
]
|
|
6157
|
-
},
|
|
6158
5988
|
"references": [
|
|
6159
5989
|
{
|
|
6160
|
-
"label": "
|
|
6161
|
-
"path": "src/wc/components/
|
|
5990
|
+
"label": "Standalone examples",
|
|
5991
|
+
"path": "src/wc/components/PanelToolHeader/PanelToolHeader.stories.ts"
|
|
6162
5992
|
}
|
|
6163
5993
|
]
|
|
6164
5994
|
},
|
|
6165
5995
|
"props": {
|
|
6166
|
-
"
|
|
5996
|
+
"actions": {
|
|
5997
|
+
"type": "PanelToolsHeaderAction[]",
|
|
5998
|
+
"required": false
|
|
5999
|
+
},
|
|
6000
|
+
"backAriaLabel": {
|
|
6001
|
+
"type": "string",
|
|
6002
|
+
"required": false
|
|
6003
|
+
},
|
|
6004
|
+
"backIcon": {
|
|
6005
|
+
"type": "string",
|
|
6006
|
+
"required": false
|
|
6007
|
+
},
|
|
6008
|
+
"heading": {
|
|
6009
|
+
"type": "string",
|
|
6010
|
+
"required": false
|
|
6011
|
+
},
|
|
6012
|
+
"menuAriaLabel": {
|
|
6013
|
+
"type": "string",
|
|
6014
|
+
"required": false
|
|
6015
|
+
},
|
|
6016
|
+
"menuControls": {
|
|
6167
6017
|
"type": "string | undefined",
|
|
6168
6018
|
"required": false
|
|
6019
|
+
},
|
|
6020
|
+
"menuExpanded": {
|
|
6021
|
+
"type": "boolean",
|
|
6022
|
+
"required": false
|
|
6023
|
+
},
|
|
6024
|
+
"menuTriggerId": {
|
|
6025
|
+
"type": "string",
|
|
6026
|
+
"required": false
|
|
6027
|
+
},
|
|
6028
|
+
"showBack": {
|
|
6029
|
+
"type": "boolean",
|
|
6030
|
+
"required": false
|
|
6031
|
+
},
|
|
6032
|
+
"showMenu": {
|
|
6033
|
+
"type": "boolean",
|
|
6034
|
+
"required": false
|
|
6169
6035
|
}
|
|
6170
6036
|
},
|
|
6171
6037
|
"events": [
|
|
6172
6038
|
{
|
|
6173
|
-
"name": "
|
|
6174
|
-
"detail": "
|
|
6039
|
+
"name": "dsAction",
|
|
6040
|
+
"detail": "{ id: string; originalEvent: MouseEvent }"
|
|
6041
|
+
},
|
|
6042
|
+
{
|
|
6043
|
+
"name": "dsBack",
|
|
6044
|
+
"detail": "MouseEvent"
|
|
6045
|
+
},
|
|
6046
|
+
{
|
|
6047
|
+
"name": "dsMenuToggle",
|
|
6048
|
+
"detail": "MouseEvent"
|
|
6175
6049
|
}
|
|
6176
6050
|
],
|
|
6177
6051
|
"slots": [],
|
|
6178
6052
|
"exports": {
|
|
6179
|
-
"customElement": "ds-
|
|
6180
|
-
"react": "
|
|
6181
|
-
"angular": "
|
|
6053
|
+
"customElement": "ds-panel-tool-header",
|
|
6054
|
+
"react": "DsPanelToolHeader",
|
|
6055
|
+
"angular": "DsPanelToolHeader"
|
|
6182
6056
|
}
|
|
6183
6057
|
},
|
|
6184
6058
|
"dependencies": [
|
|
6185
6059
|
"@ds-mo/ui",
|
|
6186
6060
|
"@ds-mo/tokens"
|
|
6187
6061
|
],
|
|
6188
|
-
"registryDependencies": [
|
|
6062
|
+
"registryDependencies": [
|
|
6063
|
+
"button-unfilled",
|
|
6064
|
+
"text",
|
|
6065
|
+
"tooltip"
|
|
6066
|
+
]
|
|
6189
6067
|
},
|
|
6190
6068
|
{
|
|
6191
|
-
"name": "
|
|
6192
|
-
"title": "
|
|
6193
|
-
"description": "
|
|
6069
|
+
"name": "panel-tool-search",
|
|
6070
|
+
"title": "PanelToolSearch",
|
|
6071
|
+
"description": "Transparent search row for the top of a PanelTools product view, with a fixed 48px allocation around the standard md search control and an optional filter-menu trigger.",
|
|
6194
6072
|
"type": "registry:ui",
|
|
6195
6073
|
"meta": {
|
|
6196
6074
|
"library": "@ds-mo/ui",
|
|
6197
6075
|
"distribution": "npm",
|
|
6198
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6199
|
-
"source": "src/wc/components/
|
|
6076
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-tool-search",
|
|
6077
|
+
"source": "src/wc/components/PanelToolSearch/PanelToolSearch.tsx",
|
|
6200
6078
|
"intentStatus": "complete",
|
|
6201
6079
|
"intent": {
|
|
6202
6080
|
"audience": "general",
|
|
6203
|
-
"status": "
|
|
6204
|
-
"summary": "
|
|
6081
|
+
"status": "experimental",
|
|
6082
|
+
"summary": "Transparent search row for the top of a PanelTools product view, with a fixed 48px allocation around the standard md search control and an optional filter-menu trigger.",
|
|
6205
6083
|
"useWhen": [
|
|
6206
|
-
"
|
|
6207
|
-
"
|
|
6208
|
-
"The
|
|
6209
|
-
"The selected value must participate in native, Angular, or React form state."
|
|
6084
|
+
"A PanelTools base view filters or searches the tool's own content.",
|
|
6085
|
+
"Several tool products need the same search-row geometry directly below the shared PanelTools header.",
|
|
6086
|
+
"The product needs a compact filter menu next to search while keeping its filter choices and matching policy application-owned."
|
|
6210
6087
|
],
|
|
6211
6088
|
"avoidWhen": [
|
|
6212
|
-
"
|
|
6213
|
-
"
|
|
6214
|
-
"The choices form a hierarchy with expandable parents."
|
|
6215
|
-
],
|
|
6216
|
-
"alternatives": [
|
|
6217
|
-
{
|
|
6218
|
-
"when": "Several independent values may be selected.",
|
|
6219
|
-
"component": "component:ds-select-multi",
|
|
6220
|
-
"reason": "SelectMulti owns array values, multi-selection semantics, and count presentation."
|
|
6221
|
-
},
|
|
6222
|
-
{
|
|
6223
|
-
"when": "The popup contains commands or state-changing actions.",
|
|
6224
|
-
"component": "component:ds-menu",
|
|
6225
|
-
"reason": "Menu uses action-menu roles and command-focused keyboard behavior."
|
|
6226
|
-
},
|
|
6227
|
-
{
|
|
6228
|
-
"when": "A small set of choices should remain visible.",
|
|
6229
|
-
"component": "component:ds-radio",
|
|
6230
|
-
"reason": "Prefer Radio for roughly two to five mutually exclusive choices when the available space allows all choices to remain visible."
|
|
6231
|
-
}
|
|
6089
|
+
"The search belongs inside a Select or SelectMulti popup; use that component's searchable behavior.",
|
|
6090
|
+
"A form needs a labelled standalone field; compose ds-input inside ds-field instead."
|
|
6232
6091
|
],
|
|
6233
6092
|
"commonlyComposedWith": [
|
|
6234
|
-
"component:ds-
|
|
6235
|
-
"component:ds-
|
|
6236
|
-
"component:ds-
|
|
6237
|
-
"component:ds-loader"
|
|
6093
|
+
"component:ds-panel-tools",
|
|
6094
|
+
"component:ds-conversation-list",
|
|
6095
|
+
"component:ds-input"
|
|
6238
6096
|
],
|
|
6239
6097
|
"accessibility": [
|
|
6240
|
-
"
|
|
6241
|
-
"The
|
|
6242
|
-
"
|
|
6243
|
-
"Keyboard navigation keeps the aria-activedescendant option scrolled into the visible listbox viewport.",
|
|
6244
|
-
"Selected options rely on active fill and foreground treatment without a redundant trailing check icon.",
|
|
6245
|
-
"Local search moves focus into the search field while preserving the active option through aria-activedescendant.",
|
|
6246
|
-
"Use errorMessage with error so the trigger is described by the rendered alert."
|
|
6098
|
+
"Provide an aria-label that names the searched domain, such as Search agent chats or Search messages.",
|
|
6099
|
+
"The standard search clear action restores focus, uses the concise localized clearLabel by itself for both its tooltip and accessible name, and emits both the empty query and dsClear.",
|
|
6100
|
+
"When showFilter is enabled, provide stable filterTriggerId and filterControls values, synchronize filterExpanded with the controlled menu, and restore focus after selection; filterAriaLabel also labels its tooltip."
|
|
6247
6101
|
],
|
|
6248
6102
|
"states": [
|
|
6249
|
-
"
|
|
6250
|
-
"
|
|
6251
|
-
"
|
|
6252
|
-
"
|
|
6253
|
-
"
|
|
6254
|
-
"The trigger label stays left-aligned at every width. The default size is md in both forms and filter bars; smaller sizes require an explicit density need.",
|
|
6255
|
-
"Use option icons only when they help users differentiate choices. Icons render only when every option in the complete list provides one; mixed icon data falls back to the text-only row layout.",
|
|
6256
|
-
"Create sections only for categories that are meaningful to customers, not merely to break a long list into arbitrary chunks.",
|
|
6257
|
-
"When any option supplies subtext, every row uses the same subtext structure and missing values render an em dash. Subtext should disambiguate or add decision-helpful information.",
|
|
6258
|
-
"Option labels and the selected trigger label stay on one line and truncate when constrained. Option subtext may wrap to at most two lines.",
|
|
6259
|
-
"The optional prefix icon and chevron always use the parent surface's secondary foreground color, including when a selected value promotes the label to primary.",
|
|
6260
|
-
"The shared popup search control stays md at every trigger size, using body-medium text, a 20px icon, and the same internal spacing as a borderless Select trigger. Its container uses menu-item padding on every side and owns a 1px bottom divider that becomes a 1.5px bold-brand stroke while search has focus. Search placeholder text is secondary at rest and quaternary while focused because it becomes decorative once the editable field is active.",
|
|
6261
|
-
"When search contains text, the shared control shows a rounded sm icon-only ButtonUnfilled with the CrossCircle icon and no border. It clears the local term, stays hidden for an empty term, and returns focus to search.",
|
|
6262
|
-
"The shared clear footer mirrors the search region's sizing: menu-item padding surrounds an md-height borderless row, and the Clear label uses the same row and label insets as option text. The outer footer owns a 1px top divider.",
|
|
6263
|
-
"An empty filtered list composes the message-only body variant of EmptyState. Keep the default neutral no-results message unless localized product guidance makes the outcome clearer.",
|
|
6264
|
-
"Enable searchable for more than roughly 20 options, user-managed listings, large domains such as addresses, or sets users cannot efficiently scan. Local matching includes option labels, subtext, and section headings; the owner resolves remote data before assigning options.",
|
|
6265
|
-
"Validation timing belongs to the form owner and may be immediate or deferred until blur or submit; the Select exposes validity and error presentation without imposing that policy.",
|
|
6266
|
-
"The error trigger uses a 1.5px bold-negative inset stroke so invalid state remains distinguishable from the normal 1px border without changing control geometry.",
|
|
6267
|
-
"An initially empty option set is not an expected Select use case. The no-results state describes a search with no matches, not a source with no choices.",
|
|
6268
|
-
"Use options for a flat list or sections for grouped choices; when sections are present they take precedence.",
|
|
6269
|
-
"The background prop describes the actual parent surface and uses the same surface set as ButtonUnfilled."
|
|
6103
|
+
"The row is always 48px high with 8px outer padding and a complete md search recipe: 32px control, text-body-medium at 14px/20px, and a 20px md search icon.",
|
|
6104
|
+
"The search icon stays foreground-secondary at rest, hover, focus, active, and while the query is filled.",
|
|
6105
|
+
"The row and control surface remain transparent so the ShellApp chrome wash is visible behind them.",
|
|
6106
|
+
"The row divider remains the same tertiary 1px boundary while the input is focused because it belongs to the 48px container rather than the input control.",
|
|
6107
|
+
"With filtering enabled, the md search control, decorative vertical divider, and borderless md Filter action are separated by 8px; filterActive promotes only the trigger foreground without adding a selected fill."
|
|
6270
6108
|
],
|
|
6271
6109
|
"responsiveBehavior": [
|
|
6272
|
-
"
|
|
6273
|
-
"The popup matches the trigger minimum width, may grow for content, and clamps to the viewport.",
|
|
6274
|
-
"Long option collections scroll inside the popup; virtualization and remote search are not part of this component."
|
|
6110
|
+
"The row fills the available drawer or fullscreen width, allows its search region to shrink inside a 300px drawer without pushing the filter trigger under the tool rail, and does not reduce its control below md density."
|
|
6275
6111
|
],
|
|
6276
6112
|
"frameworkCaveats": {
|
|
6277
6113
|
"customElements": [
|
|
6278
|
-
"
|
|
6114
|
+
"Listen for dsChange to receive the current string query and dsClear when the clear action is used.",
|
|
6115
|
+
"Listen for dsFilterToggle and pair the trigger with an externally controlled ds-menu; product-specific filter labels and filtering remain outside this component."
|
|
6279
6116
|
],
|
|
6280
6117
|
"react": [
|
|
6281
|
-
"
|
|
6118
|
+
"Use DsPanelToolSearch, bind value for controlled state, and handle onDsChange.",
|
|
6119
|
+
"Bind the optional filter trigger state and connect onDsFilterToggle to a controlled DsMenu."
|
|
6282
6120
|
],
|
|
6283
6121
|
"angular": [
|
|
6284
|
-
"Import
|
|
6122
|
+
"Import DsPanelToolSearch and bind value as a property; this search composition is not a form value accessor.",
|
|
6123
|
+
"Bind showFilter, filterExpanded, and filterActive, then connect dsFilterToggle to a product-owned ds-menu."
|
|
6285
6124
|
]
|
|
6286
6125
|
},
|
|
6287
6126
|
"references": [
|
|
6288
6127
|
{
|
|
6289
6128
|
"label": "Storybook examples",
|
|
6290
|
-
"path": "src/wc/components/
|
|
6291
|
-
},
|
|
6292
|
-
{
|
|
6293
|
-
"label": "Selection patterns",
|
|
6294
|
-
"path": "src/docs/SelectionPatterns.mdx"
|
|
6129
|
+
"path": "src/wc/components/PanelToolSearch/PanelToolSearch.stories.ts"
|
|
6295
6130
|
}
|
|
6296
6131
|
]
|
|
6297
6132
|
},
|
|
6298
6133
|
"props": {
|
|
6299
|
-
"
|
|
6300
|
-
"type": "
|
|
6134
|
+
"ariaLabel": {
|
|
6135
|
+
"type": "string",
|
|
6301
6136
|
"required": false
|
|
6302
6137
|
},
|
|
6303
|
-
"
|
|
6304
|
-
"type": "
|
|
6138
|
+
"controls": {
|
|
6139
|
+
"type": "string | undefined",
|
|
6305
6140
|
"required": false
|
|
6306
6141
|
},
|
|
6307
|
-
"
|
|
6308
|
-
"type": "
|
|
6142
|
+
"filterActive": {
|
|
6143
|
+
"type": "boolean",
|
|
6309
6144
|
"required": false
|
|
6310
6145
|
},
|
|
6311
|
-
"
|
|
6312
|
-
"type": "string
|
|
6146
|
+
"filterAriaLabel": {
|
|
6147
|
+
"type": "string",
|
|
6313
6148
|
"required": false
|
|
6314
6149
|
},
|
|
6315
|
-
"
|
|
6150
|
+
"filterControls": {
|
|
6316
6151
|
"type": "string | undefined",
|
|
6317
6152
|
"required": false
|
|
6318
6153
|
},
|
|
6319
|
-
"
|
|
6320
|
-
"type": "
|
|
6154
|
+
"filterExpanded": {
|
|
6155
|
+
"type": "boolean",
|
|
6321
6156
|
"required": false
|
|
6322
6157
|
},
|
|
6323
|
-
"
|
|
6158
|
+
"filterTriggerId": {
|
|
6324
6159
|
"type": "string",
|
|
6325
6160
|
"required": false
|
|
6326
6161
|
},
|
|
6327
|
-
"
|
|
6162
|
+
"isInactive": {
|
|
6328
6163
|
"type": "boolean",
|
|
6329
6164
|
"required": false
|
|
6330
6165
|
},
|
|
6331
|
-
"
|
|
6332
|
-
"type": "
|
|
6166
|
+
"placeholder": {
|
|
6167
|
+
"type": "string",
|
|
6333
6168
|
"required": false
|
|
6334
6169
|
},
|
|
6335
|
-
"
|
|
6336
|
-
"type": "string | undefined",
|
|
6337
|
-
"required": false
|
|
6338
|
-
},
|
|
6339
|
-
"hasBorder": {
|
|
6340
|
-
"type": "boolean",
|
|
6341
|
-
"required": false
|
|
6342
|
-
},
|
|
6343
|
-
"icon": {
|
|
6344
|
-
"type": "string | undefined",
|
|
6345
|
-
"required": false
|
|
6346
|
-
},
|
|
6347
|
-
"inputId": {
|
|
6348
|
-
"type": "string | undefined",
|
|
6349
|
-
"required": false
|
|
6350
|
-
},
|
|
6351
|
-
"isInactive": {
|
|
6352
|
-
"type": "boolean",
|
|
6353
|
-
"required": false
|
|
6354
|
-
},
|
|
6355
|
-
"isLoading": {
|
|
6356
|
-
"type": "boolean",
|
|
6357
|
-
"required": false
|
|
6358
|
-
},
|
|
6359
|
-
"loadingLabel": {
|
|
6360
|
-
"type": "string",
|
|
6361
|
-
"required": false
|
|
6362
|
-
},
|
|
6363
|
-
"name": {
|
|
6364
|
-
"type": "string | undefined",
|
|
6365
|
-
"required": false
|
|
6366
|
-
},
|
|
6367
|
-
"noResultsText": {
|
|
6368
|
-
"type": "string",
|
|
6369
|
-
"required": false
|
|
6370
|
-
},
|
|
6371
|
-
"open": {
|
|
6372
|
-
"type": "boolean",
|
|
6373
|
-
"required": false
|
|
6374
|
-
},
|
|
6375
|
-
"options": {
|
|
6376
|
-
"type": "SelectOption[]",
|
|
6377
|
-
"required": false
|
|
6378
|
-
},
|
|
6379
|
-
"placeholder": {
|
|
6380
|
-
"type": "string",
|
|
6381
|
-
"required": false
|
|
6382
|
-
},
|
|
6383
|
-
"required": {
|
|
6384
|
-
"type": "boolean",
|
|
6385
|
-
"required": false
|
|
6386
|
-
},
|
|
6387
|
-
"requiredMessage": {
|
|
6388
|
-
"type": "string",
|
|
6389
|
-
"required": false
|
|
6390
|
-
},
|
|
6391
|
-
"searchPlaceholder": {
|
|
6392
|
-
"type": "string",
|
|
6393
|
-
"required": false
|
|
6394
|
-
},
|
|
6395
|
-
"searchable": {
|
|
6170
|
+
"showFilter": {
|
|
6396
6171
|
"type": "boolean",
|
|
6397
6172
|
"required": false
|
|
6398
6173
|
},
|
|
6399
|
-
"sections": {
|
|
6400
|
-
"type": "SelectSection[]",
|
|
6401
|
-
"required": false
|
|
6402
|
-
},
|
|
6403
|
-
"size": {
|
|
6404
|
-
"type": "SelectSize",
|
|
6405
|
-
"required": false
|
|
6406
|
-
},
|
|
6407
6174
|
"value": {
|
|
6408
6175
|
"type": "string",
|
|
6409
6176
|
"required": false
|
|
6410
|
-
},
|
|
6411
|
-
"width": {
|
|
6412
|
-
"type": "SelectWidth",
|
|
6413
|
-
"required": false
|
|
6414
6177
|
}
|
|
6415
6178
|
},
|
|
6416
6179
|
"events": [
|
|
@@ -6423,15 +6186,15 @@
|
|
|
6423
6186
|
"detail": "void"
|
|
6424
6187
|
},
|
|
6425
6188
|
{
|
|
6426
|
-
"name": "
|
|
6427
|
-
"detail": "
|
|
6189
|
+
"name": "dsFilterToggle",
|
|
6190
|
+
"detail": "MouseEvent"
|
|
6428
6191
|
}
|
|
6429
6192
|
],
|
|
6430
6193
|
"slots": [],
|
|
6431
6194
|
"exports": {
|
|
6432
|
-
"customElement": "ds-
|
|
6433
|
-
"react": "
|
|
6434
|
-
"angular": "
|
|
6195
|
+
"customElement": "ds-panel-tool-search",
|
|
6196
|
+
"react": "DsPanelToolSearch",
|
|
6197
|
+
"angular": "DsPanelToolSearch"
|
|
6435
6198
|
}
|
|
6436
6199
|
},
|
|
6437
6200
|
"dependencies": [
|
|
@@ -6441,189 +6204,155 @@
|
|
|
6441
6204
|
],
|
|
6442
6205
|
"registryDependencies": [
|
|
6443
6206
|
"button-unfilled",
|
|
6444
|
-
"
|
|
6207
|
+
"divider",
|
|
6445
6208
|
"icon",
|
|
6446
|
-
"loader",
|
|
6447
6209
|
"text",
|
|
6448
6210
|
"tooltip"
|
|
6449
6211
|
]
|
|
6450
6212
|
},
|
|
6451
6213
|
{
|
|
6452
|
-
"name": "
|
|
6453
|
-
"title": "
|
|
6454
|
-
"description": "
|
|
6214
|
+
"name": "panel-tools",
|
|
6215
|
+
"title": "PanelTools",
|
|
6216
|
+
"description": "Required ShellApp utility rail and persistent drawer host for the fixed set of global Search, Agents, Messages, Stacks, Activity, and Help products.",
|
|
6455
6217
|
"type": "registry:ui",
|
|
6456
6218
|
"meta": {
|
|
6457
6219
|
"library": "@ds-mo/ui",
|
|
6458
6220
|
"distribution": "npm",
|
|
6459
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6460
|
-
"source": "src/wc/components/
|
|
6221
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/panel-tools",
|
|
6222
|
+
"source": "src/wc/components/PanelTools/PanelTools.tsx",
|
|
6461
6223
|
"intentStatus": "complete",
|
|
6462
6224
|
"intent": {
|
|
6463
|
-
"audience": "
|
|
6225
|
+
"audience": "specialized",
|
|
6464
6226
|
"status": "stable",
|
|
6465
|
-
"summary": "
|
|
6227
|
+
"summary": "Required ShellApp utility rail and persistent drawer host for the fixed set of global Search, Agents, Messages, Stacks, Activity, and Help products.",
|
|
6466
6228
|
"useWhen": [
|
|
6467
|
-
"
|
|
6468
|
-
"
|
|
6469
|
-
"
|
|
6470
|
-
"The choice set has more than roughly 20 options, comes from a user-managed listing, or represents a large domain where search materially improves retrieval."
|
|
6229
|
+
"Composing the required global tools region inside the application's single ShellApp.",
|
|
6230
|
+
"Users need to move between application-wide utilities without losing each tool's in-progress state.",
|
|
6231
|
+
"Search, AI conversations, user messages, review stacks, notifications, or help content must remain available alongside route content."
|
|
6471
6232
|
],
|
|
6472
6233
|
"avoidWhen": [
|
|
6473
|
-
"
|
|
6474
|
-
"
|
|
6475
|
-
"
|
|
6476
|
-
"
|
|
6234
|
+
"The action is specific to the current page or selected content rather than globally available across the application.",
|
|
6235
|
+
"The item navigates to a primary or secondary route; use PanelNav or BarNav instead.",
|
|
6236
|
+
"A consumer wants to add arbitrary tools, reorder fixed tools, or repurpose a semantic tool id.",
|
|
6237
|
+
"Building the mobile tools experience; future mobile ShellApp composition uses a different bottom-bar and panel pattern.",
|
|
6238
|
+
"PanelTools would be mounted outside the application's single ShellApp."
|
|
6477
6239
|
],
|
|
6478
6240
|
"alternatives": [
|
|
6479
6241
|
{
|
|
6480
|
-
"when": "
|
|
6481
|
-
"component": "component:ds-
|
|
6482
|
-
"reason": "
|
|
6242
|
+
"when": "The action navigates to a top-level application destination.",
|
|
6243
|
+
"component": "component:ds-panel-nav",
|
|
6244
|
+
"reason": "PanelNav exclusively owns primary application navigation."
|
|
6483
6245
|
},
|
|
6484
6246
|
{
|
|
6485
|
-
"when": "The
|
|
6247
|
+
"when": "The action navigates between route sections of the active destination.",
|
|
6248
|
+
"component": "component:ds-bar-nav",
|
|
6249
|
+
"reason": "BarNav exclusively owns secondary route navigation."
|
|
6250
|
+
},
|
|
6251
|
+
{
|
|
6252
|
+
"when": "Temporary contextual actions or options are needed.",
|
|
6486
6253
|
"component": "component:ds-menu",
|
|
6487
|
-
"reason": "Menu
|
|
6254
|
+
"reason": "Menu owns transient contextual choices rather than persistent global products."
|
|
6488
6255
|
}
|
|
6489
6256
|
],
|
|
6490
6257
|
"commonlyComposedWith": [
|
|
6491
|
-
"component:ds-
|
|
6492
|
-
"component:ds-
|
|
6493
|
-
"component:ds-
|
|
6494
|
-
|
|
6258
|
+
"component:ds-shell-app",
|
|
6259
|
+
"component:ds-panel-nav",
|
|
6260
|
+
"component:ds-bar-nav"
|
|
6261
|
+
],
|
|
6262
|
+
"patterns": [
|
|
6263
|
+
"pattern:application-shell"
|
|
6495
6264
|
],
|
|
6496
6265
|
"accessibility": [
|
|
6497
|
-
"
|
|
6498
|
-
"
|
|
6499
|
-
"
|
|
6500
|
-
"
|
|
6501
|
-
"
|
|
6502
|
-
"
|
|
6503
|
-
"Use errorMessage with error so the trigger is described by the rendered alert."
|
|
6266
|
+
"Provide localized accessible labels for the rail, shortcut group, and every rendered tool.",
|
|
6267
|
+
"Keep Search first in the rail header and Help last in the rail footer so keyboard and visual order remain predictable.",
|
|
6268
|
+
"Keep focus on the selected rail action when opening a drawer and allow normal Tab navigation into its content.",
|
|
6269
|
+
"Do not trigger global shortcuts while focus is in an editable control.",
|
|
6270
|
+
"Use notification dots only as supplemental unread or new-content status and never as the sole status indication.",
|
|
6271
|
+
"Explain temporarily inactive tools through an accessible label or adjacent product guidance; omit unauthorized tools entirely."
|
|
6504
6272
|
],
|
|
6505
6273
|
"states": [
|
|
6506
|
-
"
|
|
6507
|
-
"
|
|
6508
|
-
"
|
|
6509
|
-
"
|
|
6510
|
-
"The
|
|
6511
|
-
"
|
|
6512
|
-
"
|
|
6513
|
-
"
|
|
6514
|
-
"
|
|
6515
|
-
"
|
|
6516
|
-
"
|
|
6517
|
-
"
|
|
6518
|
-
"
|
|
6519
|
-
"
|
|
6520
|
-
"
|
|
6521
|
-
"
|
|
6522
|
-
"
|
|
6523
|
-
"
|
|
6524
|
-
"
|
|
6525
|
-
"
|
|
6526
|
-
"An initially empty option set is not an expected SelectMulti use case. The no-results state describes a search with no matches, not a source with no choices.",
|
|
6527
|
-
"Native form submission emits one entry per selected value under the component name.",
|
|
6528
|
-
"Use options for a flat list or sections for grouped choices. Multi-select option contracts intentionally exclude icons because the leading checkbox owns that row zone; hierarchical parent selection is deferred."
|
|
6274
|
+
"Search and Help are required; optional Agents, Messages, Stacks, and Activity tools are filtered by the application for authorization and entitlement.",
|
|
6275
|
+
"Use only the fixed semantic tool ids and canonical order: Search, Agents, Messages, Stacks, Activity, Help; do not reorder, duplicate, or repurpose them.",
|
|
6276
|
+
"Search is application-wide; Agents is user-to-AI chat; Messages is user-to-user chat; Stacks is a specialized inbox of grouped application events for review; Activity is the notification center; Help is drawer content that may link to external resources.",
|
|
6277
|
+
"Only one drawer is open at a time; selecting another tool switches directly and selecting the active tool closes to rail-only mode.",
|
|
6278
|
+
"The drawer starts closed, remains open across ordinary route changes, and retains every mounted tool's independent conversation, query, scroll, and work state.",
|
|
6279
|
+
"When storageKey is set, persist only the last active tool in this browser and still restore the drawer closed after reload.",
|
|
6280
|
+
"The application owns unread state; opening Messages, Agents, Stacks, or Activity does not automatically clear its notification dot.",
|
|
6281
|
+
"PanelTools owns the one visible header above every drawer tool view and above fullscreen views using the default shared header mode. Slotted tool content must not render a second header unless the conversation product explicitly opts into split fullscreen headers.",
|
|
6282
|
+
"PanelTools composes ds-panel-tool-header as its canonical left-aligned header implementation so standalone header stories and shell rendering cannot diverge.",
|
|
6283
|
+
"Each tool supplies its current header title, base-versus-detail Back state, and right-side actions through the headers property. Base views omit Back; deeper views expose Back and update the same header in place.",
|
|
6284
|
+
"Header Back and action events express intent only; the owning tool changes product navigation, menus, and data state. PanelTools keeps the final header action exactly 8px from the drawer edge.",
|
|
6285
|
+
"Menus opened from a right-side header action use PANEL_TOOLS_HEADER_MENU_PLACEMENT: bottom/end choice-cell alignment and a 12px side offset, placing the popup 4px below the 48px header while aligning the final menu item edge with the trigger.",
|
|
6286
|
+
"Tool view roots stay transparent so ShellApp's chrome wash remains visible; only explicitly designed child surfaces introduce a fill.",
|
|
6287
|
+
"Tools with search compose ds-panel-tool-search immediately below the shared header. Its 48px row always contains the md search control and must not be reduced to sm or xs.",
|
|
6288
|
+
"If an active optional tool becomes unavailable, PanelTools closes the drawer, clears activeTool, and emits its deselection.",
|
|
6289
|
+
"Use isInactive only for a temporarily unavailable visible tool; omit tools the user is not authorized to access.",
|
|
6290
|
+
"The application owns slotted tool products and data while PanelTools owns rail ordering, drawer selection, open state, motion, and shell events.",
|
|
6291
|
+
"Opening and closing clip an already-rendered fixed-width surface. Header and tool content remain fully opaque and retained during width motion; transition completion is accepted only at the measured terminal clip width, after which the closed surface becomes inert and paint-skipped.",
|
|
6292
|
+
"Entering and exiting fullscreen snaps without borrowing the drawer open or close animation.",
|
|
6293
|
+
"When fullscreenHeaderMode is split, PanelTools suppresses only its fullscreen shared header. The application renders exactly two canonical ds-panel-tool-header instances: a tool-title/list-actions header over the 300px history pane and a chat-title/Exit-fullscreen/chat-actions header over the detail pane. The detail header omits Back because the list remains visible."
|
|
6529
6294
|
],
|
|
6530
6295
|
"responsiveBehavior": [
|
|
6531
|
-
"
|
|
6532
|
-
"
|
|
6533
|
-
"
|
|
6296
|
+
"The open drawer reduces main-content width and uses --dimension-panel-width-xs (300px) on every supported desktop and tablet viewport.",
|
|
6297
|
+
"ShellApp owns the fixed drawer-width variable; consumers must not hardcode alternate drawer widths.",
|
|
6298
|
+
"Below 768px, do not reuse desktop PanelTools: future ShellApp mobile composition uses a bottom bar for Search, Agents, Notifications, and Stacks, while Help moves into mobile primary navigation.",
|
|
6299
|
+
"Keep named-slot content mounted while tools switch or the drawer closes so users can return to in-progress global work.",
|
|
6300
|
+
"Conversation products may use fullscreenHeaderMode split for a 300px history rail beside a flexible detail pane, each with its own canonical header; the application owns that internal split layout.",
|
|
6301
|
+
"Use fixed drawer widths for now; do not add user resizing or width persistence."
|
|
6534
6302
|
],
|
|
6535
6303
|
"frameworkCaveats": {
|
|
6536
6304
|
"customElements": [
|
|
6537
|
-
"Assign
|
|
6305
|
+
"Assign items as a JavaScript property for structured data; items-json is the string fallback.",
|
|
6306
|
+
"Assign headers as a JavaScript property and replace its object identity whenever an active tool changes title, depth, or actions.",
|
|
6307
|
+
"Keep PanelTools mounted at ShellApp scope across route changes and provide each product through its matching named slot."
|
|
6538
6308
|
],
|
|
6539
6309
|
"react": [
|
|
6540
|
-
"Pass
|
|
6310
|
+
"Pass the fixed item collection through the generated React wrapper and keep named-slot product content mounted at ShellApp scope.",
|
|
6311
|
+
"Use storageKey only for same-browser last-tool continuity; do not persist the open drawer."
|
|
6541
6312
|
],
|
|
6542
6313
|
"angular": [
|
|
6543
|
-
"Import
|
|
6314
|
+
"Import DsPanelTools from @ds-mo/ui/angular/ds-panel-tools and bind items as a property.",
|
|
6315
|
+
"Bind headers as a replaced object and route dsHeaderBack and dsHeaderAction to the active tool owner.",
|
|
6316
|
+
"Keep the component in the persistent shell layout rather than recreating it in routed page components."
|
|
6544
6317
|
]
|
|
6545
6318
|
},
|
|
6546
6319
|
"references": [
|
|
6547
6320
|
{
|
|
6548
|
-
"label": "Storybook examples",
|
|
6549
|
-
"path": "src/wc/components/
|
|
6321
|
+
"label": "Executable Storybook examples",
|
|
6322
|
+
"path": "src/wc/components/PanelTools/PanelTools.stories.ts"
|
|
6550
6323
|
},
|
|
6551
6324
|
{
|
|
6552
|
-
"label": "
|
|
6553
|
-
"path": "
|
|
6325
|
+
"label": "Framework and shell integration",
|
|
6326
|
+
"path": "docs/framework-integration.md"
|
|
6327
|
+
},
|
|
6328
|
+
{
|
|
6329
|
+
"label": "Application shell composition",
|
|
6330
|
+
"path": "agent/patterns/application-shell/pattern.agent.json"
|
|
6554
6331
|
}
|
|
6555
6332
|
]
|
|
6556
6333
|
},
|
|
6557
6334
|
"props": {
|
|
6558
|
-
"
|
|
6559
|
-
"type": "
|
|
6560
|
-
"required": false
|
|
6561
|
-
},
|
|
6562
|
-
"allowClear": {
|
|
6563
|
-
"type": "boolean",
|
|
6335
|
+
"activeTool": {
|
|
6336
|
+
"type": "PanelToolsToolId | ''",
|
|
6564
6337
|
"required": false
|
|
6565
6338
|
},
|
|
6566
|
-
"
|
|
6567
|
-
"type": "
|
|
6339
|
+
"fullscreenHeaderMode": {
|
|
6340
|
+
"type": "'shared' | 'split'",
|
|
6568
6341
|
"required": false
|
|
6569
6342
|
},
|
|
6570
|
-
"
|
|
6571
|
-
"type": "
|
|
6343
|
+
"headers": {
|
|
6344
|
+
"type": "PanelToolsHeaders",
|
|
6572
6345
|
"required": false
|
|
6573
6346
|
},
|
|
6574
|
-
"
|
|
6575
|
-
"type": "string
|
|
6347
|
+
"headersJson": {
|
|
6348
|
+
"type": "string",
|
|
6576
6349
|
"required": false
|
|
6577
6350
|
},
|
|
6578
|
-
"
|
|
6579
|
-
"type": "
|
|
6351
|
+
"items": {
|
|
6352
|
+
"type": "PanelToolsItem[]",
|
|
6580
6353
|
"required": false
|
|
6581
6354
|
},
|
|
6582
|
-
"
|
|
6583
|
-
"type": "string",
|
|
6584
|
-
"required": false
|
|
6585
|
-
},
|
|
6586
|
-
"disabled": {
|
|
6587
|
-
"type": "boolean",
|
|
6588
|
-
"required": false
|
|
6589
|
-
},
|
|
6590
|
-
"error": {
|
|
6591
|
-
"type": "boolean",
|
|
6592
|
-
"required": false
|
|
6593
|
-
},
|
|
6594
|
-
"errorMessage": {
|
|
6595
|
-
"type": "string | undefined",
|
|
6596
|
-
"required": false
|
|
6597
|
-
},
|
|
6598
|
-
"hasBorder": {
|
|
6599
|
-
"type": "boolean",
|
|
6600
|
-
"required": false
|
|
6601
|
-
},
|
|
6602
|
-
"icon": {
|
|
6603
|
-
"type": "string | undefined",
|
|
6604
|
-
"required": false
|
|
6605
|
-
},
|
|
6606
|
-
"inputId": {
|
|
6607
|
-
"type": "string | undefined",
|
|
6608
|
-
"required": false
|
|
6609
|
-
},
|
|
6610
|
-
"isInactive": {
|
|
6611
|
-
"type": "boolean",
|
|
6612
|
-
"required": false
|
|
6613
|
-
},
|
|
6614
|
-
"isLoading": {
|
|
6615
|
-
"type": "boolean",
|
|
6616
|
-
"required": false
|
|
6617
|
-
},
|
|
6618
|
-
"loadingLabel": {
|
|
6619
|
-
"type": "string",
|
|
6620
|
-
"required": false
|
|
6621
|
-
},
|
|
6622
|
-
"name": {
|
|
6623
|
-
"type": "string | undefined",
|
|
6624
|
-
"required": false
|
|
6625
|
-
},
|
|
6626
|
-
"noResultsText": {
|
|
6355
|
+
"itemsJson": {
|
|
6627
6356
|
"type": "string",
|
|
6628
6357
|
"required": false
|
|
6629
6358
|
},
|
|
@@ -6631,810 +6360,1191 @@
|
|
|
6631
6360
|
"type": "boolean",
|
|
6632
6361
|
"required": false
|
|
6633
6362
|
},
|
|
6634
|
-
"
|
|
6635
|
-
"type": "
|
|
6636
|
-
"required": false
|
|
6637
|
-
},
|
|
6638
|
-
"placeholder": {
|
|
6639
|
-
"type": "string",
|
|
6640
|
-
"required": false
|
|
6641
|
-
},
|
|
6642
|
-
"required": {
|
|
6643
|
-
"type": "boolean",
|
|
6363
|
+
"presentation": {
|
|
6364
|
+
"type": "'drawer' | 'fullscreen'",
|
|
6644
6365
|
"required": false
|
|
6645
6366
|
},
|
|
6646
|
-
"
|
|
6367
|
+
"storageKey": {
|
|
6647
6368
|
"type": "string",
|
|
6648
6369
|
"required": false
|
|
6649
6370
|
},
|
|
6650
|
-
"
|
|
6371
|
+
"toolShortcutsLabel": {
|
|
6651
6372
|
"type": "string",
|
|
6652
6373
|
"required": false
|
|
6653
6374
|
},
|
|
6654
|
-
"
|
|
6655
|
-
"type": "boolean",
|
|
6656
|
-
"required": false
|
|
6657
|
-
},
|
|
6658
|
-
"sections": {
|
|
6659
|
-
"type": "SelectMultiSection[]",
|
|
6660
|
-
"required": false
|
|
6661
|
-
},
|
|
6662
|
-
"selectedLabel": {
|
|
6375
|
+
"toolsLabel": {
|
|
6663
6376
|
"type": "string",
|
|
6664
6377
|
"required": false
|
|
6665
|
-
},
|
|
6666
|
-
"size": {
|
|
6667
|
-
"type": "SelectMultiSize",
|
|
6668
|
-
"required": false
|
|
6669
|
-
},
|
|
6670
|
-
"values": {
|
|
6671
|
-
"type": "string[]",
|
|
6672
|
-
"required": false
|
|
6673
|
-
},
|
|
6674
|
-
"width": {
|
|
6675
|
-
"type": "SelectMultiWidth",
|
|
6676
|
-
"required": false
|
|
6677
6378
|
}
|
|
6678
6379
|
},
|
|
6679
6380
|
"events": [
|
|
6680
6381
|
{
|
|
6681
|
-
"name": "
|
|
6682
|
-
"detail": "
|
|
6382
|
+
"name": "dsChromeTransitionEnd",
|
|
6383
|
+
"detail": "ChromeTransitionDetail"
|
|
6683
6384
|
},
|
|
6684
6385
|
{
|
|
6685
|
-
"name": "
|
|
6686
|
-
"detail": "
|
|
6386
|
+
"name": "dsChromeTransitionStart",
|
|
6387
|
+
"detail": "ChromeTransitionDetail"
|
|
6687
6388
|
},
|
|
6688
6389
|
{
|
|
6689
|
-
"name": "
|
|
6690
|
-
"detail": "
|
|
6390
|
+
"name": "dsHeaderAction",
|
|
6391
|
+
"detail": "{\n tool: PanelToolsToolId;\n id: string;\n }"
|
|
6392
|
+
},
|
|
6393
|
+
{
|
|
6394
|
+
"name": "dsHeaderBack",
|
|
6395
|
+
"detail": "{\n tool: PanelToolsToolId;\n }"
|
|
6396
|
+
},
|
|
6397
|
+
{
|
|
6398
|
+
"name": "dsPresentationChange",
|
|
6399
|
+
"detail": "{\n presentation: 'drawer' | 'fullscreen';\n }"
|
|
6400
|
+
},
|
|
6401
|
+
{
|
|
6402
|
+
"name": "dsToolChange",
|
|
6403
|
+
"detail": "{\n id: PanelToolsToolId;\n selected: boolean;\n }"
|
|
6691
6404
|
}
|
|
6692
6405
|
],
|
|
6693
6406
|
"slots": [],
|
|
6694
6407
|
"exports": {
|
|
6695
|
-
"customElement": "ds-
|
|
6696
|
-
"react": "
|
|
6697
|
-
"angular": "
|
|
6408
|
+
"customElement": "ds-panel-tools",
|
|
6409
|
+
"react": "DsPanelTools",
|
|
6410
|
+
"angular": "DsPanelTools"
|
|
6698
6411
|
}
|
|
6699
6412
|
},
|
|
6700
6413
|
"dependencies": [
|
|
6701
6414
|
"@ds-mo/ui",
|
|
6702
|
-
"@ds-mo/tokens"
|
|
6703
|
-
"@ds-mo/icons"
|
|
6415
|
+
"@ds-mo/tokens"
|
|
6704
6416
|
],
|
|
6705
6417
|
"registryDependencies": [
|
|
6706
6418
|
"button-unfilled",
|
|
6707
|
-
"
|
|
6708
|
-
"empty-state",
|
|
6709
|
-
"icon",
|
|
6710
|
-
"loader",
|
|
6711
|
-
"text",
|
|
6419
|
+
"panel-tool-header",
|
|
6712
6420
|
"tooltip"
|
|
6713
6421
|
]
|
|
6714
6422
|
},
|
|
6715
6423
|
{
|
|
6716
|
-
"name": "
|
|
6717
|
-
"title": "
|
|
6718
|
-
"description": "
|
|
6424
|
+
"name": "radio",
|
|
6425
|
+
"title": "Radio",
|
|
6426
|
+
"description": "Form-associated one-of-many radio selection set with vertical or horizontal layout, three densities, per-option inactive state, and roving keyboard focus.",
|
|
6719
6427
|
"type": "registry:ui",
|
|
6720
6428
|
"meta": {
|
|
6721
6429
|
"library": "@ds-mo/ui",
|
|
6722
6430
|
"distribution": "npm",
|
|
6723
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6724
|
-
"source": "src/wc/components/
|
|
6431
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/radio",
|
|
6432
|
+
"source": "src/wc/components/Radio/Radio.tsx",
|
|
6725
6433
|
"intentStatus": "complete",
|
|
6726
6434
|
"intent": {
|
|
6727
|
-
"audience": "
|
|
6435
|
+
"audience": "general",
|
|
6728
6436
|
"status": "stable",
|
|
6729
|
-
"summary": "
|
|
6437
|
+
"summary": "Form-associated one-of-many radio selection set with vertical or horizontal layout, three densities, per-option inactive state, and roving keyboard focus.",
|
|
6730
6438
|
"useWhen": [
|
|
6731
|
-
"
|
|
6732
|
-
"
|
|
6733
|
-
"
|
|
6439
|
+
"A user must select exactly one visible option from a small set.",
|
|
6440
|
+
"All available choices should remain visible for comparison.",
|
|
6441
|
+
"A form needs one selected string value with native validation, reset, or external form association."
|
|
6734
6442
|
],
|
|
6735
6443
|
"avoidWhen": [
|
|
6736
|
-
"
|
|
6737
|
-
"
|
|
6738
|
-
"
|
|
6444
|
+
"A user may select zero or multiple independent choices.",
|
|
6445
|
+
"A binary setting applies immediately rather than selecting from a set.",
|
|
6446
|
+
"The option list is too long or space-constrained to remain visible."
|
|
6739
6447
|
],
|
|
6740
|
-
"
|
|
6741
|
-
|
|
6742
|
-
|
|
6743
|
-
|
|
6744
|
-
|
|
6745
|
-
|
|
6746
|
-
|
|
6747
|
-
|
|
6748
|
-
|
|
6749
|
-
|
|
6448
|
+
"alternatives": [
|
|
6449
|
+
{
|
|
6450
|
+
"when": "A user may select zero or multiple independent choices.",
|
|
6451
|
+
"component": "component:ds-checkbox",
|
|
6452
|
+
"reason": "Checkbox communicates independent selection rather than one-of-many choice."
|
|
6453
|
+
},
|
|
6454
|
+
{
|
|
6455
|
+
"when": "A binary setting applies immediately.",
|
|
6456
|
+
"component": "component:ds-switch",
|
|
6457
|
+
"reason": "Switch communicates an immediately applied on/off setting."
|
|
6458
|
+
},
|
|
6459
|
+
{
|
|
6460
|
+
"when": "The option list is long or the available space is constrained.",
|
|
6461
|
+
"component": "component:ds-select",
|
|
6462
|
+
"reason": "Select keeps a larger one-of-many choice set compact."
|
|
6463
|
+
}
|
|
6750
6464
|
],
|
|
6751
|
-
"
|
|
6752
|
-
"
|
|
6753
|
-
"
|
|
6465
|
+
"commonlyComposedWith": [
|
|
6466
|
+
"component:ds-field",
|
|
6467
|
+
"component:ds-text"
|
|
6754
6468
|
],
|
|
6755
6469
|
"accessibility": [
|
|
6756
|
-
"
|
|
6757
|
-
"
|
|
6758
|
-
"
|
|
6759
|
-
"
|
|
6760
|
-
"Require Search and Help as the minimum PanelTools actions and provide accessible labels for every tool.",
|
|
6761
|
-
"Preserve focus and accessible names across navigation, collapse, overflow, and responsive presentation changes."
|
|
6470
|
+
"The host exposes radiogroup semantics and requires an accessible group name from aria-label or aria-labelledby.",
|
|
6471
|
+
"Each visible option exposes radio semantics, its checked state, its label text, and any inactive state.",
|
|
6472
|
+
"Arrow keys move and select through active options; Home and End select the first and last active options; Space and Enter select the focused option.",
|
|
6473
|
+
"Roving tabindex keeps one active option in the tab order, preferring the selected option."
|
|
6762
6474
|
],
|
|
6763
6475
|
"states": [
|
|
6764
|
-
"
|
|
6765
|
-
"
|
|
6766
|
-
"
|
|
6767
|
-
"
|
|
6768
|
-
"The application controls mobileDestination and mobileNavigationOpen and keeps router state independent from global tool-surface changes.",
|
|
6769
|
-
"Set gradientPreset to the single resolved global chrome preference: neutral by default, none for solid chrome, or cool, neutral, warm, and fresh for token-based washes.",
|
|
6770
|
-
"The application owns gradient preference persistence, cross-tab synchronization, and server or account precedence; ShellApp owns rendering the resolved preset across authenticated routes.",
|
|
6771
|
-
"Dashboard represents day-to-day operational work while Settings represents administrative and configuration work; route state selects the context.",
|
|
6772
|
-
"Update PanelNav groups, BarNav tabs and heading, navStyle, basePath, and currentUrl atomically from one resolved route state.",
|
|
6773
|
-
"BarNav remains present: it shows route-section tabs when available and the active PanelNav destination label as heading otherwise.",
|
|
6774
|
-
"Render one ShellPage as the default-slot child for each standard routed page; ShellApp owns the content scroller while ShellPage owns page header stickiness and content inset.",
|
|
6775
|
-
"The application filters unauthorized destinations, sections, and tools before passing them into shell components."
|
|
6476
|
+
"Unchecked circles use a tertiary-foreground inset stroke: 1.25px at md, 1px at sm, and 0.75px at xs.",
|
|
6477
|
+
"Selected circles remove the border, use a brand fill, and draw a centered on-bold foreground dot sized 8px at md, 6px at sm, and 4px at xs.",
|
|
6478
|
+
"Sizes are md with a 16px circle in a 20px placement, sm with a 12px circle in a 16px placement, and xs with an 8px circle in a 12px placement.",
|
|
6479
|
+
"The initial value is restored by native form reset; the selected value submits under name and a required set is invalid until one active option is selected."
|
|
6776
6480
|
],
|
|
6777
6481
|
"responsiveBehavior": [
|
|
6778
|
-
"
|
|
6779
|
-
"
|
|
6780
|
-
"On tablet, ShellApp keeps PanelNav permanently collapsed and prevents user expansion without overwriting the desktop preference.",
|
|
6781
|
-
"On mobile, ShellApp hides and inerts PanelNav and BarNav, uses a solid primary stage, and composes MobileNav, MobileSectionNav, ShellTools, and the persistent five-item MobileBar.",
|
|
6782
|
-
"Mobile global surfaces conceal and inert the routed workspace without unmounting it, preserving nested routes and scroll state.",
|
|
6783
|
-
"Keep PanelNav width, BarNav height, PanelTools chrome, and main-content origin stable except during intentional responsive or collapse transitions.",
|
|
6784
|
-
"The bottom bar remains visible at all route and tool depths in the foundation release."
|
|
6482
|
+
"Choose size from the density of the containing form or settings row.",
|
|
6483
|
+
"Prefer vertical layout when labels may wrap or horizontal space is constrained; horizontal layout is appropriate for short labels in a small set."
|
|
6785
6484
|
],
|
|
6786
6485
|
"frameworkCaveats": {
|
|
6787
6486
|
"customElements": [
|
|
6788
|
-
"Assign
|
|
6789
|
-
"
|
|
6487
|
+
"Assign options as a JavaScript property, set value as a property for application state updates, and listen for dsChange.",
|
|
6488
|
+
"Use the form attribute on the host when associating a radio set rendered outside its owning form."
|
|
6790
6489
|
],
|
|
6791
6490
|
"react": [
|
|
6792
|
-
"Use
|
|
6793
|
-
"Resolve all shell inputs from one router state before rendering the composition."
|
|
6491
|
+
"Use DsRadio, pass options as an array, and handle onDsChange; value is mutable and updates after user selection."
|
|
6794
6492
|
],
|
|
6795
6493
|
"angular": [
|
|
6796
|
-
"Use
|
|
6797
|
-
"Bind complex inputs as properties and update navigation inputs atomically from one resolved router state.",
|
|
6798
|
-
"Bind both nav-style attributes and properties when deterministic first paint is required."
|
|
6494
|
+
"Use DsRadio with options and value bindings plus dsChange, or import the generated radio value accessor with the component adapter."
|
|
6799
6495
|
]
|
|
6800
6496
|
},
|
|
6801
6497
|
"references": [
|
|
6802
6498
|
{
|
|
6803
|
-
"label": "
|
|
6804
|
-
"path": "src/wc/components/
|
|
6805
|
-
},
|
|
6806
|
-
{
|
|
6807
|
-
"label": "Executable Storybook composition",
|
|
6808
|
-
"path": "src/wc/components/ShellApp/ShellApp.stories.ts"
|
|
6809
|
-
},
|
|
6810
|
-
{
|
|
6811
|
-
"label": "Framework integration",
|
|
6812
|
-
"path": "docs/framework-integration.md"
|
|
6499
|
+
"label": "Storybook examples",
|
|
6500
|
+
"path": "src/wc/components/Radio/Radio.stories.ts"
|
|
6813
6501
|
},
|
|
6814
6502
|
{
|
|
6815
|
-
"label": "
|
|
6816
|
-
"path": "
|
|
6503
|
+
"label": "Cross-browser form and accessibility coverage",
|
|
6504
|
+
"path": "tests/e2e/forms.spec.ts"
|
|
6817
6505
|
}
|
|
6818
6506
|
]
|
|
6819
6507
|
},
|
|
6820
6508
|
"props": {
|
|
6821
|
-
"
|
|
6822
|
-
"type": "
|
|
6509
|
+
"ariaLabel": {
|
|
6510
|
+
"type": "string | null",
|
|
6823
6511
|
"required": false
|
|
6824
6512
|
},
|
|
6825
|
-
"
|
|
6826
|
-
"type": "
|
|
6513
|
+
"ariaLabelledby": {
|
|
6514
|
+
"type": "string | undefined",
|
|
6515
|
+
"required": false
|
|
6516
|
+
},
|
|
6517
|
+
"direction": {
|
|
6518
|
+
"type": "'vertical' | 'horizontal'",
|
|
6827
6519
|
"required": false
|
|
6828
6520
|
},
|
|
6829
|
-
"
|
|
6521
|
+
"disabled": {
|
|
6830
6522
|
"type": "boolean",
|
|
6831
6523
|
"required": false
|
|
6832
6524
|
},
|
|
6833
|
-
"
|
|
6834
|
-
"type": "
|
|
6525
|
+
"form": {
|
|
6526
|
+
"type": "string | undefined",
|
|
6835
6527
|
"required": false
|
|
6836
6528
|
},
|
|
6837
|
-
"
|
|
6529
|
+
"isInactive": {
|
|
6838
6530
|
"type": "boolean",
|
|
6839
6531
|
"required": false
|
|
6840
|
-
}
|
|
6841
|
-
|
|
6842
|
-
|
|
6532
|
+
},
|
|
6533
|
+
"name": {
|
|
6534
|
+
"type": "string | undefined",
|
|
6535
|
+
"required": false
|
|
6536
|
+
},
|
|
6537
|
+
"options": {
|
|
6538
|
+
"type": "RadioOption[]",
|
|
6539
|
+
"required": false
|
|
6540
|
+
},
|
|
6541
|
+
"required": {
|
|
6542
|
+
"type": "boolean",
|
|
6543
|
+
"required": false
|
|
6544
|
+
},
|
|
6545
|
+
"requiredMessage": {
|
|
6546
|
+
"type": "string",
|
|
6547
|
+
"required": false
|
|
6548
|
+
},
|
|
6549
|
+
"size": {
|
|
6550
|
+
"type": "RadioSize",
|
|
6551
|
+
"required": false
|
|
6552
|
+
},
|
|
6553
|
+
"value": {
|
|
6554
|
+
"type": "string",
|
|
6555
|
+
"required": false
|
|
6556
|
+
}
|
|
6557
|
+
},
|
|
6558
|
+
"events": [
|
|
6843
6559
|
{
|
|
6844
|
-
"name": "
|
|
6845
|
-
"detail": "
|
|
6560
|
+
"name": "dsChange",
|
|
6561
|
+
"detail": "string"
|
|
6846
6562
|
}
|
|
6847
6563
|
],
|
|
6848
6564
|
"slots": [],
|
|
6849
6565
|
"exports": {
|
|
6850
|
-
"customElement": "ds-
|
|
6851
|
-
"react": "
|
|
6852
|
-
"angular": "
|
|
6566
|
+
"customElement": "ds-radio",
|
|
6567
|
+
"react": "DsRadio",
|
|
6568
|
+
"angular": "DsRadio"
|
|
6853
6569
|
}
|
|
6854
6570
|
},
|
|
6855
6571
|
"dependencies": [
|
|
6856
6572
|
"@ds-mo/ui",
|
|
6857
6573
|
"@ds-mo/tokens"
|
|
6858
6574
|
],
|
|
6859
|
-
"registryDependencies": [
|
|
6575
|
+
"registryDependencies": [
|
|
6576
|
+
"text"
|
|
6577
|
+
]
|
|
6860
6578
|
},
|
|
6861
6579
|
{
|
|
6862
|
-
"name": "
|
|
6863
|
-
"title": "
|
|
6864
|
-
"description": "
|
|
6580
|
+
"name": "scroll-overlay",
|
|
6581
|
+
"title": "ScrollOverlay",
|
|
6582
|
+
"description": "Generic scroll owner for content that moves behind a persistent footer action or composer with an always-active alpha fade.",
|
|
6865
6583
|
"type": "registry:ui",
|
|
6866
6584
|
"meta": {
|
|
6867
6585
|
"library": "@ds-mo/ui",
|
|
6868
6586
|
"distribution": "npm",
|
|
6869
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6870
|
-
"source": "src/wc/components/
|
|
6587
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/scroll-overlay",
|
|
6588
|
+
"source": "src/wc/components/ScrollOverlay/ScrollOverlay.tsx",
|
|
6871
6589
|
"intentStatus": "complete",
|
|
6872
6590
|
"intent": {
|
|
6873
|
-
"audience": "
|
|
6874
|
-
"status": "
|
|
6875
|
-
"
|
|
6876
|
-
"replacementReason": "SwatchPicker now owns the same accessible interaction with a generic option model that supports both flat colors and gradients.",
|
|
6877
|
-
"summary": "Deprecated compatibility wrapper that maps the fixed ShellApp wash presets into SwatchPicker.",
|
|
6591
|
+
"audience": "general",
|
|
6592
|
+
"status": "experimental",
|
|
6593
|
+
"summary": "Generic scroll owner for content that moves behind a persistent footer action or composer with an always-active alpha fade.",
|
|
6878
6594
|
"useWhen": [
|
|
6879
|
-
"
|
|
6880
|
-
"
|
|
6595
|
+
"A bounded region owns scrolling while footer actions remain overlaid and continuously visible.",
|
|
6596
|
+
"The final content must clear a live-height footer while earlier content can move behind it."
|
|
6881
6597
|
],
|
|
6882
6598
|
"avoidWhen": [
|
|
6883
|
-
"
|
|
6884
|
-
"
|
|
6885
|
-
"A picker already exists for the application; provide exactly one canonical preference location.",
|
|
6886
|
-
"Rendering an individual swatch outside the complete picker."
|
|
6887
|
-
],
|
|
6888
|
-
"alternatives": [
|
|
6889
|
-
{
|
|
6890
|
-
"when": "The user is selecting the application light, dark, or system color mode.",
|
|
6891
|
-
"component": "component:ds-menu",
|
|
6892
|
-
"reason": "Color mode is a separate appearance preference and should use ordinary menu selection rows."
|
|
6893
|
-
}
|
|
6599
|
+
"The footer belongs in normal document flow rather than overlaying content.",
|
|
6600
|
+
"Another component already owns scrolling and cannot delegate its scrollport to this component."
|
|
6894
6601
|
],
|
|
6895
6602
|
"commonlyComposedWith": [
|
|
6896
|
-
"component:ds-
|
|
6897
|
-
"component:ds-
|
|
6898
|
-
],
|
|
6899
|
-
"patterns": [
|
|
6900
|
-
"pattern:application-shell"
|
|
6603
|
+
"component:ds-button-filled",
|
|
6604
|
+
"component:ds-message-composer"
|
|
6901
6605
|
],
|
|
6902
6606
|
"accessibility": [
|
|
6903
|
-
"Provide
|
|
6904
|
-
"
|
|
6905
|
-
"Keep the visible compact swatches and their accessible preset names; do not rely on color alone for assistive technology."
|
|
6607
|
+
"Provide scrollLabel when the scrollport needs its own named, keyboard-focusable region.",
|
|
6608
|
+
"Keep footer actions keyboard accessible and explicitly named; the fade is decorative and never intercepts pointer input."
|
|
6906
6609
|
],
|
|
6907
6610
|
"states": [
|
|
6908
|
-
"
|
|
6909
|
-
"
|
|
6910
|
-
"
|
|
6911
|
-
"The application owns local persistence, cross-tab synchronization, and server or account preference precedence; the picker owns only selection UI and events.",
|
|
6912
|
-
"Treat the fixed preset union as the only supported values and do not construct custom gradients."
|
|
6611
|
+
"The alpha mask remains active at every scroll position and moves in content coordinates so it stays pinned behind the footer without masking native scrollbars.",
|
|
6612
|
+
"The component measures the complete overlay for end clearance, measures its visible child for fade depth, and begins the fade 8px before that visible content.",
|
|
6613
|
+
"An md 32px footer action with 8px bottom inset therefore produces a 48px fade; variable-height composers produce a correspondingly taller measured fade."
|
|
6913
6614
|
],
|
|
6914
6615
|
"responsiveBehavior": [
|
|
6915
|
-
"
|
|
6916
|
-
"The future mobile account surface may present the same preference differently."
|
|
6616
|
+
"The scrollport and overlay fill the available width and height; the owner supplies responsive sizing and overlay insets."
|
|
6917
6617
|
],
|
|
6918
6618
|
"frameworkCaveats": {
|
|
6919
6619
|
"customElements": [
|
|
6920
|
-
"
|
|
6620
|
+
"Place scrollable content in the default slot and one footer wrapper in the overlay slot; use dsScroll only when the application needs position data."
|
|
6921
6621
|
],
|
|
6922
6622
|
"react": [
|
|
6923
|
-
"Use
|
|
6623
|
+
"Use DsScrollOverlay with ordinary children plus an element carrying slot=\"overlay\"."
|
|
6924
6624
|
],
|
|
6925
6625
|
"angular": [
|
|
6926
|
-
"
|
|
6626
|
+
"Import DsScrollOverlay and project the persistent footer wrapper with slot=\"overlay\"."
|
|
6927
6627
|
]
|
|
6928
6628
|
},
|
|
6929
6629
|
"references": [
|
|
6930
6630
|
{
|
|
6931
|
-
"label": "
|
|
6932
|
-
"path": "src/wc/components/
|
|
6933
|
-
},
|
|
6934
|
-
{
|
|
6935
|
-
"label": "ShellApp gradient contract",
|
|
6936
|
-
"path": "src/wc/components/ShellApp/ShellApp.mdx"
|
|
6937
|
-
},
|
|
6938
|
-
{
|
|
6939
|
-
"label": "Application shell composition",
|
|
6940
|
-
"path": "agent/patterns/application-shell/pattern.agent.json"
|
|
6631
|
+
"label": "Storybook examples",
|
|
6632
|
+
"path": "src/wc/components/ScrollOverlay/ScrollOverlay.stories.ts"
|
|
6941
6633
|
}
|
|
6942
6634
|
]
|
|
6943
6635
|
},
|
|
6944
6636
|
"props": {
|
|
6945
|
-
"
|
|
6946
|
-
"type": "string",
|
|
6947
|
-
"required": false
|
|
6948
|
-
},
|
|
6949
|
-
"value": {
|
|
6950
|
-
"type": "ShellGradientPreset",
|
|
6637
|
+
"scrollLabel": {
|
|
6638
|
+
"type": "string | undefined",
|
|
6951
6639
|
"required": false
|
|
6952
6640
|
}
|
|
6953
6641
|
},
|
|
6954
6642
|
"events": [
|
|
6955
6643
|
{
|
|
6956
|
-
"name": "
|
|
6957
|
-
"detail": "
|
|
6644
|
+
"name": "dsScroll",
|
|
6645
|
+
"detail": "ScrollOverlayScrollDetail"
|
|
6958
6646
|
}
|
|
6959
6647
|
],
|
|
6960
6648
|
"slots": [],
|
|
6961
6649
|
"exports": {
|
|
6962
|
-
"customElement": "ds-
|
|
6963
|
-
"react": "
|
|
6964
|
-
"angular": "
|
|
6650
|
+
"customElement": "ds-scroll-overlay",
|
|
6651
|
+
"react": "DsScrollOverlay",
|
|
6652
|
+
"angular": "DsScrollOverlay"
|
|
6965
6653
|
}
|
|
6966
6654
|
},
|
|
6967
6655
|
"dependencies": [
|
|
6968
6656
|
"@ds-mo/ui",
|
|
6969
6657
|
"@ds-mo/tokens"
|
|
6970
6658
|
],
|
|
6971
|
-
"registryDependencies": [
|
|
6972
|
-
"swatch-picker"
|
|
6973
|
-
]
|
|
6659
|
+
"registryDependencies": []
|
|
6974
6660
|
},
|
|
6975
6661
|
{
|
|
6976
|
-
"name": "
|
|
6977
|
-
"title": "
|
|
6978
|
-
"description": "
|
|
6662
|
+
"name": "select",
|
|
6663
|
+
"title": "Select",
|
|
6664
|
+
"description": "Form-associated single-value select with listbox semantics, local search, rich flat options, grouped sections, loading, clearing, and surface-aware trigger chrome.",
|
|
6979
6665
|
"type": "registry:ui",
|
|
6980
6666
|
"meta": {
|
|
6981
6667
|
"library": "@ds-mo/ui",
|
|
6982
6668
|
"distribution": "npm",
|
|
6983
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
6984
|
-
"source": "src/wc/components/
|
|
6669
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/select",
|
|
6670
|
+
"source": "src/wc/components/Select/Select.tsx",
|
|
6985
6671
|
"intentStatus": "complete",
|
|
6986
6672
|
"intent": {
|
|
6987
|
-
"audience": "
|
|
6988
|
-
"status": "
|
|
6989
|
-
"
|
|
6990
|
-
"replacementReason": "SwatchPicker renders its option buttons internally so an individually published radio swatch is no longer needed.",
|
|
6991
|
-
"summary": "Deprecated internal compatibility component for one legacy ShellApp gradient swatch.",
|
|
6673
|
+
"audience": "general",
|
|
6674
|
+
"status": "stable",
|
|
6675
|
+
"summary": "Form-associated single-value select with listbox semantics, local search, rich flat options, grouped sections, loading, clearing, and surface-aware trigger chrome.",
|
|
6992
6676
|
"useWhen": [
|
|
6993
|
-
"
|
|
6677
|
+
"The user must choose one value from a finite set.",
|
|
6678
|
+
"The option set benefits from local search, subtext, prefix icons, grouping, or disabled choices.",
|
|
6679
|
+
"The choice set has more than roughly 20 options, comes from a user-managed listing, or represents a large domain such as addresses where search materially improves retrieval.",
|
|
6680
|
+
"The selected value must participate in native, Angular, or React form state."
|
|
6994
6681
|
],
|
|
6995
6682
|
"avoidWhen": [
|
|
6996
|
-
"
|
|
6997
|
-
"
|
|
6998
|
-
"
|
|
6683
|
+
"Several values may be selected at once.",
|
|
6684
|
+
"The rows perform commands rather than choosing a form value.",
|
|
6685
|
+
"The choices form a hierarchy with expandable parents."
|
|
6999
6686
|
],
|
|
7000
6687
|
"alternatives": [
|
|
7001
6688
|
{
|
|
7002
|
-
"when": "
|
|
7003
|
-
"component": "component:ds-
|
|
7004
|
-
"reason": "
|
|
6689
|
+
"when": "Several independent values may be selected.",
|
|
6690
|
+
"component": "component:ds-select-multi",
|
|
6691
|
+
"reason": "SelectMulti owns array values, multi-selection semantics, and count presentation."
|
|
6692
|
+
},
|
|
6693
|
+
{
|
|
6694
|
+
"when": "The popup contains commands or state-changing actions.",
|
|
6695
|
+
"component": "component:ds-menu",
|
|
6696
|
+
"reason": "Menu uses action-menu roles and command-focused keyboard behavior."
|
|
6697
|
+
},
|
|
6698
|
+
{
|
|
6699
|
+
"when": "A small set of choices should remain visible.",
|
|
6700
|
+
"component": "component:ds-radio",
|
|
6701
|
+
"reason": "Prefer Radio for roughly two to five mutually exclusive choices when the available space allows all choices to remain visible."
|
|
7005
6702
|
}
|
|
7006
6703
|
],
|
|
7007
6704
|
"commonlyComposedWith": [
|
|
7008
|
-
"component:ds-
|
|
6705
|
+
"component:ds-text",
|
|
6706
|
+
"component:ds-icon",
|
|
6707
|
+
"component:ds-empty-state",
|
|
6708
|
+
"component:ds-loader"
|
|
7009
6709
|
],
|
|
7010
6710
|
"accessibility": [
|
|
7011
|
-
"
|
|
7012
|
-
"
|
|
7013
|
-
"
|
|
6711
|
+
"In forms, provide a persistent visible external field label; placeholder text is guidance and must not be the field's only label. In a compact filter bar, the trigger's visible text may supply the accessible name.",
|
|
6712
|
+
"The trigger uses combobox semantics and the popup uses listbox and option semantics; do not replace them with menu roles.",
|
|
6713
|
+
"Disabled options remain visible, expose aria-disabled, and are skipped by keyboard navigation and typeahead.",
|
|
6714
|
+
"Keyboard navigation keeps the aria-activedescendant option scrolled into the visible listbox viewport.",
|
|
6715
|
+
"Selected options rely on active fill and foreground treatment without a redundant trailing check icon.",
|
|
6716
|
+
"Local search moves focus into the search field while preserving the active option through aria-activedescendant.",
|
|
6717
|
+
"Use errorMessage with error so the trigger is described by the rendered alert."
|
|
7014
6718
|
],
|
|
7015
6719
|
"states": [
|
|
7016
|
-
"
|
|
7017
|
-
"
|
|
7018
|
-
"
|
|
6720
|
+
"Value is controlled through the mutable value property; dsChange reports user selection and clearing.",
|
|
6721
|
+
"Required Selects begin without an automatic selection and require the user to make an explicit choice; do not preselect the first option merely to satisfy validity.",
|
|
6722
|
+
"When allowClear is enabled, the clear affordance appears only after a value exists. Clearing is valid for optional and required fields; a required field becomes invalid until the user selects again.",
|
|
6723
|
+
"Clearing emits dsChange with an empty string and dsClear, keeps the popup open, and restores useful focus.",
|
|
6724
|
+
"Loading keeps the trigger visible, replaces its prefix icon, marks the control busy, and makes selection interaction temporarily unavailable without presenting the control as inactive.",
|
|
6725
|
+
"The trigger label stays left-aligned at every width. The default size is md in both forms and filter bars; smaller sizes require an explicit density need.",
|
|
6726
|
+
"Use option icons only when they help users differentiate choices. Icons render only when every option in the complete list provides one; mixed icon data falls back to the text-only row layout.",
|
|
6727
|
+
"Create sections only for categories that are meaningful to customers, not merely to break a long list into arbitrary chunks.",
|
|
6728
|
+
"When any option supplies subtext, every row uses the same subtext structure and missing values render an em dash. Subtext should disambiguate or add decision-helpful information.",
|
|
6729
|
+
"Option labels and the selected trigger label stay on one line and truncate when constrained. Option subtext may wrap to at most two lines.",
|
|
6730
|
+
"The optional prefix icon and chevron always use the parent surface's secondary foreground color, including when a selected value promotes the label to primary.",
|
|
6731
|
+
"The shared popup search control stays md at every trigger size, using body-medium text, a 20px icon, and the same internal spacing as a borderless Select trigger. Its container uses menu-item padding on every side and owns a 1px bottom divider that becomes a 1.5px bold-brand stroke while search has focus. Search placeholder text is secondary at rest and quaternary while focused because it becomes decorative once the editable field is active.",
|
|
6732
|
+
"When search contains text, the shared control shows a rounded sm icon-only ButtonUnfilled with the CrossCircle icon and no border. It clears the local term, stays hidden for an empty term, and returns focus to search.",
|
|
6733
|
+
"The shared clear footer mirrors the search region's sizing: menu-item padding surrounds an md-height borderless row, and the Clear label uses the same row and label insets as option text. The outer footer owns a 1px top divider.",
|
|
6734
|
+
"An empty filtered list composes the message-only body variant of EmptyState. Keep the default neutral no-results message unless localized product guidance makes the outcome clearer.",
|
|
6735
|
+
"Enable searchable for more than roughly 20 options, user-managed listings, large domains such as addresses, or sets users cannot efficiently scan. Local matching includes option labels, subtext, and section headings; the owner resolves remote data before assigning options.",
|
|
6736
|
+
"Validation timing belongs to the form owner and may be immediate or deferred until blur or submit; the Select exposes validity and error presentation without imposing that policy.",
|
|
6737
|
+
"The error trigger uses a 1.5px bold-negative inset stroke so invalid state remains distinguishable from the normal 1px border without changing control geometry.",
|
|
6738
|
+
"An initially empty option set is not an expected Select use case. The no-results state describes a search with no matches, not a source with no choices.",
|
|
6739
|
+
"Use options for a flat list or sections for grouped choices; when sections are present they take precedence.",
|
|
6740
|
+
"The background prop describes the actual parent surface and uses the same surface set as ButtonUnfilled."
|
|
7019
6741
|
],
|
|
7020
6742
|
"responsiveBehavior": [
|
|
7021
|
-
"
|
|
6743
|
+
"Use width fill for form fields and width hug for compact filter bars. Override those defaults only when the owning layout has a clear constraint.",
|
|
6744
|
+
"The popup matches the trigger minimum width, may grow for content, and clamps to the viewport.",
|
|
6745
|
+
"Long option collections scroll inside the popup; virtualization and remote search are not part of this component."
|
|
7022
6746
|
],
|
|
7023
6747
|
"frameworkCaveats": {
|
|
7024
6748
|
"customElements": [
|
|
7025
|
-
"
|
|
6749
|
+
"Assign options and sections through JavaScript properties because arrays and objects cannot be represented safely as attributes."
|
|
7026
6750
|
],
|
|
7027
6751
|
"react": [
|
|
7028
|
-
"
|
|
6752
|
+
"Pass options or sections as wrapper props and handle onDsChange, onDsClear, and onDsOpenChange."
|
|
7029
6753
|
],
|
|
7030
6754
|
"angular": [
|
|
7031
|
-
"
|
|
6755
|
+
"Import DsSelect and SelectValueAccessor when integrating with Angular Forms; bind options and sections as properties."
|
|
7032
6756
|
]
|
|
7033
6757
|
},
|
|
7034
6758
|
"references": [
|
|
7035
6759
|
{
|
|
7036
|
-
"label": "
|
|
7037
|
-
"path": "src/wc/components/
|
|
6760
|
+
"label": "Storybook examples",
|
|
6761
|
+
"path": "src/wc/components/Select/Select.stories.ts"
|
|
6762
|
+
},
|
|
6763
|
+
{
|
|
6764
|
+
"label": "Selection patterns",
|
|
6765
|
+
"path": "src/docs/SelectionPatterns.mdx"
|
|
7038
6766
|
}
|
|
7039
6767
|
]
|
|
7040
6768
|
},
|
|
7041
6769
|
"props": {
|
|
7042
|
-
"
|
|
7043
|
-
"type": "
|
|
6770
|
+
"activeFill": {
|
|
6771
|
+
"type": "boolean",
|
|
7044
6772
|
"required": false
|
|
7045
6773
|
},
|
|
7046
|
-
"
|
|
6774
|
+
"allowClear": {
|
|
7047
6775
|
"type": "boolean",
|
|
7048
6776
|
"required": false
|
|
7049
6777
|
},
|
|
7050
|
-
"
|
|
7051
|
-
"type": "
|
|
6778
|
+
"ariaDescribedby": {
|
|
6779
|
+
"type": "string | undefined",
|
|
7052
6780
|
"required": false
|
|
7053
6781
|
},
|
|
7054
|
-
"
|
|
7055
|
-
"type": "
|
|
6782
|
+
"ariaLabel": {
|
|
6783
|
+
"type": "string | null",
|
|
7056
6784
|
"required": false
|
|
7057
|
-
}
|
|
6785
|
+
},
|
|
6786
|
+
"ariaLabelledby": {
|
|
6787
|
+
"type": "string | undefined",
|
|
6788
|
+
"required": false
|
|
6789
|
+
},
|
|
6790
|
+
"background": {
|
|
6791
|
+
"type": "SelectBackground | undefined",
|
|
6792
|
+
"required": false
|
|
6793
|
+
},
|
|
6794
|
+
"clearLabel": {
|
|
6795
|
+
"type": "string",
|
|
6796
|
+
"required": false
|
|
6797
|
+
},
|
|
6798
|
+
"disabled": {
|
|
6799
|
+
"type": "boolean",
|
|
6800
|
+
"required": false
|
|
6801
|
+
},
|
|
6802
|
+
"error": {
|
|
6803
|
+
"type": "boolean",
|
|
6804
|
+
"required": false
|
|
6805
|
+
},
|
|
6806
|
+
"errorMessage": {
|
|
6807
|
+
"type": "string | undefined",
|
|
6808
|
+
"required": false
|
|
6809
|
+
},
|
|
6810
|
+
"hasBorder": {
|
|
6811
|
+
"type": "boolean",
|
|
6812
|
+
"required": false
|
|
6813
|
+
},
|
|
6814
|
+
"icon": {
|
|
6815
|
+
"type": "string | undefined",
|
|
6816
|
+
"required": false
|
|
6817
|
+
},
|
|
6818
|
+
"inputId": {
|
|
6819
|
+
"type": "string | undefined",
|
|
6820
|
+
"required": false
|
|
6821
|
+
},
|
|
6822
|
+
"isInactive": {
|
|
6823
|
+
"type": "boolean",
|
|
6824
|
+
"required": false
|
|
6825
|
+
},
|
|
6826
|
+
"isLoading": {
|
|
6827
|
+
"type": "boolean",
|
|
6828
|
+
"required": false
|
|
6829
|
+
},
|
|
6830
|
+
"loadingLabel": {
|
|
6831
|
+
"type": "string",
|
|
6832
|
+
"required": false
|
|
6833
|
+
},
|
|
6834
|
+
"name": {
|
|
6835
|
+
"type": "string | undefined",
|
|
6836
|
+
"required": false
|
|
6837
|
+
},
|
|
6838
|
+
"noResultsText": {
|
|
6839
|
+
"type": "string",
|
|
6840
|
+
"required": false
|
|
6841
|
+
},
|
|
6842
|
+
"open": {
|
|
6843
|
+
"type": "boolean",
|
|
6844
|
+
"required": false
|
|
6845
|
+
},
|
|
6846
|
+
"options": {
|
|
6847
|
+
"type": "SelectOption[]",
|
|
6848
|
+
"required": false
|
|
6849
|
+
},
|
|
6850
|
+
"placeholder": {
|
|
6851
|
+
"type": "string",
|
|
6852
|
+
"required": false
|
|
6853
|
+
},
|
|
6854
|
+
"required": {
|
|
6855
|
+
"type": "boolean",
|
|
6856
|
+
"required": false
|
|
6857
|
+
},
|
|
6858
|
+
"requiredMessage": {
|
|
6859
|
+
"type": "string",
|
|
6860
|
+
"required": false
|
|
6861
|
+
},
|
|
6862
|
+
"searchPlaceholder": {
|
|
6863
|
+
"type": "string",
|
|
6864
|
+
"required": false
|
|
6865
|
+
},
|
|
6866
|
+
"searchable": {
|
|
6867
|
+
"type": "boolean",
|
|
6868
|
+
"required": false
|
|
6869
|
+
},
|
|
6870
|
+
"sections": {
|
|
6871
|
+
"type": "SelectSection[]",
|
|
6872
|
+
"required": false
|
|
6873
|
+
},
|
|
6874
|
+
"size": {
|
|
6875
|
+
"type": "SelectSize",
|
|
6876
|
+
"required": false
|
|
6877
|
+
},
|
|
6878
|
+
"value": {
|
|
6879
|
+
"type": "string",
|
|
6880
|
+
"required": false
|
|
6881
|
+
},
|
|
6882
|
+
"width": {
|
|
6883
|
+
"type": "SelectWidth",
|
|
6884
|
+
"required": false
|
|
6885
|
+
}
|
|
7058
6886
|
},
|
|
7059
6887
|
"events": [
|
|
7060
6888
|
{
|
|
7061
|
-
"name": "
|
|
7062
|
-
"detail": "
|
|
6889
|
+
"name": "dsChange",
|
|
6890
|
+
"detail": "string"
|
|
6891
|
+
},
|
|
6892
|
+
{
|
|
6893
|
+
"name": "dsClear",
|
|
6894
|
+
"detail": "void"
|
|
6895
|
+
},
|
|
6896
|
+
{
|
|
6897
|
+
"name": "dsOpenChange",
|
|
6898
|
+
"detail": "boolean"
|
|
7063
6899
|
}
|
|
7064
6900
|
],
|
|
7065
6901
|
"slots": [],
|
|
7066
6902
|
"exports": {
|
|
7067
|
-
"customElement": "ds-
|
|
7068
|
-
"react": "
|
|
7069
|
-
"angular": "
|
|
6903
|
+
"customElement": "ds-select",
|
|
6904
|
+
"react": "DsSelect",
|
|
6905
|
+
"angular": "DsSelect"
|
|
7070
6906
|
}
|
|
7071
6907
|
},
|
|
7072
6908
|
"dependencies": [
|
|
7073
6909
|
"@ds-mo/ui",
|
|
7074
|
-
"@ds-mo/tokens"
|
|
6910
|
+
"@ds-mo/tokens",
|
|
6911
|
+
"@ds-mo/icons"
|
|
7075
6912
|
],
|
|
7076
|
-
"registryDependencies": [
|
|
6913
|
+
"registryDependencies": [
|
|
6914
|
+
"button-unfilled",
|
|
6915
|
+
"empty-state",
|
|
6916
|
+
"icon",
|
|
6917
|
+
"loader",
|
|
6918
|
+
"text",
|
|
6919
|
+
"tooltip"
|
|
6920
|
+
]
|
|
7077
6921
|
},
|
|
7078
6922
|
{
|
|
7079
|
-
"name": "
|
|
7080
|
-
"title": "
|
|
7081
|
-
"description": "
|
|
6923
|
+
"name": "select-multi",
|
|
6924
|
+
"title": "SelectMulti",
|
|
6925
|
+
"description": "Form-associated multi-value select with a persistent trigger label, inline selected count, local search, rich flat options, grouped sections, loading, and clear-all behavior.",
|
|
7082
6926
|
"type": "registry:ui",
|
|
7083
6927
|
"meta": {
|
|
7084
6928
|
"library": "@ds-mo/ui",
|
|
7085
6929
|
"distribution": "npm",
|
|
7086
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/
|
|
7087
|
-
"source": "src/wc/components/
|
|
6930
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/select-multi",
|
|
6931
|
+
"source": "src/wc/components/SelectMulti/SelectMulti.tsx",
|
|
7088
6932
|
"intentStatus": "complete",
|
|
7089
6933
|
"intent": {
|
|
7090
|
-
"audience": "
|
|
7091
|
-
"status": "
|
|
7092
|
-
"summary": "
|
|
6934
|
+
"audience": "general",
|
|
6935
|
+
"status": "stable",
|
|
6936
|
+
"summary": "Form-associated multi-value select with a persistent trigger label, inline selected count, local search, rich flat options, grouped sections, loading, and clear-all behavior.",
|
|
7093
6937
|
"useWhen": [
|
|
7094
|
-
"
|
|
6938
|
+
"The user may choose several independent values from one finite set.",
|
|
6939
|
+
"A compact trigger should summarize selection with the field label and a count.",
|
|
6940
|
+
"The option set benefits from local search, subtext, grouping, or disabled choices.",
|
|
6941
|
+
"The choice set has more than roughly 20 options, comes from a user-managed listing, or represents a large domain where search materially improves retrieval."
|
|
7095
6942
|
],
|
|
7096
6943
|
"avoidWhen": [
|
|
7097
|
-
"
|
|
7098
|
-
"
|
|
6944
|
+
"Exactly one value may be selected.",
|
|
6945
|
+
"Selected values must remain individually removable as persistent tags outside the popup.",
|
|
6946
|
+
"The choices form a hierarchy with cascading parent selection.",
|
|
6947
|
+
"The customer task benefits more from keeping every choice and checkbox directly visible; choose between SelectMulti and a visible checkbox list from the use-case context rather than a fixed option-count threshold."
|
|
7099
6948
|
],
|
|
7100
|
-
"
|
|
7101
|
-
|
|
6949
|
+
"alternatives": [
|
|
6950
|
+
{
|
|
6951
|
+
"when": "Exactly one value may be selected.",
|
|
6952
|
+
"component": "component:ds-select",
|
|
6953
|
+
"reason": "Select owns scalar form value and single-select listbox behavior."
|
|
6954
|
+
},
|
|
6955
|
+
{
|
|
6956
|
+
"when": "The popup contains actions rather than values.",
|
|
6957
|
+
"component": "component:ds-menu",
|
|
6958
|
+
"reason": "Menu uses command semantics and closes according to action-menu expectations."
|
|
6959
|
+
}
|
|
7102
6960
|
],
|
|
7103
|
-
"
|
|
7104
|
-
"
|
|
6961
|
+
"commonlyComposedWith": [
|
|
6962
|
+
"component:ds-text",
|
|
6963
|
+
"component:ds-checkbox",
|
|
6964
|
+
"component:ds-empty-state",
|
|
6965
|
+
"component:ds-loader"
|
|
7105
6966
|
],
|
|
7106
6967
|
"accessibility": [
|
|
7107
|
-
"
|
|
7108
|
-
"
|
|
6968
|
+
"In forms, provide a persistent visible external field label. In a compact filter bar, the trigger's visible persistent label and count may supply the accessible name.",
|
|
6969
|
+
"The popup is a listbox with aria-multiselectable and every option exposes its independent aria-selected state.",
|
|
6970
|
+
"Disabled options expose aria-disabled and are skipped by keyboard navigation and typeahead.",
|
|
6971
|
+
"Keyboard navigation keeps the aria-activedescendant option scrolled into the visible listbox viewport.",
|
|
6972
|
+
"Each row uses a medium-size presentation-only ds-checkbox indicator; multi-select option rows never add a prefix icon alongside it, and the option remains the sole selection semantic and interaction target.",
|
|
6973
|
+
"The trigger keeps its field label visible and appends the current selected count; an explicit aria-label or aria-labelledby remains the authoritative accessible name when supplied.",
|
|
6974
|
+
"Use errorMessage with error so the trigger is described by the rendered alert."
|
|
7109
6975
|
],
|
|
7110
6976
|
"states": [
|
|
7111
|
-
"
|
|
7112
|
-
"
|
|
6977
|
+
"Values is a controlled JavaScript array; dsChange emits a new array after each user toggle.",
|
|
6978
|
+
"Required SelectMulti controls begin without an automatic selection and require the user to make an explicit choice.",
|
|
6979
|
+
"Selecting an option keeps the popup open so additional values can be toggled.",
|
|
6980
|
+
"The trigger label stays left-aligned at every width; every option row uses the same leading medium Checkbox indicator. The default control size is md in both forms and filter bars.",
|
|
6981
|
+
"The selected count always follows the persistent label as plain text separated by a centered dot, including for one selection, and counts every selected value even when search or grouping hides it. Never replace the count with selected option names.",
|
|
6982
|
+
"Create sections only for categories that are meaningful to customers, not merely to break a long list into arbitrary chunks.",
|
|
6983
|
+
"When any option supplies subtext, every row uses the same subtext structure and missing values render an em dash. Subtext should disambiguate or add decision-helpful information.",
|
|
6984
|
+
"Option labels stay on one line and truncate when constrained. Option subtext may wrap to at most two lines.",
|
|
6985
|
+
"The optional prefix icon and chevron always use the parent surface's secondary foreground color, including when selection promotes the label and count to primary.",
|
|
6986
|
+
"The shared popup search control stays md at every trigger size, using body-medium text, a 20px icon, and the same internal spacing as a borderless Select trigger. Its container uses menu-item padding on every side and owns a 1px bottom divider that becomes a 1.5px bold-brand stroke while search has focus. Search placeholder text is secondary at rest and quaternary while focused because it becomes decorative once the editable field is active.",
|
|
6987
|
+
"When search contains text, the shared control shows a rounded sm icon-only ButtonUnfilled with the Cross icon and no border. It clears the local term, stays hidden for an empty term, and returns focus to search.",
|
|
6988
|
+
"The shared summary-and-clear footer mirrors the search region's sizing: menu-item padding surrounds an md-height borderless row, and both texts use the same row and label insets as option text. The outer footer owns a 1px top divider.",
|
|
6989
|
+
"An empty filtered list composes the message-only body variant of EmptyState. Keep the default neutral no-results message unless localized product guidance makes the outcome clearer.",
|
|
6990
|
+
"Enable searchable for more than roughly 20 options, user-managed listings, large domains such as addresses, or sets users cannot efficiently scan. Local matching includes option labels, subtext, and section headings; the owner resolves remote data before assigning options.",
|
|
6991
|
+
"When allowClear is enabled, clear-all appears only after at least one value exists. Clearing is valid for optional and required fields; a required field becomes invalid until the user selects again.",
|
|
6992
|
+
"Clear-all emits an empty dsChange and dsClear while preserving useful popup or search focus.",
|
|
6993
|
+
"Loading keeps the trigger visible, marks the control busy, and makes selection interaction temporarily unavailable without presenting the control as inactive.",
|
|
6994
|
+
"SelectMulti has no maximum-selection behavior; every available non-inactive option may be selected.",
|
|
6995
|
+
"Validation timing belongs to the form owner and may be immediate or deferred until blur or submit; the component exposes validity and error presentation without imposing that policy.",
|
|
6996
|
+
"The error trigger uses a 1.5px bold-negative inset stroke so invalid state remains distinguishable from the normal 1px border without changing control geometry.",
|
|
6997
|
+
"An initially empty option set is not an expected SelectMulti use case. The no-results state describes a search with no matches, not a source with no choices.",
|
|
6998
|
+
"Native form submission emits one entry per selected value under the component name.",
|
|
6999
|
+
"Use options for a flat list or sections for grouped choices. Multi-select option contracts intentionally exclude icons because the leading checkbox owns that row zone; hierarchical parent selection is deferred."
|
|
7113
7000
|
],
|
|
7114
7001
|
"responsiveBehavior": [
|
|
7115
|
-
"
|
|
7002
|
+
"Use width fill for form fields and width hug for compact filter bars; the persistent trigger label avoids variable-width selected labels.",
|
|
7003
|
+
"The popup matches the trigger minimum width, may grow for content, and clamps to the viewport.",
|
|
7004
|
+
"Long option collections scroll inside the popup; virtualization and remote search are not part of this version."
|
|
7116
7005
|
],
|
|
7006
|
+
"frameworkCaveats": {
|
|
7007
|
+
"customElements": [
|
|
7008
|
+
"Assign values, options, and sections through JavaScript properties; array values cannot be represented safely as attributes."
|
|
7009
|
+
],
|
|
7010
|
+
"react": [
|
|
7011
|
+
"Pass values, options, and sections as wrapper props and handle onDsChange, onDsClear, and onDsOpenChange."
|
|
7012
|
+
],
|
|
7013
|
+
"angular": [
|
|
7014
|
+
"Import DsSelectMulti and SelectMultiValueAccessor when integrating with Angular Forms."
|
|
7015
|
+
]
|
|
7016
|
+
},
|
|
7117
7017
|
"references": [
|
|
7118
7018
|
{
|
|
7119
|
-
"label": "Storybook",
|
|
7120
|
-
"path": "src/wc/components/
|
|
7019
|
+
"label": "Storybook examples",
|
|
7020
|
+
"path": "src/wc/components/SelectMulti/SelectMulti.stories.ts"
|
|
7021
|
+
},
|
|
7022
|
+
{
|
|
7023
|
+
"label": "Selection patterns",
|
|
7024
|
+
"path": "src/docs/SelectionPatterns.mdx"
|
|
7121
7025
|
}
|
|
7122
7026
|
]
|
|
7123
7027
|
},
|
|
7124
7028
|
"props": {
|
|
7125
|
-
"
|
|
7126
|
-
"type": "
|
|
7029
|
+
"activeFill": {
|
|
7030
|
+
"type": "boolean",
|
|
7127
7031
|
"required": false
|
|
7128
7032
|
},
|
|
7129
|
-
"
|
|
7033
|
+
"allowClear": {
|
|
7130
7034
|
"type": "boolean",
|
|
7131
7035
|
"required": false
|
|
7132
7036
|
},
|
|
7133
|
-
"
|
|
7037
|
+
"ariaDescribedby": {
|
|
7038
|
+
"type": "string | undefined",
|
|
7039
|
+
"required": false
|
|
7040
|
+
},
|
|
7041
|
+
"ariaLabel": {
|
|
7042
|
+
"type": "string | null",
|
|
7043
|
+
"required": false
|
|
7044
|
+
},
|
|
7045
|
+
"ariaLabelledby": {
|
|
7046
|
+
"type": "string | undefined",
|
|
7047
|
+
"required": false
|
|
7048
|
+
},
|
|
7049
|
+
"background": {
|
|
7050
|
+
"type": "SelectMultiBackground | undefined",
|
|
7051
|
+
"required": false
|
|
7052
|
+
},
|
|
7053
|
+
"clearLabel": {
|
|
7054
|
+
"type": "string",
|
|
7055
|
+
"required": false
|
|
7056
|
+
},
|
|
7057
|
+
"disabled": {
|
|
7058
|
+
"type": "boolean",
|
|
7059
|
+
"required": false
|
|
7060
|
+
},
|
|
7061
|
+
"error": {
|
|
7062
|
+
"type": "boolean",
|
|
7063
|
+
"required": false
|
|
7064
|
+
},
|
|
7065
|
+
"errorMessage": {
|
|
7066
|
+
"type": "string | undefined",
|
|
7067
|
+
"required": false
|
|
7068
|
+
},
|
|
7069
|
+
"hasBorder": {
|
|
7070
|
+
"type": "boolean",
|
|
7071
|
+
"required": false
|
|
7072
|
+
},
|
|
7073
|
+
"icon": {
|
|
7074
|
+
"type": "string | undefined",
|
|
7075
|
+
"required": false
|
|
7076
|
+
},
|
|
7077
|
+
"inputId": {
|
|
7078
|
+
"type": "string | undefined",
|
|
7079
|
+
"required": false
|
|
7080
|
+
},
|
|
7081
|
+
"isInactive": {
|
|
7082
|
+
"type": "boolean",
|
|
7083
|
+
"required": false
|
|
7084
|
+
},
|
|
7085
|
+
"isLoading": {
|
|
7086
|
+
"type": "boolean",
|
|
7087
|
+
"required": false
|
|
7088
|
+
},
|
|
7089
|
+
"loadingLabel": {
|
|
7090
|
+
"type": "string",
|
|
7091
|
+
"required": false
|
|
7092
|
+
},
|
|
7093
|
+
"name": {
|
|
7094
|
+
"type": "string | undefined",
|
|
7095
|
+
"required": false
|
|
7096
|
+
},
|
|
7097
|
+
"noResultsText": {
|
|
7098
|
+
"type": "string",
|
|
7099
|
+
"required": false
|
|
7100
|
+
},
|
|
7101
|
+
"open": {
|
|
7102
|
+
"type": "boolean",
|
|
7103
|
+
"required": false
|
|
7104
|
+
},
|
|
7105
|
+
"options": {
|
|
7106
|
+
"type": "SelectMultiOption[]",
|
|
7107
|
+
"required": false
|
|
7108
|
+
},
|
|
7109
|
+
"placeholder": {
|
|
7110
|
+
"type": "string",
|
|
7111
|
+
"required": false
|
|
7112
|
+
},
|
|
7113
|
+
"required": {
|
|
7114
|
+
"type": "boolean",
|
|
7115
|
+
"required": false
|
|
7116
|
+
},
|
|
7117
|
+
"requiredMessage": {
|
|
7118
|
+
"type": "string",
|
|
7119
|
+
"required": false
|
|
7120
|
+
},
|
|
7121
|
+
"searchPlaceholder": {
|
|
7122
|
+
"type": "string",
|
|
7123
|
+
"required": false
|
|
7124
|
+
},
|
|
7125
|
+
"searchable": {
|
|
7126
|
+
"type": "boolean",
|
|
7127
|
+
"required": false
|
|
7128
|
+
},
|
|
7129
|
+
"sections": {
|
|
7130
|
+
"type": "SelectMultiSection[]",
|
|
7131
|
+
"required": false
|
|
7132
|
+
},
|
|
7133
|
+
"selectedLabel": {
|
|
7134
7134
|
"type": "string",
|
|
7135
7135
|
"required": false
|
|
7136
7136
|
},
|
|
7137
|
-
"
|
|
7138
|
-
"type": "
|
|
7137
|
+
"size": {
|
|
7138
|
+
"type": "SelectMultiSize",
|
|
7139
|
+
"required": false
|
|
7140
|
+
},
|
|
7141
|
+
"values": {
|
|
7142
|
+
"type": "string[]",
|
|
7143
|
+
"required": false
|
|
7144
|
+
},
|
|
7145
|
+
"width": {
|
|
7146
|
+
"type": "SelectMultiWidth",
|
|
7147
|
+
"required": false
|
|
7148
|
+
}
|
|
7149
|
+
},
|
|
7150
|
+
"events": [
|
|
7151
|
+
{
|
|
7152
|
+
"name": "dsChange",
|
|
7153
|
+
"detail": "string[]"
|
|
7154
|
+
},
|
|
7155
|
+
{
|
|
7156
|
+
"name": "dsClear",
|
|
7157
|
+
"detail": "void"
|
|
7158
|
+
},
|
|
7159
|
+
{
|
|
7160
|
+
"name": "dsOpenChange",
|
|
7161
|
+
"detail": "boolean"
|
|
7162
|
+
}
|
|
7163
|
+
],
|
|
7164
|
+
"slots": [],
|
|
7165
|
+
"exports": {
|
|
7166
|
+
"customElement": "ds-select-multi",
|
|
7167
|
+
"react": "DsSelectMulti",
|
|
7168
|
+
"angular": "DsSelectMulti"
|
|
7169
|
+
}
|
|
7170
|
+
},
|
|
7171
|
+
"dependencies": [
|
|
7172
|
+
"@ds-mo/ui",
|
|
7173
|
+
"@ds-mo/tokens",
|
|
7174
|
+
"@ds-mo/icons"
|
|
7175
|
+
],
|
|
7176
|
+
"registryDependencies": [
|
|
7177
|
+
"button-unfilled",
|
|
7178
|
+
"checkbox",
|
|
7179
|
+
"empty-state",
|
|
7180
|
+
"icon",
|
|
7181
|
+
"loader",
|
|
7182
|
+
"text",
|
|
7183
|
+
"tooltip"
|
|
7184
|
+
]
|
|
7185
|
+
},
|
|
7186
|
+
{
|
|
7187
|
+
"name": "shell-app",
|
|
7188
|
+
"title": "ShellApp",
|
|
7189
|
+
"description": "The single required workspace root for standard authenticated application pages, coordinating primary and secondary navigation, tools chrome, responsive composition, content geometry, shared styling, and shell behavior.",
|
|
7190
|
+
"type": "registry:ui",
|
|
7191
|
+
"meta": {
|
|
7192
|
+
"library": "@ds-mo/ui",
|
|
7193
|
+
"distribution": "npm",
|
|
7194
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/shell-app",
|
|
7195
|
+
"source": "src/wc/components/ShellApp/ShellApp.tsx",
|
|
7196
|
+
"intentStatus": "complete",
|
|
7197
|
+
"intent": {
|
|
7198
|
+
"audience": "specialized",
|
|
7199
|
+
"status": "stable",
|
|
7200
|
+
"summary": "The single required workspace root for standard authenticated application pages, coordinating primary and secondary navigation, tools chrome, responsive composition, content geometry, shared styling, and shell behavior.",
|
|
7201
|
+
"useWhen": [
|
|
7202
|
+
"Building any standard authenticated product or workspace page with CompoMo.",
|
|
7203
|
+
"PanelNav, BarNav, ShellTools, mobile navigation, page content, shared chrome, responsive behavior, and shell shortcuts must be composed as one application frame.",
|
|
7204
|
+
"Future application templates need the supported base-page composition boundary."
|
|
7205
|
+
],
|
|
7206
|
+
"avoidWhen": [
|
|
7207
|
+
"Building authentication, onboarding, public, marketing, print, error, or intentionally focused full-screen experiences that require a different layout.",
|
|
7208
|
+
"Another ShellApp already exists in the page; applications must render exactly one and must never nest ShellApps.",
|
|
7209
|
+
"Building content inside an existing ShellApp; render the page content rather than another shell."
|
|
7210
|
+
],
|
|
7211
|
+
"commonlyComposedWith": [
|
|
7212
|
+
"component:ds-panel-nav",
|
|
7213
|
+
"component:ds-bar-nav",
|
|
7214
|
+
"component:ds-panel-tools",
|
|
7215
|
+
"component:ds-shell-tools",
|
|
7216
|
+
"component:ds-mobile-sheet-nav",
|
|
7217
|
+
"component:ds-mobile-header",
|
|
7218
|
+
"component:ds-mobile-bar-nav",
|
|
7219
|
+
"component:ds-shell-page",
|
|
7220
|
+
"component:ds-swatch-picker"
|
|
7221
|
+
],
|
|
7222
|
+
"patterns": [
|
|
7223
|
+
"pattern:application-shell",
|
|
7224
|
+
"pattern:shell-page"
|
|
7225
|
+
],
|
|
7226
|
+
"accessibility": [
|
|
7227
|
+
"Keep primary destinations in PanelNav and secondary route sections in BarNav.",
|
|
7228
|
+
"Ensure the default content region contains the page's single main landmark.",
|
|
7229
|
+
"Keep PanelNav, BarNav, and PanelTools-compatible chrome available in desktop and tablet compositions and the persistent mobile bar available below 768px.",
|
|
7230
|
+
"Do not override browser keyboard chords when enabling shell shortcuts.",
|
|
7231
|
+
"Require Search and Help as the minimum PanelTools actions and provide accessible labels for every tool.",
|
|
7232
|
+
"Preserve focus and accessible names across navigation, collapse, overflow, and responsive presentation changes."
|
|
7233
|
+
],
|
|
7234
|
+
"states": [
|
|
7235
|
+
"Render exactly one ShellApp as the workspace root and never nest it.",
|
|
7236
|
+
"PanelNav, BarNav, and ShellTools are the responsive shell regions; ShellTools contains at least Search and Help even when no additional product tools apply.",
|
|
7237
|
+
"The application router owns the current route, authorization filtering, Dashboard or Settings context, destination collections, section collections, and localized content labels.",
|
|
7238
|
+
"ShellApp propagates navStyle and resolved responsive mode and coordinates layout, gradient alignment, transitions, metrics, shortcuts, and mobile-stage visibility.",
|
|
7239
|
+
"The application controls mobileDestination and mobileSheetNavOpen and keeps router state independent from global tool-surface changes.",
|
|
7240
|
+
"Set gradientPreset to the single resolved global chrome preference: neutral by default, none for solid chrome, or cool, neutral, warm, and fresh for token-based washes.",
|
|
7241
|
+
"The application owns gradient preference persistence, cross-tab synchronization, and server or account precedence; ShellApp owns rendering the resolved preset across authenticated routes.",
|
|
7242
|
+
"Dashboard represents day-to-day operational work while Settings represents administrative and configuration work; route state selects the context.",
|
|
7243
|
+
"Update PanelNav groups, BarNav tabs and heading, navStyle, basePath, and currentUrl atomically from one resolved route state.",
|
|
7244
|
+
"BarNav remains present: it shows route-section tabs when available and the active PanelNav destination label as heading otherwise.",
|
|
7245
|
+
"Render one ShellPage as the default-slot child for each standard routed page; ShellApp owns the content scroller while ShellPage owns page header stickiness and content inset.",
|
|
7246
|
+
"The application filters unauthorized destinations, sections, and tools before passing them into shell components."
|
|
7247
|
+
],
|
|
7248
|
+
"responsiveBehavior": [
|
|
7249
|
+
"ShellApp owns the fixed system breakpoints and resolves desktop at 1200px and wider, tablet from 768px through 1199px, and mobile below 768px.",
|
|
7250
|
+
"On desktop, PanelNav defaults expanded, permits user collapse or expansion, and respects the locally persisted desktop preference.",
|
|
7251
|
+
"On tablet, ShellApp keeps PanelNav permanently collapsed and prevents user expansion without overwriting the desktop preference.",
|
|
7252
|
+
"On mobile, ShellApp hides and inerts PanelNav and BarNav, uses a solid primary stage, and composes routed ShellPage MobileHeader presentations, MobileSheetNav, ShellTools, and the persistent five-item MobileBarNav.",
|
|
7253
|
+
"Mobile global surfaces conceal and inert the routed workspace without unmounting it, preserving nested routes and scroll state.",
|
|
7254
|
+
"Keep PanelNav width, BarNav height, PanelTools chrome, and main-content origin stable except during intentional responsive or collapse transitions.",
|
|
7255
|
+
"The bottom bar remains visible at all route and tool depths in the foundation release."
|
|
7256
|
+
],
|
|
7257
|
+
"frameworkCaveats": {
|
|
7258
|
+
"customElements": [
|
|
7259
|
+
"Assign complex navigation and tool collections as JavaScript properties on the slotted components.",
|
|
7260
|
+
"Stamp route-derived nav-style before components connect when deterministic first paint is required."
|
|
7261
|
+
],
|
|
7262
|
+
"react": [
|
|
7263
|
+
"Use generated wrappers and preserve native slot names for desktop navigation, responsive tools, mobile navigation, and main content.",
|
|
7264
|
+
"Resolve all shell inputs from one router state before rendering the composition."
|
|
7265
|
+
],
|
|
7266
|
+
"angular": [
|
|
7267
|
+
"Use generated standalone adapters and preserve slot attributes in templates.",
|
|
7268
|
+
"Bind complex inputs as properties and update navigation inputs atomically from one resolved router state.",
|
|
7269
|
+
"Bind both nav-style attributes and properties when deterministic first paint is required."
|
|
7270
|
+
]
|
|
7271
|
+
},
|
|
7272
|
+
"references": [
|
|
7273
|
+
{
|
|
7274
|
+
"label": "Component guide",
|
|
7275
|
+
"path": "src/wc/components/ShellApp/ShellApp.mdx"
|
|
7276
|
+
},
|
|
7277
|
+
{
|
|
7278
|
+
"label": "Executable Storybook composition",
|
|
7279
|
+
"path": "src/wc/components/ShellApp/ShellApp.stories.ts"
|
|
7280
|
+
},
|
|
7281
|
+
{
|
|
7282
|
+
"label": "Framework integration",
|
|
7283
|
+
"path": "docs/framework-integration.md"
|
|
7284
|
+
},
|
|
7285
|
+
{
|
|
7286
|
+
"label": "Application shell contract",
|
|
7287
|
+
"path": "agent/patterns/application-shell/pattern.agent.json"
|
|
7288
|
+
}
|
|
7289
|
+
]
|
|
7290
|
+
},
|
|
7291
|
+
"props": {
|
|
7292
|
+
"gradientPreset": {
|
|
7293
|
+
"type": "ShellGradientPreset",
|
|
7294
|
+
"required": false
|
|
7295
|
+
},
|
|
7296
|
+
"mobileDestination": {
|
|
7297
|
+
"type": "MobileDestination",
|
|
7139
7298
|
"required": false
|
|
7140
7299
|
},
|
|
7141
|
-
"
|
|
7300
|
+
"mobileSheetNavOpen": {
|
|
7142
7301
|
"type": "boolean",
|
|
7143
7302
|
"required": false
|
|
7144
7303
|
},
|
|
7145
|
-
"
|
|
7146
|
-
"type": "
|
|
7147
|
-
"required": false
|
|
7148
|
-
},
|
|
7149
|
-
"menuLabel": {
|
|
7150
|
-
"type": "string",
|
|
7151
|
-
"required": false
|
|
7152
|
-
},
|
|
7153
|
-
"navigationExpanded": {
|
|
7154
|
-
"type": "boolean",
|
|
7304
|
+
"navStyle": {
|
|
7305
|
+
"type": "NavChromeStyle",
|
|
7155
7306
|
"required": false
|
|
7156
7307
|
},
|
|
7157
|
-
"
|
|
7308
|
+
"shortcutsEnabled": {
|
|
7158
7309
|
"type": "boolean",
|
|
7159
7310
|
"required": false
|
|
7160
|
-
},
|
|
7161
|
-
"searchLabel": {
|
|
7162
|
-
"type": "string",
|
|
7163
|
-
"required": false
|
|
7164
7311
|
}
|
|
7165
7312
|
},
|
|
7166
7313
|
"events": [
|
|
7167
7314
|
{
|
|
7168
|
-
"name": "
|
|
7169
|
-
"detail": "
|
|
7170
|
-
},
|
|
7171
|
-
{
|
|
7172
|
-
"name": "dsNavigationToggle",
|
|
7173
|
-
"detail": "boolean"
|
|
7315
|
+
"name": "dsResponsiveModeChange",
|
|
7316
|
+
"detail": "{ mode: ShellResponsiveMode }"
|
|
7174
7317
|
}
|
|
7175
7318
|
],
|
|
7176
7319
|
"slots": [],
|
|
7177
7320
|
"exports": {
|
|
7178
|
-
"customElement": "ds-shell-
|
|
7179
|
-
"react": "
|
|
7180
|
-
"angular": "
|
|
7321
|
+
"customElement": "ds-shell-app",
|
|
7322
|
+
"react": "DsShellApp",
|
|
7323
|
+
"angular": "DsShellApp"
|
|
7181
7324
|
}
|
|
7182
7325
|
},
|
|
7183
7326
|
"dependencies": [
|
|
7184
7327
|
"@ds-mo/ui",
|
|
7185
|
-
"@ds-mo/tokens"
|
|
7186
|
-
"@ds-mo/icons"
|
|
7328
|
+
"@ds-mo/tokens"
|
|
7187
7329
|
],
|
|
7188
|
-
"registryDependencies": [
|
|
7189
|
-
"icon",
|
|
7190
|
-
"text"
|
|
7191
|
-
]
|
|
7330
|
+
"registryDependencies": []
|
|
7192
7331
|
},
|
|
7193
7332
|
{
|
|
7194
|
-
"name": "shell-
|
|
7195
|
-
"title": "
|
|
7196
|
-
"description": "
|
|
7333
|
+
"name": "shell-gradient-picker",
|
|
7334
|
+
"title": "ShellGradientPicker",
|
|
7335
|
+
"description": "Deprecated compatibility wrapper that maps the fixed ShellApp wash presets into SwatchPicker.",
|
|
7197
7336
|
"type": "registry:ui",
|
|
7198
7337
|
"meta": {
|
|
7199
7338
|
"library": "@ds-mo/ui",
|
|
7200
7339
|
"distribution": "npm",
|
|
7201
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/shell-
|
|
7202
|
-
"source": "src/wc/components/
|
|
7340
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/shell-gradient-picker",
|
|
7341
|
+
"source": "src/wc/components/ShellGradientPicker/ShellGradientPicker.tsx",
|
|
7203
7342
|
"intentStatus": "complete",
|
|
7204
7343
|
"intent": {
|
|
7205
7344
|
"audience": "specialized",
|
|
7206
|
-
"status": "
|
|
7207
|
-
"
|
|
7345
|
+
"status": "deprecated",
|
|
7346
|
+
"replacedBy": "component:ds-swatch-picker",
|
|
7347
|
+
"replacementReason": "SwatchPicker now owns the same accessible interaction with a generic option model that supports both flat colors and gradients.",
|
|
7348
|
+
"summary": "Deprecated compatibility wrapper that maps the fixed ShellApp wash presets into SwatchPicker.",
|
|
7208
7349
|
"useWhen": [
|
|
7209
|
-
"
|
|
7350
|
+
"Adding the Appearance or Theme section to the application's user or account menu.",
|
|
7351
|
+
"Users must choose the global ShellApp chrome treatment from none, cool, neutral, warm, or fresh."
|
|
7210
7352
|
],
|
|
7211
7353
|
"avoidWhen": [
|
|
7212
|
-
"
|
|
7213
|
-
"
|
|
7354
|
+
"Choosing semantic intent, page background, chart, content, or brand colors.",
|
|
7355
|
+
"Building an arbitrary gradient editor or allowing custom gradient values.",
|
|
7356
|
+
"A picker already exists for the application; provide exactly one canonical preference location.",
|
|
7357
|
+
"Rendering an individual swatch outside the complete picker."
|
|
7358
|
+
],
|
|
7359
|
+
"alternatives": [
|
|
7360
|
+
{
|
|
7361
|
+
"when": "The user is selecting the application light, dark, or system color mode.",
|
|
7362
|
+
"component": "component:ds-menu",
|
|
7363
|
+
"reason": "Color mode is a separate appearance preference and should use ordinary menu selection rows."
|
|
7364
|
+
}
|
|
7214
7365
|
],
|
|
7215
7366
|
"commonlyComposedWith": [
|
|
7216
7367
|
"component:ds-shell-app",
|
|
7217
|
-
"component:ds-
|
|
7368
|
+
"component:ds-menu"
|
|
7218
7369
|
],
|
|
7219
7370
|
"patterns": [
|
|
7220
7371
|
"pattern:application-shell"
|
|
7221
7372
|
],
|
|
7222
7373
|
"accessibility": [
|
|
7223
|
-
"
|
|
7224
|
-
"
|
|
7374
|
+
"Provide a localized groupLabel that describes the shell appearance choice.",
|
|
7375
|
+
"Treat the presets as one radio group with one Tab stop; Arrow keys, Home, and End move and select within the group.",
|
|
7376
|
+
"Keep the visible compact swatches and their accessible preset names; do not rely on color alone for assistive technology."
|
|
7225
7377
|
],
|
|
7226
7378
|
"states": [
|
|
7227
|
-
"
|
|
7228
|
-
"
|
|
7379
|
+
"Neutral is the default preset; none renders solid shell chrome without a wash.",
|
|
7380
|
+
"Cool, neutral, warm, and fresh use design tokens and automatically adapt to the active light or dark color theme.",
|
|
7381
|
+
"Apply dsChange immediately to ShellApp.gradientPreset and keep the containing account menu open.",
|
|
7382
|
+
"The application owns local persistence, cross-tab synchronization, and server or account preference precedence; the picker owns only selection UI and events.",
|
|
7383
|
+
"Treat the fixed preset union as the only supported values and do not construct custom gradients."
|
|
7229
7384
|
],
|
|
7230
7385
|
"responsiveBehavior": [
|
|
7231
|
-
"
|
|
7386
|
+
"Keep the compact picker in the user or account appearance menu on supported desktop and tablet shell compositions.",
|
|
7387
|
+
"The future mobile account surface may present the same preference differently."
|
|
7232
7388
|
],
|
|
7389
|
+
"frameworkCaveats": {
|
|
7390
|
+
"customElements": [
|
|
7391
|
+
"Listen for dsChange, resolve application preference precedence, and assign the result to the single ShellApp gradientPreset property."
|
|
7392
|
+
],
|
|
7393
|
+
"react": [
|
|
7394
|
+
"Use the generated wrapper and handle onDsChange without closing the containing account menu."
|
|
7395
|
+
],
|
|
7396
|
+
"angular": [
|
|
7397
|
+
"Bind value to the resolved preference and handle dsChange to update application state."
|
|
7398
|
+
]
|
|
7399
|
+
},
|
|
7233
7400
|
"references": [
|
|
7234
7401
|
{
|
|
7235
|
-
"label": "
|
|
7236
|
-
"path": "src/wc/components/
|
|
7402
|
+
"label": "Replacement stories",
|
|
7403
|
+
"path": "src/wc/components/SwatchPicker/SwatchPicker.stories.ts"
|
|
7404
|
+
},
|
|
7405
|
+
{
|
|
7406
|
+
"label": "ShellApp gradient contract",
|
|
7407
|
+
"path": "src/wc/components/ShellApp/ShellApp.mdx"
|
|
7408
|
+
},
|
|
7409
|
+
{
|
|
7410
|
+
"label": "Application shell composition",
|
|
7411
|
+
"path": "agent/patterns/application-shell/pattern.agent.json"
|
|
7237
7412
|
}
|
|
7238
7413
|
]
|
|
7239
7414
|
},
|
|
7240
7415
|
"props": {
|
|
7241
|
-
"
|
|
7242
|
-
"type": "string",
|
|
7243
|
-
"required": false
|
|
7244
|
-
},
|
|
7245
|
-
"browseContext": {
|
|
7246
|
-
"type": "NavChromeStyle",
|
|
7247
|
-
"required": false
|
|
7248
|
-
},
|
|
7249
|
-
"currentUrl": {
|
|
7250
|
-
"type": "string",
|
|
7251
|
-
"required": false
|
|
7252
|
-
},
|
|
7253
|
-
"dashboardGroups": {
|
|
7254
|
-
"type": "PanelNavGroup[]",
|
|
7255
|
-
"required": false
|
|
7256
|
-
},
|
|
7257
|
-
"dashboardLabel": {
|
|
7258
|
-
"type": "string",
|
|
7259
|
-
"required": false
|
|
7260
|
-
},
|
|
7261
|
-
"heading": {
|
|
7262
|
-
"type": "string",
|
|
7263
|
-
"required": false
|
|
7264
|
-
},
|
|
7265
|
-
"helpLabel": {
|
|
7266
|
-
"type": "string",
|
|
7267
|
-
"required": false
|
|
7268
|
-
},
|
|
7269
|
-
"navigationLabel": {
|
|
7416
|
+
"groupLabel": {
|
|
7270
7417
|
"type": "string",
|
|
7271
7418
|
"required": false
|
|
7272
7419
|
},
|
|
7273
|
-
"
|
|
7274
|
-
"type": "
|
|
7275
|
-
"required": false
|
|
7276
|
-
},
|
|
7277
|
-
"settingsGroups": {
|
|
7278
|
-
"type": "PanelNavGroup[]",
|
|
7279
|
-
"required": false
|
|
7280
|
-
},
|
|
7281
|
-
"settingsLabel": {
|
|
7282
|
-
"type": "string",
|
|
7420
|
+
"value": {
|
|
7421
|
+
"type": "ShellGradientPreset",
|
|
7283
7422
|
"required": false
|
|
7284
7423
|
}
|
|
7285
7424
|
},
|
|
7286
7425
|
"events": [
|
|
7287
7426
|
{
|
|
7288
|
-
"name": "
|
|
7289
|
-
"detail": "
|
|
7290
|
-
},
|
|
7291
|
-
{
|
|
7292
|
-
"name": "dsAuxiliarySelect",
|
|
7293
|
-
"detail": "ShellMobileNavAuxiliaryDetail"
|
|
7294
|
-
},
|
|
7295
|
-
{
|
|
7296
|
-
"name": "dsBrowseContextChange",
|
|
7297
|
-
"detail": "NavChromeStyle"
|
|
7298
|
-
},
|
|
7299
|
-
{
|
|
7300
|
-
"name": "dsClose",
|
|
7301
|
-
"detail": "void"
|
|
7427
|
+
"name": "dsChange",
|
|
7428
|
+
"detail": "ShellGradientPreset"
|
|
7302
7429
|
}
|
|
7303
7430
|
],
|
|
7304
7431
|
"slots": [],
|
|
7305
7432
|
"exports": {
|
|
7306
|
-
"customElement": "ds-shell-
|
|
7307
|
-
"react": "
|
|
7308
|
-
"angular": "
|
|
7433
|
+
"customElement": "ds-shell-gradient-picker",
|
|
7434
|
+
"react": "DsShellGradientPicker",
|
|
7435
|
+
"angular": "DsShellGradientPicker"
|
|
7309
7436
|
}
|
|
7310
7437
|
},
|
|
7311
7438
|
"dependencies": [
|
|
7312
7439
|
"@ds-mo/ui",
|
|
7313
|
-
"@ds-mo/tokens"
|
|
7314
|
-
"@ds-mo/icons"
|
|
7440
|
+
"@ds-mo/tokens"
|
|
7315
7441
|
],
|
|
7316
7442
|
"registryDependencies": [
|
|
7317
|
-
"
|
|
7318
|
-
"tab-group",
|
|
7319
|
-
"text"
|
|
7443
|
+
"swatch-picker"
|
|
7320
7444
|
]
|
|
7321
7445
|
},
|
|
7322
7446
|
{
|
|
7323
|
-
"name": "shell-
|
|
7324
|
-
"title": "
|
|
7325
|
-
"description": "
|
|
7447
|
+
"name": "shell-gradient-swatch",
|
|
7448
|
+
"title": "ShellGradientSwatch",
|
|
7449
|
+
"description": "Deprecated internal compatibility component for one legacy ShellApp gradient swatch.",
|
|
7326
7450
|
"type": "registry:ui",
|
|
7327
7451
|
"meta": {
|
|
7328
7452
|
"library": "@ds-mo/ui",
|
|
7329
7453
|
"distribution": "npm",
|
|
7330
|
-
"storybook": "https://zainadeel.github.io/compomo/?path=/story/shell-
|
|
7331
|
-
"source": "src/wc/components/
|
|
7454
|
+
"storybook": "https://zainadeel.github.io/compomo/?path=/story/shell-gradient-swatch",
|
|
7455
|
+
"source": "src/wc/components/ShellGradientSwatch/ShellGradientSwatch.tsx",
|
|
7332
7456
|
"intentStatus": "complete",
|
|
7333
7457
|
"intent": {
|
|
7334
|
-
"audience": "
|
|
7335
|
-
"status": "
|
|
7336
|
-
"
|
|
7458
|
+
"audience": "internal",
|
|
7459
|
+
"status": "deprecated",
|
|
7460
|
+
"replacedBy": "component:ds-swatch-picker",
|
|
7461
|
+
"replacementReason": "SwatchPicker renders its option buttons internally so an individually published radio swatch is no longer needed.",
|
|
7462
|
+
"summary": "Deprecated internal compatibility component for one legacy ShellApp gradient swatch.",
|
|
7337
7463
|
"useWhen": [
|
|
7338
|
-
"
|
|
7464
|
+
"Maintaining or extending ShellGradientPicker inside CompoMo."
|
|
7339
7465
|
],
|
|
7340
7466
|
"avoidWhen": [
|
|
7341
|
-
"
|
|
7342
|
-
"
|
|
7467
|
+
"Building application UI directly; use ShellGradientPicker instead.",
|
|
7468
|
+
"Selecting semantic, brand, chart, page, or arbitrary gradient colors.",
|
|
7469
|
+
"Creating a partial or custom set of shell gradient choices."
|
|
7343
7470
|
],
|
|
7344
7471
|
"alternatives": [
|
|
7345
7472
|
{
|
|
7346
|
-
"when": "
|
|
7347
|
-
"component": "component:ds-
|
|
7348
|
-
"reason": "
|
|
7473
|
+
"when": "An application needs the supported global shell appearance control.",
|
|
7474
|
+
"component": "component:ds-swatch-picker",
|
|
7475
|
+
"reason": "SwatchPicker provides the complete radio-group semantics, keyboard behavior, generic previews, and selection event."
|
|
7349
7476
|
}
|
|
7350
7477
|
],
|
|
7351
7478
|
"commonlyComposedWith": [
|
|
7352
|
-
"component:ds-
|
|
7353
|
-
"component:ds-shell-mobile-bar",
|
|
7354
|
-
"component:ds-bar-nav"
|
|
7355
|
-
],
|
|
7356
|
-
"patterns": [
|
|
7357
|
-
"pattern:application-shell"
|
|
7479
|
+
"component:ds-swatch-picker"
|
|
7358
7480
|
],
|
|
7359
7481
|
"accessibility": [
|
|
7360
|
-
"
|
|
7361
|
-
"
|
|
7482
|
+
"Keep radio semantics, aria-checked state, and a preset-specific accessible name on the internal button.",
|
|
7483
|
+
"Let ShellGradientPicker manage the roving tab stop and group keyboard navigation.",
|
|
7484
|
+
"Do not expose an unlabeled color-only choice."
|
|
7362
7485
|
],
|
|
7363
7486
|
"states": [
|
|
7364
|
-
"
|
|
7365
|
-
"
|
|
7487
|
+
"Preset determines the token-based preview; selected determines radio state and selected visuals.",
|
|
7488
|
+
"The selected swatch owns the radio group's single tab stop while ShellGradientPicker coordinates selection and focus movement.",
|
|
7489
|
+
"isInactive disables interaction but does not remove the accessible name."
|
|
7366
7490
|
],
|
|
7367
7491
|
"responsiveBehavior": [
|
|
7368
|
-
"
|
|
7492
|
+
"Preserve the fixed compact swatch geometry and let ShellGradientPicker own layout."
|
|
7369
7493
|
],
|
|
7370
7494
|
"frameworkCaveats": {
|
|
7371
7495
|
"customElements": [
|
|
7372
|
-
"
|
|
7496
|
+
"Do not instantiate this internal primitive in consuming applications."
|
|
7373
7497
|
],
|
|
7374
7498
|
"react": [
|
|
7375
|
-
"
|
|
7499
|
+
"Use DsShellGradientPicker rather than the generated swatch wrapper."
|
|
7376
7500
|
],
|
|
7377
7501
|
"angular": [
|
|
7378
|
-
"
|
|
7502
|
+
"Use DsShellGradientPicker rather than importing DsShellGradientSwatch."
|
|
7379
7503
|
]
|
|
7380
7504
|
},
|
|
7381
7505
|
"references": [
|
|
7382
7506
|
{
|
|
7383
|
-
"label": "
|
|
7384
|
-
"path": "src/wc/components/
|
|
7507
|
+
"label": "Parent picker",
|
|
7508
|
+
"path": "src/wc/components/ShellGradientPicker/ShellGradientPicker.tsx"
|
|
7385
7509
|
}
|
|
7386
7510
|
]
|
|
7387
7511
|
},
|
|
7388
7512
|
"props": {
|
|
7389
|
-
"
|
|
7390
|
-
"type": "string",
|
|
7391
|
-
"required": false
|
|
7392
|
-
},
|
|
7393
|
-
"currentUrl": {
|
|
7394
|
-
"type": "string",
|
|
7395
|
-
"required": false
|
|
7396
|
-
},
|
|
7397
|
-
"heading": {
|
|
7398
|
-
"type": "string | undefined",
|
|
7399
|
-
"required": false
|
|
7400
|
-
},
|
|
7401
|
-
"navigationLabel": {
|
|
7402
|
-
"type": "string",
|
|
7513
|
+
"ariaLabel": {
|
|
7514
|
+
"type": "string | null",
|
|
7403
7515
|
"required": false
|
|
7404
7516
|
},
|
|
7405
|
-
"
|
|
7406
|
-
"type": "
|
|
7517
|
+
"isInactive": {
|
|
7518
|
+
"type": "boolean",
|
|
7407
7519
|
"required": false
|
|
7408
7520
|
},
|
|
7409
|
-
"
|
|
7410
|
-
"type": "
|
|
7521
|
+
"preset": {
|
|
7522
|
+
"type": "ShellGradientPreset",
|
|
7411
7523
|
"required": false
|
|
7412
7524
|
},
|
|
7413
|
-
"
|
|
7414
|
-
"type": "
|
|
7525
|
+
"selected": {
|
|
7526
|
+
"type": "boolean",
|
|
7415
7527
|
"required": false
|
|
7416
7528
|
}
|
|
7417
7529
|
},
|
|
7418
7530
|
"events": [
|
|
7419
7531
|
{
|
|
7420
|
-
"name": "
|
|
7421
|
-
"detail": "
|
|
7532
|
+
"name": "dsSelect",
|
|
7533
|
+
"detail": "ShellGradientPreset"
|
|
7422
7534
|
}
|
|
7423
7535
|
],
|
|
7424
7536
|
"slots": [],
|
|
7425
7537
|
"exports": {
|
|
7426
|
-
"customElement": "ds-shell-
|
|
7427
|
-
"react": "
|
|
7428
|
-
"angular": "
|
|
7538
|
+
"customElement": "ds-shell-gradient-swatch",
|
|
7539
|
+
"react": "DsShellGradientSwatch",
|
|
7540
|
+
"angular": "DsShellGradientSwatch"
|
|
7429
7541
|
}
|
|
7430
7542
|
},
|
|
7431
7543
|
"dependencies": [
|
|
7432
7544
|
"@ds-mo/ui",
|
|
7433
7545
|
"@ds-mo/tokens"
|
|
7434
7546
|
],
|
|
7435
|
-
"registryDependencies": [
|
|
7436
|
-
"text"
|
|
7437
|
-
]
|
|
7547
|
+
"registryDependencies": []
|
|
7438
7548
|
},
|
|
7439
7549
|
{
|
|
7440
7550
|
"name": "shell-page",
|
|
@@ -7485,7 +7595,7 @@
|
|
|
7485
7595
|
],
|
|
7486
7596
|
"accessibility": [
|
|
7487
7597
|
"ShellPage exposes the routed page as the main landmark; render exactly one active ShellPage inside ShellApp.",
|
|
7488
|
-
"Provide
|
|
7598
|
+
"Provide one BarTitle or BarWorkflow through the desktop header slot and one MobileHeader through mobile-header when the page participates in the mobile shell.",
|
|
7489
7599
|
"Keep loading, empty, validation, error, progress, success, and failure communication in the default product-content slot.",
|
|
7490
7600
|
"Responsive variant changes preserve the same heading, controls, accessible names, and keyboard focus targets."
|
|
7491
7601
|
],
|
|
@@ -7494,12 +7604,13 @@
|
|
|
7494
7604
|
"headerPresentation=auto selects the matching header variant from headerCapacity and scroll position.",
|
|
7495
7605
|
"expanded, compact, and constrained are explicit overrides for exceptional layouts and deterministic examples.",
|
|
7496
7606
|
"contentInset=default supplies standard page gutters; none permits maps, canvases, and other full-bleed content.",
|
|
7497
|
-
"The
|
|
7607
|
+
"The header slot accepts one desktop BarTitle or BarWorkflow; mobile-header accepts the corresponding MobileHeader presentation. The default slot owns router output and all page product content."
|
|
7498
7608
|
],
|
|
7499
7609
|
"responsiveBehavior": [
|
|
7500
7610
|
"The owning application shell resolves viewport and persistent-chrome state into the explicit headerCapacity prop; ShellPage never guesses the cause of reduced width from its own rendered size.",
|
|
7501
7611
|
"Roomy capacity expands at the top and compacts after scroll; compact capacity stays compact; constrained capacity uses the constrained action layout.",
|
|
7502
7612
|
"A ShellPage-managed BarTitle remains concealed until headerCapacity is available and its rendered variant matches the resolved presentation, preventing a default-variant flash during route activation.",
|
|
7613
|
+
"responsiveMode=mobile hides and inerts the desktop header, exposes mobile-header, and disables desktop scroll-compaction geometry.",
|
|
7503
7614
|
"Update headerCapacity synchronously with shell layout state so opening tools or crossing application breakpoints cannot briefly render the wrong presentation.",
|
|
7504
7615
|
"On roomy pages, the expanded header scrolls upward until its title and action row reaches the compact row position, then snaps variants without moving that shared visual anchor.",
|
|
7505
7616
|
"Scroll compaction preserves the expanded page flow offset so content never jumps beneath the sticky header.",
|
|
@@ -7508,15 +7619,15 @@
|
|
|
7508
7619
|
],
|
|
7509
7620
|
"frameworkCaveats": {
|
|
7510
7621
|
"customElements": [
|
|
7511
|
-
"Import ShellPage with BarTitle or BarWorkflow
|
|
7622
|
+
"Import ShellPage with BarTitle or BarWorkflow in slot=header and MobileHeader in slot=mobile-header, then render route content as default children.",
|
|
7512
7623
|
"Do not set BarTitle.variant while ShellPage owns headerPresentation."
|
|
7513
7624
|
],
|
|
7514
7625
|
"react": [
|
|
7515
|
-
"Render
|
|
7626
|
+
"Render the desktop header with slot=header and DsMobileHeader with slot=mobile-header inside DsShellPage.",
|
|
7516
7627
|
"Use contentInset none only for deliberately full-bleed page products."
|
|
7517
7628
|
],
|
|
7518
7629
|
"angular": [
|
|
7519
|
-
"Import the generated standalone DsShellPage adapter with
|
|
7630
|
+
"Import the generated standalone DsShellPage adapter with the desktop header and DsMobileHeader, preserve both header slots, and place router-outlet in the default slot.",
|
|
7520
7631
|
"Do not add another overflow auto wrapper around the routed page."
|
|
7521
7632
|
]
|
|
7522
7633
|
},
|
|
@@ -7547,6 +7658,10 @@
|
|
|
7547
7658
|
"headerPresentation": {
|
|
7548
7659
|
"type": "ShellPageHeaderPresentation",
|
|
7549
7660
|
"required": false
|
|
7661
|
+
},
|
|
7662
|
+
"responsiveMode": {
|
|
7663
|
+
"type": "ShellResponsiveMode",
|
|
7664
|
+
"required": false
|
|
7550
7665
|
}
|
|
7551
7666
|
},
|
|
7552
7667
|
"events": [],
|
|
@@ -7595,7 +7710,9 @@
|
|
|
7595
7710
|
"commonlyComposedWith": [
|
|
7596
7711
|
"component:ds-shell-app",
|
|
7597
7712
|
"component:ds-panel-tool-header",
|
|
7598
|
-
"component:ds-
|
|
7713
|
+
"component:ds-mobile-header",
|
|
7714
|
+
"component:ds-mobile-section-switcher",
|
|
7715
|
+
"component:ds-mobile-bar-nav"
|
|
7599
7716
|
],
|
|
7600
7717
|
"patterns": [
|
|
7601
7718
|
"pattern:application-shell"
|
|
@@ -7603,7 +7720,7 @@
|
|
|
7603
7720
|
"accessibility": [
|
|
7604
7721
|
"Only the active mobile tool view participates in focus or the accessibility tree.",
|
|
7605
7722
|
"Header Back and application-owned header actions preserve the PanelTools event contract.",
|
|
7606
|
-
"Inbox uses
|
|
7723
|
+
"Inbox uses the MobileSectionSwitcher popup trigger for Messages, Stacks, and Activity and never relies on a gesture-only interaction."
|
|
7607
7724
|
],
|
|
7608
7725
|
"states": [
|
|
7609
7726
|
"The application owns open and activeTool and replaces headers when tool depth changes.",
|
|
@@ -7612,7 +7729,7 @@
|
|
|
7612
7729
|
],
|
|
7613
7730
|
"responsiveBehavior": [
|
|
7614
7731
|
"Desktop and tablet compose PanelTools-compatible rail and drawer chrome.",
|
|
7615
|
-
"Mobile renders
|
|
7732
|
+
"Mobile renders one centered MobileHeader for every tool and presents Messages, Stacks, and Activity directly as peer section titles without an additional Inbox heading."
|
|
7616
7733
|
],
|
|
7617
7734
|
"frameworkCaveats": {
|
|
7618
7735
|
"customElements": [
|
|
@@ -7724,9 +7841,10 @@
|
|
|
7724
7841
|
"@ds-mo/tokens"
|
|
7725
7842
|
],
|
|
7726
7843
|
"registryDependencies": [
|
|
7727
|
-
"
|
|
7844
|
+
"button-unfilled",
|
|
7845
|
+
"mobile-header",
|
|
7728
7846
|
"panel-tools",
|
|
7729
|
-
"
|
|
7847
|
+
"tooltip"
|
|
7730
7848
|
]
|
|
7731
7849
|
},
|
|
7732
7850
|
{
|