@ids-group-ltd/ids-design-system 0.13.2 → 0.13.4
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/CHANGELOG.md +1106 -9
- package/components.md +563 -44
- package/design-system.md +9 -0
- package/docs/agent/INDEX.md +58 -17
- package/docs/agent/charts/chart-colour-which-palette-a-chart-takes.md +1 -1
- package/docs/agent/charts/column-series-component.md +8 -0
- package/docs/agent/charts/ds-bar-chart.md +6 -1
- package/docs/agent/charts/ds-chart-data-table.md +10 -0
- package/docs/agent/charts/ds-chart.md +8 -0
- package/docs/agent/charts/ds-column-chart.md +7 -2
- package/docs/agent/charts/ds-funnel-chart.md +5 -1
- package/docs/agent/charts/ds-heatmap-chart.md +20 -0
- package/docs/agent/charts/ds-line-chart.md +8 -4
- package/docs/agent/charts/{ds-donut-chart.md → ds-pie-chart.md} +10 -6
- package/docs/agent/charts/ds-scatter-chart.md +20 -0
- package/docs/agent/charts/ds-waterfall-chart.md +20 -0
- package/docs/agent/charts/line-series-component.md +8 -0
- package/docs/agent/charts/reference-label-component.md +8 -0
- package/docs/agent/charts/reference-line-component.md +8 -0
- package/docs/agent/charts/series-annotation-component.md +10 -0
- package/docs/agent/feedback/ds-alert.md +4 -0
- package/docs/agent/feedback/ds-avatar-group.md +4 -0
- package/docs/agent/feedback/ds-avatar.md +4 -0
- package/docs/agent/feedback/ds-badge.md +4 -0
- package/docs/agent/feedback/ds-banner.md +5 -1
- package/docs/agent/feedback/ds-bar.md +17 -0
- package/docs/agent/feedback/ds-description-item.md +8 -0
- package/docs/agent/feedback/ds-description-list.md +8 -0
- package/docs/agent/feedback/ds-empty-state.md +4 -0
- package/docs/agent/feedback/ds-list-item.md +8 -0
- package/docs/agent/feedback/ds-list.md +8 -0
- package/docs/agent/feedback/ds-loading-overlay.md +8 -0
- package/docs/agent/feedback/ds-skeleton.md +4 -0
- package/docs/agent/feedback/ds-spinner.md +4 -0
- package/docs/agent/feedback/ds-stat.md +4 -0
- package/docs/agent/feedback/ds-status-dot.md +4 -0
- package/docs/agent/feedback/ds-tag.md +4 -0
- package/docs/agent/feedback/ds-timeline-item.md +8 -0
- package/docs/agent/feedback/ds-toast-region.md +8 -0
- package/docs/agent/feedback/ds-toast.md +4 -0
- package/docs/agent/feedback/ds-tree.md +8 -0
- package/docs/agent/forms/ds-autocomplete.md +4 -0
- package/docs/agent/forms/ds-button-group.md +8 -0
- package/docs/agent/forms/ds-button.md +6 -2
- package/docs/agent/forms/ds-checkbox.md +4 -0
- package/docs/agent/forms/ds-color-picker.md +8 -0
- package/docs/agent/forms/ds-date-picker.md +5 -1
- package/docs/agent/forms/ds-dropzone.md +4 -0
- package/docs/agent/forms/ds-field-group.md +8 -0
- package/docs/agent/forms/ds-filter-bar.md +8 -0
- package/docs/agent/forms/ds-icon-button.md +4 -0
- package/docs/agent/forms/ds-input.md +13 -1
- package/docs/agent/forms/ds-multi-select.md +4 -0
- package/docs/agent/forms/ds-number-stepper.md +4 -0
- package/docs/agent/forms/ds-otp-input.md +8 -0
- package/docs/agent/forms/ds-password-rules.md +8 -0
- package/docs/agent/forms/ds-radio-group.md +8 -0
- package/docs/agent/forms/ds-radio.md +4 -0
- package/docs/agent/forms/ds-search.md +4 -0
- package/docs/agent/forms/ds-segmented.md +8 -0
- package/docs/agent/forms/ds-select.md +4 -0
- package/docs/agent/forms/ds-slider.md +8 -0
- package/docs/agent/forms/ds-split-button.md +8 -0
- package/docs/agent/forms/ds-switch.md +4 -0
- package/docs/agent/forms/ds-textarea.md +5 -1
- package/docs/agent/forms/ds-time-picker.md +8 -0
- package/docs/agent/forms/ds-toggle-button.md +8 -0
- package/docs/agent/forms/filter-item-directive.md +8 -0
- package/docs/agent/forms/the-picker-family-ds-select-ds-multi-select-ds-autocomplete.md +4 -0
- package/docs/agent/navigation/ds-app-layout.md +6 -2
- package/docs/agent/navigation/ds-auth-layout.md +5 -1
- package/docs/agent/navigation/ds-breadcrumbs.md +4 -0
- package/docs/agent/navigation/ds-container.md +8 -0
- package/docs/agent/navigation/ds-divider.md +4 -0
- package/docs/agent/navigation/ds-inline.md +8 -0
- package/docs/agent/navigation/ds-page-footer.md +4 -0
- package/docs/agent/navigation/ds-page-header.md +5 -1
- package/docs/agent/navigation/ds-pagination.md +5 -1
- package/docs/agent/navigation/ds-sidenav-footer.md +8 -0
- package/docs/agent/navigation/ds-sidenav-group.md +4 -0
- package/docs/agent/navigation/ds-sidenav-item.md +4 -0
- package/docs/agent/navigation/ds-sidenav.md +4 -0
- package/docs/agent/navigation/ds-stack.md +8 -0
- package/docs/agent/navigation/ds-stepper.md +4 -0
- package/docs/agent/navigation/ds-tab.md +8 -0
- package/docs/agent/navigation/ds-tabs.md +5 -1
- package/docs/agent/overlays/ds-bottom-sheet.md +4 -0
- package/docs/agent/overlays/ds-drawer.md +4 -0
- package/docs/agent/overlays/ds-menu.md +4 -0
- package/docs/agent/overlays/ds-modal-card.md +4 -0
- package/docs/agent/overlays/ds-modal.md +4 -0
- package/docs/agent/overlays/ds-popover.md +4 -0
- package/docs/agent/overlays/ds-tooltip-panel.md +8 -0
- package/docs/agent/overlays/ds-tooltip.md +4 -0
- package/docs/agent/surfaces/ds-accordion-item.md +8 -0
- package/docs/agent/surfaces/ds-accordion.md +4 -0
- package/docs/agent/surfaces/ds-card.md +6 -2
- package/docs/agent/tables/ds-cell-template.md +8 -0
- package/docs/agent/tables/ds-table-columns.md +8 -0
- package/docs/agent/tables/ds-table-export.md +8 -0
- package/docs/agent/tables/ds-table.md +9 -2
- package/docs/agent/tables/header-filter-directive.md +8 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-accordion.mjs +4 -4
- package/fesm2022/ids-group-ltd-ids-design-system-components-accordion.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-alert.mjs +10 -8
- package/fesm2022/ids-group-ltd-ids-design-system-components-alert.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-app-layout.mjs +19 -19
- package/fesm2022/ids-group-ltd-ids-design-system-components-app-layout.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-auth-layout.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-auth-layout.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-autocomplete.mjs +7 -6
- package/fesm2022/ids-group-ltd-ids-design-system-components-autocomplete.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-badge.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-badge.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-banner.mjs +9 -6
- package/fesm2022/ids-group-ltd-ids-design-system-components-banner.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar-chart.mjs +119 -30
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar.mjs +95 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-bottom-sheet.mjs +3 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-bottom-sheet.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-button.mjs +7 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-button.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-card.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-card.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-data-table.mjs +32 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-data-table.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-legend.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-legend.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-tooltip.mjs +84 -43
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-tooltip.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart.mjs +1322 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-checkbox.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-checkbox.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-color-picker.mjs +8 -6
- package/fesm2022/ids-group-ltd-ids-design-system-components-color-picker.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-column-chart.mjs +164 -126
- package/fesm2022/ids-group-ltd-ids-design-system-components-column-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-date-picker.mjs +5 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-date-picker.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-description-list.mjs +4 -4
- package/fesm2022/ids-group-ltd-ids-design-system-components-description-list.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-dropzone.mjs +23 -16
- package/fesm2022/ids-group-ltd-ids-design-system-components-dropzone.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-empty-state.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-empty-state.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-field-group.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-field-group.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-filter-bar.mjs +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-filter-bar.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-funnel-chart.mjs +32 -13
- package/fesm2022/ids-group-ltd-ids-design-system-components-funnel-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-heatmap-chart.mjs +217 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-heatmap-chart.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-input.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-input.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-layout.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-layout.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-line-chart.mjs +185 -573
- package/fesm2022/ids-group-ltd-ids-design-system-components-line-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-list.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-list.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-loading-overlay.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-loading-overlay.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-menu.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-menu.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-modal.mjs +6 -6
- package/fesm2022/ids-group-ltd-ids-design-system-components-modal.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-multi-select.mjs +7 -5
- package/fesm2022/ids-group-ltd-ids-design-system-components-multi-select.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-number-stepper.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-number-stepper.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-otp-input.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-otp-input.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-page-header.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-page-header.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-pagination.mjs +14 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-pagination.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-pie-chart.mjs +391 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-pie-chart.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-popover.mjs +5 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-popover.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-radio-group.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-radio-group.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-scatter-chart.mjs +300 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-scatter-chart.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-search.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-search.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-segmented.mjs +9 -4
- package/fesm2022/ids-group-ltd-ids-design-system-components-segmented.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-select.mjs +7 -5
- package/fesm2022/ids-group-ltd-ids-design-system-components-select.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-sidenav-footer.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-sidenav-footer.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-sidenav.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-sidenav.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-slider.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-slider.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-split-button.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-split-button.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-stat.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-stat.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-table-columns.mjs +4 -4
- package/fesm2022/ids-group-ltd-ids-design-system-components-table-columns.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-table-export.mjs +4 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-table-export.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-table.mjs +9 -9
- package/fesm2022/ids-group-ltd-ids-design-system-components-table.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-tabs.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-tabs.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-tag.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-tag.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-textarea.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-textarea.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-time-picker.mjs +5 -3
- package/fesm2022/ids-group-ltd-ids-design-system-components-time-picker.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-timeline.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-timeline.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-toast.mjs +34 -21
- package/fesm2022/ids-group-ltd-ids-design-system-components-toast.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-tree.mjs +2 -2
- package/fesm2022/ids-group-ltd-ids-design-system-components-tree.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-waterfall-chart.mjs +252 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-waterfall-chart.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components.mjs +429 -24
- package/fesm2022/ids-group-ltd-ids-design-system-components.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-core.mjs +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-core.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system.mjs +8 -4
- package/fesm2022/ids-group-ltd-ids-design-system.mjs.map +1 -1
- package/migrations/0.10.0.json +2 -2
- package/migrations/0.10.1.json +3 -3
- package/migrations/0.10.2.json +8 -28
- package/migrations/0.11.0.json +3 -3
- package/migrations/0.11.1.json +15 -15
- package/migrations/0.11.2.json +9 -9
- package/migrations/0.11.3.json +1 -1
- package/migrations/0.11.4.json +8 -8
- package/migrations/0.12.1.json +1 -1
- package/migrations/0.12.2.json +1 -1
- package/migrations/0.12.3.json +3 -3
- package/migrations/0.13.0.json +24 -32
- package/migrations/0.13.1.json +5 -5
- package/migrations/0.13.3.json +211 -0
- package/migrations/0.13.4.json +994 -0
- package/migrations/0.5.0.json +1 -1
- package/migrations/0.8.0.json +4 -3
- package/migrations/0.9.0.json +1 -1
- package/package.json +57 -25
- package/styles/_chart-frame.scss +31 -8
- package/styles/_check-box.scss +12 -12
- package/styles/_dropdown-overlay.scss +14 -10
- package/styles/_field-box.scss +3 -3
- package/styles/_field-label.scss +7 -7
- package/styles/_overlay-motion.scss +1 -1
- package/styles/_table-controls.scss +3 -3
- package/styles/_tokens-charts.scss +69 -12
- package/styles/_tokens.scss +3 -3
- package/styles/_typography.scss +101 -101
- package/themes/dark/_theme.scss +13 -0
- package/types/ids-group-ltd-ids-design-system-components-accordion.d.ts +3 -3
- package/types/ids-group-ltd-ids-design-system-components-alert.d.ts +5 -4
- package/types/ids-group-ltd-ids-design-system-components-app-layout.d.ts +17 -17
- package/types/ids-group-ltd-ids-design-system-components-autocomplete.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-banner.d.ts +4 -2
- package/types/ids-group-ltd-ids-design-system-components-bar-chart.d.ts +37 -3
- package/types/ids-group-ltd-ids-design-system-components-bar.d.ts +63 -0
- package/types/ids-group-ltd-ids-design-system-components-bottom-sheet.d.ts +1 -1
- package/types/ids-group-ltd-ids-design-system-components-button.d.ts +6 -2
- package/types/ids-group-ltd-ids-design-system-components-chart-data-table.d.ts +31 -0
- package/types/ids-group-ltd-ids-design-system-components-chart-tooltip.d.ts +11 -4
- package/types/ids-group-ltd-ids-design-system-components-chart.d.ts +729 -0
- package/types/ids-group-ltd-ids-design-system-components-color-picker.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-column-chart.d.ts +99 -38
- package/types/ids-group-ltd-ids-design-system-components-date-picker.d.ts +9 -7
- package/types/ids-group-ltd-ids-design-system-components-dropzone.d.ts +4 -4
- package/types/ids-group-ltd-ids-design-system-components-funnel-chart.d.ts +9 -1
- package/types/ids-group-ltd-ids-design-system-components-heatmap-chart.d.ts +124 -0
- package/types/ids-group-ltd-ids-design-system-components-line-chart.d.ts +84 -148
- package/types/ids-group-ltd-ids-design-system-components-multi-select.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-pagination.d.ts +13 -1
- package/types/{ids-group-ltd-ids-design-system-components-donut-chart.d.ts → ids-group-ltd-ids-design-system-components-pie-chart.d.ts} +35 -17
- package/types/ids-group-ltd-ids-design-system-components-popover.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-scatter-chart.d.ts +183 -0
- package/types/ids-group-ltd-ids-design-system-components-segmented.d.ts +5 -1
- package/types/ids-group-ltd-ids-design-system-components-select.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-table-export.d.ts +3 -0
- package/types/ids-group-ltd-ids-design-system-components-table.d.ts +11 -11
- package/types/ids-group-ltd-ids-design-system-components-time-picker.d.ts +3 -1
- package/types/ids-group-ltd-ids-design-system-components-toast.d.ts +5 -2
- package/types/ids-group-ltd-ids-design-system-components-waterfall-chart.d.ts +116 -0
- package/types/ids-group-ltd-ids-design-system-components.d.ts +151 -9
- package/types/ids-group-ltd-ids-design-system-core.d.ts +78 -4
- package/types/ids-group-ltd-ids-design-system.d.ts +16 -12
- package/docs/agent/feedback/ds-meter.md +0 -11
- package/docs/agent/feedback/ds-progress.md +0 -10
- package/fesm2022/ids-group-ltd-ids-design-system-components-donut-chart.mjs +0 -351
- package/fesm2022/ids-group-ltd-ids-design-system-components-donut-chart.mjs.map +0 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-meter.mjs +0 -61
- package/fesm2022/ids-group-ltd-ids-design-system-components-meter.mjs.map +0 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-progress.mjs +0 -65
- package/fesm2022/ids-group-ltd-ids-design-system-components-progress.mjs.map +0 -1
- package/types/ids-group-ltd-ids-design-system-components-meter.d.ts +0 -36
- package/types/ids-group-ltd-ids-design-system-components-progress.d.ts +0 -40
package/components.md
CHANGED
|
@@ -153,7 +153,7 @@ text rather than a state. Retune app-wide with `DS_CONFIG.field.stateIcons` (per
|
|
|
153
153
|
is not a validated field; where a search needs a label or an error line, use `ds-input`.
|
|
154
154
|
|
|
155
155
|
#### `<ds-button>` — `ButtonComponent`
|
|
156
|
-
Inputs: **two orthogonal axes** — `color: ButtonColor = 'primary'` (`'primary' | 'secondary' | 'tertiary' | 'neutral' | 'error' | 'success' | 'warning'`) and `variant: ButtonVariant = 'solid'` (`'solid' | 'tonal' | 'outline' | 'ghost' | 'text'`). Plus `size: DsSize | null = null` (unset resolves `DS_CONFIG.control.size`, then `md`), `type: 'button' | 'submit' | 'reset' = 'button'`, `disabled`, `loading`, `fullWidth`, `icon: IconName | null`, and the destination pair `routerLink: DsRouterLink = null` (a path, a command array or a `UrlTree`) / `href: string = ''`, with the modifiers `fragment` / `queryParams` / `queryParamsHandling` (routerLink-only) and `target` / `rel` (either link), plus `routerLinkActiveOptions` and `ariaCurrent`. Plus the refusal pair below: `disabledReason`, and the field message inputs `hint` / `warning` / `error` / `messageIcon` / `reserveMessage` / `ariaDescribedBy`.
|
|
156
|
+
Inputs: **two orthogonal axes** — `color: ButtonColor = 'primary'` (`'primary' | 'secondary' | 'tertiary' | 'neutral' | 'error' | 'success' | 'warning'`) and `variant: ButtonVariant = 'solid'` (`'solid' | 'tonal' | 'outline' | 'ghost' | 'text'`). Plus `size: DsSize | null = null` (unset resolves `DS_CONFIG.control.size`, then `md`), `type: 'button' | 'submit' | 'reset' = 'button'`, `align: ButtonAlign = 'center'` (`'center' | 'between'`; `'between'` pushes the label and a trailing icon to opposite edges, and only shows once something widens the button past its contents), `disabled`, `loading`, `fullWidth`, `icon: IconName | null`, and the destination pair `routerLink: DsRouterLink = null` (a path, a command array or a `UrlTree`) / `href: string = ''`, with the modifiers `fragment` / `queryParams` / `queryParamsHandling` (routerLink-only) and `target` / `rel` (either link), plus `routerLinkActiveOptions` and `ariaCurrent`. Plus the refusal pair below: `disabledReason`, and the field message inputs `hint` / `warning` / `error` / `messageIcon` / `reserveMessage` / `ariaDescribedBy`.
|
|
157
157
|
Axis meaning: **variant is loudness** (solid > tonal > outline/ghost/text), **color is hue** — every pair renders, and the UX-discouraged ones dev-warn with the reason. Only solid and tonal paint a fill: outline, ghost and text are TRANSPARENT, so they adopt the surface they sit on. Disabled splits by whether the fill can carry the state: `solid` and `tonal` keep `oklch(from accent 70% 0.035 h)`, while `outline`, `ghost` and `text` — the three with no fill of their own — mix the label toward the surface, `color-mix(in srgb, <label> 40%, var(--surface-default))`, because a fixed lightness cannot serve both themes. (History: the single `variant` axis was split into color × variant in 2026-06; `danger`→`error`, `link`→`text`, the old `ghost`→`outline`.)
|
|
158
158
|
Output: `(pressed): MouseEvent` — only fires when not disabled and not loading
|
|
159
159
|
**Three elements, decided by destination.** `routerLink` → an `<a [routerLink]>` with `routerLinkActive`; `href` → a plain `<a href>`; **neither → a `<button type="button">`** — the same rule `ds-sidenav-item` follows, and for the same reason: a control that navigates has to BE a link, or middle-click, open-in-new-tab, copy-link-address and the `link` role a screen reader announces are all gone. Styling is identical across all three (class-based on `.button`, and the anchor's UA underline is reset), so target the class, never the tag — measured at zero differences across eleven computed properties, focus ring included. `type` and `loading` are button-only and dev-warn if set on a link: an anchor has no form to submit, and a navigation cannot be in flight before it starts. A disabled link takes `aria-disabled` plus `tabindex="-1"` — an anchor has no native disabled state — and its click is swallowed, which is what stops an `href` from navigating anyway. **`controlRef`** (was `buttonRef` before 0.12.3) is typed `ElementRef<HTMLElement>` for that reason: it resolves whichever element rendered.
|
|
@@ -167,6 +167,10 @@ Content slots: default (label / leading or trailing icon), plus `[dsButtonSubtex
|
|
|
167
167
|
Layout: a message-bearing button becomes a column (host class `with-message`), and because the host shrinks to fit, a message longer than the label widens the pair — button included, exactly as a field's control spans its own message. Without a message the host keeps the `inline-flex` box every existing layout was built against.
|
|
168
168
|
Tokens: `--ds-button-bg-color`, `--ds-button-bg-color-hover`, `--ds-button-bg-color-active`, `--ds-button-bg-color-disabled`, `--ds-button-label-color`, `--ds-button-label-color-disabled`, `--ds-button-border-color`, `--ds-button-border-color-disabled`, `--ds-button-border-width`, `--ds-button-radius`, `--ds-button-pressed-shadow`, `--ds-button-shadow`, `--ds-button-shadow-hover`. The focus ring is not a button token — set `--focus-ring-color`, `--focus-ring-width` or `--focus-ring-offset` on the button's own scope. The last two are the REST and hover shadow, both `none` by default — before them the only way to give a button a resting shadow was a deep selector into its inner `<button>`. `-shadow-hover` falls back to `-shadow`, so setting the resting one alone keeps the button steady under the pointer; focus and pressed keep their own hooks and still win while those states are on. For `variant="solid"`, `-bg-color-hover` / `-bg-color-active` / `-pressed-shadow` default to a `color-mix()` derivation of the resolved fill (88 % / 76 % + black — the theme's hover/pressed recipe), so overriding the fill alone retints the whole state set; tonal, outline, ghost and text keep explicit ramp defaults, so a full retint there means setting the state tokens too.
|
|
169
169
|
|
|
170
|
+
<!-- inputs:ds-button -->
|
|
171
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `color: ButtonColor = 'primary'`, `variant: 'solid' | 'tonal' | 'ghost' | 'outline' | 'text' = 'solid'`, `align: 'center' | 'between' = 'center'`, `size: 'sm' | 'md' | 'lg' = null`, `routerLink: DsRouterLink = null`, `href: string = ''`, `fragment: string | undefined`, `queryParams: Params | null | undefined`, `queryParamsHandling: QueryParamsHandling | null | undefined`, `target: string | undefined`, `rel: string | undefined`, `routerLinkActiveOptions: { exact: boolean } | IsActiveMatchOptions`, `ariaCurrent: 'page' | 'step' | 'location' | 'date' | 'time' | 'true'`, `type: 'button' | 'submit' | 'reset' = 'button'`, `disabled: boolean = false`, `loading: boolean = false`, `fullWidth: boolean = false`, `ariaLabel: string | null = null`, `icon: IconName | null = null`, `trailingIcon: IconName | null = null`, `ariaHasPopup: 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog' = null`, `ariaExpanded: boolean | null = null`, `ariaControls: string | null = null`, `disabledReason: string = ''`, `ariaDescribedBy: string | null = null`
|
|
172
|
+
<!-- /inputs -->
|
|
173
|
+
|
|
170
174
|
#### `<ds-icon-button>` — `IconButtonComponent`
|
|
171
175
|
Icon-only action with its own taxonomy, distinct from `ds-button`. `ariaLabel` is required (icon-only must be labelled for a11y).
|
|
172
176
|
Inputs: `icon: required IconName`, `ariaLabel: required string`, `ariaDescribedBy: string | null = null` (point at text the page already shows — e.g. why the action is refused; icon-only leaves no room for a second line, which is why there is deliberately no `disabledReason` here), `variant: IconButtonVariant = 'standard'` (`'standard' | 'filled' | 'tonal' | 'outlined'`), `size: IconButtonSize = 'md'` (`'sm' | 'md' | 'lg'` = 32/40/48), `type: 'button' | 'submit' | 'reset' = 'button'`, `disabled: boolean = false`, `selected: boolean = false` (toggle — sets `aria-pressed`)
|
|
@@ -174,6 +178,10 @@ Output: `(pressed): MouseEvent` — fires when not disabled
|
|
|
174
178
|
Variant emphasis: `standard` chromeless (hover-reveal) · `filled` `--primary` · `tonal` `--primary-muted` · `outlined` bordered. `selected` renders the pressed/active fill.
|
|
175
179
|
Tokens: `--ds-icon-button-bg-color`, `--ds-icon-button-icon-color`, `--ds-icon-button-border`, `--ds-icon-button-bg-color-hover`, `--ds-icon-button-bg-color-active`, `--ds-icon-button-icon-color-hover`, `--ds-icon-button-radius`. The focus ring is not an icon-button token — set `--focus-ring-color`, `--focus-ring-width` or `--focus-ring-offset` on its own scope. `filled`/`selected` derive hover/active from the resolved bg, `standard`/`tonal`/`outlined` keep explicit ramp defaults.
|
|
176
180
|
|
|
181
|
+
<!-- inputs:ds-icon-button -->
|
|
182
|
+
All inputs: `icon: required IconName`, `ariaLabel: required string`, `ariaDescribedBy: string | null = null`, `variant: 'standard' | 'filled' | 'tonal' | 'outlined' = 'standard'`, `color: ButtonColor = 'primary'`, `size: 'sm' | 'md' | 'lg' = null`, `type: 'button' | 'submit' | 'reset' = 'button'`, `disabled: boolean = false`, `selected: boolean = false`, `ariaExpanded: boolean | null = null`, `ariaControls: string | null = null`
|
|
183
|
+
<!-- /inputs -->
|
|
184
|
+
|
|
177
185
|
#### `<ds-input>` — `InputComponent`
|
|
178
186
|
Inputs: `value: model<string>`, `type: InputType = 'text'` (`'text' | 'email' | 'password' | 'number' | 'tel' | 'url' | 'search'`), `size: 'sm' | 'md' | 'lg' = 'md'`, `label: string = ''`, `hint: string = ''`, `placeholder: string = ''`, `disabled: boolean = false`, `invalid: boolean = false`, `required: boolean = false`, `optional: boolean = false`, `name: string | null = null`, `clearable: boolean | null = null` (inline clear (×) button; `null` resolves to `true` for `type="search"` and `false` otherwise)
|
|
179
187
|
Content slots — addon attributes apply to any child element:
|
|
@@ -191,29 +199,61 @@ Example:
|
|
|
191
199
|
</ds-input>
|
|
192
200
|
```
|
|
193
201
|
|
|
194
|
-
Tokens: `--ds-input-bg-color`, `--ds-input-border`, `--ds-input-border-hover`, `--ds-input-border-focus`, `--ds-input-text-color`, `--ds-input-placeholder`, `--ds-input-radius`, `--ds-input-
|
|
202
|
+
Tokens: `--ds-input-bg-color`, `--ds-input-border`, `--ds-input-border-hover`, `--ds-input-border-focus`, `--ds-input-text-color`, `--ds-input-placeholder`, `--ds-input-radius`, `--ds-input-padding-x`, `--ds-input-padding-y`, `--ds-input-focus-shadow`, `--ds-input-border-error`, `--ds-input-bg-color-error`, `--ds-input-border-success`, `--ds-input-bg-color-disabled`
|
|
203
|
+
|
|
204
|
+
<!-- inputs:ds-input -->
|
|
205
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = ''`, `type: InputType = 'text'`, `size: 'sm' | 'md' | 'lg' = null`, `label: string = ''`, `placeholder: string = ''`, `disabled: boolean = false`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `success: string = ''`, `loading: boolean = false`, `required: boolean = false`, `optional: boolean = false`, `name: string | null = null`, `min: number | null = null`, `max: number | null = null`, `step: number | null = null`, `autocomplete: string | null = null`, `autofocus: boolean = false`, `ariaLabel: string | null = null`, `ariaDescribedBy: string | null = null`, `maxLength: number | null = null`, `minLength: number | null = null`, `pattern: readonly RegExp[] = []`, `enterKeyHint: 'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send' | null = null`, `inputMode: | 'none'
|
|
206
|
+
| 'text'
|
|
207
|
+
| 'decimal'
|
|
208
|
+
| 'numeric'
|
|
209
|
+
| 'tel'
|
|
210
|
+
| 'search'
|
|
211
|
+
| 'email'
|
|
212
|
+
| 'url'
|
|
213
|
+
| null = null`, `clearable: boolean | null = null`, `passwordToggle: boolean = false`, `passwordVisible: boolean = false`
|
|
214
|
+
<!-- /inputs -->
|
|
195
215
|
|
|
196
216
|
#### `<ds-textarea>` — `TextareaComponent`
|
|
197
217
|
Multi-line counterpart to `<ds-input>` — same wrapper/states, reuses the `--ds-input-*` token family. No prefix/suffix slots.
|
|
198
218
|
Inputs: `value: model<string>`, `size: 'sm' | 'md' | 'lg' = 'md'`, `label`, `hint`, `placeholder`, `disabled`, `invalid`, `required`, `optional: boolean = false`, `name`, `rows: number = 3`
|
|
199
|
-
Tokens: same `--ds-input-*` family as `<ds-input>` (textarea overrides `--ds-input-
|
|
219
|
+
Tokens: same `--ds-input-*` family as `<ds-input>` (textarea overrides `--ds-input-padding-y` to `--space-3` for vertical breathing room).
|
|
200
220
|
New: `autosize: boolean = false` (grows with content; forces `resize='none'`), `minRows`/`maxRows: number | null = null`, `resize: 'none' | 'vertical' | 'horizontal' | 'both' = 'vertical'`.
|
|
201
221
|
|
|
222
|
+
<!-- inputs:ds-textarea -->
|
|
223
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = ''`, `size: 'sm' | 'md' | 'lg' = null`, `label: string = ''`, `placeholder: string = ''`, `disabled: boolean = false`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `success: string = ''`, `required: boolean = false`, `optional: boolean = false`, `rows: number = 3`, `name: string | null = null`, `autosize: boolean = false`, `minRows: number | null = null`, `maxRows: number | null = null`, `resize: 'none' | 'vertical' | 'horizontal' | 'both' = 'vertical'`, `ariaLabel: string | null = null`, `maxLength: number | null = null`, `minLength: number | null = null`, `pattern: readonly RegExp[] = []`
|
|
224
|
+
<!-- /inputs -->
|
|
225
|
+
|
|
202
226
|
#### `<ds-number-stepper>` — `NumberStepperComponent`
|
|
203
227
|
Spinbox for bounded quantities — −/+ buttons around a numeric value.
|
|
204
228
|
Inputs: `value: model<number> = 0`, `min: number = 0`, `max: number | null = null`, `step: number = 1`, `size: 'sm' | 'md' | 'lg' = 'md'`, `disabled: boolean = false`
|
|
205
229
|
Methods: `inc()`, `dec()` (clamp to min/max). Buttons disable at the bounds.
|
|
206
230
|
Tokens: `--ds-number-stepper-field-width` sizes the number itself and is derived from the box height by default — a value with more digits than that width holds is clipped rather than wrapped, so widen it for large quantities. Also `--ds-number-stepper-bg-color`, `--ds-number-stepper-border-color`, `--ds-number-stepper-step-bg-color-active`, `--ds-number-stepper-focus-shadow`.
|
|
207
231
|
|
|
232
|
+
<!-- inputs:ds-number-stepper -->
|
|
233
|
+
All inputs: `value: number = 0`, `min: number = 0`, `max: number | null = null`, `step: number = 1`, `size: 'sm' | 'md' | 'lg' = null`, `disabled: boolean = false`, `ariaLabel: string | null = null`
|
|
234
|
+
<!-- /inputs -->
|
|
235
|
+
|
|
208
236
|
#### `<ds-checkbox>` — `CheckboxComponent`
|
|
209
237
|
Inputs: `checked: model<boolean>`, `indeterminate: boolean = false`, `disabled: boolean = false`, `name: string | null = null`, `inputId: string | null = null`
|
|
210
238
|
|
|
239
|
+
<!-- inputs:ds-checkbox -->
|
|
240
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `checked: boolean = false`, `indeterminate: boolean = false`, `disabled: boolean = false`, `name: string | null = null`, `inputId: string | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `required: boolean = false`, `label: string = ''`, `ariaLabel: string | null = null`
|
|
241
|
+
<!-- /inputs -->
|
|
242
|
+
|
|
211
243
|
#### `<ds-radio>` — `RadioComponent`
|
|
212
244
|
Inputs: `checked: model<boolean>`, `disabled: boolean = false`, `name: string = ''`, `value: string = ''`, `inputId: string | null = null`. Use in groups via shared `name`.
|
|
213
245
|
|
|
246
|
+
<!-- inputs:ds-radio -->
|
|
247
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `checked: boolean = false`, `deselectable: boolean = false`, `disabled: boolean = false`, `name: string = ''`, `value: unknown = ''`, `inputId: string | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `required: boolean = false`, `label: string = ''`, `ariaLabel: string | null = null`
|
|
248
|
+
<!-- /inputs -->
|
|
249
|
+
|
|
214
250
|
#### `<ds-switch>` — `SwitchComponent`
|
|
215
251
|
Inputs: `checked: model<boolean>`, `disabled: boolean = false`, `name: string | null = null`, `variant: 'default' | 'success' | 'error' = 'default'`, `inputId: string | null = null`
|
|
216
252
|
|
|
253
|
+
<!-- inputs:ds-switch -->
|
|
254
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `checked: boolean = false`, `disabled: boolean = false`, `name: string | null = null`, `variant: 'default' | 'success' | 'error' = 'default'`, `inputId: string | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `required: boolean = false`, `label: string = ''`, `ariaLabel: string | null = null`
|
|
255
|
+
<!-- /inputs -->
|
|
256
|
+
|
|
217
257
|
#### The picker family — `<ds-select>`, `<ds-multi-select>`, `<ds-autocomplete>`
|
|
218
258
|
Five rules hold across all three: one meaning per member name, difference only where a reason is stated, one panel implementation (`.dropdown-panel` / `.dropdown-list`), no library-invented string without a slot to replace it, and one way to clip a line.
|
|
219
259
|
|
|
@@ -232,19 +272,35 @@ Shared panel tokens — the three pickers portal their panel out of the componen
|
|
|
232
272
|
|
|
233
273
|
Shared option tokens, painting the row inside any of the three panels: `--ds-option-selected-bg-color`, `-hover`, `--ds-option-selected-label-color`, `--ds-option-check-color`. `ds-select` and `ds-autocomplete` mark the selection with the check glyph these paint; `ds-multi-select` uses a checkbox and answers to `--ds-multi-select-check-bg-color` instead.
|
|
234
274
|
|
|
275
|
+
<!-- inputs:ds-select -->
|
|
276
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = ''`, `options: readonly SelectItem[] = []`, `width: 'fill' | 'content' = 'fill'`, `placeholder: string = ''`, `size: 'sm' | 'md' | 'lg' = null`, `label: string = ''`, `disabled: boolean = false`, `loading: boolean = false`, `scrollActiveIntoView: boolean = true`, `panelClass: string | readonly string[] = []`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `success: string = ''`, `required: boolean = false`, `optional: boolean = false`, `name: string | null = null`, `ariaLabel: string | null = null`, `clearable: boolean = false`
|
|
277
|
+
<!-- /inputs -->
|
|
278
|
+
|
|
235
279
|
#### `<ds-select>` — `SelectComponent`
|
|
236
280
|
Inputs: `value: model<string>`, `options: SelectItem[]`, `placeholder: string = ''`, `size`, `width`, `label`, `disabled`, `readOnly`, `readonly` (an alias of `readOnly`, because signal forms binds by name), `success`, `required`, `optional`, `clearable`, `name: string | null = null`, `ariaLabel`
|
|
237
281
|
Trigger plus a CDK overlay panel. Keyboard: ArrowUp/Down, Enter/Space, Home/End, Escape, skipping group headers. `isSelectOptionGroup(item)` is re-exported as a type guard.
|
|
238
282
|
|
|
283
|
+
<!-- inputs:ds-select -->
|
|
284
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = ''`, `options: readonly SelectItem[] = []`, `width: 'fill' | 'content' = 'fill'`, `placeholder: string = ''`, `size: 'sm' | 'md' | 'lg' = null`, `label: string = ''`, `disabled: boolean = false`, `loading: boolean = false`, `scrollActiveIntoView: boolean = true`, `panelClass: string | readonly string[] = []`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `success: string = ''`, `required: boolean = false`, `optional: boolean = false`, `name: string | null = null`, `ariaLabel: string | null = null`, `clearable: boolean = false`
|
|
285
|
+
<!-- /inputs -->
|
|
286
|
+
|
|
239
287
|
#### `<ds-multi-select>` — `MultiSelectComponent`
|
|
240
288
|
Inputs: `value: model<string[]>`, `options: readonly MultiSelectItem[]`, `placeholder: string = 'Select…'`, `searchPlaceholder: string = 'Filter…'`, `searchable: boolean | number | null = null` (`true` always shows the filter row, `false` never, a NUMBER shows it once the option count reaches it), `selectAll: boolean | 'group' | 'both' = false` (`'group'` puts a row per group, `'both'` adds a global row beside them), `triggerDisplay: DsTriggerDisplay = 'full'` (`'full' | 'count' | 'labels'`), `maxVisibleChips: number | 'fit' | 'all' | null = null` (a NUMBER is a ceiling, not an exact count — fewer fit when the trigger is narrow), `width`, `size`, `label`, `disabled`, `success`, `required`, `optional`, `ariaLabel`
|
|
241
289
|
|
|
290
|
+
<!-- inputs:ds-multi-select -->
|
|
291
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string[] = []`, `options: readonly MultiSelectItem[] = []`, `placeholder: string = 'Select…'`, `searchPlaceholder: string = 'Filter…'`, `searchable: boolean | number | null = null`, `name: string | null = null`, `panelClass: string | readonly string[] = []`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `clearable: boolean = false`, `filterWith: ((option: MultiSelectOption, query: string) => boolean) | 'none'`, `loading: boolean = false`, `scrollActiveIntoView: boolean = true`, `maxVisibleChips: number | 'fit' | 'all' | null = null`, `disabled: boolean = false`, `success: string = ''`, `ariaLabel: string | null = null`, `width: 'fill' | 'content' = 'fill'`, `size: 'sm' | 'md' | 'lg' = null`, `triggerDisplay: 'full' | 'count' | 'labels' = 'full'`, `label: string = ''`, `required: boolean = false`, `optional: boolean = false`, `selectAll: boolean | 'group' | 'both' = false`
|
|
292
|
+
<!-- /inputs -->
|
|
293
|
+
|
|
242
294
|
#### `<ds-autocomplete>` — `AutocompleteComponent<T>`
|
|
243
295
|
Type-ahead picker, generic on the option value.
|
|
244
296
|
Inputs: `options: readonly AutocompleteItem<T>[]`, `value: model<T | readonly T[] | null>`, `multiple: boolean = false`, `placeholder: string = 'Select…'`, `showChevron: boolean = true`, `valueOverflow: AutocompleteValueOverflow = 'ellipsis'` (`'ellipsis' | 'wrap'` — a settled single value clips rather than growing the trigger), `maxVisibleChips`, `allowCreate: boolean = false`, `width`, `size`, `label`, `disabled`, `success`, `required`, `optional`, `ariaLabel`
|
|
245
297
|
Output: `(create): string` — the typed text, when `allowCreate` is on and nothing matched.
|
|
246
298
|
In multiple mode the selection renders as chips above the trigger.
|
|
247
299
|
|
|
300
|
+
<!-- inputs:ds-autocomplete -->
|
|
301
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `options: readonly AutocompleteItem<T>[] = []`, `value: T | readonly T[] | null = null`, `multiple: boolean = false`, `showChevron: boolean = true`, `maxVisibleChips: number | 'fit' | 'all' | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `width: 'fill' | 'content' = 'fill'`, `valueOverflow: 'ellipsis' | 'wrap' = 'ellipsis'`, `placeholder: string = 'Select…'`, `disabled: boolean = false`, `success: string = ''`, `allowCreate: boolean = false`, `label: string = ''`, `compareWith: (a: T | null, b: T | null) => boolean`, `name: string | null = null`, `panelClass: string | readonly string[] = []`, `readOnly: boolean = false`, `readonlyBinding: boolean = false`, `clearable: boolean = false`, `searchPlaceholder: string = ''`, `filterWith: ((option: AutocompleteOption<T>, query: string) => boolean) | 'none'`, `loading: boolean = false`, `scrollActiveIntoView: boolean = true`, `required: boolean = false`, `optional: boolean = false`, `ariaLabel: string | null = null`
|
|
302
|
+
<!-- /inputs -->
|
|
303
|
+
|
|
248
304
|
#### `<ds-search>` — `SearchComponent`
|
|
249
305
|
Pre-styled search input with built-in icon. A form control, but not a field: no label, no message row.
|
|
250
306
|
Inputs: `value: model<string>`, `placeholder: string = 'Search'`, `shortcut: string = ''` (rendered as a hint pill, e.g. `⌘K`), `showIcon: boolean = true`, `clearable: boolean = false`, `ariaLabel: string = ''`, `disabled: boolean = false`, `hidden: boolean = false`, `size: DsSize | null = null`, `debounce: number = 0` (ms held before `value` updates; clearing, Enter and `clear()` all skip the timer)
|
|
@@ -252,80 +308,213 @@ Output: `(submitted): string` — emits the current value on Enter / form submit
|
|
|
252
308
|
Methods: `clear()` — empties the field, drops an armed keystroke and publishes `''` at once, which writing `''` into `value` does not; `focus()`.
|
|
253
309
|
Binds through `NG_VALUE_ACCESSOR`, taking the value plumbing without the field-message layer — so `hint` / `error` / `warning` / `errors` / `invalid` / `touched` / `reserveMessage` / `messageIcon` are NOT inputs here.
|
|
254
310
|
|
|
311
|
+
<!-- inputs:ds-search -->
|
|
312
|
+
All inputs: `hidden: boolean = false`, `value: string = ''`, `placeholder: string = 'Search'`, `shortcut: string = ''`, `showIcon: boolean = true`, `clearable: boolean = false`, `ariaLabel: string = ''`, `disabled: boolean = false`, `size: 'sm' | 'md' | 'lg' = null`, `debounce: number = 0`
|
|
313
|
+
<!-- /inputs -->
|
|
314
|
+
|
|
255
315
|
#### `<ds-date-picker>` — `DatePickerComponent`
|
|
256
|
-
Inputs: `mode: 'single' | 'range' = 'single'`, `size: 'sm' | 'md' | 'lg' = 'md'`, `value: model<Date |
|
|
316
|
+
Inputs: `mode: 'single' | 'range' = 'single'`, `size: 'sm' | 'md' | 'lg' = 'md'`, `value: model<Date | DateRangeValue | null>` (`DateRangeValue = [Date | null, Date | null]`), `placeholder: string = 'Select date'`, `label: string = ''`, `hint: string = ''`, `required: boolean = false`, `optional: boolean = false`
|
|
257
317
|
Trigger button opens a CDK overlay calendar; selecting a day in `'single'` closes the panel, in `'range'` it closes after the second pick.
|
|
258
318
|
|
|
319
|
+
<!-- inputs:ds-date-picker -->
|
|
320
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `mode: 'single' | 'range' = 'single'`, `size: 'sm' | 'md' | 'lg' = null`, `fullWidth: boolean = false`, `value: Date | DateRangeValue | null = null`, `placeholder: string = 'Select date'`, `label: string = ''`, `required: boolean = false`, `optional: boolean = false`, `panelClass: string | readonly string[] = []`, `disabled: boolean = false`, `success: string = ''`, `ariaLabel: string | null = null`, `minYear: number`, `maxYear: number`, `minDate: Date | null = null`, `maxDate: Date | null = null`, `disabledDate: ((date: Date) => boolean) | null = null`, `presets: readonly DatePickerPreset[] = []`, `locale: string | null = null`, `dateFormat: string | null = null`, `firstDayOfWeek: number | null = null`, `defaultDate: Date | null = null`, `allowInput: boolean = true`
|
|
321
|
+
<!-- /inputs -->
|
|
322
|
+
|
|
259
323
|
#### `<ds-dropzone>` — `DropzoneComponent`
|
|
260
324
|
File upload area.
|
|
261
325
|
Inputs: `accept: string = ''`, `multiple: boolean = false`, `files: model<DropzoneFile[]>` (`{ id, name, size, state: 'uploading' | 'success' | 'error', progress }`)
|
|
262
326
|
Outputs: `(filesAdded): File[]` (raw browser File list from drop or picker), `(fileRemoved): DropzoneFile` (a chip's remove button)
|
|
263
327
|
|
|
328
|
+
<!-- inputs:ds-dropzone -->
|
|
329
|
+
All inputs: `accept: string = ''`, `multiple: boolean = false`, `files: DropzoneFile[] = []`, `disabled: boolean = false`
|
|
330
|
+
<!-- /inputs -->
|
|
331
|
+
|
|
264
332
|
---
|
|
265
333
|
|
|
334
|
+
#### `<ds-button-group>` — `ButtonGroupComponent`
|
|
335
|
+
|
|
336
|
+
<!-- inputs:ds-button-group -->
|
|
337
|
+
All inputs: `ariaLabel: string | null = null`
|
|
338
|
+
<!-- /inputs -->
|
|
339
|
+
|
|
340
|
+
#### `<ds-split-button>` — `SplitButtonComponent`
|
|
341
|
+
|
|
342
|
+
<!-- inputs:ds-split-button -->
|
|
343
|
+
All inputs: `label: string = ''`, `variant: 'primary' | 'outline' = 'primary'`, `icon: IconName | null = null`, `disabled: boolean = false`, `menuItems: readonly SplitButtonItem[] = []`, `menuLabel: string = 'More actions'`
|
|
344
|
+
<!-- /inputs -->
|
|
345
|
+
|
|
346
|
+
#### `<ds-toggle-button>` — `ToggleButtonComponent`
|
|
347
|
+
|
|
348
|
+
<!-- inputs:ds-toggle-button -->
|
|
349
|
+
All inputs: `pressed: boolean = false`, `icon: string = ''`, `disabled: boolean = false`
|
|
350
|
+
<!-- /inputs -->
|
|
351
|
+
|
|
352
|
+
#### `<ds-color-picker>` — `ColorPickerComponent`
|
|
353
|
+
|
|
354
|
+
<!-- inputs:ds-color-picker -->
|
|
355
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = '#2F54FF'`, `presets: readonly string[]`, `panelClass: string | readonly string[] = []`, `disabled: boolean = false`, `ariaLabel: string = 'Choose colour'`, `success: string = ''`
|
|
356
|
+
<!-- /inputs -->
|
|
357
|
+
|
|
358
|
+
#### `<ds-field-group>` — `FieldGroupComponent`
|
|
359
|
+
|
|
360
|
+
<!-- inputs:ds-field-group -->
|
|
361
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `invalid: boolean = false`, `disabled: boolean = false`, `fullWidth: boolean = false`
|
|
362
|
+
<!-- /inputs -->
|
|
363
|
+
|
|
364
|
+
#### `<ds-otp-input>` — `OtpInputComponent`
|
|
365
|
+
|
|
366
|
+
<!-- inputs:ds-otp-input -->
|
|
367
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string = ''`, `length: number = 6`, `mode: 'numeric' | 'alphanumeric' = 'numeric'`, `mask: boolean = false`, `disabled: boolean = false`, `success: string = ''`, `ariaLabel: string = 'Verification code'`
|
|
368
|
+
<!-- /inputs -->
|
|
369
|
+
|
|
370
|
+
#### `<ds-password-rules>` — `PasswordRulesComponent`
|
|
371
|
+
|
|
372
|
+
<!-- inputs:ds-password-rules -->
|
|
373
|
+
All inputs: `value: string = ''`, `rules: readonly DsPasswordRule[] = []`, `showUnmet: boolean = false`, `columns: 1 | 2 = 1`, `listId: string`
|
|
374
|
+
<!-- /inputs -->
|
|
375
|
+
|
|
376
|
+
#### `<ds-radio-group>` — `RadioGroupComponent`
|
|
377
|
+
|
|
378
|
+
<!-- inputs:ds-radio-group -->
|
|
379
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: unknown = null`, `name: string | null = null`, `disabled: boolean = false`, `ariaLabel: string | null = null`, `label: string = ''`
|
|
380
|
+
<!-- /inputs -->
|
|
381
|
+
|
|
382
|
+
#### `<ds-segmented>` — `SegmentedComponent`
|
|
383
|
+
|
|
384
|
+
<!-- inputs:ds-segmented -->
|
|
385
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `options: readonly SegmentedOption[] = []`, `value: string = ''`, `ariaLabel: string | null = null`, `label: string = ''`, `disabled: boolean = false`, `joined: boolean = false`
|
|
386
|
+
<!-- /inputs -->
|
|
387
|
+
|
|
388
|
+
#### `<ds-slider>` — `SliderComponent`
|
|
389
|
+
|
|
390
|
+
<!-- inputs:ds-slider -->
|
|
391
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: SliderValue = 0`, `min: number = 0`, `max: number = 100`, `step: number = 1`, `range: boolean = false`, `disabled: boolean = false`, `ariaLabel: string | null = null`
|
|
392
|
+
<!-- /inputs -->
|
|
393
|
+
|
|
394
|
+
#### `<ds-time-picker>` — `TimePickerComponent`
|
|
395
|
+
|
|
396
|
+
<!-- inputs:ds-time-picker -->
|
|
397
|
+
All inputs: `hint: string = ''`, `error: string = ''`, `warning: string = ''`, `reserveMessage: boolean | null = null`, `messageIcon: IconName | false | null = null`, `errors: readonly DsFieldError[] = []`, `invalid: boolean = false`, `touched: boolean = false`, `hidden: boolean = false`, `value: string | TimeRangeValue | null = null`, `mode: 'single' | 'range' = 'single'`, `minuteStep: number = 1`, `minTime: string | null = null`, `maxTime: string | null = null`, `disabledTime: ((time: string) => boolean) | null = null`, `size: 'sm' | 'md' | 'lg' = null`, `fullWidth: boolean = false`, `label: string = ''`, `required: boolean = false`, `optional: boolean = false`, `panelClass: string | readonly string[] = []`, `disabled: boolean = false`, `success: string = ''`, `placeholder: string = '--:--'`, `clearable: boolean = false`, `ariaLabel: string | null = null`, `format: '24h' | '12h' = null`
|
|
398
|
+
<!-- /inputs -->
|
|
399
|
+
|
|
400
|
+
#### `<ds-filter-bar>` — `FilterBarComponent`
|
|
401
|
+
|
|
402
|
+
<!-- inputs:ds-filter-bar -->
|
|
403
|
+
All inputs: `moreLabel: string = 'more'`, `panelLabel: string = 'More filters'`, `triggerSize: 'sm' | 'md' | 'lg' = 'md'`
|
|
404
|
+
<!-- /inputs -->
|
|
405
|
+
|
|
406
|
+
#### `<ng-template[dsFilterItem]>` — `FilterItemDirective`
|
|
407
|
+
|
|
408
|
+
<!-- inputs:ng-template[dsFilterItem] -->
|
|
409
|
+
All inputs: `width: unknown`
|
|
410
|
+
<!-- /inputs -->
|
|
411
|
+
|
|
266
412
|
### Display & feedback
|
|
267
413
|
|
|
268
414
|
#### `<ds-badge>` — `BadgeComponent`
|
|
269
415
|
Inputs: `status: DsStatusKey` (consumer-registered status key; colours wired via `styles/status`, unset → neutral), `withDot: boolean = false`, `solid: boolean = false`, `count: number | null = null`, `max: number = 99`
|
|
270
416
|
Content: label text. Use for status pills, counts, lifecycle markers.
|
|
271
417
|
|
|
418
|
+
<!-- inputs:ds-badge -->
|
|
419
|
+
All inputs: `status: DsStatusKey`, `withDot: boolean | null = null`, `solid: boolean = false`, `count: number | null = null`, `max: number = 99`, `countLabel: string = 'notifications'`
|
|
420
|
+
<!-- /inputs -->
|
|
421
|
+
|
|
272
422
|
#### `<ds-status-dot>` — `StatusDotComponent`
|
|
273
423
|
Input: `status: DsStatusKey` (same consumer-registered vocabulary as `ds-badge`; colours wired via `styles/status`, unset → neutral). Tiny coloured dot.
|
|
274
424
|
|
|
425
|
+
<!-- inputs:ds-status-dot -->
|
|
426
|
+
All inputs: `status: DsStatusKey`, `ariaLabel: string | null = null`
|
|
427
|
+
<!-- /inputs -->
|
|
428
|
+
|
|
275
429
|
#### `<ds-tag>` — `TagComponent`
|
|
276
430
|
Inputs: `variant: 'solid' | 'neutral' = 'solid'`, `closable: boolean = false`
|
|
277
431
|
Output: `(closed): void` — emits when the close button is pressed
|
|
278
432
|
Content: label.
|
|
279
433
|
|
|
434
|
+
<!-- inputs:ds-tag -->
|
|
435
|
+
All inputs: `variant: 'solid' | 'neutral' = 'solid'`, `closable: boolean = false`, `interactive: boolean = false`, `selected: boolean = false`, `closeLabel: string = 'Remove'`
|
|
436
|
+
<!-- /inputs -->
|
|
437
|
+
|
|
280
438
|
#### `<ds-avatar>` — `AvatarComponent`
|
|
281
439
|
Inputs: `size: 'xs' | 'sm' | 'md' | 'lg' = 'md'`, `initials: string = ''`, `imageUrl: string | null = null`, `tint: { bg, fg } | 'neutral' | null = null` (off-token override; `'neutral'` swaps to the overflow-chip palette)
|
|
282
440
|
|
|
441
|
+
<!-- inputs:ds-avatar -->
|
|
442
|
+
All inputs: `size: 'xs' | 'sm' | 'md' | 'lg' = 'md'`, `initials: string = ''`, `name: string = ''`, `initialsRule: ((name: string) => string) | null = null`, `imageUrl: string | null = null`, `ariaLabel: string | null = null`, `tint: { bg: string; fg: string } | 'neutral' | null = null`, `status: 'online' | 'offline' | 'away' | 'busy' = null`, `fallbackIcon: IconName | null = null`, `seed: string | null = null`, `avoidHues: readonly (readonly [number, number])[] = []`
|
|
443
|
+
<!-- /inputs -->
|
|
444
|
+
|
|
283
445
|
#### `<ds-avatar-group>` — `AvatarGroupComponent`
|
|
284
446
|
Inputs: `max: number = 4` (visible avatars before "+N" overflow), `total: number | null = null` (used to compute the overflow count; without `total` no overflow chip renders).
|
|
285
447
|
Content: project `<ds-avatar>` children.
|
|
286
448
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
449
|
+
<!-- inputs:ds-avatar-group -->
|
|
450
|
+
All inputs: `max: number = 4`, `total: number | null = null`
|
|
451
|
+
<!-- /inputs -->
|
|
452
|
+
|
|
453
|
+
#### `<ds-bar>` — `BarComponent`
|
|
454
|
+
One horizontal track with one fill: a task's completion, or a measurement on a known scale. No circular variant.
|
|
455
|
+
Inputs: `value: number = 0` (in units of `max`, clamped), `max: number = 100`, `semantics: 'progress' | 'meter' | 'none' = 'progress'`, `variant: 'default' | 'success' | 'warning' | 'error' = 'default'`, `indeterminate: boolean = false`, `color: string | null = null`, `target: number | null = null`, `ariaLabel: string | null = null`.
|
|
456
|
+
`semantics` is the claim the bar makes, and it decides the role: `'progress'` is how far a task has got (`role="progressbar"`), `'meter'` is a measurement on a known scale with no beginning and no completion — a rate, a score, a count against a ceiling (`role="meter"`), `'none'` draws it and hides it from assistive technology. Use `'none'` for a bar in a table cell whose figure is printed beside it: left at the default, a table of two hundred rows announces two hundred progress bars.
|
|
457
|
+
`max` is the scale `value` and `target` are read against; left at 100 they are percentages. Set it to the real total — `[value]="37" [max]="80"` — and `aria-valuenow`/`aria-valuemax` carry "37 of 80" instead of a percentage the caller had to compute. For a column of measurements it is usually the column's own largest value. Zero or less falls back to 100.
|
|
458
|
+
`target` is a second point on the same scale, drawn as a hairline across the track — a goal, a baseline or a threshold. Clamped like `value` and ignored while `indeterminate`. The role announces one value, so name the comparison in `ariaLabel` ("Resolved 62% against a 75% target").
|
|
459
|
+
`indeterminate` is ignored unless `semantics` is `'progress'`: only a task has an unknown duration.
|
|
460
|
+
The bar fills its box, so the column decides its width. A box sized to its content is sized by what its contents contribute intrinsically and a `100%`-wide child contributes nothing, so the host carries a `min-inline-size` of `3rem`.
|
|
461
|
+
Tokens: `--ds-bar-height`, `--ds-bar-min-width`, `--ds-bar-track-color`, `--ds-bar-fill-color`, `--ds-bar-fill-color-success`, `--ds-bar-fill-color-warning`, `--ds-bar-fill-color-error`, `--ds-bar-target-color`, `--ds-bar-target-width`.
|
|
462
|
+
|
|
463
|
+
<!-- inputs:ds-bar -->
|
|
464
|
+
All inputs: `value: number = 0`, `max: number = 100`, `semantics: 'progress' | 'meter' | 'none' = 'progress'`, `variant: 'default' | 'success' | 'warning' | 'error' = 'default'`, `indeterminate: boolean = false`, `color: string | null = null`, `ariaLabel: string | null = null`, `target: number | null = null`
|
|
465
|
+
<!-- /inputs -->
|
|
301
466
|
|
|
302
467
|
#### `<ds-spinner>` — `SpinnerComponent`
|
|
303
468
|
Input: `size: 'sm' | 'md' | 'lg' = 'md'`. Pure-CSS spinner, `role="status"` with built-in `aria-label`.
|
|
304
469
|
|
|
470
|
+
<!-- inputs:ds-spinner -->
|
|
471
|
+
All inputs: `size: 'sm' | 'md' | 'lg' = 'md'`
|
|
472
|
+
<!-- /inputs -->
|
|
473
|
+
|
|
305
474
|
#### `<ds-skeleton>` — `SkeletonComponent`
|
|
306
475
|
Inputs: `width?: string`, `height?: string`, `circle: boolean = false`, `inline: boolean = false`. Shimmer animation requires the global `_skeleton-shimmer.scss` (already pulled in by `ds.scss`).
|
|
307
476
|
|
|
477
|
+
<!-- inputs:ds-skeleton -->
|
|
478
|
+
All inputs: `width: string | undefined`, `height: string | undefined`, `circle: boolean = false`, `inline: boolean = false`
|
|
479
|
+
<!-- /inputs -->
|
|
480
|
+
|
|
308
481
|
#### `<ds-stat>` — `StatComponent`
|
|
309
482
|
Inputs: `label: required string`, `value: required string | number`, `delta: number | null = null`, `deltaLabel: string = ''`, `caption: string = ''`, `unit: string = ''`, `variant: 'default' | 'danger' = 'default'`
|
|
310
483
|
Delta direction is derived from the sign of `delta`: positive → up (arrow + green), negative → down (arrow + red), zero/null → neutral.
|
|
311
484
|
|
|
485
|
+
<!-- inputs:ds-stat -->
|
|
486
|
+
All inputs: `label: required string`, `value: string | number | null = ''`, `delta: number | null = null`, `deltaLabel: string = ''`, `deltaTone: 'neutral' | 'secondary' = null`, `caption: string = ''`, `unit: string = ''`, `variant: 'default' | 'error' = 'default'`, `size: 'sm' | 'md' | 'lg' = 'md'`
|
|
487
|
+
<!-- /inputs -->
|
|
488
|
+
|
|
312
489
|
#### `<ds-empty-state>` — `EmptyStateComponent`
|
|
313
490
|
Inputs: `variant: 'none' | 'loading' | 'error' | 'locked' = 'none'`, `icon: IconName | null = null` (defaults derive from variant — `warn` for error, `lock` for locked, `package` otherwise), `title: string = ''`, `body: string = ''`
|
|
314
491
|
Content slot: `[actions]` — CTA buttons / links.
|
|
315
492
|
|
|
493
|
+
<!-- inputs:ds-empty-state -->
|
|
494
|
+
All inputs: `variant: 'none' | 'loading' | 'error' | 'locked' | 'success' = 'none'`, `icon: IconName | null = null`, `title: string = ''`, `body: string = ''`
|
|
495
|
+
<!-- /inputs -->
|
|
496
|
+
|
|
316
497
|
#### `<ds-banner>` — `BannerComponent`
|
|
317
498
|
Inputs: `variant: 'info' | 'success' | 'warning' | 'severe' | 'error' | 'neutral' = 'info'`, `title: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null` (variant-derived default), `compact: boolean = false`, `layout: 'stacked' | 'row' = 'stacked'`, `accentRail: boolean = true`
|
|
318
499
|
Output: `(closed): void`
|
|
319
500
|
Content slots: default (body text), `[actions]` (trailing CTAs)
|
|
320
|
-
- `layout="stacked"` (default): actions wrap onto a new line, indented under the body. Use for
|
|
501
|
+
- `layout="stacked"` (default): actions wrap onto a new line, indented under the body. Use for multiple-line messages or multiple CTAs.
|
|
321
502
|
- `layout="row"`: actions sit at the right edge, vertically centred with the body. Use for one-line messages with a single trailing CTA.
|
|
322
503
|
|
|
504
|
+
<!-- inputs:ds-banner -->
|
|
505
|
+
All inputs: `variant: BannerVariant = 'info'`, `title: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null`, `compact: boolean = false`, `layout: 'stacked' | 'row' = 'stacked'`, `accentRail: boolean = true`, `announce: boolean | null = null`
|
|
506
|
+
<!-- /inputs -->
|
|
507
|
+
|
|
323
508
|
#### `<ds-alert>` — `AlertComponent`
|
|
324
509
|
Inline message, `ds-banner`'s smaller twin — same anatomy, sized for placement inside a form or a card rather than across a page.
|
|
325
510
|
Inputs: `variant: 'info' | 'success' | 'warning' | 'error' | 'neutral' = 'info'`, `title: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null` (variant-derived default)
|
|
326
511
|
Output: `(closed): void`
|
|
327
512
|
Content slots: default (body text), `[actions]` (trailing CTAs)
|
|
328
513
|
|
|
514
|
+
<!-- inputs:ds-alert -->
|
|
515
|
+
All inputs: `variant: 'info' | 'success' | 'warning' | 'error' | 'neutral' = 'info'`, `title: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null`, `announce: boolean | null = null`
|
|
516
|
+
<!-- /inputs -->
|
|
517
|
+
|
|
329
518
|
#### `<ds-toast>` — `ToastComponent`
|
|
330
519
|
Inputs: `variant: 'info' | 'success' | 'warning' | 'error' | 'loading' = 'info'`, `title: string = ''`, `message: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null` (variant-derived default), `action: ToastAction | null = null` (`{ label, handler }` — renders a trailing button)
|
|
331
520
|
Output: `(closed): void`
|
|
@@ -333,8 +522,60 @@ Content slots: default (body text, an alternative to `message`), `[actions]` (tr
|
|
|
333
522
|
|
|
334
523
|
The companion `<ds-toast-region>` lives inside the `ToastService` (see Services) — it is auto-mounted via a CDK overlay on first `toast.show()`, so consumers do **not** need to place `<ds-toast-region>` anywhere in their markup. Render `<ds-toast>` directly only for static specimens.
|
|
335
524
|
|
|
525
|
+
<!-- inputs:ds-toast -->
|
|
526
|
+
All inputs: `variant: 'info' | 'success' | 'warning' | 'error' | 'loading' = 'info'`, `title: string = ''`, `body: string = ''`, `dismissible: boolean = false`, `icon: IconName | null = null`, `action: ToastAction | null = null`
|
|
527
|
+
<!-- /inputs -->
|
|
528
|
+
|
|
336
529
|
---
|
|
337
530
|
|
|
531
|
+
#### `<ds-list>` — `ListComponent`
|
|
532
|
+
|
|
533
|
+
<!-- inputs:ds-list -->
|
|
534
|
+
All inputs: `dividers: boolean = true`
|
|
535
|
+
<!-- /inputs -->
|
|
536
|
+
|
|
537
|
+
#### `<ds-list-item>` — `ListItemComponent`
|
|
538
|
+
|
|
539
|
+
<!-- inputs:ds-list-item -->
|
|
540
|
+
All inputs: `title: string = ''`, `subtitle: string = ''`, `clickable: boolean = false`, `selected: boolean = false`, `disabled: boolean = false`
|
|
541
|
+
<!-- /inputs -->
|
|
542
|
+
|
|
543
|
+
#### `<ds-loading-overlay>` — `LoadingOverlayComponent`
|
|
544
|
+
|
|
545
|
+
<!-- inputs:ds-loading-overlay -->
|
|
546
|
+
All inputs: `loading: boolean = false`, `label: string = ''`, `blur: boolean = true`, `spinnerSize: 'sm' | 'md' | 'lg' = 'md'`, `insetTop: string = '0'`, `inertContent: boolean = true`
|
|
547
|
+
<!-- /inputs -->
|
|
548
|
+
|
|
549
|
+
#### `<ds-timeline-item>` — `TimelineItemComponent`
|
|
550
|
+
|
|
551
|
+
<!-- inputs:ds-timeline-item -->
|
|
552
|
+
All inputs: `heading: string = ''`, `time: string = ''`, `icon: IconName | null = null`, `tone: TimelineTone = 'default'`
|
|
553
|
+
<!-- /inputs -->
|
|
554
|
+
|
|
555
|
+
#### `<ds-toast-region>` — `ToastRegionComponent`
|
|
556
|
+
|
|
557
|
+
<!-- inputs:ds-toast-region -->
|
|
558
|
+
All inputs: `maxVisible: number`, `showQueueCount: boolean = true`
|
|
559
|
+
<!-- /inputs -->
|
|
560
|
+
|
|
561
|
+
#### `<ds-tree>` — `TreeComponent`
|
|
562
|
+
|
|
563
|
+
<!-- inputs:ds-tree -->
|
|
564
|
+
All inputs: `nodes: readonly TreeNode[] = []`, `expandedIds: Set<string>`, `selectedId: string | null = null`
|
|
565
|
+
<!-- /inputs -->
|
|
566
|
+
|
|
567
|
+
#### `<ds-description-list>` — `DescriptionListComponent`
|
|
568
|
+
|
|
569
|
+
<!-- inputs:ds-description-list -->
|
|
570
|
+
All inputs: `orientation: 'horizontal' | 'stacked' = 'horizontal'`
|
|
571
|
+
<!-- /inputs -->
|
|
572
|
+
|
|
573
|
+
#### `<ds-description-item>` — `DescriptionItemComponent`
|
|
574
|
+
|
|
575
|
+
<!-- inputs:ds-description-item -->
|
|
576
|
+
All inputs: `term: string = ''`, `copyValue: string | null = null`
|
|
577
|
+
<!-- /inputs -->
|
|
578
|
+
|
|
338
579
|
### Layout & navigation
|
|
339
580
|
|
|
340
581
|
#### `<ds-sidenav>` — `SidenavComponent`
|
|
@@ -343,11 +584,19 @@ Content: default slot for groups/items + custom brand/footer rows
|
|
|
343
584
|
**The brand row leads home only if you say so.** `brandRoute` turns the mark + wordmark into one link; unset, the row stays a plain block. A logo that goes nowhere should not be a link, and whether a mark is a way home is an app's decision, not the DS's — so this is opt-in, like every other new capability here. The link announces itself as `"<brand>, home"` because a wordmark alone does not say where it goes; `brandLinkLabel` overrides that. Router targets only, and `RouterLink` is instantiated only inside the `@if`, so an app with no router provided still renders the sidenav. A collapse toggle projected into the row stays OUTSIDE the link — one control never nests inside another.
|
|
344
585
|
Tokens: `--ds-sidenav-bg-color`, `--ds-sidenav-border`, `--ds-sidenav-width`, `--ds-sidenav-width-collapsed`, `--ds-sidenav-mark-bg-color`, `--ds-sidenav-mark-label-color`
|
|
345
586
|
|
|
587
|
+
<!-- inputs:ds-sidenav -->
|
|
588
|
+
All inputs: `collapsed: boolean = false`, `rail: boolean = true`, `brand: string | null = null`, `logoLetter: string | null = null`, `brandRoute: string | readonly unknown[] | null = null`, `brandLinkLabel: string | null = null`
|
|
589
|
+
<!-- /inputs -->
|
|
590
|
+
|
|
346
591
|
#### `<ds-sidenav-group>` — `SidenavGroupComponent`
|
|
347
592
|
Inputs: `label: string = ''`, `icon: IconName | null = null`, `expandable: boolean = false`, `expanded: model<boolean> = true`
|
|
348
593
|
Content slots: default (items); `[ds-group-icon]` (custom group icon when not using a DS IconName)
|
|
349
594
|
When `expandable=true` renders header button with toggle + caret; collapses body when not expanded.
|
|
350
595
|
|
|
596
|
+
<!-- inputs:ds-sidenav-group -->
|
|
597
|
+
All inputs: `label: string = ''`, `icon: IconName | null = null`, `expandable: boolean = false`, `routerLink: DsRouterLink = null`, `ariaCurrent: 'page' | 'step' | 'location' | 'date' | 'time' | 'true'`, `expanded: boolean = true`
|
|
598
|
+
<!-- /inputs -->
|
|
599
|
+
|
|
351
600
|
#### `<ds-sidenav-item>` — `SidenavItemComponent`
|
|
352
601
|
Inputs: `icon: IconName | null = null` (optional — falls back to `[icon]` slot), `label: required string`, `href: string = ''`, `routerLink: string | readonly unknown[] | null = null`, `active: boolean = false`, `badge: number | null = null`, `hasAlert: boolean = false`, `rail: boolean | null = null` (draws the active item's edge marker; unset follows the parent `ds-sidenav`)
|
|
353
602
|
Content slots: `[icon]` (custom icon when not using a DS IconName), `[trailing]` (right-aligned chrome — badges, indicators, kbd shortcuts)
|
|
@@ -355,6 +604,10 @@ Content slots: `[icon]` (custom icon when not using a DS IconName), `[trailing]`
|
|
|
355
604
|
**Three elements, decided by destination.** `routerLink` → an `<a [routerLink]>` with `routerLinkActive`; `href` → a plain `<a href>`; **neither → a `<button type="button">`**. Until 0.11.0 the last case fell back to `href="#"`, which navigates: it rewrites the URL and discards the scroll position on every click. An item that only emits `activate` is a button. Styling is identical across all three — the rules are class-based (`.item`) and the button's UA chrome is reset — so target the class, never the tag.
|
|
356
605
|
Tokens (on `:host`): `--ds-sidenav-item-label-color`, `--ds-sidenav-item-label-color-hover`, `--ds-sidenav-item-bg-color-hover`, `--ds-sidenav-item-bg-color-active` (default: `--accent-subtitle` — a wash, not a solid pill), `--ds-sidenav-item-label-color-active` (default: `--accent-strong`), `--ds-sidenav-item-bg-color-active-hover` (default: `--accent-muted`, deepening toward the accent), `--ds-sidenav-item-rail` (left rail, default: `--accent-strong`), `--ds-sidenav-item-radius`, `--ds-sidenav-alert-color`
|
|
357
606
|
|
|
607
|
+
<!-- inputs:ds-sidenav-item -->
|
|
608
|
+
All inputs: `icon: IconName | null = null`, `label: required string`, `href: string = ''`, `routerLink: DsRouterLink = null`, `active: boolean = false`, `ariaCurrent: 'page' | 'step' | 'location' | 'date' | 'time' | 'true'`, `badge: number | null = null`, `hasAlert: boolean = false`, `disabled: boolean = false`, `rail: boolean | null = null`
|
|
609
|
+
<!-- /inputs -->
|
|
610
|
+
|
|
358
611
|
#### `<ds-topbar>` — `TopBarComponent`
|
|
359
612
|
No inputs.
|
|
360
613
|
Content slots: `[title]`, `[breadcrumbs]`, `[search]`, `[actions]`. Sits at `--topbar-h` height.
|
|
@@ -364,61 +617,141 @@ Tokens (on `:host`): `--ds-topbar-height`, `--ds-topbar-bg-color`, `--ds-topbar-
|
|
|
364
617
|
Inputs: `topbarSpan: 'content' | 'full' = 'content'`, `railOpen: model<boolean> = false` (the overlay rail below `--bp-lg`), `railLabel: string = 'Navigation'`, `restoreScroll: boolean = false`, `restoreScrollTimeout: number = 2000` (ms), `scrollReset: 'path' | 'always' | 'never' = 'path'`
|
|
365
618
|
Content slots: `[sidenav]`, `[topbar]`, default (the page)
|
|
366
619
|
Reads: `railId` and the read-only `railOverlay` signal, for a consumer-built burger; `dsRailTrigger` wires one for you.
|
|
367
|
-
Tokens: `--ds-app-layout-
|
|
368
|
-
It owns the app's scroll CONTAINER, so a screen that needs to move the scroll calls `
|
|
620
|
+
Tokens: `--ds-app-layout-padding-x`, `--ds-app-layout-padding-y`, `--ds-app-layout-content-max-width`, `--ds-app-layout-height`, `--ds-app-layout-rail-bg-color`, `--ds-app-layout-rail-shadow`, `--ds-app-layout-scrim-color`
|
|
621
|
+
It owns the app's scroll CONTAINER, so a screen that needs to move the scroll calls `AppLayoutScrollService` rather than touching `window`.
|
|
622
|
+
|
|
623
|
+
<!-- inputs:ds-app-layout -->
|
|
624
|
+
All inputs: `topbarSpan: 'content' | 'full' = 'content'`, `railOpen: boolean = false`, `railLabel: string = 'Navigation'`, `restoreScroll: boolean = false`, `restoreScrollTimeout: number = 2000`, `scrollReset: 'path' | 'never' | 'always' = 'path'`
|
|
625
|
+
<!-- /inputs -->
|
|
369
626
|
|
|
370
627
|
#### `<ds-auth-layout>` — `AuthLayoutComponent`
|
|
371
628
|
Inputs: `brand: string | null = null`, `logoLetter: string | null = null`, `tagline: string | null = null` (all three fall back to `DS_CONFIG.brand`), `cardElevation: CardElevation = 'raised'`, `cardPadding: CardPadding = 'lg'`, `landmark: 'main' | 'none' = 'none'`
|
|
372
629
|
Content slots: `[brand]` (replaces the whole mark row), `[dsBrandName]` (the name beside the generated mark), default (the card body), `[dsAuthSupport]` (the line under the card)
|
|
373
|
-
Tokens: `--ds-auth-layout-min-height`, `--ds-auth-layout-bg-color`, `--ds-auth-layout-gap`, `--ds-auth-layout-
|
|
630
|
+
Tokens: `--ds-auth-layout-min-height`, `--ds-auth-layout-bg-color`, `--ds-auth-layout-gap`, `--ds-auth-layout-padding-block`, `--ds-auth-layout-card-max-width`, `--ds-auth-layout-mark-size`, `--ds-auth-layout-mark-radius`, `--ds-auth-layout-mark-bg-color`, `--ds-auth-layout-mark-label-color`
|
|
374
631
|
`landmark="main"` only when the page has no other `<main>`; the sign-in card is not automatically the document's main landmark.
|
|
375
632
|
|
|
633
|
+
<!-- inputs:ds-auth-layout -->
|
|
634
|
+
All inputs: `brand: string | null = null`, `logoLetter: string | null = null`, `tagline: string | null = null`, `cardElevation: 'flat' | 'raised' | 'hover' | 'interactive' = 'raised'`, `cardPadding: 'none' | 'sm' | 'md' | 'lg' = 'lg'`, `landmark: 'main' | 'none' = 'none'`
|
|
635
|
+
<!-- /inputs -->
|
|
636
|
+
|
|
376
637
|
#### `<ds-page-header>` — `PageHeaderComponent`
|
|
377
638
|
Inputs: `eyebrow: string = ''`, `title: required string`, `subtitle: string = ''`, `compact: boolean = false`, `divider: boolean = false`, `metaDivider: boolean = false`
|
|
378
639
|
Content slots: `[breadcrumbs]`, `[title-badge]` (sits next to the title text), `[actions]` (right edge of title row), `[meta]` (under the title row), `[tabs]` (under the meta row)
|
|
379
|
-
Tokens: `--ds-page-header-eyebrow-text-color`, `--ds-page-header-title-text-color`, `--ds-page-header-subtitle-text-color`, `--ds-page-header-meta-text-color`, `--ds-page-header-meta-icon-color`, `--ds-page-header-divider`, `--ds-page-header-title-
|
|
640
|
+
Tokens: `--ds-page-header-eyebrow-text-color`, `--ds-page-header-title-text-color`, `--ds-page-header-subtitle-text-color`, `--ds-page-header-meta-text-color`, `--ds-page-header-meta-icon-color`, `--ds-page-header-divider`, `--ds-page-header-title-font-size` (default `--font-size-h3`; `compact` flips to `--font-size-h4`). The page-header does NOT own its bottom gap — the parent page `:host` owns spacing via `display: flex; flex-direction: column; gap: var(--space-4)`.
|
|
641
|
+
|
|
642
|
+
<!-- inputs:ds-page-header -->
|
|
643
|
+
All inputs: `eyebrow: string = ''`, `title: string = ''`, `subtitle: string = ''`, `compact: boolean = false`, `divider: boolean = false`, `metaDivider: boolean = false`
|
|
644
|
+
<!-- /inputs -->
|
|
380
645
|
|
|
381
646
|
#### `<ds-page-footer>` — `PageFooterComponent`
|
|
382
647
|
Input: `variant: 'default' | 'compact' | 'save' = 'default'`
|
|
383
648
|
Content: default `<ng-content>`. Sticky footer bar pattern.
|
|
384
649
|
|
|
650
|
+
<!-- inputs:ds-page-footer -->
|
|
651
|
+
All inputs: `variant: 'default' | 'compact' | 'save' = 'default'`
|
|
652
|
+
<!-- /inputs -->
|
|
653
|
+
|
|
385
654
|
#### `<ds-breadcrumbs>` — `BreadcrumbsComponent`
|
|
386
655
|
Inputs: `items: BreadcrumbItem[] | null = null` (`{ label?, href?, icon? }` — when `null`/omitted, the component reads from `BreadcrumbsService.items` so route-driven flows work without a per-page `[items]` binding), `separator: IconName | null = null` (overrides `DsConfig.breadcrumbs.separator`, falls back to `'chevronRight'`), `clickable: boolean | null = null` (overrides `DsConfig.breadcrumbs.clickable`, falls back to `true`)
|
|
387
656
|
Output: `(navigate): BreadcrumbItem` — emits when an item with `href` is clicked and `clickable` resolves to `true` (event is `preventDefault`-ed so the consumer can decide what to do)
|
|
388
657
|
|
|
658
|
+
<!-- inputs:ds-breadcrumbs -->
|
|
659
|
+
All inputs: `items: BreadcrumbItem[] | null = null`, `separator: IconName | null = null`, `clickable: boolean | null = null`, `maxItems: number | null = null`
|
|
660
|
+
<!-- /inputs -->
|
|
661
|
+
|
|
389
662
|
#### `<ds-tabs>` + `<ds-tab>` — `TabsComponent`, `TabComponent`
|
|
390
663
|
Container holds `<ds-tab label="…">` children.
|
|
391
664
|
Tabs inputs: `selectedIndex: model<number> = 0`, `variant: 'line' | 'pills' = 'line'`
|
|
392
665
|
Tab inputs: `label: required string`, `icon: IconName | null = null`, `count: number | null = null`, `disabled: boolean = false`. The tab's projected content renders in the active panel.
|
|
393
|
-
Tokens: `--ds-tab-label-color`, `--ds-tab-label-color-hover`, `--ds-tab-label-color-active`, `--ds-tab-indicator-color`, `--ds-tab-indicator-width`, `--ds-tab-
|
|
666
|
+
Tokens: `--ds-tab-label-color`, `--ds-tab-label-color-hover`, `--ds-tab-label-color-active`, `--ds-tab-indicator-color`, `--ds-tab-indicator-width`, `--ds-tab-padding-x`, `--ds-tab-padding-y`, `--ds-tabs-divider`, `--ds-tabs-pills-bg-color`, `--ds-tab-pill-bg-color-hover` (inactive hover, defaults to `var(--primary-subtle)`), `--ds-tab-pill-bg-color-active` (defaults to `var(--surface-default)` — elevated card), `--ds-tab-pill-bg-color-active-hover` (defaults to `var(--primary-subtle)`), `--ds-tab-pill-label-color-active` (defaults to `var(--primary-strong)`), `--ds-tab-pill-radius` (defaults to `var(--radius-md)` — same as buttons/inputs; override per-instance to `var(--radius-pill)` for fully round pills).
|
|
667
|
+
|
|
668
|
+
<!-- inputs:ds-tabs -->
|
|
669
|
+
All inputs: `selectedIndex: number = 0`, `variant: 'line' | 'pills' = 'line'`, `lazy: boolean = false`, `scrollable: boolean = false`, `closable: boolean = false`, `orientation: 'horizontal' | 'vertical' = 'horizontal'`, `urlParam: string = ''`, `rememberLastTab: boolean = false`
|
|
670
|
+
<!-- /inputs -->
|
|
394
671
|
|
|
395
672
|
#### `<ds-stepper>` — `StepperComponent`
|
|
396
673
|
Inputs: `steps: readonly string[] = []`, `current: number = 0`. Horizontal step indicator with done/active/upcoming nodes.
|
|
397
674
|
|
|
675
|
+
<!-- inputs:ds-stepper -->
|
|
676
|
+
All inputs: `steps: readonly string[] = []`, `current: number = 0`, `labelPosition: 'bottom' | 'inline' = 'bottom'`, `orientation: 'horizontal' | 'vertical' = 'horizontal'`, `clickable: boolean = false`, `errorSteps: readonly number[] = []`
|
|
677
|
+
<!-- /inputs -->
|
|
678
|
+
|
|
398
679
|
#### `<ds-pagination>` — `PaginationComponent`
|
|
399
|
-
Inputs: `total: required number`, `pageSize: model<number> = 10`, `currentPage: model<number> = 1`, `pageSizeOptions: number[] = [10, 25, 50, 100]`, `showLabel: boolean = true`
|
|
680
|
+
Inputs: `total: required number`, `pageSize: model<number> = 10`, `currentPage: model<number> = 1`, `pageSizeOptions: number[] = [10, 25, 50, 100]`, `showLabel: boolean = true`, `size: DsSize | null = null` (unset resolves `DS_CONFIG.control.size`, then `sm`), `layout: PaginationLayout = 'grouped'` (`'grouped' | 'spread'`; `'spread'` gives the nav full width and pushes the label and the controls to opposite edges)
|
|
400
681
|
Outputs: `(currentPageChange): number`, `(pageSizeChange): number`
|
|
401
682
|
|
|
683
|
+
<!-- inputs:ds-pagination -->
|
|
684
|
+
All inputs: `total: required number`, `pageSize: number = 10`, `currentPage: number = 1`, `pageSizeOptions: number[]`, `showLabel: boolean = true`, `showPageSize: boolean = true`, `size: 'sm' | 'md' | 'lg' = null`, `layout: 'grouped' | 'spread' = 'grouped'`
|
|
685
|
+
<!-- /inputs -->
|
|
686
|
+
|
|
402
687
|
#### `<ds-divider>` — `DividerComponent`
|
|
403
688
|
Inputs: `variant: 'default' | 'strong' | 'vertical' | 'label' = 'default'`, `spacing: 'none' | 'sm' | 'md' | 'lg' = 'md'`
|
|
404
689
|
Content: label text (when `variant="label"`).
|
|
405
690
|
|
|
691
|
+
<!-- inputs:ds-divider -->
|
|
692
|
+
All inputs: `variant: 'default' | 'strong' | 'vertical' | 'label' = 'default'`, `spacing: 'none' | 'sm' | 'md' | 'lg' = 'md'`
|
|
693
|
+
<!-- /inputs -->
|
|
694
|
+
|
|
406
695
|
---
|
|
407
696
|
|
|
697
|
+
#### `<ds-container>` — `ContainerComponent`
|
|
698
|
+
|
|
699
|
+
<!-- inputs:ds-container -->
|
|
700
|
+
All inputs: `size: 'sm' | 'md' | 'lg' | 'xl' | 'full' = 'xl'`
|
|
701
|
+
<!-- /inputs -->
|
|
702
|
+
|
|
703
|
+
#### `<ds-inline>` — `InlineComponent`
|
|
704
|
+
|
|
705
|
+
<!-- inputs:ds-inline -->
|
|
706
|
+
All inputs: `gap: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' = null`, `align: 'start' | 'center' | 'end' | 'stretch' = null`, `justify: 'start' | 'center' | 'end' | 'between' = null`, `wrap: boolean = true`
|
|
707
|
+
<!-- /inputs -->
|
|
708
|
+
|
|
709
|
+
#### `<ds-stack>` — `StackComponent`
|
|
710
|
+
|
|
711
|
+
<!-- inputs:ds-stack -->
|
|
712
|
+
All inputs: `gap: 'none' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' = null`, `align: 'start' | 'center' | 'end' | 'stretch' = null`
|
|
713
|
+
<!-- /inputs -->
|
|
714
|
+
|
|
715
|
+
#### `<ds-sidenav-footer>` — `SidenavFooterComponent`
|
|
716
|
+
|
|
717
|
+
<!-- inputs:ds-sidenav-footer -->
|
|
718
|
+
All inputs: `userName: string = ''`, `userRole: string = ''`, `alerts: boolean = false`, `collapsed: boolean = false`, `searchProvider: SidenavSearchProvider | null = null`, `alertItems: readonly SidenavAlertItem[] | null = null`, `profileRoute: string = ''`
|
|
719
|
+
<!-- /inputs -->
|
|
720
|
+
|
|
721
|
+
#### `<ds-tab>` — `TabComponent`
|
|
722
|
+
|
|
723
|
+
<!-- inputs:ds-tab -->
|
|
724
|
+
All inputs: `label: required string`, `icon: IconName | null = null`, `count: number | null = null`, `disabled: boolean = false`, `value: string | null = null`
|
|
725
|
+
<!-- /inputs -->
|
|
726
|
+
|
|
408
727
|
### Surfaces
|
|
409
728
|
|
|
410
729
|
#### `<ds-card>` — `CardComponent`
|
|
411
|
-
Inputs: `elevation: 'flat' | 'raised' | 'hover' | 'interactive' = 'flat'`, `padding: 'none' | 'sm' | 'md' | 'lg' | null = null` (when `null`, no `padding-*` class is applied and the consumer controls padding via own CSS or `--ds-card-
|
|
730
|
+
Inputs: `elevation: 'flat' | 'raised' | 'hover' | 'interactive' = 'flat'`, `padding: 'none' | 'sm' | 'md' | 'lg' | null = null` (when `null`, no `padding-*` class is applied and the consumer controls padding via own CSS or `--ds-card-padding`)
|
|
412
731
|
Output: `(pressed): MouseEvent` — fires only when `elevation="interactive"`
|
|
413
|
-
Tokens: `--ds-card-bg-color`, `--ds-card-border`, `--ds-card-radius`, `--ds-card-
|
|
732
|
+
Tokens: `--ds-card-bg-color`, `--ds-card-border`, `--ds-card-radius`, `--ds-card-padding`, `--ds-card-shadow`, `--ds-card-shadow-hover`, `--ds-card-hover-lift`, `--ds-card-overflow`. The focus ring is not a card token — set `--focus-ring-color`, `--focus-ring-width` or `--focus-ring-offset` on the card's own scope
|
|
414
733
|
Full-bleed child: a child whose background reaches the card edge paints square corners over the radius, and the host cannot fix it — the rounded box is the card's inner element. Set `--ds-card-overflow: clip` (`clip`, not `hidden`, so the card stays out of the scroll-container business). It is opt-in because a clipped card also cuts the focus ring off a child at its edge; where the clipped card holds focusable content, pair it with `data-focus="inset"`.
|
|
415
734
|
Convention tokens (consumer-side `.title` projected into the card slot — declared at `:root`, not on the host): `--card-title-fs` (default `var(--font-size-h4)` = 22px; a brand can step it down to `var(--font-size-h5)`). Consumer markup: `<h3 class="title">…</h3>`; local `.title` class reads the token via `font:` shorthand together with `--font-weight-bold` / `--line-height-snug` / `--font-heading`.
|
|
416
735
|
|
|
736
|
+
<!-- inputs:ds-card -->
|
|
737
|
+
All inputs: `elevation: 'flat' | 'raised' | 'hover' | 'interactive' = null`, `padding: 'none' | 'sm' | 'md' | 'lg' = null`
|
|
738
|
+
<!-- /inputs -->
|
|
739
|
+
|
|
417
740
|
#### `<ds-accordion>` + `<ds-accordion-item>` — `AccordionComponent`, `AccordionItemComponent`
|
|
418
741
|
Accordion is a thin wrapper that rounds + borders its children. Item inputs: `title: string = ''`, `expanded: model<boolean> = false`. Content slots on item: default (body), `[badge]` (rendered next to the title in the header).
|
|
419
742
|
|
|
743
|
+
<!-- inputs:ds-accordion -->
|
|
744
|
+
All inputs: `multiple: boolean = true`
|
|
745
|
+
<!-- /inputs -->
|
|
746
|
+
|
|
420
747
|
---
|
|
421
748
|
|
|
749
|
+
#### `<ds-accordion-item>` — `AccordionItemComponent`
|
|
750
|
+
|
|
751
|
+
<!-- inputs:ds-accordion-item -->
|
|
752
|
+
All inputs: `title: required string`, `expanded: boolean = false`, `disabled: boolean = false`
|
|
753
|
+
<!-- /inputs -->
|
|
754
|
+
|
|
422
755
|
### Overlay
|
|
423
756
|
|
|
424
757
|
#### `<ds-modal>` — `ModalComponent`
|
|
@@ -426,90 +759,169 @@ Inputs: `open: model<boolean> = false`, `size: 'sm' | 'md' | 'lg' = 'md'`, `dang
|
|
|
426
759
|
Output: `(closed): void` — fires on backdrop click, close button, or `open` being set to false. `(confirmed)` is declared on the component but no internal handler emits it; treat it as not implemented and emit confirmation from the consumer-side action button instead.
|
|
427
760
|
Content slots: `[body]`, `[impact]` (highlighted strip under the body for destructive consequences), `[actions]` (footer button row). Backdrop click + close button close the dialog.
|
|
428
761
|
|
|
762
|
+
<!-- inputs:ds-modal -->
|
|
763
|
+
All inputs: `open: boolean = false`, `size: 'sm' | 'md' | 'lg' | 'xl' | 'fullscreen' = 'md'`, `status: 'info' | 'success' | 'warning' | 'error' = null`, `title: required string`, `subtitle: string | null = null`, `dividers: boolean | null = null`, `closeOnBackdrop: boolean = true`, `persistent: boolean = false`
|
|
764
|
+
<!-- /inputs -->
|
|
765
|
+
|
|
429
766
|
#### `<ds-modal-card>` — `ModalCardComponent`
|
|
430
767
|
The visual card the `<ds-modal>` host renders inside its backdrop. Exposed as a separate selector for cases where you need custom positioning (e.g. inside a drawer) without re-implementing the dialog chrome. Inputs: `size`, `danger`, `title: required`, `showClose: boolean = true`. Output: `(closed)`. Slots: `[body]`, `[impact]`, `[actions]`.
|
|
431
768
|
|
|
769
|
+
<!-- inputs:ds-modal-card -->
|
|
770
|
+
All inputs: `size: 'sm' | 'md' | 'lg' | 'xl' | 'fullscreen' = 'md'`, `status: 'info' | 'success' | 'warning' | 'error' = null`, `title: required string`, `subtitle: string | null = null`, `showClose: boolean = true`, `dividers: boolean | null = null`, `icon: IconName | null = null`, `dialogRole: 'dialog' | 'alertdialog' = null`
|
|
771
|
+
<!-- /inputs -->
|
|
772
|
+
|
|
432
773
|
#### `<ds-drawer>` — `DrawerComponent`
|
|
433
774
|
Side panel (no `side` input — always anchored right).
|
|
434
775
|
Inputs: `open: model<boolean> = false`, `size: 'md' | 'lg' = 'md'`, `title: string = ''`
|
|
435
776
|
Output: `(closed): void`
|
|
436
777
|
Content slots: `[drawer-body]`, `[drawer-footer]`.
|
|
437
778
|
|
|
779
|
+
<!-- inputs:ds-drawer -->
|
|
780
|
+
All inputs: `open: boolean = false`, `size: 'sm' | 'md' | 'lg' = 'md'`, `placement: 'right' | 'left' | 'top' | 'bottom' = 'right'`, `title: required string`
|
|
781
|
+
<!-- /inputs -->
|
|
782
|
+
|
|
438
783
|
#### `<ds-bottom-sheet>` — `BottomSheetComponent`
|
|
439
784
|
Mobile-first panel anchored to the bottom edge (touch equivalent of drawer/modal). Drag-down on the grab strip, scrim tap, or Esc dismisses; body scroll locks while open; caps width + centres on wide viewports.
|
|
440
785
|
Inputs: `open: model<boolean> = false`, `title: string = ''`
|
|
441
786
|
Output: `(closed): void`
|
|
442
787
|
Content slots: default (body), `[actions]` (footer).
|
|
443
788
|
|
|
789
|
+
<!-- inputs:ds-bottom-sheet -->
|
|
790
|
+
All inputs: `open: boolean = false`, `title: required string`, `snapPoints: readonly number[] = []`
|
|
791
|
+
<!-- /inputs -->
|
|
792
|
+
|
|
444
793
|
#### `<ds-popover>` — `PopoverComponent`
|
|
445
794
|
Floating panel anchored to a trigger via CDK overlay. Input: `align: 'start' | 'end' = 'start'` — controls overlay alignment relative to the trigger (`start` = left-edge anchored, `end` = right-edge anchored). Open via the component method `toggle(triggerElement)` (or `close()`), and project the panel body inside a `<ng-template #panel>` (read internally via `viewChild`).
|
|
446
795
|
|
|
796
|
+
<!-- inputs:ds-popover -->
|
|
797
|
+
All inputs: `align: 'start' | 'end' = 'start'`, `placement: 'top' | 'bottom' | 'left' | 'right' = 'bottom'`, `arrow: boolean = false`, `panelRole: string | null = null`, `panelLabel: string | null = null`
|
|
798
|
+
<!-- /inputs -->
|
|
799
|
+
|
|
447
800
|
#### `[dsTooltip]` — `TooltipDirective`
|
|
448
801
|
Attribute directive. Apply to any focusable element.
|
|
449
802
|
Inputs: `dsTooltip: string = ''` (the text; empty disables), `dsTooltipPlacement: 'top' | 'bottom' | 'left' | 'right' = 'top'`, `dsTooltipDelay: number = 120` (ms)
|
|
450
803
|
Renders `<ds-tooltip-panel>` via CDK overlay on hover / focus; hides on leave / blur.
|
|
451
804
|
|
|
805
|
+
<!-- inputs:[dsTooltip] -->
|
|
806
|
+
All inputs: `dsTooltip: string = ''`, `dsTooltipPlacement: 'top' | 'bottom' | 'left' | 'right' = 'top'`, `dsTooltipDelay: number = 120`, `dsTooltipWhenClipped: boolean = false`
|
|
807
|
+
<!-- /inputs -->
|
|
808
|
+
|
|
452
809
|
#### `<ds-menu>` + `<ds-menu-item>` — `MenuComponent`, `MenuItemComponent`
|
|
453
810
|
Menu is a container. Item inputs: `icon: IconName | null = null`, `disabled: boolean = false`, `danger: boolean = false`. Output: `(pressed): MouseEvent`. Content: label text; supports `[icon]` content slot for custom icons.
|
|
454
811
|
|
|
812
|
+
<!-- inputs:ds-menu-item -->
|
|
813
|
+
All inputs: `icon: IconName | null = null`, `disabled: boolean = false`, `error: boolean = false`, `quiet: boolean = false`, `description: string = ''`, `submenu: TemplateRef<unknown> | null = null`
|
|
814
|
+
<!-- /inputs -->
|
|
815
|
+
|
|
455
816
|
---
|
|
456
817
|
|
|
818
|
+
#### `<ds-tooltip-panel>` — `TooltipPanelComponent`
|
|
819
|
+
|
|
820
|
+
<!-- inputs:ds-tooltip-panel -->
|
|
821
|
+
All inputs: `text: required string`, `placement: required 'top' | 'bottom' | 'left' | 'right'`, `panelId: string = ''`
|
|
822
|
+
<!-- /inputs -->
|
|
823
|
+
|
|
457
824
|
### Tables
|
|
458
825
|
|
|
459
826
|
#### `<ds-table>` — `TableComponent<T extends { id: string }>`
|
|
460
|
-
Inputs: `data: required readonly T[]`, `columns: required readonly TableColumn<T>[]`, `selectable: boolean = false`, `bordered: boolean = false` (opt-in outer border + radius; off by default so tables flush inside `<ds-card padding="none">` don't double-border), `loading: false | 'skeleton' | 'overlay' = false`, `stickyHeader: boolean = true`, `selectedIds: model<Set<string>>`, `sortKey: model<string | null>`, `
|
|
827
|
+
Inputs: `data: required readonly T[]`, `columns: required readonly TableColumn<T>[]`, `selectable: boolean = false`, `bordered: boolean = false` (opt-in outer border + radius; off by default so tables flush inside `<ds-card padding="none">` don't double-border), `loading: false | 'skeleton' | 'overlay' = false`, `stickyHeader: boolean = true`, `selectedIds: model<Set<string>>`, `sortKey: model<string | null>`, `sortDirection: model<SortDirection>` (`'asc' | 'desc' | null`), `skeletonRows: number = 5`
|
|
461
828
|
Outputs: `(rowClicked): T`, `(sortChange): SortChangeEvent` (`{ key, dir }`)
|
|
462
829
|
Column shape: `{ key: string, label: string, sortable?: boolean, align?: 'left' | 'right' | 'center', cell?: (row: T) => string }`
|
|
463
830
|
Opening a row: give one column `link: (row) => <route target> | null` and its value renders as a real `<a>` — visible without hovering, in the tab order as a link, and Ctrl/Cmd-clickable, none of which a clickable `<tr>` can do. `null` for a row leaves that cell as plain text, so a partly-reachable list stays one column; external URLs go through a `[dsCellTemplate]` instead, since `link` takes Angular route targets only. It composes with `rowInteractive` (the link stops its click from reaching the row), but the two together cost **two tab stops per row** — on a long list prefer the link alone. `interactive: true` only tints a cell on row hover, which a keyboard or touch user never sees; prefer `link` wherever the row actually leads somewhere.
|
|
464
831
|
Cell templates: `<ng-template dsCellTemplate="<colKey>" let-row>…</ng-template>` — `row` is typed `unknown`, narrow via a helper method on the host.
|
|
465
832
|
Content slots: `[empty]` (rendered when `data.length === 0`), `[bulk-actions]` (rendered in the bulk action bar when `selectable && some selected`)
|
|
466
833
|
Loading modes: `'skeleton'` replaces rows with shimmer placeholders driven by the global `--skeleton-shimmer-x` keyframe; `'overlay'` keeps existing rows visible behind a translucent layer with a centred spinner.
|
|
467
|
-
Tokens: `--ds-table-border: var(--border-default)`, `--ds-table-radius: var(--radius-md)`, `--ds-table-bg-color`, `--ds-table-head-text-color: var(--text-secondary)`, `--ds-table-head-bg-color: var(--surface-secondary)`, `--ds-table-head-
|
|
834
|
+
Tokens: `--ds-table-border: var(--border-default)`, `--ds-table-radius: var(--radius-md)`, `--ds-table-bg-color`, `--ds-table-head-text-color: var(--text-secondary)`, `--ds-table-head-bg-color: var(--surface-secondary)`, `--ds-table-head-font-size: var(--font-size-xs)`, `--ds-table-row-hover-bg-color`, `--ds-table-row-selected-bg-color`, `--ds-table-divider`, `--ds-table-sort-active-icon-color`, `--ds-table-cell-padding-x/y`. (Renamed 2026-06: `--ds-table-header-*` → `--ds-table-head-*`, matching the tokens reference.)
|
|
835
|
+
|
|
836
|
+
<!-- inputs:ds-table -->
|
|
837
|
+
All inputs: `data: required readonly T[]`, `rowId: ((row: T) => string) | null = null`, `columns: required readonly TableColumn<T>[]`, `selectable: boolean = false`, `bordered: boolean | null = null`, `loading: boolean | 'skeleton' | 'overlay' = false`, `stickyHeader: boolean = true`, `maxHeight: string | null = null`, `density: 'default' | 'compact' = 'default'`, `zebra: boolean = false`, `animateHeight: boolean = false`, `selectedIds: Set<string>`, `sortKey: string | null = null`, `sortDirection: 'asc' | 'desc' = null`, `sortingOrder: SortDirection[]`, `sortAnnouncement: (label: string, dir: SortDirection) => string`, `rangeAnnouncement: (first: number, last: number, total: number) => string`, `skeletonRows: number = 5`, `caption: string = ''`, `rowInteractive: boolean = false`, `activeRowId: string | null = null`, `filterQuery: string = ''`, `columnFilters: Map<string, ReadonlySet<string>>`, `persistLayout: boolean = false`, `storageKey: string = ''`, `stickyScrollbar: boolean | null = null`, `pageSize: number | null = null`, `page: number = 1`, `pageSizeOptions: number[]`, `showPageSize: boolean = true`, `showLabel: boolean = true`, `total: number | null = null`, `scrollToTopOnPageChange: boolean = false`, `sortMode: 'client' | 'server' | 'none' = null`, `filterMode: 'client' | 'server' | 'none' = null`, `columnFilterOptions: ReadonlyMap<string, readonly string[]>`, `stickyScrollbarOffset: string | null = null`, `stickyFirstColumn: boolean = false`, `virtualScroll: boolean = false`, `virtualRowSize: number = 44`, `lazy: boolean = false`, `rowActions: readonly TableRowAction<T>[] = []`, `cellTemplateMap: Record<string, TemplateRef<{ $implicit: unknown; row: unknown }>> = {}`, `emptyTemplate: TemplateRef<unknown> | null = null`, `expandableRows: boolean = false`, `expandedIds: Set<string>`, `expandMode: 'multiple' | 'single' = 'multiple'`, `expandAllToggle: boolean = false`, `rowExpandTemplate: TemplateRef<{
|
|
838
|
+
$implicit: unknown;
|
|
839
|
+
row: unknown;
|
|
840
|
+
}> | null = null`
|
|
841
|
+
<!-- /inputs -->
|
|
468
842
|
|
|
469
843
|
---
|
|
470
844
|
|
|
845
|
+
#### `[dsCellTemplate]` — `CellTemplateDirective`
|
|
846
|
+
|
|
847
|
+
<!-- inputs:[dsCellTemplate] -->
|
|
848
|
+
All inputs: `dsCellTemplate: required string`
|
|
849
|
+
<!-- /inputs -->
|
|
850
|
+
|
|
851
|
+
#### `<ng-template[dsHeaderFilter]>` — `HeaderFilterDirective`
|
|
852
|
+
|
|
853
|
+
<!-- inputs:ng-template[dsHeaderFilter] -->
|
|
854
|
+
All inputs: `dsHeaderFilter: required string`, `active: boolean = false`
|
|
855
|
+
<!-- /inputs -->
|
|
856
|
+
|
|
857
|
+
#### `[dsTableColumns]` — `DsTableColumns`
|
|
858
|
+
|
|
859
|
+
<!-- inputs:[dsTableColumns] -->
|
|
860
|
+
All inputs: `reorderableColumns: boolean = false`, `hiddenKeys: Set<string> | null = null`, `columnOrder: string[] | null = null`
|
|
861
|
+
<!-- /inputs -->
|
|
862
|
+
|
|
863
|
+
#### `[dsTableExport]` — `DsTableExport`
|
|
864
|
+
|
|
865
|
+
<!-- inputs:[dsTableExport] -->
|
|
866
|
+
All inputs: `dsTableExport: boolean = true`, `exportFilename: string = 'table.csv'`, `exportFetcher: (() => Promise<readonly T[] | Blob | string>) | null = null`
|
|
867
|
+
<!-- /inputs -->
|
|
868
|
+
|
|
471
869
|
### Charts
|
|
472
870
|
|
|
473
871
|
#### `<ds-bar-chart>` — `BarChartComponent`
|
|
474
|
-
Inputs: `data: readonly BarChartRow[]` (required), `max: number | null = null` (track length is relative to this; null uses the largest value, so the longest row always fills its track — a max BELOW the largest value is allowed and its bar clips at the track edge), `caption: string | null = null`, `summary: string | null = null` (accessible name; generated from the data when omitted), `dataTable: '
|
|
872
|
+
Inputs: `data: readonly BarChartRow[]` (required), `max: number | null = null` (track length is relative to this; null uses the largest value, so the longest row always fills its track — a max BELOW the largest value is allowed and its bar clips at the track edge), `caption: string | null = null`, `summary: string | null = null` (accessible name; generated from the data when omitted), `dataTable: 'none' | 'toggle' | 'visible' = 'none'` (`'toggle'` renders a closed `<details>`; `'none'` is only correct when the same numbers are already in the DOM nearby), `showPercent: boolean = true`, `loading: boolean = false`, `emptyText: string = 'No data'`, `error: boolean = false`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number) => string`, `interactive: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `staggerMs: number = 0`
|
|
475
873
|
Output: `(rowClicked): BarChartRow` — emits the clicked row.
|
|
476
874
|
Interaction: `interactive: boolean = false` turns on the affordance — pointer cursor, hover tint and the keyboard route. `dimOthers: boolean = false` is a SEPARATE opt-in that fades every other mark while one is hovered or focused; off by default, because the fade costs the separation between the faded marks (dE 14.8 -> 2.1 at the default dim opacity) — it buys loudness for one mark and pays for it with the rest. The output fires whether or not it is set. The keyboard route is ONE tab stop for the whole chart, not one per mark: arrows walk the marks, Home and End reach the extremes, and the ends wrap. `tooltip: 'item' | 'none' = 'item'` opens a panel for the hovered, tapped or focused mark; a tap latches it until the next tap outside. Project an `<ng-template #dsChartTooltip let-tip>` to replace its contents — `tip` is `{ category: string; entries: { label, value, formatted, color }[] }`.
|
|
477
875
|
Motion: marks that leave finish leaving before marks that arrive start. `staggerMs: number = 0` spaces the arrivals; `40` is the documented step and the total is capped at 300ms. Every duration is a `--ds-motion-chart-*` role, so `prefers-reduced-motion` zeroes them with nothing per chart.
|
|
478
876
|
States: `loading` draws skeleton marks at the real count; `error` shows `errorText` in place of the plot, which is a different claim from an empty `data` showing `emptyText`.
|
|
479
877
|
Row: `BarChartRow = { label: string; value: number; percent?: number; color?: string }`. `percent` is derived from `value / max` when omitted.
|
|
878
|
+
`value` may be a `[low, high]` pair instead of a number: the bar spans between its own ends rather than from zero, which compares a duration and its PLACEMENT at once, and the ends may be written either way round. `target` draws a tick across the bar at one reading; `ranges` paints qualitative bands behind it, given as their upper bounds in ascending order. Together they are the bullet chart, which is a bar with two extras rather than a chart type. The bands take one neutral hue at rising opacity, never the series palette. Tokens: `--ds-bar-chart-band-color`, `--ds-bar-chart-target-color`, `--ds-bar-chart-target-width`, `--ds-bar-chart-target-overhang`.
|
|
480
879
|
Colour: the rows are ONE series, so they all take `--ds-chart-series-default-color`. Set `color` on the single row the reader should land on, usually to `var(--ds-chart-series-accent-color)`. There is no accent flag — the accent is a colour, so a boolean would only be a less flexible way of setting one. Do NOT reach for `--ds-chart-series-1-color` … `-8-color` here: those separate series from one another, and a bar chart's rows are not separate series.
|
|
481
880
|
Behaviour: a non-finite value draws no bar and prints `—`; a negative value clamps to an empty bar; a share too small for one decimal prints `<0.1%` rather than `0.0%`.
|
|
482
881
|
Rhythm: a label belongs to the bar under it, so `--ds-bar-chart-label-gap` is deliberately much smaller than `--ds-bar-chart-row-gap`. Level the two and the eye starts grouping a bar with the label BELOW it, which reads every row off by one.
|
|
483
882
|
Tokens: `--ds-bar-chart-track-color`, `--ds-bar-chart-track-height`, `--ds-bar-chart-row-gap`, `--ds-bar-chart-label-gap`.
|
|
484
883
|
|
|
884
|
+
<!-- inputs:ds-bar-chart -->
|
|
885
|
+
All inputs: `data: required readonly BarChartRow[]`, `max: number | null = null`, `frame: 'auto' | 'none' = null`, `tooltipLingerMs: number | null = null`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `partOfWhole: boolean = false`, `showPercent: boolean = true`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `staggerMs: number = 0`, `tooltip: 'item' | 'none' = 'item'`
|
|
886
|
+
<!-- /inputs -->
|
|
887
|
+
|
|
485
888
|
#### `<ds-column-chart>` — `ColumnChartComponent`
|
|
486
889
|
Vertical columns for a short series read left to right — months, stages, teams — measured against one value axis whose ticks snap to round numbers.
|
|
487
|
-
Inputs: `data: readonly ColumnChartPoint[]` (required), `showValues: boolean = true` (each column prints its own value above itself), `tickCount: number = 5` (a hint: ticks snap to a round step, so an axis asked for three ends up with five and one asked for ten stops at eight), `caption: string | null = null`, `summary: string | null = null`, `dataTable: '
|
|
890
|
+
Inputs: `data: readonly ColumnChartPoint[]` (required), `showValues: boolean = true` (each column prints its own value above itself), `tickCount: number = 5` (a hint: ticks snap to a round step, so an axis asked for three ends up with five and one asked for ten stops at eight), `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `emptyText: string = 'No data'`, `error: boolean = false`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number) => string`, `interactive: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `staggerMs: number = 0`, `thresholds: readonly ChartThreshold[] = []`
|
|
488
891
|
Output: `(pointClicked): ColumnChartPoint` — same contract as `ds-bar-chart`'s `rowClicked`.
|
|
489
892
|
Interaction: `interactive: boolean = false` turns on the affordance — pointer cursor, hover tint and the keyboard route. `dimOthers: boolean = false` is a SEPARATE opt-in that fades every other mark while one is hovered or focused; off by default, because the fade costs the separation between the faded marks (dE 14.8 -> 2.1 at the default dim opacity) — it buys loudness for one mark and pays for it with the rest. The output fires whether or not it is set. The keyboard route is ONE tab stop for the whole chart, not one per mark: arrows walk the marks, Home and End reach the extremes, and the ends wrap. `tooltip: 'item' | 'none' = 'item'` opens a panel for the hovered, tapped or focused mark; a tap latches it until the next tap outside. Project an `<ng-template #dsChartTooltip let-tip>` to replace its contents — `tip` is `{ category: string; entries: { label, value, formatted, color }[] }`.
|
|
490
893
|
Motion: marks that leave finish leaving before marks that arrive start. `staggerMs: number = 0` spaces the arrivals; `40` is the documented step and the total is capped at 300ms. Every duration is a `--ds-motion-chart-*` role, so `prefers-reduced-motion` zeroes them with nothing per chart.
|
|
491
894
|
States: `loading` draws skeleton marks at the real count; `error` shows `errorText` in place of the plot, which is a different claim from an empty `data` showing `emptyText`.
|
|
492
895
|
Point: `ColumnChartPoint = { label: string; value: number; color?: string }`
|
|
896
|
+
Thresholds: `ChartThreshold = { value: number; label?: string; color?: string; to?: number; dash?: 'solid' | 'dashed' | 'dotted' }` draws a target, a budget or an SLA across the plot, behind the columns. ONE number, not a coordinate pair; `to` makes the same object a band between two readings, in either order; `dash` defaults to `'dashed'`. A threshold widens the value axis to hold it, and is named in the generated description, so a target above every column is neither drawn off the plot nor left unsaid.
|
|
493
897
|
Colour: the categorical palette by position — `--ds-chart-series-1-color` onward. Set `color` on a column that carries a meaning its position does not, such as `var(--ds-chart-series-accent-color)` on the period the reader should land on. This is the one chart where the default is a judgement call rather than a rule: columns often ARE separate things (revenue by region), and where they are one quantity over time, `color` puts every column on `--ds-chart-series-default-color` in one pass.
|
|
494
|
-
Tokens: `--ds-column-chart-plot-height`, `--ds-column-chart-column-width` (share of its own cell), `--ds-column-chart-column-max-width` (the cap that stops a five-column chart drawing slabs wider than their labels), `--ds-column-chart-column-gap`, `--ds-column-chart-grid-line-color`, `--ds-column-chart-value-space` (headroom for the value printed above a full-height column), `--ds-column-chart-axis-width` (the tick-label column; widen it for a `valueFormat` that prints longer ticks, which are clipped rather than wrapped).
|
|
898
|
+
Tokens: `--ds-column-chart-plot-height`, `--ds-column-chart-column-width` (share of its own cell), `--ds-column-chart-column-max-width` (the cap that stops a five-column chart drawing slabs wider than their labels), `--ds-column-chart-column-gap`, `--ds-column-chart-grid-line-color`, `--ds-column-chart-value-space` (headroom for the value printed above a full-height column), `--ds-column-chart-axis-width` (the tick-label column; widen it for a `valueFormat` that prints longer ticks, which are clipped rather than wrapped). Reference lines take `--ds-chart-threshold-color`, `--ds-chart-threshold-band-opacity`, `--ds-chart-threshold-dashed-pattern` and `--ds-chart-threshold-dotted-pattern`.
|
|
899
|
+
|
|
900
|
+
<!-- inputs:ds-column-chart -->
|
|
901
|
+
All inputs: `data: required readonly ColumnChartPoint[] | readonly ColumnChartSeries[]`, `stack: 'none' | 'grouped' | 'stacked' | 'normalized' = 'none'`, `thresholds: readonly ChartThreshold[] = []`, `showValues: boolean = true`, `tickCount: number = 5`, `frame: 'auto' | 'none' = null`, `tooltipLingerMs: number | null = null`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `partOfWhole: boolean = false`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `staggerMs: number = 0`, `tooltip: 'item' | 'none' = 'item'`, `tooltipAnchor: 'mark' | 'cell' = 'mark'`
|
|
902
|
+
<!-- /inputs -->
|
|
495
903
|
|
|
496
|
-
#### `<ds-
|
|
904
|
+
#### `<ds-pie-chart>` — `PieChartComponent`
|
|
497
905
|
A ring that splits one total into its parts, with the middle free for the total or a headline figure of your own.
|
|
498
|
-
Inputs: `data: readonly
|
|
499
|
-
Output: `(sliceClicked):
|
|
906
|
+
Inputs: `data: readonly PieChartSlice[]` (required), `centerValue: string | null = null`, `centerLabel: string | null = null`, `legend: 'end' | 'bottom' | 'none' = 'end'`, `maxSlices: number | null = null`, `otherLabel: string = 'Other'`, `innerRadius: number = 0.68`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `emptyText: string = 'No data'`, `error: boolean = false`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number) => string`, `interactive: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `staggerMs: number = 0`
|
|
907
|
+
Output: `(sliceClicked): PieChartSlice`
|
|
500
908
|
Interaction: `interactive: boolean = false` turns on the affordance — pointer cursor, hover tint and the keyboard route. `dimOthers: boolean = false` is a SEPARATE opt-in that fades every other mark while one is hovered or focused; off by default, because the fade costs the separation between the faded marks (dE 14.8 -> 2.1 at the default dim opacity) — it buys loudness for one mark and pays for it with the rest. The output fires whether or not it is set. The keyboard route is ONE tab stop for the whole chart, not one per mark: arrows walk the marks, Home and End reach the extremes, and the ends wrap. `tooltip: 'item' | 'none' = 'item'` opens a panel for the hovered, tapped or focused mark; a tap latches it until the next tap outside. Project an `<ng-template #dsChartTooltip let-tip>` to replace its contents — `tip` is `{ category: string; entries: { label, value, formatted, color }[] }`.
|
|
501
909
|
Motion: the RING fades as one object rather than slice by slice — arcs share their edges, and fading them one at a time lets the background through every seam. `staggerMs` is accepted for parity with the other four charts and has no effect here, because there is nothing to stagger. Marks that leave finish leaving before marks that arrive start. `staggerMs: number = 0` spaces the arrivals; `40` is the documented step and the total is capped at 300ms. Every duration is a `--ds-motion-chart-*` role, so `prefers-reduced-motion` zeroes them with nothing per chart.
|
|
502
910
|
States: `loading` draws skeleton marks at the real count; `error` shows `errorText` in place of the plot, which is a different claim from an empty `data` showing `emptyText`.
|
|
503
|
-
Slice: `
|
|
911
|
+
Slice: `PieChartSlice = { id: string; label: string; value: number; slot?: number }`. `slot` is a 1-based palette slot: pinning a slice keeps every other slice's colour where it is when one is filtered out of `data`; left off, the colour follows the index and the whole ring repaints.
|
|
504
912
|
Colour: slices ARE different things, so this is the chart the categorical palette exists for — `--ds-chart-series-1-color` … `--ds-chart-series-8-color`.
|
|
505
913
|
Behaviour: percentages use largest-remainder rounding, so a legend's shares add up to exactly 100 and a real non-zero slice never prints `0%`.
|
|
506
914
|
`maxSlices` caps the legend: past it the smallest slices are summed into one named by `otherLabel`, which takes the neutral eighth palette slot. Off by default, because grouping changes what the chart says. The kept slices stay in the order given rather than being re-sorted by value, and the total is unchanged — the tail is summed, never dropped. A limit below 2 is ignored.
|
|
507
|
-
`
|
|
508
|
-
Tokens: `--ds-
|
|
915
|
+
`innerRadius: 0` closes the hole into a pie, and the centre content goes with it: `centerValue` and `centerLabel` render only where there is a hole to hold them. A value outside [0, 1) falls back to the default rather than drawing nothing. The centre box is held to the square that fits inside the hole with a 56% floor, so a long value can overhang the ring; a halo of the chart's own background carries it there.
|
|
916
|
+
Tokens: `--ds-pie-chart-size`, `--ds-pie-chart-gap`, `--ds-pie-chart-swatch-size`, `--ds-pie-chart-legend-row-gap`, `--ds-pie-chart-legend-row-height`, `--ds-pie-chart-outline-width` (the placeholder ring drawn when there is no data and when every slice is zero).
|
|
917
|
+
|
|
918
|
+
<!-- inputs:ds-pie-chart -->
|
|
919
|
+
All inputs: `data: required readonly PieChartSlice[]`, `centerValue: string | null = null`, `centerLabel: string | null = null`, `legend: 'end' | 'bottom' | 'none' = 'end'`, `maxSlices: number | null = null`, `otherLabel: string = 'Other'`, `innerRadius: number = 0.68`, `frame: 'auto' | 'none' = null`, `tooltipLingerMs: number | null = null`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `partOfWhole: boolean = true`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `staggerMs: number = 0`, `tooltip: 'item' | 'none' = 'item'`
|
|
920
|
+
<!-- /inputs -->
|
|
509
921
|
|
|
510
922
|
#### `<ds-funnel-chart>` — `FunnelChartComponent`
|
|
511
923
|
Stages of a journey, drawn top to bottom in the order you give them — they are never sorted, because the order is the meaning.
|
|
512
|
-
Inputs: `data: readonly FunnelChartStage[]` (required), `shape: 'taper' | 'width' | 'area' = 'area'`, `showTable: boolean = true` (the aligned stage table under the funnel: value, share of the first stage, and how much fell away since the stage above), `caption: string | null = null`, `summary: string | null = null`, `dataTable: '
|
|
924
|
+
Inputs: `data: readonly FunnelChartStage[]` (required), `shape: 'taper' | 'width' | 'area' = 'area'`, `showTable: boolean = true` (the aligned stage table under the funnel: value, share of the first stage, and how much fell away since the stage above), `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `emptyText: string = 'No data'`, `error: boolean = false`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number) => string`, `interactive: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `staggerMs: number = 0`
|
|
513
925
|
Output: `(stageClicked): FunnelChartStage`
|
|
514
926
|
Interaction: `interactive: boolean = false` turns on the affordance — pointer cursor, hover tint and the keyboard route. `dimOthers: boolean = false` is a SEPARATE opt-in that fades every other mark while one is hovered or focused; off by default, because the fade costs the separation between the faded marks (dE 14.8 -> 2.1 at the default dim opacity) — it buys loudness for one mark and pays for it with the rest. The output fires whether or not it is set. The keyboard route is ONE tab stop for the whole chart, not one per mark: arrows walk the marks, Home and End reach the extremes, and the ends wrap. `tooltip: 'item' | 'none' = 'item'` opens a panel for the hovered, tapped or focused mark; a tap latches it until the next tap outside. Project an `<ng-template #dsChartTooltip let-tip>` to replace its contents — `tip` is `{ category: string; entries: { label, value, formatted, color }[] }`.
|
|
515
927
|
Motion: marks that leave finish leaving before marks that arrive start. `staggerMs: number = 0` spaces the arrivals; `40` is the documented step and the total is capped at 300ms. Every duration is a `--ds-motion-chart-*` role, so `prefers-reduced-motion` zeroes them with nothing per chart.
|
|
@@ -520,18 +932,77 @@ Shape: `'area'` is the default — the fixed silhouette with the stage boundarie
|
|
|
520
932
|
Colour: the stages are one quantity draining, not N categories, so they take the single-hue ramp `--ds-chart-ramp-1-color` … `--ds-chart-ramp-8-color`, spread across however many stages there are. The LAST stage leaves the ramp for `--ds-chart-series-accent-color` — it is the outcome the funnel is read for.
|
|
521
933
|
Tokens: `--ds-funnel-chart-stage-height`, `--ds-funnel-chart-stage-gap`, `--ds-funnel-chart-row-gap`.
|
|
522
934
|
|
|
935
|
+
<!-- inputs:ds-funnel-chart -->
|
|
936
|
+
All inputs: `data: required readonly FunnelChartStage[]`, `shape: 'taper' | 'width' | 'area' = 'area'`, `showTable: boolean = true`, `frame: 'auto' | 'none' = null`, `tooltipLingerMs: number | null = null`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `drop: 'relative' | 'absolute' | 'none' = 'relative'`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `staggerMs: number = 0`, `tooltip: 'item' | 'none' = 'item'`
|
|
937
|
+
<!-- /inputs -->
|
|
938
|
+
|
|
939
|
+
#### `<ds-heatmap-chart>` — `HeatmapChartComponent`
|
|
940
|
+
A matrix of readings coloured by magnitude — depot by weekday, hour by date, queue by region.
|
|
941
|
+
Inputs: `columns: readonly string[]` (required in practice), `data: readonly HeatmapChartRow[]` (required), `min: number | null = null`, `max: number | null = null`, `showValues: boolean = false`, `interactive: boolean = false`, `dimOthers: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `caption: string | null = null`, `frame: 'auto' | 'none' = 'auto'`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string = 'No data'`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number, location) => string`
|
|
942
|
+
Output: `(cellClicked): HeatmapChartCell`
|
|
943
|
+
Row: `HeatmapChartRow = { id?: string; label: string; data: readonly (number | null)[] }` — one reading per column, in the chart's own column order.
|
|
944
|
+
Cell: `HeatmapChartCell = { row, rowIndex, column, columnIndex, value }`
|
|
945
|
+
Not optional here: colour is the only channel carrying the quantity on the grid, so the scale under it and the annex table below it are always drawn — there is no `dataTable` input to turn the table off, because WCAG 1.4.1 is not satisfied by a grid of coloured squares. Every cell also names its own reading to assistive tech as `row, column: value`.
|
|
946
|
+
A `null` reading is a hole, not a low value: it draws as the surface, stays out of the colour scale, is inert under `interactive`, and never fires `cellClicked`. The ramp's coldest step is a real measurement, and painting "we never measured this" with it states a figure nobody recorded.
|
|
947
|
+
`min` / `max` only ever OPEN the scale further. Set both to compare two heat maps by colour — unset, each spans its own readings and the same hue means a different quantity on each.
|
|
948
|
+
Colour: the single-hue heat scale `--ds-chart-heat-1-color` … `--ds-chart-heat-8-color`, which spans the full lightness range and therefore runs 1.14:1 to 9.07:1 against white. It is NOT `--ds-chart-ramp-*`, which stays in the middle of the range for the funnel's stages. `showValues` draws the glyph in the cell's own colour inverted, which stays legible at either end without picking one ink for the whole scale.
|
|
949
|
+
The grid scrolls sideways below its natural width rather than crushing the cells, the same answer `ds-table` gives.
|
|
950
|
+
Tokens: `--ds-heatmap-chart-cell-size`, `--ds-heatmap-chart-cell-gap`, `--ds-heatmap-chart-cell-radius`, `--ds-heatmap-chart-label-color`, `--ds-heatmap-chart-label-font-size`, `--ds-heatmap-chart-missing-color`, `--ds-heatmap-chart-focus-color`, `--ds-heatmap-chart-focus-width`.
|
|
951
|
+
|
|
952
|
+
<!-- inputs:ds-heatmap-chart -->
|
|
953
|
+
All inputs: `columns: readonly string[] = []`, `data: readonly HeatmapChartRow[] = []`, `caption: string | null = null`, `min: number | null = null`, `max: number | null = null`, `showValues: boolean = false`, `interactive: boolean = false`, `dimOthers: boolean = false`, `frame: 'auto' | 'none' = null`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string | null = null`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `tooltip: 'item' | 'none' = 'item'`
|
|
954
|
+
<!-- /inputs -->
|
|
955
|
+
|
|
956
|
+
#### `<ds-scatter-chart>` — `ScatterChartComponent`
|
|
957
|
+
Two continuous quantities against each other — weight against carriage cost, distance against time, volume against conversion. The other charts all put categories on one axis; this one does not.
|
|
958
|
+
Inputs: `data: readonly ScatterChartSeries[]` (required), `xLabel: string | null = null`, `yLabel: string | null = null`, `decimator: 'minMax' | 'lttb' | 'none' = 'minMax'`, `tickCount: number = 5`, `caption: string | null = null`, `summary: string | null = null`, `interactive: boolean = false`, `frame: 'auto' | 'none' = 'auto'`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string = 'No data'`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number, location) => string`
|
|
959
|
+
Output: `(pointClicked): ScatterChartReading`
|
|
960
|
+
Series: `ScatterChartSeries = { id: string; label: string; data: readonly { x: number; y: number }[]; color?: string }`
|
|
961
|
+
`xLabel` / `yLabel` are not decoration: without them the reader has two numbers and no idea which is which, and on a scatter that is the whole reading.
|
|
962
|
+
It thins its own data, and it says so. SVG degrades by the number of NODES, not readings — the same data as a line is one `<path>`, as a scatter it is one node per point, and Lighthouse warns at ~800 nodes and errors at ~1400 on a page that may hold four more charts. Past FOUR times the plot's width in marks the series is decimated, a line under the plot says how many readings were thinned, and the annex table still lists every one.
|
|
963
|
+
`decimator`: `'minMax'` is the default because it is the only one that promises anything — each bucket's highest and lowest reading survive by construction, so the spike a reader is looking for cannot be the point that was dropped, and a bucket's answer does not depend on its neighbours. `'lttb'` draws a truer silhouette at the same budget with no such promise. `'none'` is the caller taking the node budget on themselves.
|
|
964
|
+
The annex table is built when it is OPENED: `<details>` keeps its children in the DOM while shut, so 12 000 readings parked 48 000 nodes on the page - three times what decimating the plot had just saved. Closed the chart is 615 nodes; opened, every reading is there.
|
|
965
|
+
Marks are semi-transparent by default, because the interesting thing is where they pile up: at full opacity a cluster of forty and a cluster of four are the same solid disc.
|
|
966
|
+
The budget is a gate, not a paragraph: the decimator is fed 100 000 readings and the output is asserted to fit the plot, with a control that the same data undecimated does not.
|
|
967
|
+
Tokens: `--ds-scatter-chart-grid-line-color`, `--ds-scatter-chart-axis-line-color`, `--ds-scatter-chart-axis-label-color`, `--ds-scatter-chart-axis-font-size`, `--ds-scatter-chart-dot-radius`, `--ds-scatter-chart-dot-opacity`, `--ds-scatter-chart-focus-color`, `--ds-scatter-chart-focus-width`.
|
|
968
|
+
|
|
969
|
+
<!-- inputs:ds-scatter-chart -->
|
|
970
|
+
All inputs: `data: readonly ScatterChartSeries[] = []`, `xLabel: string | null = null`, `yLabel: string | null = null`, `decimator: 'minMax' | 'lttb' | 'none' = 'minMax'`, `tickCount: number = 5`, `caption: string | null = null`, `summary: string | null = null`, `interactive: boolean = false`, `frame: 'auto' | 'none' = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string | null = null`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `tooltip: 'item' | 'none' = 'item'`, `dimOthers: boolean = false`
|
|
971
|
+
<!-- /inputs -->
|
|
972
|
+
|
|
973
|
+
#### `<ds-waterfall-chart>` — `WaterfallChartComponent`
|
|
974
|
+
A running total, bar by bar: what a figure started at, what moved it, and what it ended at.
|
|
975
|
+
Inputs: `data: readonly WaterfallChartBar[]` (required), `showValues: boolean = true`, `showConnectors: boolean = true`, `caption: string | null = null`, `summary: string | null = null`, `tickCount: number = 5`, `interactive: boolean = false`, `frame: 'auto' | 'none' = 'auto'`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string = 'No data'`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number, location) => string`
|
|
976
|
+
Output: `(barClicked): WaterfallChartBar`
|
|
977
|
+
Bar: `WaterfallChartBar = { id?: string; label: string; value: number; kind?: 'delta' | 'total' | 'subtotal' }`
|
|
978
|
+
Every row adds its `value` to the running sum wherever it sits. A `'delta'` (the default) hangs from the level the bar before it left off at; a `'total'` or `'subtotal'` stands on zero at the sum reached, which makes it a figure in its own right rather than a change. A closing total usually carries `value: 0` — it prints the sum, not a change. A subtotal differs from a total only in that the chain carries on past it.
|
|
979
|
+
Order is never sorted: the sequence is the meaning.
|
|
980
|
+
Colour never carries the meaning alone. Each bar prints its own sign above it (`+130`, `-320`, and a total's plain sum), and each bar's accessible name says "increase", "decrease" or "total" in words, so the chart survives forced colours, a monochrome print and a reader who cannot tell the two hues apart.
|
|
981
|
+
Colour: `--ds-chart-positive-color` and `--ds-chart-negative-color`, NOT `--success` / `--error` — a waterfall's up and down are not success and failure, and a cost rising is a rise and a bad one. They point at the palette's two lead hues. A total takes `--ds-chart-series-default-color`, because it is not a change at all.
|
|
982
|
+
`showConnectors` draws the dashed rule chaining one bar to the next at the level they share; without it the bars read as separate columns rather than as one running total.
|
|
983
|
+
Built on `<ds-chart>` with a column series and a waterfall-specific mark projected into it, so the axis, the gridlines, the frame and the annex table are the family's own. A chain that falls past zero opens the axis downwards rather than clipping.
|
|
984
|
+
Tokens: `--ds-waterfall-chart-connector-color`, `--ds-waterfall-chart-skeleton-height`.
|
|
985
|
+
|
|
986
|
+
<!-- inputs:ds-waterfall-chart -->
|
|
987
|
+
All inputs: `data: readonly WaterfallChartBar[] = []`, `showValues: boolean = true`, `showConnectors: boolean = true`, `caption: string | null = null`, `summary: string | null = null`, `tickCount: number = 5`, `interactive: boolean = false`, `frame: 'auto' | 'none' = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `loading: boolean = false`, `error: boolean = false`, `emptyText: string | null = null`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`
|
|
988
|
+
<!-- /inputs -->
|
|
989
|
+
|
|
523
990
|
#### `<ds-line-chart>` — `LineChartComponent`
|
|
524
991
|
One or more series plotted over a shared set of categories.
|
|
525
|
-
Inputs: `categories: readonly string[]` (required), `series: readonly LineChartSeries[]` (required), `yAxisMode: '
|
|
526
|
-
Output: `(pointClicked):
|
|
992
|
+
Inputs: `categories: readonly string[]` (required), `series: readonly LineChartSeries[]` (required), `yAxisMode: 'aligned' | 'exact' | 'dual-grid' | 'split' = 'aligned'`, `curve: 'linear' | 'step' | 'smooth' = 'linear'`, `stack: 'none' | 'stacked' | 'normalized' = 'none'`, `showMarkers: boolean = true`, `gaps: 'break' | 'zero' = 'break'`, `tickCount: number = 5`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'none' | 'toggle' | 'visible' = 'none'`, `loading: boolean = false`, `emptyText: string = 'No data'`, `error: boolean = false`, `errorText: string = 'Could not load the data'`, `valueFormat: (value: number) => string`, `interactive: boolean = false`, `tooltip: 'item' | 'axis' | 'none' = 'axis'`, `patterns: boolean = false`, `staggerMs: number = 0`, `legendFilters: boolean = false`, `hiddenSeries: readonly string[] = []` (two-way), `rescaleOnHide: boolean = false`, `noVisibleSeriesText: string = 'All series are hidden'`
|
|
993
|
+
Output: `(pointClicked): LineChartReading` — the reading that was clicked or activated. Fires whether or not `interactive` is set.
|
|
527
994
|
Interaction: a pointer moving over the plot picks the CATEGORY under it — a band paints behind every series and `tooltip="axis"`, the default here, names every series at that category. Tabbing reaches ONE marker per series; arrows walk that series' readings, and a focused marker's tooltip names its own series alone. A tap picks a category and latches the panel until the next tap outside; markers carry a transparent hit stroke of 24px, or 44px under `(pointer: coarse)`. `dimOthers` is the same separate opt-in as on the other four, and here it is the legend hover that drives it.
|
|
528
995
|
Legend: drawn whenever there is more than one series. `legendFilters` turns each entry into a checkbox that hides its series, `hiddenSeries` is two-way so a page can drive it from a URL parameter, and hovering an entry dims the others and thickens the one hovered. **The axis does not move when a series is hidden** unless `rescaleOnHide` says so — a silent rescale turns a period-over-period comparison into a different claim. Hiding every series replaces the plot with `noVisibleSeriesText` on a `role="status"` line, legend still rendered.
|
|
529
996
|
Second channel: `patterns` gives every series a dash of its own, in palette-slot order, with slot 1 left solid. Off by default — the shipped palette clears the colour-blind separation threshold on its own, so this is for monochrome print, a retuned palette, or a reader who asks for it.
|
|
530
997
|
Series: `LineChartSeries = { id: string; label: string; data: readonly (number | null)[]; axis?: 'primary' | 'secondary'; area?: boolean; slot?: number }`. A `null` is a missing reading and `gaps` decides what it draws — `'break'` leaves a hole in the line, `'zero'` plants a point on the baseline. `area` fills the band between the line and its axis baseline. `slot` pins a palette slot, so hiding one series leaves every other series' colour alone.
|
|
531
|
-
`yAxisMode` only matters once a series sets `axis: 'secondary'
|
|
998
|
+
`yAxisMode` only matters once a series sets `axis: 'secondary'`, and every name says what is done to the GRIDLINES: `'aligned'` shares one set and rounds the secondary step up, so that series stops short of the top; `'exact'` shares the gridlines but ends the secondary axis on its largest reading, so it uses the full height and its labels are not round; `'dual-grid'` scales and grids each axis on its own; `'split'` draws two plots one above the other, sharing the category axis. `curve` decides what is drawn BETWEEN two readings: `'linear'` asserts nothing, `'step'` holds each reading to the next, `'smooth'` is a monotone cubic that draws no peak the data lacks. `stack` decides how several series share the axis: `'stacked'` starts each where the one below it ended, `'normalized'` divides by the category's own total so the axis reads in shares. Only a series with `area: true` fills, and stacking runs per axis.
|
|
532
999
|
Colour: series ARE different things, so the categorical palette applies — `--ds-chart-series-1-color` onward, by position or by `slot`.
|
|
533
1000
|
`annotations: LineChartAnnotation[]` pins a label over one reading — `{ categoryIndex, label, seriesId? }`, the series defaulting to the first plotted one — so a peak reads in a screenshot with no pointer. Placed above the reading, below it where the plot has no room, and anchored to its own edge within 48 view units of one. An annotation whose series is hidden or whose reading is `null` draws nothing. Marked `aria-hidden`: the annex table already carries every reading, so announcing it again reads the number twice.
|
|
534
|
-
Tokens: `--ds-line-chart-plot-height`, `--ds-line-chart-line-width`, `--ds-line-chart-dot-radius`, `--ds-line-chart-area-opacity`, `--ds-line-chart-swatch-size`, `--ds-line-chart-grid-line-color`, `--ds-line-chart-axis-line-color`, `--ds-line-chart-axis-label-color`, `--ds-line-chart-axis-font-size`, `--ds-line-chart-annotation-color`, `--ds-line-chart-annotation-font-size`, `--ds-line-chart-annotation-weight`, `--ds-line-chart-annotation-halo-color`, `--ds-line-chart-annotation-halo-width`.
|
|
1001
|
+
Tokens: `--ds-line-chart-plot-height`, `--ds-line-chart-line-width`, `--ds-line-chart-dot-radius`, `--ds-line-chart-area-opacity`, `--ds-line-chart-swatch-size`, `--ds-line-chart-grid-line-color`, `--ds-line-chart-axis-line-color`, `--ds-line-chart-axis-label-color`, `--ds-line-chart-axis-font-size`, `--ds-line-chart-annotation-color`, `--ds-line-chart-annotation-font-size`, `--ds-line-chart-annotation-font-weight`, `--ds-line-chart-annotation-halo-color`, `--ds-line-chart-annotation-halo-width`.
|
|
1002
|
+
|
|
1003
|
+
<!-- inputs:ds-line-chart -->
|
|
1004
|
+
All inputs: `categories: required readonly string[]`, `series: required readonly LineChartSeries[]`, `yAxisMode: 'aligned' | 'exact' | 'dual-grid' | 'split' = 'aligned'`, `showMarkers: boolean = true`, `annotations: readonly LineChartAnnotation[] = []`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `gaps: 'break' | 'zero' = 'break'`, `curve: 'linear' | 'step' | 'smooth' = 'linear'`, `stack: 'none' | 'stacked' | 'normalized' = 'none'`, `yAxisLabel: string | null = null`, `secondaryAxisLabel: string | null = null`, `tickCount: number = 5`, `frame: 'auto' | 'none' = null`, `tooltipLingerMs: number | null = null`, `caption: string | null = null`, `summary: string | null = null`, `dataTable: 'toggle' | 'visible' | 'none' = null`, `max: number | null = null`, `maxSecondary: number | null = null`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `hiddenSeries: readonly string[] = []`, `rescaleOnHide: boolean = false`, `legendFilters: boolean = false`, `legendMode: 'toggle' | 'isolate' = 'isolate'`, `noVisibleSeriesText: string = 'All series are hidden'`, `patterns: boolean = false`, `staggerMs: number = 0`, `tooltip: 'item' | 'axis' | 'none' = 'axis'`, `tooltipAnchor: 'point' | 'pointer' = 'point'`
|
|
1005
|
+
<!-- /inputs -->
|
|
535
1006
|
|
|
536
1007
|
#### Chart defaults — what `DS_CONFIG` decides once
|
|
537
1008
|
Four chart inputs resolve through `DS_CONFIG.chart` because they are one decision per APP, not per plot: `valueFormat` (a number reads one way in a product; a formatter passed per chart drifts as soon as there are two screens), `dataTable` (whether the numbers behind a plot have a non-visual route is an accessibility policy), `emptyText` and `errorText` (copy, and the place localisation lands). Precedence is the input, then the config, then the built-in — so binding one on a single chart still wins.
|
|
@@ -553,10 +1024,54 @@ Tokens: `--ds-chart-frame-border-color`, `--ds-chart-frame-border-width`, `--ds-
|
|
|
553
1024
|
|
|
554
1025
|
#### Chart colour — which palette a chart takes
|
|
555
1026
|
Three families, and reaching for the wrong one is the usual chart bug. Set the `--ds-chart-*` contract tokens, never the `--chart-categorical-*` / `--chart-ramp-*` palette behind them.
|
|
556
|
-
- **Categorical** — `--ds-chart-series-1-color` … `--ds-chart-series-8-color`, for marks that are DIFFERENT THINGS:
|
|
1027
|
+
- **Categorical** — `--ds-chart-series-1-color` … `--ds-chart-series-8-color`, for marks that are DIFFERENT THINGS: pie slices, line series. Eight hues, each clearing 3:1 on white for WCAG 1.4.11 and at least dE 15 from every other under normal, deuteranope and protanope vision. No hue between 35 and 130: a yellow or a lime cannot be both rich and 3:1 on white, and forcing one past the floor turns it to mustard. Slots 7 and 8 are the "rest" / "other" buckets, and slot 8 is a neutral on purpose — every eighth HUE that clears the floor lands within dE 4 of one of the other seven under some colour-vision deficiency.
|
|
557
1028
|
- **Single series** — `--ds-chart-series-default-color` plus `--ds-chart-series-accent-color`, for marks that are ONE thing measured repeatedly: bar rows, columns. One colour for all of them, and the accent on the one the reader should land on.
|
|
558
1029
|
- **Ramp** — `--ds-chart-ramp-1-color` … `--ds-chart-ramp-8-color`, one hue light to deep, for the ORDERED stages of a single quantity: the funnel.
|
|
559
1030
|
|
|
1031
|
+
#### `<ds-chart-data-table>` — `ChartDataTableComponent`
|
|
1032
|
+
The annex table under a chart: every reading in a `<details>` a reader can open. Cells arrive already formatted, because how a value reads is the chart's decision, not the table's. `rowHeader` renders each row's first cell as a `<th scope="row">`, for a matrix whose rows are named rather than numbered; `toggled` fires when the disclosure changes, for a chart that builds its rows only when they are asked for.
|
|
1033
|
+
|
|
1034
|
+
<!-- inputs:ds-chart-data-table -->
|
|
1035
|
+
All inputs: `columns: readonly string[] = []`, `rows: readonly ChartDataRow[] = []`, `caption: string | null = null`, `open: boolean = false`, `rowHeader: boolean = false`
|
|
1036
|
+
<!-- /inputs -->
|
|
1037
|
+
|
|
1038
|
+
#### `<ds-chart>` — `ChartComponent`
|
|
1039
|
+
|
|
1040
|
+
<!-- inputs:ds-chart -->
|
|
1041
|
+
All inputs: `categories: readonly string[] = []`, `tickCount: number = 5`, `min: number | null = null`, `max: number | null = null`, `cursor: 'none' | 'category' = 'none'`, `cursorPin: boolean = false`, `tooltipLingerMs: number | null = null`, `maxSecondary: number | null = null`, `plotHeight: number = 240`, `axisGutter: number = 46`, `valueSpace: number = 20`, `caption: string | null = null`, `interactive: boolean = false`, `summary: string | null = null`, `frame: 'auto' | 'none' = null`, `loading: boolean = false`, `emptyText: string | null = null`, `error: boolean = false`, `errorText: string | null = null`, `valueFormat: ChartValueFormat | null = null`, `secondaryAxisMode: 'aligned' | 'exact' | 'dual-grid' | 'split' = 'aligned'`, `axisColor: string | null = null`, `secondaryAxisColor: string | null = null`, `axisLabel: string | null = null`, `secondaryAxisLabel: string | null = null`
|
|
1042
|
+
<!-- /inputs -->
|
|
1043
|
+
|
|
1044
|
+
#### `<g[dsColumnSeries]>` — `ColumnSeriesComponent`
|
|
1045
|
+
|
|
1046
|
+
<!-- inputs:g[dsColumnSeries] -->
|
|
1047
|
+
All inputs: `data: readonly ColumnSeriesPoint[] = []`, `showValues: boolean = true`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `staggerMs: number = 0`, `partOfWhole: boolean = false`, `tooltip: 'item' | 'none' = 'item'`, `tooltipAnchor: 'mark' | 'cell' = 'mark'`, `tooltipLingerMs: number = 0`, `valueFormat: ChartValueFormat`, `columnWidthRatio: number = 0.8`, `slot: number = 0`, `slotCount: number = 1`, `offsets: readonly ChartStackOffset[] | null = null`, `seriesColor: string | null = null`, `seriesFill: 'solid' | 'hatched' = null`, `seriesLabel: string | null = null`
|
|
1048
|
+
<!-- /inputs -->
|
|
1049
|
+
|
|
1050
|
+
#### `<g[dsLineSeries]>` — `LineSeriesComponent`
|
|
1051
|
+
|
|
1052
|
+
<!-- inputs:g[dsLineSeries] -->
|
|
1053
|
+
All inputs: `data: readonly LineSeriesData[] = []`, `showMarkers: boolean = true`, `interactive: boolean = false`, `pinOnClick: boolean = false`, `dimOthers: boolean = false`, `highlighted: string | null = null`, `patterns: readonly string[] = []`, `stacked: boolean = false`, `staggerMs: number = 0`, `gaps: 'break' | 'zero' = 'break'`, `curve: 'linear' | 'step' | 'smooth' = 'linear'`, `tooltip: 'item' | 'axis' | 'none' = 'item'`, `tooltipAnchor: 'reading' | 'pointer' = 'reading'`, `tooltipLingerMs: number = 0`, `valueFormat: ChartValueFormat`
|
|
1054
|
+
<!-- /inputs -->
|
|
1055
|
+
|
|
1056
|
+
#### `<g[dsSeriesAnnotation]>` — `SeriesAnnotationComponent`
|
|
1057
|
+
A label pinned to one reading, legible with no pointer. Takes the readings rather than finding them: a mark never sees the other marks, so the caller that owns the series is the one that knows which value a label belongs to. Reports no domain.
|
|
1058
|
+
|
|
1059
|
+
<!-- inputs:g[dsSeriesAnnotation] -->
|
|
1060
|
+
All inputs: `annotations: readonly ChartAnnotation[] = []`
|
|
1061
|
+
<!-- /inputs -->
|
|
1062
|
+
|
|
1063
|
+
#### `<g[dsReferenceLabel]>` — `ReferenceLabelComponent`
|
|
1064
|
+
|
|
1065
|
+
<!-- inputs:g[dsReferenceLabel] -->
|
|
1066
|
+
All inputs: `thresholds: readonly ChartThreshold[] = []`
|
|
1067
|
+
<!-- /inputs -->
|
|
1068
|
+
|
|
1069
|
+
#### `<g[dsReferenceLine]>` — `ReferenceLineComponent`
|
|
1070
|
+
|
|
1071
|
+
<!-- inputs:g[dsReferenceLine] -->
|
|
1072
|
+
All inputs: `thresholds: readonly ChartThreshold[] = []`
|
|
1073
|
+
<!-- /inputs -->
|
|
1074
|
+
|
|
560
1075
|
### Domain
|
|
561
1076
|
|
|
562
1077
|
#### `<ds-w3w>` — `W3wComponent`
|
|
@@ -576,6 +1091,10 @@ All built-in icons (kebab-case where indicated, camelCase otherwise — DS uses
|
|
|
576
1091
|
|
|
577
1092
|
Icons render inside `<svg viewBox="0 0 24 24" fill="none" stroke="currentColor">`. For consumer-side icons without forking DS, use `provideDsIcons(…)` below.
|
|
578
1093
|
|
|
1094
|
+
<!-- inputs:ds-w3w -->
|
|
1095
|
+
All inputs: `prefix: string = '///'`, `address: required string`, `copyable: boolean = true`
|
|
1096
|
+
<!-- /inputs -->
|
|
1097
|
+
|
|
579
1098
|
#### `DS_ICON_REGISTRY` / `provideDsIcons(icons)`
|
|
580
1099
|
|
|
581
1100
|
Consumer apps can register additional icons without forking DS. Each entry maps a name to the raw SVG body — everything that goes *inside* `<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75">`. Typically one or more `<path>` / `<circle>` / `<rect>` elements with no `stroke`/`fill` of their own (the host SVG paints them).
|