@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
|
@@ -18,16 +18,16 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/props<AppBar|Navigatio
|
|
|
18
18
|
|
|
19
19
|
## How layouts are linked (read this first)
|
|
20
20
|
|
|
21
|
-
- **`SApp`** is the root. It provides the app state and is itself an *app-level* layout. Wrap the whole app in it (after installing the `createSUI()` plugin).
|
|
21
|
+
- **`SApp`** is the root. It provides the app state and is itself an *app-level* layout. Wrap the whole app in it (after installing the `createSUI()` plugin). It is at least the viewport height (`100dvh`), and an `SLayout` directly inside it grows with it, so don't add your own `min-height: 100vh` wrapper. A direct child with `s_height--fill` grows the same way, so a page root with `s_display__flex s_justify__center s_align__center s_height--fill` centres its content in the viewport (see the `centered-page` recipe).
|
|
22
22
|
- **`SLayout`** creates a layout scope. Children find it by name:
|
|
23
23
|
- SLayout without `name` → children **without `for`** join it as the **app-level** layout (inside `SApp`).
|
|
24
24
|
- SLayout with `name="x"` → **every** child needs `for="x"`. A child without `for` joins the app-level layout instead, so offsets silently break.
|
|
25
25
|
- **App-level vs nested.** A layout is app-level when its name equals the plugin name (`'sui'` by default, so: no `name`) or when it has the `app` prop. A named layout (`name="x"` with no `app` prop on it and its children) is a *nested* layout:
|
|
26
26
|
- `SNavigationDrawer` is `position: absolute` inside the layout (not fixed), and `permanent` has **no effect**.
|
|
27
27
|
- `SFooter` ignores `position`. `SBottomNavigation` is not fixed unless you set `position="fixed"`.
|
|
28
|
-
- `SMain` renders `<section>` with `min-height: 100%` instead of `<main>` with `100vh
|
|
28
|
+
- `SMain` renders `<section>` with `min-height: 100%` instead of `<main>` with `100vh` (minus the app bar and footer heights).
|
|
29
29
|
- Without `SApp`, an unnamed `SLayout` and its children do **not** link up.
|
|
30
|
-
- Below the `md` breakpoint (or with `forceMobile`), a drawer becomes a mobile overlay. It does not push `SMain`, opens by swiping in from the screen edge, and closes on an outside click.
|
|
30
|
+
- Below the `md` breakpoint (or with `forceMobile`), a drawer becomes a mobile overlay. It does not push `SMain`, opens by swiping in from the screen edge, dims what is behind it with a scrim (the page for an app-level drawer, the layout for a nested one), and closes on an outside click or a tap on the scrim.
|
|
31
31
|
|
|
32
32
|
```vue
|
|
33
33
|
<!-- Recommended: app-level layout -->
|
|
@@ -44,66 +44,239 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/props<AppBar|Navigatio
|
|
|
44
44
|
|
|
45
45
|
## SApp / SLayout
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
47
|
+
<!-- generated:api:start SLayout -->
|
|
48
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
49
|
+
|
|
50
|
+
**SLayout props**
|
|
51
|
+
|
|
52
|
+
| Prop | Type | Default | Required | Values |
|
|
53
|
+
| --- | --- | --- | --- | --- |
|
|
54
|
+
| `app` | `boolean` | — | no | — |
|
|
55
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
56
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
57
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
58
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
59
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
60
|
+
| `name` | `string` | — | no | — |
|
|
61
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
62
|
+
|
|
63
|
+
**SLayout slots**
|
|
64
|
+
|
|
65
|
+
| Slot | Slot props |
|
|
66
|
+
| --- | --- |
|
|
67
|
+
| `default` | `{}` |
|
|
68
|
+
|
|
69
|
+
**SLayout events**
|
|
70
|
+
|
|
71
|
+
None.
|
|
72
|
+
|
|
73
|
+
<!-- generated:api:end SLayout -->
|
|
74
|
+
|
|
75
|
+
**SLayout notes**
|
|
76
|
+
|
|
77
|
+
- `name`: Layout name. Children link with `for` (default: plugin name (`'sui'`))
|
|
78
|
+
- `app`: Treat as the app-level layout (default: `true` on SApp, `false` on SLayout)
|
|
79
|
+
- `width` / `height` / `min*` / `max*`: SLayout only: dimensions
|
|
52
80
|
|
|
53
81
|
Slot: `default`. SLayout is a flex column, `position: relative`.
|
|
54
82
|
|
|
83
|
+
<!-- generated:api:start SApp -->
|
|
84
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
85
|
+
|
|
86
|
+
**SApp props**
|
|
87
|
+
|
|
88
|
+
| Prop | Type | Default | Required | Values |
|
|
89
|
+
| --- | --- | --- | --- | --- |
|
|
90
|
+
| `app` | `boolean` | `true` | no | — |
|
|
91
|
+
| `name` | `string` | — | no | — |
|
|
92
|
+
|
|
93
|
+
**SApp slots**
|
|
94
|
+
|
|
95
|
+
| Slot | Slot props |
|
|
96
|
+
| --- | --- |
|
|
97
|
+
| `default` | `{}` |
|
|
98
|
+
|
|
99
|
+
**SApp events**
|
|
100
|
+
|
|
101
|
+
None.
|
|
102
|
+
|
|
103
|
+
<!-- generated:api:end SApp -->
|
|
104
|
+
|
|
55
105
|
---
|
|
56
106
|
|
|
57
107
|
## SAppBar
|
|
58
108
|
|
|
59
109
|
Built on SToolbar. It renders a `<header>`.
|
|
60
110
|
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
|
67
|
-
|
|
|
68
|
-
| `
|
|
69
|
-
| `
|
|
70
|
-
| `
|
|
71
|
-
| `
|
|
72
|
-
| `
|
|
73
|
-
| `
|
|
74
|
-
| `
|
|
75
|
-
| `
|
|
76
|
-
|
|
77
|
-
|
|
111
|
+
<!-- generated:api:start SAppBar -->
|
|
112
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
113
|
+
|
|
114
|
+
**SAppBar props**
|
|
115
|
+
|
|
116
|
+
| Prop | Type | Default | Required | Values |
|
|
117
|
+
| --- | --- | --- | --- | --- |
|
|
118
|
+
| `app` | `boolean` | — | no | — |
|
|
119
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
120
|
+
| `color` | `string` | `"appBar"` | no | — |
|
|
121
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
122
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
123
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
124
|
+
| `density` | `ToolbarDensityType \| null` | — | no | `comfortable`, `compact`, `default` |
|
|
125
|
+
| `elevateOnScroll` | `boolean` | — | no | — |
|
|
126
|
+
| `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 | — |
|
|
127
|
+
| `extended` | `boolean \| null` | — | no | — |
|
|
128
|
+
| `extensionClass` | `string \| Record<string, boolean \| undefined>` | — | no | — |
|
|
129
|
+
| `extensionHeight` | `string \| number` | `defaultToolbarExtensionHeight` | no | — |
|
|
130
|
+
| `extensionStyle` | `Record<string, string>` | — | no | — |
|
|
131
|
+
| `fixedExtension` | `boolean` | — | no | — |
|
|
132
|
+
| `for` | `string` | — | no | — |
|
|
133
|
+
| `height` | `string \| number \| null` | `defaultToolbarContentHeight` | no | — |
|
|
134
|
+
| `hideOnScroll` | `boolean` | — | no | — |
|
|
135
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
136
|
+
| `position` | `Position` | — | no | `absolute`, `fixed`, `relative`, `static`, `sticky` |
|
|
137
|
+
| `scrollBehavior` | `"auto" \| "smooth"` | — | no | `auto`, `smooth` |
|
|
138
|
+
| `scrollTarget` | `string \| HTMLElement` | — | no | — |
|
|
139
|
+
| `scrollThreshold` | `number` | `defaultToolbarContentHeight` | no | — |
|
|
140
|
+
| `tag` | `HtmlTagName \| null` | `"header"` | 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` |
|
|
141
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
142
|
+
| `title` | `string \| null` | — | no | — |
|
|
143
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
144
|
+
|
|
145
|
+
**SAppBar slots**
|
|
146
|
+
|
|
147
|
+
| Slot | Slot props |
|
|
148
|
+
| --- | --- |
|
|
149
|
+
| `default` | `{}` |
|
|
150
|
+
| `extension` | `{}` |
|
|
151
|
+
|
|
152
|
+
**SAppBar events**
|
|
153
|
+
|
|
154
|
+
None.
|
|
155
|
+
|
|
156
|
+
<!-- generated:api:end SAppBar -->
|
|
157
|
+
|
|
158
|
+
**SAppBar notes**
|
|
159
|
+
|
|
160
|
+
- `for` / `app`: Layout link (see above)
|
|
161
|
+
- `position`: `SMain` adds a top margin only when `fixed` (default: `undefined` (in flow))
|
|
162
|
+
- `elevateOnScroll`: Shadow after scrolling (needs `fixed`/`absolute`)
|
|
163
|
+
- `hideOnScroll`: Hide on scroll down, show on scroll up
|
|
164
|
+
- `scrollTarget` / `scrollThreshold`: Scroll source and threshold (default: window / `64`)
|
|
165
|
+
- `height`: Bar height
|
|
166
|
+
- `density`: Height preset
|
|
167
|
+
- `extended`: Show the extension row (default: auto (`true` when `#extension` is used))
|
|
168
|
+
- `extensionHeight`: Extension height
|
|
169
|
+
- `fixedExtension`: Keep only the extension visible (fixed)
|
|
170
|
+
- `title`: Title text
|
|
171
|
+
- `color`: Background
|
|
172
|
+
- `elevation`, `outlined`, `underlined`, `borderRadius`, `tag`: Shared props (default: `tag: 'header'`)
|
|
173
|
+
|
|
174
|
+
**Slots:** `default`, `extension`. SAppBar does **not** forward `prepend`/`append`, so put everything in `default` and use `SSpacer`. The content keeps an inset from the bar edges (the title and any other first/last item 16px, toolbar buttons 10px); no extra padding is needed.
|
|
78
175
|
|
|
79
176
|
## SAppBarTitle
|
|
80
177
|
|
|
81
178
|
Props: `text`, `color`, `tag`. Slots: `default` (or `text`).
|
|
82
179
|
|
|
180
|
+
<!-- generated:api:start SAppBarTitle -->
|
|
181
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
182
|
+
|
|
183
|
+
**SAppBarTitle props**
|
|
184
|
+
|
|
185
|
+
| Prop | Type | Default | Required | Values |
|
|
186
|
+
| --- | --- | --- | --- | --- |
|
|
187
|
+
| `color` | `string` | — | no | — |
|
|
188
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
189
|
+
| `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` |
|
|
190
|
+
| `text` | `string \| null` | — | no | — |
|
|
191
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
192
|
+
|
|
193
|
+
**SAppBarTitle slots**
|
|
194
|
+
|
|
195
|
+
| Slot | Slot props |
|
|
196
|
+
| --- | --- |
|
|
197
|
+
| `default` | `{}` |
|
|
198
|
+
| `text` | `{}` |
|
|
199
|
+
|
|
200
|
+
**SAppBarTitle events**
|
|
201
|
+
|
|
202
|
+
None.
|
|
203
|
+
|
|
204
|
+
<!-- generated:api:end SAppBarTitle -->
|
|
205
|
+
|
|
83
206
|
---
|
|
84
207
|
|
|
85
208
|
## SNavigationDrawer
|
|
86
209
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
|
93
|
-
|
|
|
94
|
-
| `
|
|
95
|
-
| `
|
|
96
|
-
| `
|
|
97
|
-
| `
|
|
98
|
-
| `
|
|
99
|
-
| `
|
|
100
|
-
| `
|
|
101
|
-
| `
|
|
102
|
-
| `
|
|
103
|
-
| `
|
|
104
|
-
| `
|
|
105
|
-
| `
|
|
106
|
-
| `
|
|
210
|
+
<!-- generated:api:start SNavigationDrawer -->
|
|
211
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
212
|
+
|
|
213
|
+
**SNavigationDrawer props**
|
|
214
|
+
|
|
215
|
+
| Prop | Type | Default | Required | Values |
|
|
216
|
+
| --- | --- | --- | --- | --- |
|
|
217
|
+
| `activator` | `string \| HTMLElement \| ComponentPublicInstance \| null` | — | no | — |
|
|
218
|
+
| `app` | `boolean` | — | no | — |
|
|
219
|
+
| `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 | — |
|
|
220
|
+
| `expandOnHover` | `boolean` | — | no | — |
|
|
221
|
+
| `for` | `string` | — | no | — |
|
|
222
|
+
| `forceMobile` | `boolean` | — | no | — |
|
|
223
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
224
|
+
| `hideOverlay` | `boolean` | — | no | — |
|
|
225
|
+
| `location` | `LocationRaw` | — | no | — |
|
|
226
|
+
| `maxWidth` | `number` | — | no | — |
|
|
227
|
+
| `minWidth` | `number` | — | no | — |
|
|
228
|
+
| `miniVariant` | `boolean` | — | no | — |
|
|
229
|
+
| `miniVariantWidth` | `string \| number` | — | no | — |
|
|
230
|
+
| `modelValue` | `boolean` | — | no | — |
|
|
231
|
+
| `offsetX` | `number \| null` | — | no | — |
|
|
232
|
+
| `offsetY` | `number \| null` | — | no | — |
|
|
233
|
+
| `permanent` | `boolean` | — | no | — |
|
|
234
|
+
| `persistent` | `boolean` | — | no | — |
|
|
235
|
+
| `position` | `Position` | — | no | `absolute`, `fixed`, `relative`, `static`, `sticky` |
|
|
236
|
+
| `resizable` | `boolean` | — | no | — |
|
|
237
|
+
| `tag` | `"div" \| "nav" \| "section" \| null` | — | no | `div`, `nav`, `section` |
|
|
238
|
+
| `touchless` | `boolean` | — | no | — |
|
|
239
|
+
| `width` | `string \| number` | — | no | — |
|
|
240
|
+
|
|
241
|
+
**SNavigationDrawer slots**
|
|
242
|
+
|
|
243
|
+
| Slot | Slot props |
|
|
244
|
+
| --- | --- |
|
|
245
|
+
| `append` | `{ class: string; }` |
|
|
246
|
+
| `default` | `{ on: { click: () => void; transitionend: (e: Event) => void; mouseenter: () => void; mouseleave: () => void; }; }` |
|
|
247
|
+
| `prepend` | `{ class: string; }` |
|
|
248
|
+
|
|
249
|
+
**SNavigationDrawer events**
|
|
250
|
+
|
|
251
|
+
| Event | Payload |
|
|
252
|
+
| --- | --- |
|
|
253
|
+
| `transitionend` | `[value: Event]` |
|
|
254
|
+
| `update:miniVariant` | `[value: boolean]` |
|
|
255
|
+
| `update:modelValue` | `[value: boolean \| undefined]` |
|
|
256
|
+
| `update:width` | `[value: number]` |
|
|
257
|
+
|
|
258
|
+
<!-- generated:api:end SNavigationDrawer -->
|
|
259
|
+
|
|
260
|
+
**SNavigationDrawer notes**
|
|
261
|
+
|
|
262
|
+
- `for` / `app`: Layout link
|
|
263
|
+
- `v-model`: Open state. At mount and on every resize it opens itself on desktop and closes itself on mobile, whatever the starting value (unless `persistent`)
|
|
264
|
+
- `location`: Side. `bottom` is always mobile-style (default: `'left'`)
|
|
265
|
+
- `permanent`: Always open on desktop (**app-level layout only**)
|
|
266
|
+
- `persistent`: Desktop: ignore outside clicks and resizes
|
|
267
|
+
- `miniVariant`: Collapsed width (`v-model:mini-variant`)
|
|
268
|
+
- `miniVariantWidth`: Mini width (set it, e.g. `56`) (default: `256` when not numeric)
|
|
269
|
+
- `expandOnHover`: Mini until hovered
|
|
270
|
+
- `forceMobile`: Use mobile behaviour on desktop
|
|
271
|
+
- `touchless`: Disable swipe and hover handlers
|
|
272
|
+
- `activator`: Only **excluded from click-outside**. It does **not** toggle the drawer
|
|
273
|
+
- `width`: Width. Use `v-model:width` with `resizable` (default: `256`)
|
|
274
|
+
- `resizable`: Drag handle on the inner edge (desktop, not mini). Arrow keys resize by 16px
|
|
275
|
+
- `minWidth` / `maxWidth`: Resize limits (default: `200` / `720`)
|
|
276
|
+
- `height`: Height. App-level = the drawer has `app`, or its `for` is the app's name (default: `100vh` when app-level, else `100%`)
|
|
277
|
+
- `position`, `elevation`: Shared props
|
|
278
|
+
- `tag`: Root element (default: `nav` when app-level, else `aside`)
|
|
279
|
+
- `hideOverlay`: Don't dim the page (or the nested layout) behind an open mobile drawer
|
|
107
280
|
|
|
108
281
|
**Slots:** `prepend`, `default` (scope `{ on }`: `click`, `transitionend`, `mouseenter`, `mouseleave` handlers), `append`.
|
|
109
282
|
**Events:** `update:modelValue`, `update:width` (resize end), `update:miniVariant`, `transitionend`.
|
|
@@ -122,30 +295,138 @@ A left and a right drawer can share one layout. Each one offsets its own side of
|
|
|
122
295
|
|
|
123
296
|
Props: `for`, `app`, `tag` (default `main` at app level, `section` otherwise). Slot: `default`. Margins follow the drawers (left/right), a `fixed` app bar (top), and the bottom navigation (app level) or footer (nested).
|
|
124
297
|
|
|
298
|
+
<!-- generated:api:start SMain -->
|
|
299
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
300
|
+
|
|
301
|
+
**SMain props**
|
|
302
|
+
|
|
303
|
+
| Prop | Type | Default | Required | Values |
|
|
304
|
+
| --- | --- | --- | --- | --- |
|
|
305
|
+
| `app` | `boolean` | — | no | — |
|
|
306
|
+
| `for` | `string` | — | no | — |
|
|
307
|
+
| `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` |
|
|
308
|
+
|
|
309
|
+
**SMain slots**
|
|
310
|
+
|
|
311
|
+
| Slot | Slot props |
|
|
312
|
+
| --- | --- |
|
|
313
|
+
| `default` | `{}` |
|
|
314
|
+
|
|
315
|
+
**SMain events**
|
|
316
|
+
|
|
317
|
+
None.
|
|
318
|
+
|
|
319
|
+
<!-- generated:api:end SMain -->
|
|
320
|
+
|
|
125
321
|
## SFooter
|
|
126
322
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
|
133
|
-
|
|
|
323
|
+
<!-- generated:api:start SFooter -->
|
|
324
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
325
|
+
|
|
326
|
+
**SFooter props**
|
|
327
|
+
|
|
328
|
+
| Prop | Type | Default | Required | Values |
|
|
329
|
+
| --- | --- | --- | --- | --- |
|
|
330
|
+
| `app` | `boolean` | — | no | — |
|
|
331
|
+
| `color` | `string` | — | no | — |
|
|
332
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
333
|
+
| `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 | — |
|
|
334
|
+
| `for` | `string` | — | no | — |
|
|
335
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
336
|
+
| `inset` | `boolean` | `false` | no | — |
|
|
337
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
338
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
339
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
340
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
341
|
+
| `padless` | `boolean` | `false` | no | — |
|
|
342
|
+
| `position` | `Position` | — | no | `absolute`, `fixed`, `relative`, `static`, `sticky` |
|
|
343
|
+
| `tag` | `"div" \| "footer" \| null` | `"footer"` | no | `div`, `footer` |
|
|
344
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
345
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
346
|
+
|
|
347
|
+
**SFooter slots**
|
|
348
|
+
|
|
349
|
+
| Slot | Slot props |
|
|
350
|
+
| --- | --- |
|
|
351
|
+
| `default` | `{}` |
|
|
352
|
+
|
|
353
|
+
**SFooter events**
|
|
354
|
+
|
|
355
|
+
None.
|
|
356
|
+
|
|
357
|
+
<!-- generated:api:end SFooter -->
|
|
358
|
+
|
|
359
|
+
**SFooter notes**
|
|
360
|
+
|
|
361
|
+
- `for` / `app`: Layout link
|
|
362
|
+
- `position`: Applied only in an app-level layout
|
|
363
|
+
- `inset` / `padless`: Inset / no padding
|
|
364
|
+
- `color`, `elevation`, `height`, `width`, `min*`/`max*`: Shared props
|
|
365
|
+
- `tag`: Root element
|
|
134
366
|
|
|
135
367
|
Slot: `default`. Its width tracks the drawers.
|
|
136
368
|
|
|
137
369
|
## SBottomNavigation
|
|
138
370
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
| `
|
|
147
|
-
| `
|
|
148
|
-
| `
|
|
371
|
+
<!-- generated:api:start SBottomNavigation -->
|
|
372
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
373
|
+
|
|
374
|
+
**SBottomNavigation props**
|
|
375
|
+
|
|
376
|
+
| Prop | Type | Default | Required | Values |
|
|
377
|
+
| --- | --- | --- | --- | --- |
|
|
378
|
+
| `activeClass` | `string` | — | no | — |
|
|
379
|
+
| `app` | `boolean` | — | no | — |
|
|
380
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
381
|
+
| `bordered` | `boolean` | — | no | — |
|
|
382
|
+
| `continuous` | `boolean` | — | no | — |
|
|
383
|
+
| `dense` | `boolean` | — | no | — |
|
|
384
|
+
| `for` | `string` | — | no | — |
|
|
385
|
+
| `grow` | `boolean` | — | no | — |
|
|
386
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
387
|
+
| `hideOnScroll` | `boolean` | — | no | — |
|
|
388
|
+
| `horizontal` | `boolean` | — | no | — |
|
|
389
|
+
| `inputValue` | `boolean` | — | no | — |
|
|
390
|
+
| `mandatory` | `boolean` | — | no | — |
|
|
391
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
392
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
393
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
394
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
395
|
+
| `modelValue` | `GroupItemValue` | — | no | — |
|
|
396
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
397
|
+
| `position` | `Position` | — | no | `absolute`, `fixed`, `relative`, `static`, `sticky` |
|
|
398
|
+
| `scrollBehavior` | `"auto" \| "smooth"` | — | no | `auto`, `smooth` |
|
|
399
|
+
| `scrollTarget` | `string \| HTMLElement` | — | no | — |
|
|
400
|
+
| `scrollThreshold` | `number` | — | no | — |
|
|
401
|
+
| `shift` | `boolean` | — | no | — |
|
|
402
|
+
| `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` |
|
|
403
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
404
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
405
|
+
|
|
406
|
+
**SBottomNavigation slots**
|
|
407
|
+
|
|
408
|
+
| Slot | Slot props |
|
|
409
|
+
| --- | --- |
|
|
410
|
+
| `default` | `{}` |
|
|
411
|
+
|
|
412
|
+
**SBottomNavigation events**
|
|
413
|
+
|
|
414
|
+
| Event | Payload |
|
|
415
|
+
| --- | --- |
|
|
416
|
+
| `update:modelValue` | `[value: GroupItemValue \| undefined]` |
|
|
417
|
+
|
|
418
|
+
<!-- generated:api:end SBottomNavigation -->
|
|
419
|
+
|
|
420
|
+
**SBottomNavigation notes**
|
|
421
|
+
|
|
422
|
+
- `v-model`: `value` of the selected child `SButton`
|
|
423
|
+
- `height`: **Set it.** Without it the bar collapses and SMain gets no bottom offset
|
|
424
|
+
- `activeClass`: Class added to the selected button. **There is no active styling without it**
|
|
425
|
+
- `mandatory`: Always keep one selected
|
|
426
|
+
- `grow` / `shift` / `horizontal` / `dense` / `bordered`: Layout variants
|
|
427
|
+
- `hideOnScroll`: Hide on scroll. It also overwrites `v-model` with a boolean, so avoid combining it with selection
|
|
428
|
+
- `position`: Set `fixed` in a nested layout (default: fixed at app level)
|
|
429
|
+
- `for` / `app`, `tag`, `width`, border props: Shared props
|
|
149
430
|
|
|
150
431
|
Slot: `default`. Use `SButton`s with a `value`.
|
|
151
432
|
|
|
@@ -166,13 +447,42 @@ The column component is **`SColumn`**. There is no `SCol`.
|
|
|
166
447
|
|
|
167
448
|
**SRow:**
|
|
168
449
|
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
|
175
|
-
|
|
|
450
|
+
<!-- generated:api:start SRow -->
|
|
451
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
452
|
+
|
|
453
|
+
**SRow props**
|
|
454
|
+
|
|
455
|
+
| Prop | Type | Default | Required | Values |
|
|
456
|
+
| --- | --- | --- | --- | --- |
|
|
457
|
+
| `align` | `GridAlignPropertyType \| null` | — | no | `baseline`, `center`, `end`, `start`, `stretch` |
|
|
458
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
459
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
460
|
+
| `dense` | `boolean \| null` | — | no | — |
|
|
461
|
+
| `fillHeight` | `boolean \| null` | — | no | — |
|
|
462
|
+
| `gap` | `string \| number \| null` | — | no | — |
|
|
463
|
+
| `justify` | `GridJustifyPropertyType \| null` | — | no | `center`, `end`, `spaceAround`, `spaceBetween`, `start` |
|
|
464
|
+
| `noGutters` | `boolean \| null` | — | no | — |
|
|
465
|
+
| `noOuterGutters` | `boolean \| null` | — | no | — |
|
|
466
|
+
|
|
467
|
+
**SRow slots**
|
|
468
|
+
|
|
469
|
+
| Slot | Slot props |
|
|
470
|
+
| --- | --- |
|
|
471
|
+
| `default` | `{}` |
|
|
472
|
+
|
|
473
|
+
**SRow events**
|
|
474
|
+
|
|
475
|
+
None.
|
|
476
|
+
|
|
477
|
+
<!-- generated:api:end SRow -->
|
|
478
|
+
|
|
479
|
+
**SRow notes**
|
|
480
|
+
|
|
481
|
+
- `align`: Cross-axis
|
|
482
|
+
- `justify`: Main-axis (**camelCase**)
|
|
483
|
+
- `noGutters` / `noOuterGutters` / `dense` / `fillHeight`: Gutters / height
|
|
484
|
+
- `gap`: Custom gap (replaces gutters)
|
|
485
|
+
- `contentClass` / `contentStyle`: Inner wrapper class/style
|
|
176
486
|
|
|
177
487
|
**SColumn:** `cols`, `sm`, `md`, `lg` (`1`–`12 \| 'auto' \| 'grow'`), `order` (number), `alignSelf`, `contentClass`/`contentStyle`. There is no `xl`.
|
|
178
488
|
|
|
@@ -187,6 +497,82 @@ The column component is **`SColumn`**. There is no `SCol`.
|
|
|
187
497
|
</SContainer>
|
|
188
498
|
```
|
|
189
499
|
|
|
500
|
+
<!-- generated:api:start SContainer -->
|
|
501
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
502
|
+
|
|
503
|
+
**SContainer props**
|
|
504
|
+
|
|
505
|
+
| Prop | Type | Default | Required | Values |
|
|
506
|
+
| --- | --- | --- | --- | --- |
|
|
507
|
+
| `color` | `string` | — | no | — |
|
|
508
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
509
|
+
| `fill` | `boolean` | — | no | — |
|
|
510
|
+
| `fluid` | `boolean` | — | no | — |
|
|
511
|
+
| `narrow` | `boolean` | — | no | — |
|
|
512
|
+
| `padless` | `boolean` | — | no | — |
|
|
513
|
+
| `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` |
|
|
514
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
515
|
+
| `wide` | `boolean` | — | no | — |
|
|
516
|
+
|
|
517
|
+
**SContainer slots**
|
|
518
|
+
|
|
519
|
+
| Slot | Slot props |
|
|
520
|
+
| --- | --- |
|
|
521
|
+
| `default` | `{}` |
|
|
522
|
+
|
|
523
|
+
**SContainer events**
|
|
524
|
+
|
|
525
|
+
None.
|
|
526
|
+
|
|
527
|
+
<!-- generated:api:end SContainer -->
|
|
528
|
+
|
|
529
|
+
<!-- generated:api:start SColumn -->
|
|
530
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
531
|
+
|
|
532
|
+
**SColumn props**
|
|
533
|
+
|
|
534
|
+
| Prop | Type | Default | Required | Values |
|
|
535
|
+
| --- | --- | --- | --- | --- |
|
|
536
|
+
| `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` |
|
|
537
|
+
| `cols` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
538
|
+
| `contentClass` | `string \| string[] \| Record<string, boolean>` | — | no | — |
|
|
539
|
+
| `contentStyle` | `StyleValue` | — | no | — |
|
|
540
|
+
| `lg` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
541
|
+
| `md` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
542
|
+
| `order` | `number \| null` | — | no | — |
|
|
543
|
+
| `sm` | `"1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "10" \| "11" \| "12" \| ColumnNumber \| null` | — | no | — |
|
|
544
|
+
|
|
545
|
+
**SColumn slots**
|
|
546
|
+
|
|
547
|
+
| Slot | Slot props |
|
|
548
|
+
| --- | --- |
|
|
549
|
+
| `default` | `{}` |
|
|
550
|
+
|
|
551
|
+
**SColumn events**
|
|
552
|
+
|
|
553
|
+
None.
|
|
554
|
+
|
|
555
|
+
<!-- generated:api:end SColumn -->
|
|
556
|
+
|
|
557
|
+
<!-- generated:api:start SSpacer -->
|
|
558
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
559
|
+
|
|
560
|
+
**SSpacer props**
|
|
561
|
+
|
|
562
|
+
None.
|
|
563
|
+
|
|
564
|
+
**SSpacer slots**
|
|
565
|
+
|
|
566
|
+
| Slot | Slot props |
|
|
567
|
+
| --- | --- |
|
|
568
|
+
| `default` | `{}` |
|
|
569
|
+
|
|
570
|
+
**SSpacer events**
|
|
571
|
+
|
|
572
|
+
None.
|
|
573
|
+
|
|
574
|
+
<!-- generated:api:end SSpacer -->
|
|
575
|
+
|
|
190
576
|
---
|
|
191
577
|
|
|
192
578
|
## Full example
|
|
@@ -224,3 +610,4 @@ The column component is **`SColumn`**. There is no `SCol`.
|
|
|
224
610
|
| `<SCol>` | `<SColumn>` |
|
|
225
611
|
| `<SBottomNavigation v-model="tab">` with no `height`/`active-class` | Set `:height` and `active-class` |
|
|
226
612
|
| `<SAppBar elevate-on-scroll>` with no position | Add `position="fixed"` |
|
|
613
|
+
| `padding-top: env(safe-area-inset-top)` on a fixed `SAppBar` / `SBottomNavigation` / mobile drawer | They pad by the iPhone safe areas themselves; only add `viewport-fit=cover` to the viewport meta (getting-started skill). Your own `env()` padding doubles the inset |
|