@khsura/sui 1.18.3 → 1.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/@types/components/cards/sCardText.vue.d.ts +2 -2
- package/@types/components/datePicker/sDatePickerSwitch.vue.d.ts +2 -0
- package/@types/components/form/index.d.ts +1 -0
- package/@types/components/form/radio/sRadio.vue.d.ts +3 -0
- package/@types/components/form/sFormRow.vue.d.ts +18 -0
- package/@types/components/form/sInput.vue.d.ts +1 -0
- package/@types/components/form/sSelect.vue.d.ts +2 -0
- package/@types/components/layout/sNavigationDrawer.vue.d.ts +6 -6
- package/@types/components/progress/sProgressCircular.vue.d.ts +1 -0
- package/@types/components/progress/sProgressLinear.vue.d.ts +1 -0
- package/@types/components/sAutocomplete.vue.d.ts +3 -0
- package/@types/components/slideGroup/sSlideGroup.vue.d.ts +4 -1
- package/@types/components/table/sTable.vue.d.ts +17 -96
- package/@types/components/tabs/sTabs.vue.d.ts +2 -2
- package/@types/configs/app.d.ts +4 -0
- package/@types/configs/i18n.d.ts +3 -0
- package/@types/configs/provider.d.ts +1 -0
- package/@types/constants/color.d.ts +15 -0
- package/@types/constants/cssVariables.d.ts +4 -0
- package/@types/constants/datePicker.d.ts +7 -0
- package/@types/constants/i18n.d.ts +3 -0
- package/@types/constants/index.d.ts +3 -0
- package/@types/constants/keyboard.d.ts +12 -0
- package/@types/constants/listbox.d.ts +1 -0
- package/@types/constants/overlay.d.ts +5 -0
- package/@types/constants/tabs.d.ts +4 -0
- package/@types/definitions/props/core/propsLink.d.ts +2 -2
- package/@types/definitions/props/propsAutocomplete.d.ts +6 -0
- package/@types/definitions/props/propsInput.d.ts +1 -0
- package/@types/definitions/props/propsLink.d.ts +2 -2
- package/@types/definitions/props/propsProgressCircular.d.ts +2 -0
- package/@types/definitions/props/propsProgressLinear.d.ts +2 -0
- package/@types/definitions/props/propsSelect.d.ts +4 -0
- package/@types/definitions/props/propsSlideGroup.d.ts +4 -0
- package/@types/definitions/props/propsTable.d.ts +1 -0
- package/@types/definitions/props/propsTextarea.d.ts +3 -0
- package/@types/helpers/colorHelpers.d.ts +1 -1
- package/@types/helpers/createAppStore.d.ts +4 -0
- package/@types/lib/color.d.ts +21 -2
- package/@types/lib/index.d.ts +4 -0
- package/@types/lib/linkLocation.d.ts +9 -0
- package/@types/lib/overlayPlacement.d.ts +11 -0
- package/@types/lib/revealInScroller.d.ts +11 -0
- package/@types/lib/safeArea.d.ts +3 -0
- package/@types/playwright.visual.config.d.ts +3 -0
- package/@types/services/backgroundScrollService.d.ts +8 -2
- package/@types/services/datePicker/datePickerItemDateService.d.ts +1 -0
- package/@types/services/dialogService.d.ts +4 -8
- package/@types/services/fieldLayoutService.d.ts +19 -0
- package/@types/services/formInputService.d.ts +6 -0
- package/@types/services/index.d.ts +7 -0
- package/@types/services/linkService.d.ts +11 -1
- package/@types/services/listboxNavigationService.d.ts +20 -0
- package/@types/services/menuService.d.ts +2 -0
- package/@types/services/overlayFocusService.d.ts +10 -0
- package/@types/services/routerLinkService.d.ts +19 -0
- package/@types/services/scrollableFocusService.d.ts +10 -0
- package/@types/services/surfaceTextColorService.d.ts +8 -0
- package/@types/services/tabsService.d.ts +9 -0
- package/@types/store/index.d.ts +1 -0
- package/@types/store/scrollLockStore.d.ts +1 -0
- package/@types/tests/visual/constants/a11yAudit.d.ts +4 -0
- package/@types/tests/visual/constants/index.d.ts +4 -0
- package/@types/tests/visual/constants/resizeScroll.d.ts +10 -0
- package/@types/tests/visual/constants/storyRender.d.ts +5 -0
- package/@types/tests/visual/constants/visualMatrix.d.ts +20 -0
- package/@types/tests/visual/schemas/index.d.ts +1 -0
- package/@types/tests/visual/schemas/storyIndex.d.ts +17 -0
- package/@types/tests/visual/types/a11yAudit.d.ts +2 -0
- package/@types/tests/visual/types/index.d.ts +2 -0
- package/@types/tests/visual/types/visualStory.d.ts +8 -0
- package/@types/types/app.d.ts +2 -0
- package/@types/types/breadcrumbs.d.ts +2 -2
- package/@types/types/index.d.ts +2 -0
- package/@types/types/link.d.ts +20 -0
- package/@types/types/menu.d.ts +17 -0
- package/@types/types/safeArea.d.ts +1 -0
- package/@types/types/table.d.ts +45 -0
- package/@types/vite.config.d.ts +1 -0
- package/README.md +22 -31
- package/dist/base.css.map +1 -1
- package/dist/s-ui.css +1 -1
- package/dist/s-ui.js +3122 -2478
- package/dist/s-ui.umd.cjs +1 -1
- package/dist/styles/components/button/mixins.scss +5 -0
- package/dist/styles/components/form/_variables.scss +11 -0
- package/dist/styles/components/form/index.scss +1 -0
- package/dist/styles/components/index.scss +1 -0
- package/dist/styles/mixins/_app.scss +7 -0
- package/dist/styles/tools/_safeArea.scss +8 -0
- package/dist/styles/tools/index.scss +1 -0
- package/dist/sui-api.json +10128 -0
- package/package.json +30 -6
- package/sui-plugin/.claude-plugin/plugin.json +2 -2
- package/sui-plugin/README.md +24 -1
- package/sui-plugin/skills/sui-component/SKILL.md +13 -3
- package/sui-plugin/skills/sui-component/references/alert.md +30 -14
- package/sui-plugin/skills/sui-component/references/autocomplete.md +96 -34
- package/sui-plugin/skills/sui-component/references/badge.md +55 -29
- package/sui-plugin/skills/sui-component/references/breadcrumbs.md +33 -19
- package/sui-plugin/skills/sui-component/references/button.md +76 -37
- package/sui-plugin/skills/sui-component/references/calendar.md +64 -34
- package/sui-plugin/skills/sui-component/references/cards.md +142 -25
- package/sui-plugin/skills/sui-component/references/carousel.md +107 -42
- package/sui-plugin/skills/sui-component/references/chip.md +52 -28
- package/sui-plugin/skills/sui-component/references/date-picker.md +148 -61
- package/sui-plugin/skills/sui-component/references/dialog.md +60 -21
- package/sui-plugin/skills/sui-component/references/divider.md +15 -6
- package/sui-plugin/skills/sui-component/references/droppable.md +36 -16
- package/sui-plugin/skills/sui-component/references/expansion-panels.md +107 -30
- package/sui-plugin/skills/sui-component/references/form.md +483 -35
- package/sui-plugin/skills/sui-component/references/icon.md +30 -11
- package/sui-plugin/skills/sui-component/references/image.md +39 -17
- package/sui-plugin/skills/sui-component/references/layout.md +456 -69
- package/sui-plugin/skills/sui-component/references/list.md +223 -52
- package/sui-plugin/skills/sui-component/references/menu.md +64 -28
- package/sui-plugin/skills/sui-component/references/overlay.md +35 -16
- package/sui-plugin/skills/sui-component/references/progress.md +76 -26
- package/sui-plugin/skills/sui-component/references/sheet.md +46 -23
- package/sui-plugin/skills/sui-component/references/slide-group.md +77 -38
- package/sui-plugin/skills/sui-component/references/snackbar.md +48 -17
- package/sui-plugin/skills/sui-component/references/split-view.md +51 -12
- package/sui-plugin/skills/sui-component/references/stepper.md +58 -23
- package/sui-plugin/skills/sui-component/references/table.md +123 -55
- package/sui-plugin/skills/sui-component/references/tabs.md +78 -30
- package/sui-plugin/skills/sui-component/references/toggle-button-group.md +85 -39
- package/sui-plugin/skills/sui-component/references/toolbar.md +92 -33
- package/sui-plugin/skills/sui-component/references/tooltip.md +58 -20
- package/sui-plugin/skills/sui-component/references/window.md +89 -29
- package/sui-plugin/skills/sui-form/SKILL.md +23 -16
- package/sui-plugin/skills/sui-getting-started/SKILL.md +60 -44
- package/sui-plugin/skills/sui-layout/SKILL.md +3 -1
- package/sui-plugin/skills/sui-utilities/docs/classes.md +1 -1
|
@@ -6,41 +6,127 @@ Data table with client-side sorting, selection and expansion state, grouping (op
|
|
|
6
6
|
|
|
7
7
|
Types: `node_modules/@khsura/sui/@types/definitions/props/propsTable.d.ts`. The `TableHeader`, `TableItemClass`, and `TableSortOrder` types are exported from `@khsura/sui`.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
| `dense` | `boolean` | `false` |
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `hidePagination` | `boolean` | `false` |
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
40
|
-
| `
|
|
41
|
-
| `
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
9
|
+
<!-- generated:api:start STable -->
|
|
10
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
11
|
+
|
|
12
|
+
**STable props**
|
|
13
|
+
|
|
14
|
+
| Prop | Type | Default | Required | Values |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| `dense` | `boolean` | `false` | no | — |
|
|
17
|
+
| `expanded` | `T[]` | — | no | — |
|
|
18
|
+
| `foldable` | `boolean` | `false` | no | — |
|
|
19
|
+
| `folded` | `boolean \| string[]` | `[]` | no | — |
|
|
20
|
+
| `groupBy` | `string \| string[]` | — | no | — |
|
|
21
|
+
| `headers` | `TableHeader<string>[]` | `[]` | yes | — |
|
|
22
|
+
| `hideHeader` | `boolean` | `false` | no | — |
|
|
23
|
+
| `hidePagination` | `boolean` | `false` | no | — |
|
|
24
|
+
| `hideTopBottomBorders` | `boolean` | `false` | no | — |
|
|
25
|
+
| `hideVerticalBorders` | `boolean` | `false` | no | — |
|
|
26
|
+
| `itemClass` | `TableItemClass<T, string>` | — | no | — |
|
|
27
|
+
| `itemFooter` | `string` | `""` | no | — |
|
|
28
|
+
| `itemFooterClass` | `TableItemClass<T, string>` | — | no | — |
|
|
29
|
+
| `itemFooterStyle` | `TableItemStyle<T, string>` | — | no | — |
|
|
30
|
+
| `itemHeader` | `string` | `""` | no | — |
|
|
31
|
+
| `itemHeaderClass` | `TableItemClass<T, string>` | — | no | — |
|
|
32
|
+
| `itemHeaderStyle` | `TableItemStyle<T, string>` | — | no | — |
|
|
33
|
+
| `itemKey` | `string` | — | no | — |
|
|
34
|
+
| `itemRowClass` | `TableRowClass<T>` | — | no | — |
|
|
35
|
+
| `itemStyle` | `TableItemStyle<T, string>` | — | no | — |
|
|
36
|
+
| `items` | `T[]` | `[]` | yes | — |
|
|
37
|
+
| `itemsPerPage` | `number` | — | no | — |
|
|
38
|
+
| `itemsPerPageLabel` | `string` | — | no | — |
|
|
39
|
+
| `loading` | `boolean` | — | no | — |
|
|
40
|
+
| `loadingText` | `string` | — | no | — |
|
|
41
|
+
| `multiSort` | `boolean` | `false` | no | — |
|
|
42
|
+
| `noDataText` | `string` | — | no | — |
|
|
43
|
+
| `outlined` | `boolean` | `false` | no | — |
|
|
44
|
+
| `rounded` | `boolean` | — | no | — |
|
|
45
|
+
| `selected` | `T[]` | — | no | — |
|
|
46
|
+
| `shadowExpandedContent` | `boolean` | `false` | no | — |
|
|
47
|
+
| `singleExpand` | `boolean` | — | no | — |
|
|
48
|
+
| `singleSelect` | `boolean` | — | no | — |
|
|
49
|
+
| `stickyHeader` | `boolean` | `false` | no | — |
|
|
50
|
+
| `stickyLeftColumnsOffset` | `number` | — | no | — |
|
|
51
|
+
| `stickyLeftColumnsSize` | `number` | `0` | no | — |
|
|
52
|
+
| `stickyLeftColumnsStart` | `number` | `0` | no | — |
|
|
53
|
+
| `stickyRightColumn` | `boolean` | — | no | — |
|
|
54
|
+
| `tile` | `boolean` | — | no | — |
|
|
55
|
+
| `totalItems` | `number` | — | no | — |
|
|
56
|
+
| `underlined` | `boolean` | — | no | — |
|
|
57
|
+
|
|
58
|
+
**STable slots**
|
|
59
|
+
|
|
60
|
+
| Slot | Slot props | Description |
|
|
61
|
+
| --- | --- | --- |
|
|
62
|
+
| `expanded` | `{ item: T; }` | Content of an expanded row. |
|
|
63
|
+
| `group` | `TableGroupSlotProps<T>` | Group row content, rendered when `groupBy` is set. |
|
|
64
|
+
| `header.<column>` (pattern `^header\..+$`) | `TableHeaderSlotProps` | Header cell of one column; the key is `header.` followed by the column's `value`. |
|
|
65
|
+
| `item.<column>` (pattern `^item\..+$`) | `TableItemSlotProps<T>` | Body cell of one column; the key is `item.` followed by the column's `value`. |
|
|
66
|
+
| `itemFooter` | `TableItemFooterSlotProps<T>` | Full-width row below an item, rendered when `itemFooter` is set and the item has that key. |
|
|
67
|
+
| `itemHeader` | `TableItemHeaderSlotProps<T>` | Full-width row above an item, rendered when `itemHeader` is set and the item has that key. |
|
|
68
|
+
| `itemsPerPageLabel` | `any` | Label of the items-per-page selector in the pagination. |
|
|
69
|
+
| `loadingData` | `any` | Shown instead of the rows while `loading` is set and `items` is still empty. |
|
|
70
|
+
| `noData` | `any` | Shown instead of the rows when `items` is empty and not loading. |
|
|
71
|
+
|
|
72
|
+
**STable events**
|
|
73
|
+
|
|
74
|
+
| Event | Payload |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| `click:row` | `[value: { item: T; expand: () => void; isExpanded: boolean; }]` |
|
|
77
|
+
| `update:expanded` | `[value: T[]]` |
|
|
78
|
+
| `update:folded` | `[value: boolean \| string[]]` |
|
|
79
|
+
| `update:itemsPerPage` | `[value: number \| undefined]` |
|
|
80
|
+
| `update:options` | `[{ pageIndex: number; itemsPerPage: number; sortBy: { key: string; order: TableSortOrder; }[]; }]` |
|
|
81
|
+
| `update:selected` | `[value: T[]]` |
|
|
82
|
+
|
|
83
|
+
<!-- generated:api:end STable -->
|
|
84
|
+
|
|
85
|
+
**STable notes**
|
|
86
|
+
|
|
87
|
+
- `headers`: Column definitions (see below)
|
|
88
|
+
- `items`: Row objects
|
|
89
|
+
- `itemKey`: Field used to match **expanded** rows (default: first header's `value`)
|
|
90
|
+
- `dense`: Compact cells
|
|
91
|
+
- `loading`: Indeterminate progress bar. Hides the no-data row; while `items` is still empty it shows a full-width loading row instead
|
|
92
|
+
- `loadingText`: Text of that loading row (`#loadingData` slot overrides it) (default: i18n `table.loading` → `'Loading…'`)
|
|
93
|
+
- `outlined` / `underlined`: Border styles
|
|
94
|
+
- `rounded` / `tile`: Declared, but **no effect** (the table never reads them)
|
|
95
|
+
- `hideHeader`: Hide `<thead>`
|
|
96
|
+
- `hideVerticalBorders`: Remove column borders
|
|
97
|
+
- `hideTopBottomBorders`: Remove outer top/bottom borders
|
|
98
|
+
- `hidePagination`: Hides the pager only when `itemsPerPage` is unset or greater than the total
|
|
99
|
+
- `stickyHeader`: Sticky header row. Give the table a height limit (`style="max-height: 400px"` or a `height`): the rows scroll inside the table, the header sticks and the pagination stays visible below
|
|
100
|
+
- `multiSort`: Sort by several columns
|
|
101
|
+
- `groupBy`: Group rows by item field(s). Group name = values joined with a space
|
|
102
|
+
- `foldable`: Clicking a group row collapses or expands it
|
|
103
|
+
- `selected`: Selected rows (`v-model:selected`)
|
|
104
|
+
- `singleSelect`: At most one selected row
|
|
105
|
+
- `expanded`: Expanded rows (`v-model:expanded`)
|
|
106
|
+
- `singleExpand`: At most one expanded row
|
|
107
|
+
- `shadowExpandedContent`: Inner shadow on expanded content
|
|
108
|
+
- `totalItems`: Server-side total. When it is greater than `items.length`, items are **not** sliced per page
|
|
109
|
+
- `itemsPerPageLabel`: Pager label text (default: `'Items per page: '`)
|
|
110
|
+
- `noDataText`: Empty-state text (`#noData` slot overrides it) (default: i18n `table.noData` → `'No data'`)
|
|
111
|
+
- `itemClass` / `itemStyle`: Per-cell class/style (value or `({ item, cellKey, cellType }) => …`)
|
|
112
|
+
- `itemRowClass`: `<tr>` class (value or `({ item, cellType }) => …`)
|
|
113
|
+
- `itemHeader` / `itemFooter`: Item field. When it is truthy on a row, a full-width row is rendered above/below that row (default: `''`)
|
|
114
|
+
- `itemHeaderClass` / `itemHeaderStyle` / `itemFooterClass` / `itemFooterStyle`: Styling for those rows
|
|
115
|
+
- `stickyLeftColumnsStart`: Index of the first left-sticky column
|
|
116
|
+
- `stickyLeftColumnsSize`: Number of left-sticky columns (sticking activates on horizontal scroll)
|
|
117
|
+
- `stickyLeftColumnsOffset`: Extra columns counted before sticking activates
|
|
118
|
+
- `stickyRightColumn`: Stick the last column to the right
|
|
119
|
+
- `click:row` (event): A body row was clicked. Rows do **not** expand on their own: call `expand()`
|
|
120
|
+
- `update:options` (event): Emitted when the page or page size changes (not when the sort changes)
|
|
121
|
+
- `update:selected` / `update:expanded` (event): Model updates
|
|
122
|
+
- `item.<value>` (slot): Body cell
|
|
123
|
+
- `header.<value>` (slot): Header cell content
|
|
124
|
+
- `group` (slot): Group row content (default: the group name)
|
|
125
|
+
- `itemHeader` / `itemFooter` (slot): Full-width rows from `itemHeader`/`itemFooter`
|
|
126
|
+
- `expanded` (slot): Content of an expanded row
|
|
127
|
+
- `noData` (slot): Empty state
|
|
128
|
+
- `loadingData` (slot): Loading row, shown while `loading` is set and `items` is empty
|
|
129
|
+
- `itemsPerPageLabel` (slot): Pager label
|
|
44
130
|
|
|
45
131
|
### TableHeader
|
|
46
132
|
|
|
@@ -72,26 +158,6 @@ interface TableHeader {
|
|
|
72
158
|
- `v-model:items-per-page`: `number`. **The pager is rendered only when this is set.** Options are 10/25/50/100 plus your value.
|
|
73
159
|
- `v-model:folded`: `boolean | string[]`, the collapsed group names (`true` = all collapsed). Default `[]`. Works without binding.
|
|
74
160
|
|
|
75
|
-
## Events
|
|
76
|
-
|
|
77
|
-
| Event | Payload | Description |
|
|
78
|
-
|-------|---------|-------------|
|
|
79
|
-
| `click:row` | `{ item, expand: () => void, isExpanded: boolean }` | A body row was clicked. Rows do **not** expand on their own: call `expand()` |
|
|
80
|
-
| `update:options` | `{ pageIndex, itemsPerPage, sortBy: { key, order }[] }` | Emitted when the page or page size changes (not when the sort changes) |
|
|
81
|
-
| `update:selected` / `update:expanded` | `T[]` | Model updates |
|
|
82
|
-
|
|
83
|
-
## Slots
|
|
84
|
-
|
|
85
|
-
| Slot | Props | Description |
|
|
86
|
-
|------|-------|-------------|
|
|
87
|
-
| `item.<value>` | `{ item, value, header, row, col, group, select, expand, isSelected, isExpanded, isLeftSticked }` | Body cell |
|
|
88
|
-
| `header.<value>` | `{ header, isSticked }` | Header cell content |
|
|
89
|
-
| `group` | `{ group, items, isFolded, toggleFold }` | Group row content (default: the group name) |
|
|
90
|
-
| `itemHeader` / `itemFooter` | `{ item, value, row, group, select, expand, isSelected, isExpanded, … }` | Full-width rows from `itemHeader`/`itemFooter` |
|
|
91
|
-
| `expanded` | `{ item }` | Content of an expanded row |
|
|
92
|
-
| `noData` | — | Empty state |
|
|
93
|
-
| `itemsPerPageLabel` | — | Pager label |
|
|
94
|
-
|
|
95
161
|
## Usage
|
|
96
162
|
|
|
97
163
|
```vue
|
|
@@ -149,3 +215,5 @@ const perPage = ref(10)
|
|
|
149
215
|
| Waiting for `update:options` to fetch on sort change | It fires only for page/page-size changes. Sorting is always client-side |
|
|
150
216
|
| Rebuilding item objects and expecting `selected` to persist | Selection matches by **object identity** (`itemKey` applies only to expansion) |
|
|
151
217
|
| Buttons inside a row also trigger `click:row` | Use `@click.stop` |
|
|
218
|
+
| Using `STable` without importing it (registered globally with `app.component` and no `GlobalComponents` types) and expecting typed `#item.<value>` slots | The slot `item` is typed from `items` only when the template knows the component type: import `STable` from `@khsura/sui` in the SFC (Nuxt's generated component types also work). Otherwise `item` is `any` |
|
|
219
|
+
| Wrapping `STable` in a fixed-height `div` to get a sticky header | Put the height limit on `STable` itself. Older versions clipped the rows and the pagination instead of scrolling them |
|
|
@@ -6,52 +6,99 @@ Single-select tab strip, built on the toggle-button group. It renders only the t
|
|
|
6
6
|
|
|
7
7
|
Types: `node_modules/@khsura/sui/@types/definitions/props/propsTabs.d.ts`, `propsTab.d.ts`
|
|
8
8
|
|
|
9
|
+
The tabs stay on **one row**. Each tab keeps the width of its label (tabs stretch to fill spare room), and when they do not fit, the row scrolls sideways (touch, trackpad, shift+wheel) with no scrollbar. The selected tab is scrolled into view on mount and whenever the selection changes. Don't wrap `STabs` in `SSlideGroup` or add `overflow-x: auto` yourself. (Older versions wrapped the tabs onto several rows on phones.)
|
|
10
|
+
|
|
9
11
|
---
|
|
10
12
|
|
|
11
13
|
## STabs
|
|
12
14
|
|
|
13
|
-
|
|
15
|
+
<!-- generated:api:start STabs -->
|
|
16
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
14
17
|
|
|
15
|
-
|
|
16
|
-
|------|------|---------|-------------|
|
|
17
|
-
| `modelValue` | `string \| number` | **required** | Active tab's `tab` value (use `v-model`) |
|
|
18
|
-
| `dense` | `boolean` | `false` | Compact tab height |
|
|
19
|
-
| `bordered` | `boolean` | `false` | Bordered strip |
|
|
20
|
-
| `selectedTabColor` | `string` | `'primary'` | Color of the active tab button |
|
|
21
|
-
| `shrink` | `boolean` | `false` | Tabs size to their content instead of stretching |
|
|
22
|
-
| `outlined` | `boolean \| null` | `undefined` | Outlined border on the strip |
|
|
23
|
-
| `underlined` | `boolean \| null` | `undefined` | Bottom-border style on the strip (not an active-tab indicator) |
|
|
24
|
-
| `borderRadius` | `'tile' \| 'rounded' \| number \| string \| null` | `undefined` | Strip border radius |
|
|
18
|
+
**STabs props**
|
|
25
19
|
|
|
26
|
-
|
|
20
|
+
| Prop | Type | Default | Required | Values |
|
|
21
|
+
| --- | --- | --- | --- | --- |
|
|
22
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
23
|
+
| `bordered` | `boolean` | — | no | — |
|
|
24
|
+
| `dense` | `boolean` | — | no | — |
|
|
25
|
+
| `modelValue` | `string \| number` | — | yes | — |
|
|
26
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
27
|
+
| `selectedTabColor` | `string` | `"primary"` | no | — |
|
|
28
|
+
| `shrink` | `boolean` | — | no | — |
|
|
29
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
30
|
+
|
|
31
|
+
**STabs slots**
|
|
32
|
+
|
|
33
|
+
| Slot | Slot props |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| `default` | `{}` |
|
|
27
36
|
|
|
28
|
-
|
|
37
|
+
**STabs events**
|
|
29
38
|
|
|
30
|
-
|
|
|
31
|
-
|
|
32
|
-
| `
|
|
39
|
+
| Event | Payload |
|
|
40
|
+
| --- | --- |
|
|
41
|
+
| `update:modelValue` | `[value: string \| number]` |
|
|
33
42
|
|
|
34
|
-
|
|
43
|
+
<!-- generated:api:end STabs -->
|
|
35
44
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
45
|
+
**STabs notes**
|
|
46
|
+
|
|
47
|
+
- `modelValue`: Active tab's `tab` value (use `v-model`) (default: **required**)
|
|
48
|
+
- `dense`: Compact tab height
|
|
49
|
+
- `bordered`: Bordered strip
|
|
50
|
+
- `selectedTabColor`: Color of the active tab button
|
|
51
|
+
- `shrink`: Tabs size to their content instead of stretching
|
|
52
|
+
- `outlined`: Outlined border on the strip
|
|
53
|
+
- `underlined`: Bottom-border style on the strip (not an active-tab indicator)
|
|
54
|
+
- `borderRadius`: Strip border radius
|
|
55
|
+
- `default` (slot): `STab` components
|
|
56
|
+
- `update:modelValue` (event): Active tab changed
|
|
57
|
+
|
|
58
|
+
Always exactly one tab active (mandatory, single-select).
|
|
39
59
|
|
|
40
60
|
---
|
|
41
61
|
|
|
42
62
|
## STab
|
|
43
63
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
|
50
|
-
|
|
|
64
|
+
<!-- generated:api:start STab -->
|
|
65
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
66
|
+
|
|
67
|
+
**STab props**
|
|
68
|
+
|
|
69
|
+
| Prop | Type | Default | Required | Values |
|
|
70
|
+
| --- | --- | --- | --- | --- |
|
|
71
|
+
| `alignSelf` | `"center" \| "auto" \| "start" \| "normal" \| "end" \| "self-start" \| "self-end" \| "flex-start" \| "flex-end" \| "baseline" \| "first baseline" \| "last baseline" \| "stretch" \| "safe center" \| "unsafe center" \| "inherit" \| "initial" \| null` | — | no | `auto`, `baseline`, `center`, `end`, `first baseline`, `flex-end`, `flex-start`, `inherit`, `initial`, `last baseline`, `normal`, `safe center`, `self-end`, `self-start`, `start`, `stretch`, `unsafe center` |
|
|
72
|
+
| `cols` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
73
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
74
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
75
|
+
| `disabled` | `boolean` | — | no | — |
|
|
76
|
+
| `lg` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
77
|
+
| `md` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
78
|
+
| `order` | `number \| null` | — | no | — |
|
|
79
|
+
| `sm` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
80
|
+
| `tab` | `string \| number` | — | yes | — |
|
|
81
|
+
|
|
82
|
+
**STab slots**
|
|
83
|
+
|
|
84
|
+
| Slot | Slot props |
|
|
85
|
+
| --- | --- |
|
|
86
|
+
| `default` | `{}` |
|
|
87
|
+
|
|
88
|
+
**STab events**
|
|
89
|
+
|
|
90
|
+
None.
|
|
91
|
+
|
|
92
|
+
<!-- generated:api:end STab -->
|
|
93
|
+
|
|
94
|
+
**STab notes**
|
|
51
95
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
96
|
+
- `tab`: Identifier matched against `STabs` model (default: **required**)
|
|
97
|
+
- `disabled`: Disable this tab
|
|
98
|
+
- `cols` / `sm` / `md` / `lg`: Grid column width per breakpoint (no `xl`)
|
|
99
|
+
- `order`: Flex order
|
|
100
|
+
- `alignSelf`: Flex alignment
|
|
101
|
+
- `default` (slot): Tab label
|
|
55
102
|
|
|
56
103
|
---
|
|
57
104
|
|
|
@@ -85,4 +132,5 @@ const active = ref<'overview' | 'api'>('overview')
|
|
|
85
132
|
| `<STab value="a">` / `<STab :index="0">` | `<STab tab="a">`. The identifier prop is `tab` |
|
|
86
133
|
| `<STabs>` without `v-model` | `modelValue` is required |
|
|
87
134
|
| Panels that slide between tabs | Bind the same model to [SWindow](./window.md) with `SWindowItem value` = the `STab tab` |
|
|
135
|
+
| Many tabs on a phone wrapping onto several rows | They no longer wrap: the row scrolls sideways. Keep labels short anyway, so more of them are visible |
|
|
88
136
|
| `underlined` to get an active underline | It styles the strip's border. Use `selectedTabColor` for the active state |
|
|
@@ -10,59 +10,105 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/propsToggleButtonGroup
|
|
|
10
10
|
|
|
11
11
|
## SToggleButtonGroup
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `dense` | `boolean` |
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
13
|
+
<!-- generated:api:start SToggleButtonGroup -->
|
|
14
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
15
|
+
|
|
16
|
+
**SToggleButtonGroup props**
|
|
17
|
+
|
|
18
|
+
| Prop | Type | Default | Required | Values |
|
|
19
|
+
| --- | --- | --- | --- | --- |
|
|
20
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
21
|
+
| `bordered` | `boolean` | — | no | — |
|
|
22
|
+
| `dense` | `boolean` | — | no | — |
|
|
23
|
+
| `mandatory` | `boolean` | — | no | — |
|
|
24
|
+
| `modelValue` | `(GroupItemValue[] & T[]) \| null` | `[]` | no | — |
|
|
25
|
+
| `multiple` | `boolean` | — | no | — |
|
|
26
|
+
| `nowrap` | `boolean` | — | no | — |
|
|
27
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
28
|
+
| `selectedColor` | `string` | `"primary"` | no | — |
|
|
29
|
+
| `shrink` | `boolean` | — | no | — |
|
|
30
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
31
|
+
| `variant` | `"underlined" \| "inset" \| null` | — | no | `inset`, `underlined` |
|
|
32
|
+
|
|
33
|
+
**SToggleButtonGroup slots**
|
|
34
|
+
|
|
35
|
+
| Slot | Slot props |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| `default` | `{}` |
|
|
38
|
+
|
|
39
|
+
**SToggleButtonGroup events**
|
|
40
|
+
|
|
41
|
+
| Event | Payload |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| `update:modelValue` | `[value: T[] \| null]` |
|
|
44
|
+
|
|
45
|
+
<!-- generated:api:end SToggleButtonGroup -->
|
|
46
|
+
|
|
47
|
+
**SToggleButtonGroup notes**
|
|
48
|
+
|
|
49
|
+
- `modelValue` (`v-model`): Selected button identifiers — **always an array**, even for single selection
|
|
50
|
+
- `multiple`: Allow several selected buttons
|
|
51
|
+
- `mandatory`: Keep one selected (auto-selects the first button when empty)
|
|
52
|
+
- `selectedColor`: Color of the selected button
|
|
53
|
+
- `variant`: `underlined` = underline the selected button; `inset` = segmented/pill look
|
|
54
|
+
- `dense`: Compact (small-size) buttons
|
|
55
|
+
- `bordered`: Border around the group and between buttons (ignored with `inset`)
|
|
56
|
+
- `shrink`: Buttons size to content instead of stretching
|
|
57
|
+
- `outlined`: Outlined group border
|
|
58
|
+
- `underlined`: Underlined group border
|
|
59
|
+
- `borderRadius`: Group corner radius
|
|
60
|
+
- `default` (slot): `SToggleButton` components
|
|
61
|
+
- `update:modelValue` (event): Selection changed
|
|
28
62
|
|
|
29
63
|
`GroupItemValue` = `string | number | boolean | symbol`. (`nowrap` is typed but has no effect.)
|
|
30
64
|
|
|
31
|
-
|
|
65
|
+
---
|
|
32
66
|
|
|
33
|
-
|
|
34
|
-
|------|-------------|
|
|
35
|
-
| `default` | `SToggleButton` components |
|
|
67
|
+
## SToggleButton
|
|
36
68
|
|
|
37
|
-
|
|
69
|
+
Must be inside `SToggleButtonGroup` (throws otherwise).
|
|
38
70
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
| `update:modelValue` | `GroupItemValue[]` | Selection changed |
|
|
71
|
+
<!-- generated:api:start SToggleButton -->
|
|
72
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
42
73
|
|
|
43
|
-
|
|
74
|
+
**SToggleButton props**
|
|
44
75
|
|
|
45
|
-
|
|
76
|
+
| Prop | Type | Default | Required | Values |
|
|
77
|
+
| --- | --- | --- | --- | --- |
|
|
78
|
+
| `activeClass` | `string \| null` | — | no | — |
|
|
79
|
+
| `alignSelf` | `"center" \| "auto" \| "start" \| "normal" \| "end" \| "self-start" \| "self-end" \| "flex-start" \| "flex-end" \| "baseline" \| "first baseline" \| "last baseline" \| "stretch" \| "safe center" \| "unsafe center" \| "inherit" \| "initial" \| null` | — | no | `auto`, `baseline`, `center`, `end`, `first baseline`, `flex-end`, `flex-start`, `inherit`, `initial`, `last baseline`, `normal`, `safe center`, `self-end`, `self-start`, `start`, `stretch`, `unsafe center` |
|
|
80
|
+
| `cols` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
81
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
82
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
83
|
+
| `disabled` | `boolean` | — | no | — |
|
|
84
|
+
| `index` | `GroupItemValue \| null` | — | no | — |
|
|
85
|
+
| `lg` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
86
|
+
| `md` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
87
|
+
| `order` | `number \| null` | — | no | — |
|
|
88
|
+
| `sm` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
46
89
|
|
|
47
|
-
|
|
90
|
+
**SToggleButton slots**
|
|
48
91
|
|
|
49
|
-
|
|
92
|
+
| Slot | Slot props |
|
|
93
|
+
| --- | --- |
|
|
94
|
+
| `default` | `{}` |
|
|
50
95
|
|
|
51
|
-
|
|
52
|
-
|------|------|---------|-------------|
|
|
53
|
-
| `index` | `GroupItemValue \| null` | vnode `key` | Identifier stored in the group's `v-model`. Falls back to `:key`, then an auto id |
|
|
54
|
-
| `disabled` | `boolean` | `false` | Disable this button |
|
|
55
|
-
| `cols` / `sm` / `md` / `lg` | `1–12 \| 'auto' \| 'grow'` | `undefined` | Grid column width of the button |
|
|
56
|
-
| `order` | `number` | `undefined` | Flex order |
|
|
57
|
-
| `alignSelf` | CSS `align-self` value | `undefined` | Alignment |
|
|
96
|
+
**SToggleButton events**
|
|
58
97
|
|
|
59
|
-
|
|
98
|
+
None.
|
|
99
|
+
|
|
100
|
+
<!-- generated:api:end SToggleButton -->
|
|
60
101
|
|
|
61
|
-
|
|
102
|
+
**SToggleButton notes**
|
|
62
103
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
104
|
+
- `index`: Identifier stored in the group's `v-model`. Falls back to `:key`, then an auto id (default: vnode `key`)
|
|
105
|
+
- `disabled`: Disable this button
|
|
106
|
+
- `cols` / `sm` / `md` / `lg`: Grid column width of the button
|
|
107
|
+
- `order`: Flex order
|
|
108
|
+
- `alignSelf`: Alignment
|
|
109
|
+
- `default` (slot): Button content
|
|
110
|
+
|
|
111
|
+
There is **no `value` prop** — use `index` or `:key`.
|
|
66
112
|
|
|
67
113
|
---
|
|
68
114
|
|
|
@@ -10,36 +10,72 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/propsToolbar.d.ts`, `p
|
|
|
10
10
|
|
|
11
11
|
## SToolbar
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
13
|
+
<!-- generated:api:start SToolbar -->
|
|
14
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
15
|
+
|
|
16
|
+
**SToolbar props**
|
|
17
|
+
|
|
18
|
+
| Prop | Type | Default | Required | Values |
|
|
19
|
+
| --- | --- | --- | --- | --- |
|
|
20
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
21
|
+
| `color` | `string` | — | no | — |
|
|
22
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
23
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
24
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
25
|
+
| `density` | `ToolbarDensityType \| null` | — | no | `comfortable`, `compact`, `default` |
|
|
26
|
+
| `elevation` | `"" \| 0 \| 1 \| 2 \| 22 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 23 \| 24 \| "1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| "13" \| "14" \| "15" \| "16" \| "17" \| "18" \| "19" \| "20" \| "21" \| "22" \| "23" \| "24" \| null` | — | no | — |
|
|
27
|
+
| `extended` | `boolean \| null` | — | no | — |
|
|
28
|
+
| `extensionClass` | `string \| Record<string, boolean \| undefined>` | — | no | — |
|
|
29
|
+
| `extensionHeight` | `string \| number` | `defaultToolbarExtensionHeight` | no | — |
|
|
30
|
+
| `extensionStyle` | `Record<string, string>` | — | no | — |
|
|
31
|
+
| `height` | `string \| number \| null` | `defaultToolbarContentHeight` | no | — |
|
|
32
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
33
|
+
| `position` | `Position` | — | no | `absolute`, `fixed`, `relative`, `static`, `sticky` |
|
|
34
|
+
| `tag` | `HtmlTagName \| null` | — | no | `a`, `abbr`, `acronym`, `address`, `applet`, `area`, `article`, `aside`, `audio`, `b`, `base`, `basefont`, `bdi`, `bdo`, `big`, `blockquote`, `body`, `br`, `button`, `canvas`, `caption`, `center`, `cite`, `code`, `col`, `colgroup`, `data`, `datalist`, `dd`, `del`, `details`, `dfn`, `dialog`, `dir`, `div`, `dl`, `dt`, `em`, `embed`, `fieldset`, `figcaption`, `figure`, `font`, `footer`, `form`, `frame`, `frameset`, `h1`, `h1> to <h6`, `h2`, `h3`, `h4`, `h5`, `h6`, `head`, `header`, `hr`, `html`, `i`, `iframe`, `img`, `input`, `ins`, `kbd`, `label`, `legend`, `li`, `link`, `main`, `map`, `mark`, `meta`, `meter`, `nav`, `noframes`, `noscript`, `object`, `ol`, `optgroup`, `option`, `output`, `p`, `param`, `picture`, `pre`, `progress`, `q`, `rp`, `rt`, `ruby`, `s`, `samp`, `script`, `section`, `select`, `small`, `source`, `span`, `strike`, `strong`, `style`, `sub`, `summary`, `sup`, `svg`, `table`, `tbody`, `td`, `template`, `textarea`, `tfoot`, `th`, `thead`, `time`, `title`, `tr`, `track`, `tt`, `u`, `ul`, `var`, `video`, `wbr` |
|
|
35
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
36
|
+
| `title` | `string \| null` | — | no | — |
|
|
37
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
38
|
+
|
|
39
|
+
**SToolbar slots**
|
|
40
|
+
|
|
41
|
+
| Slot | Slot props |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| `append` | `{}` |
|
|
44
|
+
| `default` | `{}` |
|
|
45
|
+
| `extension` | `{}` |
|
|
46
|
+
| `prepend` | `{}` |
|
|
47
|
+
|
|
48
|
+
**SToolbar events**
|
|
49
|
+
|
|
50
|
+
None.
|
|
51
|
+
|
|
52
|
+
<!-- generated:api:end SToolbar -->
|
|
53
|
+
|
|
54
|
+
**SToolbar notes**
|
|
55
|
+
|
|
56
|
+
- `color`: Background color (preset or CSS). Child `SButton`s and `SToolbarTitle` adapt to it
|
|
57
|
+
- `colorThreshold`: Contrast threshold for the dark/light text decision
|
|
58
|
+
- `elevation`: Shadow depth
|
|
59
|
+
- `density`: Reduces the main row by 0 / 8 / 16 px and the extension by 0 / 4 / 8 px
|
|
60
|
+
- `height`: Main row height
|
|
61
|
+
- `extended`: Show the extension row
|
|
62
|
+
- `extensionHeight`: Extension row height
|
|
63
|
+
- `extensionClass`: Class for the extension row
|
|
64
|
+
- `extensionStyle`: Style for the extension row
|
|
65
|
+
- `contentClass` / `contentStyle`: Class/style for the main content row
|
|
66
|
+
- `position`: CSS position
|
|
67
|
+
- `outlined` / `underlined`: Border styles
|
|
68
|
+
- `borderRadius`: Border radius
|
|
69
|
+
- `tag`: Root HTML element (default: `'div'`)
|
|
70
|
+
- `default` (slot): Main row content (horizontal flex)
|
|
71
|
+
- `prepend` (slot): Separate **row above** the main row
|
|
72
|
+
- `append` (slot): Separate **row below** the main row (and below the extension)
|
|
73
|
+
- `extension` (slot): Extension row. Only shown with `extended`
|
|
31
74
|
|
|
32
75
|
`title` is declared but **never rendered**. Use `SToolbarTitle`.
|
|
33
76
|
|
|
34
77
|
### Slots
|
|
35
78
|
|
|
36
|
-
| Slot | Description |
|
|
37
|
-
|------|-------------|
|
|
38
|
-
| `default` | Main row content (horizontal flex) |
|
|
39
|
-
| `prepend` | Separate **row above** the main row |
|
|
40
|
-
| `append` | Separate **row below** the main row (and below the extension) |
|
|
41
|
-
| `extension` | Extension row. Only shown with `extended` |
|
|
42
|
-
|
|
43
79
|
The toolbar root is a column flexbox, so `prepend` / `append` are rows, **not** left/right items.
|
|
44
80
|
|
|
45
81
|
No events.
|
|
@@ -48,15 +84,38 @@ No events.
|
|
|
48
84
|
|
|
49
85
|
## SToolbarTitle
|
|
50
86
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
87
|
+
<!-- generated:api:start SToolbarTitle -->
|
|
88
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
89
|
+
|
|
90
|
+
**SToolbarTitle props**
|
|
91
|
+
|
|
92
|
+
| Prop | Type | Default | Required | Values |
|
|
93
|
+
| --- | --- | --- | --- | --- |
|
|
94
|
+
| `color` | `string` | — | no | — |
|
|
95
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
96
|
+
| `tag` | `HtmlTagName \| null` | — | no | `a`, `abbr`, `acronym`, `address`, `applet`, `area`, `article`, `aside`, `audio`, `b`, `base`, `basefont`, `bdi`, `bdo`, `big`, `blockquote`, `body`, `br`, `button`, `canvas`, `caption`, `center`, `cite`, `code`, `col`, `colgroup`, `data`, `datalist`, `dd`, `del`, `details`, `dfn`, `dialog`, `dir`, `div`, `dl`, `dt`, `em`, `embed`, `fieldset`, `figcaption`, `figure`, `font`, `footer`, `form`, `frame`, `frameset`, `h1`, `h1> to <h6`, `h2`, `h3`, `h4`, `h5`, `h6`, `head`, `header`, `hr`, `html`, `i`, `iframe`, `img`, `input`, `ins`, `kbd`, `label`, `legend`, `li`, `link`, `main`, `map`, `mark`, `meta`, `meter`, `nav`, `noframes`, `noscript`, `object`, `ol`, `optgroup`, `option`, `output`, `p`, `param`, `picture`, `pre`, `progress`, `q`, `rp`, `rt`, `ruby`, `s`, `samp`, `script`, `section`, `select`, `small`, `source`, `span`, `strike`, `strong`, `style`, `sub`, `summary`, `sup`, `svg`, `table`, `tbody`, `td`, `template`, `textarea`, `tfoot`, `th`, `thead`, `time`, `title`, `tr`, `track`, `tt`, `u`, `ul`, `var`, `video`, `wbr` |
|
|
97
|
+
| `text` | `string \| null` | — | no | — |
|
|
98
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
99
|
+
|
|
100
|
+
**SToolbarTitle slots**
|
|
101
|
+
|
|
102
|
+
| Slot | Slot props |
|
|
103
|
+
| --- | --- |
|
|
104
|
+
| `default` | `{}` |
|
|
105
|
+
| `text` | `{}` |
|
|
106
|
+
|
|
107
|
+
**SToolbarTitle events**
|
|
108
|
+
|
|
109
|
+
None.
|
|
110
|
+
|
|
111
|
+
<!-- generated:api:end SToolbarTitle -->
|
|
112
|
+
|
|
113
|
+
**SToolbarTitle notes**
|
|
55
114
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
115
|
+
- `text`: Title text (if no slot)
|
|
116
|
+
- `tag`: Root element (default: `'div'`)
|
|
117
|
+
- `default` (slot): Title content
|
|
118
|
+
- `text` (slot): Alternative to the default slot
|
|
60
119
|
|
|
61
120
|
Renders nothing when it has no slot content and no `text`. Its color comes from the parent toolbar.
|
|
62
121
|
|