@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,43 +6,82 @@ Button with variants, preset sizes, colors, loading state and link behavior.
|
|
|
6
6
|
|
|
7
7
|
Types: `node_modules/@khsura/sui/@types/definitions/props/propsButton.d.ts`
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
| `
|
|
17
|
-
| `
|
|
18
|
-
| `
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `disabled` | `boolean` |
|
|
22
|
-
| `elevation` | `0
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
|
38
|
-
|
|
39
|
-
| `
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
|
44
|
-
|
|
45
|
-
|
|
9
|
+
<!-- generated:api:start SButton -->
|
|
10
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
11
|
+
|
|
12
|
+
**SButton props**
|
|
13
|
+
|
|
14
|
+
| Prop | Type | Default | Required | Values |
|
|
15
|
+
| --- | --- | --- | --- | --- |
|
|
16
|
+
| `activeClass` | `string \| null` | — | no | — |
|
|
17
|
+
| `block` | `boolean` | — | no | — |
|
|
18
|
+
| `borderRadius` | `` number \| "tile" \| "rounded" \| `${number}em` \| `${number}px` \| `${number}rem` \| `${number}%` \| `${number}vh` \| `${number}vw` \| null `` | — | no | — |
|
|
19
|
+
| `color` | `string` | — | no | — |
|
|
20
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
21
|
+
| `disabled` | `boolean \| null` | — | no | — |
|
|
22
|
+
| `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 | — |
|
|
23
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
24
|
+
| `href` | `string \| null` | — | no | — |
|
|
25
|
+
| `loading` | `boolean` | — | no | — |
|
|
26
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
27
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
28
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
29
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
30
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
31
|
+
| `readonly` | `boolean \| null` | — | no | — |
|
|
32
|
+
| `rel` | `string \| null` | — | no | — |
|
|
33
|
+
| `rounded` | `boolean` | — | no | — |
|
|
34
|
+
| `selected` | `boolean` | — | no | — |
|
|
35
|
+
| `size` | `SizePropertyType` | — | no | `default`, `extra`, `large`, `mini`, `small` |
|
|
36
|
+
| `tag` | `"a" \| "button" \| null` | `"button"` | no | `a`, `button` |
|
|
37
|
+
| `target` | `"_blank" \| "_self" \| "_parent" \| "_top"` | — | no | `_blank`, `_parent`, `_self`, `_top` |
|
|
38
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
39
|
+
| `to` | `LinkLocation \| null` | — | no | — |
|
|
40
|
+
| `type` | `ButtonTypeType` | — | no | `button`, `reset`, `submit` |
|
|
41
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
42
|
+
| `value` | `string \| number \| boolean` | — | no | — |
|
|
43
|
+
| `variant` | `"text" \| "icon" \| "fab" \| null` | — | no | `fab`, `icon`, `text` |
|
|
44
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
45
|
+
|
|
46
|
+
**SButton slots**
|
|
47
|
+
|
|
48
|
+
| Slot | Slot props |
|
|
49
|
+
| --- | --- |
|
|
50
|
+
| `default` | `{}` |
|
|
51
|
+
|
|
52
|
+
**SButton events**
|
|
53
|
+
|
|
54
|
+
| Event | Payload |
|
|
55
|
+
| --- | --- |
|
|
56
|
+
| `click` | `[value: Event]` |
|
|
57
|
+
|
|
58
|
+
<!-- generated:api:end SButton -->
|
|
59
|
+
|
|
60
|
+
**SButton notes**
|
|
61
|
+
|
|
62
|
+
- `color`: Preset name (`primary`, `secondary`, `error`, ...) or any CSS color
|
|
63
|
+
- `colorThreshold`: Luminance threshold for automatic light/dark text
|
|
64
|
+
- `variant`: `fab` = floating action button, `text` = no background, `icon` = circular icon button. No other values exist
|
|
65
|
+
- `size`: Preset size
|
|
66
|
+
- `type`: HTML button `type` (default: `'button'` (when unset))
|
|
67
|
+
- `loading`: Replaces the content with a spinner and disables the button
|
|
68
|
+
- `block`: Full width. A block button does not shrink, so two block buttons side by side in one flex row overflow — put each in its own `SColumn`
|
|
69
|
+
- `rounded`: Pill shape (ignored for `variant="icon"`)
|
|
70
|
+
- `disabled`: Disable interaction
|
|
71
|
+
- `elevation`: Shadow depth
|
|
72
|
+
- `outlined`: Border style, text-colored
|
|
73
|
+
- `underlined`: Underlined style
|
|
74
|
+
- `borderRadius`: Custom radius (`8`, `'8px'`, `'1rem'`, ...)
|
|
75
|
+
- `href`: Renders an `<a href>`
|
|
76
|
+
- `to`: Renders a `router-link` when the app uses vue-router; without it, a plain `<a href>` (a route given by `name` gets no `href`, so pass a path)
|
|
77
|
+
- `target`: Only applied with `href`
|
|
78
|
+
- `rel`: Only applied with `href`
|
|
79
|
+
- `tag`: Root tag when neither `href` nor `to` is set
|
|
80
|
+
- `width` / `height`: Dimensions
|
|
81
|
+
- `minWidth` / `maxWidth` / `minHeight` / `maxHeight`: Constraints
|
|
82
|
+
- `value`: Selection value when used inside `SBottomNavigation`
|
|
83
|
+
- `click` (event): Native click
|
|
84
|
+
- `default` (slot): Label / content (hidden while `loading`)
|
|
46
85
|
|
|
47
86
|
## Usage
|
|
48
87
|
|
|
@@ -7,43 +7,73 @@ Calendar with month and week views, events, and prev/next navigation. (`SCalenda
|
|
|
7
7
|
|
|
8
8
|
Types: `node_modules/@khsura/sui/@types/definitions/props/propsCalendar.d.ts`
|
|
9
9
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
|
16
|
-
|
|
|
17
|
-
| `
|
|
18
|
-
| `color` | `string` |
|
|
19
|
-
| `
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
10
|
+
<!-- generated:api:start SCalendar -->
|
|
11
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
12
|
+
|
|
13
|
+
**SCalendar props**
|
|
14
|
+
|
|
15
|
+
| Prop | Type | Default | Required | Values |
|
|
16
|
+
| --- | --- | --- | --- | --- |
|
|
17
|
+
| `allDayRows` | `number` | — | no | — |
|
|
18
|
+
| `color` | `string` | — | no | — |
|
|
19
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
20
|
+
| `eventColor` | `((event: T) => string)` | — | no | — |
|
|
21
|
+
| `eventOverlapMode` | `"stacked" \| "column"` | — | no | `column`, `stacked` |
|
|
22
|
+
| `events` | `T[]` | — | no | — |
|
|
23
|
+
| `focus` | `string` | — | no | — |
|
|
24
|
+
| `hideHeader` | `boolean` | — | no | — |
|
|
25
|
+
| `longWeekdays` | `boolean` | — | no | — |
|
|
26
|
+
| `minWeeks` | `number` | — | no | — |
|
|
27
|
+
| `shortMonths` | `boolean` | — | no | — |
|
|
28
|
+
| `showMonthOnFirst` | `boolean` | — | no | — |
|
|
29
|
+
| `showWeek` | `boolean` | — | no | — |
|
|
30
|
+
| `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` |
|
|
31
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
32
|
+
| `type` | `"month" \| "week"` | `"month"` | no | `month`, `week` |
|
|
33
|
+
|
|
34
|
+
**SCalendar slots**
|
|
35
|
+
|
|
36
|
+
| Slot | Slot props |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `event` | `{ event: CalendarEventExtended<T>; }` |
|
|
39
|
+
|
|
40
|
+
**SCalendar events**
|
|
41
|
+
|
|
42
|
+
| Event | Payload |
|
|
43
|
+
| --- | --- |
|
|
44
|
+
| `change` | `[{ start: CalendarDate; end: CalendarDate; }]` |
|
|
45
|
+
| `click:date` | `[{ date: CalendarDate; events: T[]; }]` |
|
|
46
|
+
| `click:event` | `[{ date: CalendarDate; event: T; }]` |
|
|
47
|
+
| `click:time` | `[{ date: CalendarDate; events: T[]; }]` |
|
|
48
|
+
| `update:focus` | `[value: string \| undefined]` |
|
|
49
|
+
|
|
50
|
+
<!-- generated:api:end SCalendar -->
|
|
51
|
+
|
|
52
|
+
**SCalendar notes**
|
|
53
|
+
|
|
54
|
+
- `type`: View. Set it once — see Gotchas
|
|
55
|
+
- `focus` (`v-model:focus`): Focused date; invalid/empty → today (default: today)
|
|
56
|
+
- `events`: Events to display
|
|
57
|
+
- `eventColor`: Per-event color (otherwise `event.color`)
|
|
58
|
+
- `color`: Highlight color of the focused date
|
|
59
|
+
- `theme` / `colorThreshold`: Theme override / text-contrast threshold
|
|
60
|
+
- `hideHeader`: *Week view:* hide the weekday header
|
|
61
|
+
- `showWeek`: *Week view:* week-number column
|
|
62
|
+
- `longWeekdays`: *Week view:* full weekday names
|
|
63
|
+
- `showMonthOnFirst`: *Week view:* month name on the 1st
|
|
64
|
+
- `shortMonths`: *Week view:* abbreviated month names
|
|
65
|
+
- `minWeeks`: *Week view:* minimum weeks rendered (default: `1`)
|
|
66
|
+
- `eventOverlapMode`: *Week view:* layout of overlapping timed events (default: `'column'`)
|
|
67
|
+
- `allDayRows`: *Week view:* all-day rows before "more" (default: `7`)
|
|
68
|
+
- `update:focus` (event): Focus changed
|
|
69
|
+
- `change` (event): Focus changed (navigation or date click); range of the new month/week. **Not emitted on mount**
|
|
70
|
+
- `click:date` (event): Date clicked (also moves focus there)
|
|
71
|
+
- `click:event` (event): Event clicked
|
|
72
|
+
- `click:time` (event): Time slot clicked (week view)
|
|
73
|
+
- `event` (slot): **Month view only** — custom event bar content. `event` has extra `isStartDate`, `isEndDate`, `isWeekStart`, `isWeekEnd`
|
|
28
74
|
|
|
29
75
|
The week-view props have no effect in month view. `tag` is typed but ignored (root is always a `div`).
|
|
30
76
|
|
|
31
|
-
## Events
|
|
32
|
-
|
|
33
|
-
| Event | Payload | Description |
|
|
34
|
-
|-------|---------|-------------|
|
|
35
|
-
| `update:focus` | `string` | Focus changed |
|
|
36
|
-
| `change` | `{ start: CalendarDate, end: CalendarDate }` | Focus changed (navigation or date click); range of the new month/week. **Not emitted on mount** |
|
|
37
|
-
| `click:date` | `{ date: CalendarDate, events: CalendarEvent[] }` | Date clicked (also moves focus there) |
|
|
38
|
-
| `click:event` | `{ date: CalendarDate, event: CalendarEvent }` | Event clicked |
|
|
39
|
-
| `click:time` | `{ date: CalendarDate, events: CalendarEvent[] }` | Time slot clicked (week view) |
|
|
40
|
-
|
|
41
|
-
## Slots
|
|
42
|
-
|
|
43
|
-
| Slot | Scoped data | Description |
|
|
44
|
-
|------|-------------|-------------|
|
|
45
|
-
| `event` | `{ event }` | **Month view only** — custom event bar content. `event` has extra `isStartDate`, `isEndDate`, `isWeekStart`, `isWeekEnd` |
|
|
46
|
-
|
|
47
77
|
## Exposed (template ref)
|
|
48
78
|
|
|
49
79
|
```ts
|
|
@@ -10,31 +10,62 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/propsCard.d.ts`
|
|
|
10
10
|
|
|
11
11
|
## SCard
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `href` | `string` |
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
|
36
|
-
|
|
37
|
-
| `
|
|
13
|
+
<!-- generated:api:start SCard -->
|
|
14
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
15
|
+
|
|
16
|
+
**SCard 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
|
+
| `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 | — |
|
|
24
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
25
|
+
| `href` | `string \| null` | — | no | — |
|
|
26
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
27
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
28
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
29
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
30
|
+
| `outlined` | `boolean \| null` | — | no | — |
|
|
31
|
+
| `rel` | `string \| null` | — | no | — |
|
|
32
|
+
| `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` |
|
|
33
|
+
| `target` | `"_blank" \| "_self" \| "_parent" \| "_top"` | — | no | `_blank`, `_parent`, `_self`, `_top` |
|
|
34
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
35
|
+
| `to` | `LinkLocation \| null` | — | no | — |
|
|
36
|
+
| `underlined` | `boolean \| null` | — | no | — |
|
|
37
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
38
|
+
|
|
39
|
+
**SCard slots**
|
|
40
|
+
|
|
41
|
+
| Slot | Slot props |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| `default` | `{}` |
|
|
44
|
+
|
|
45
|
+
**SCard events**
|
|
46
|
+
|
|
47
|
+
None.
|
|
48
|
+
|
|
49
|
+
<!-- generated:api:end SCard -->
|
|
50
|
+
|
|
51
|
+
**SCard notes**
|
|
52
|
+
|
|
53
|
+
- `color`: Background: preset/app color name or CSS color
|
|
54
|
+
- `colorThreshold`: Luminance threshold used to pick light/dark text on a custom color
|
|
55
|
+
- `theme`: Force light/dark text styling
|
|
56
|
+
- `elevation`: Shadow depth (default: `undefined` (no shadow))
|
|
57
|
+
- `outlined`: Border
|
|
58
|
+
- `underlined`: Bottom border only
|
|
59
|
+
- `borderRadius`: Border radius override
|
|
60
|
+
- `tag`: Root element (ignored when `href`/`to` is set) (default: `'div'`)
|
|
61
|
+
- `href`: Render as `<a>`
|
|
62
|
+
- `to`: Render as `router-link` (takes precedence over `href`; plain `<a href>` without vue-router)
|
|
63
|
+
- `target`: Link target
|
|
64
|
+
- `rel`: Link rel
|
|
65
|
+
- `width` / `height`: Dimensions
|
|
66
|
+
- `maxWidth` / `maxHeight`: Max dimensions
|
|
67
|
+
- `minWidth` / `minHeight`: Min dimensions
|
|
68
|
+
- `default` (slot): Card content (`SCardTitle`, `SCardSubtitle`, `SCardText`, `SCardActions`, `SImage`, …)
|
|
38
69
|
|
|
39
70
|
### Events
|
|
40
71
|
|
|
@@ -55,6 +86,92 @@ Each takes only `tag` (default `'div'`) and a `default` slot. No events.
|
|
|
55
86
|
|
|
56
87
|
Spacing between adjacent title → subtitle → text is tightened automatically.
|
|
57
88
|
|
|
89
|
+
`SCardTitle` is a flex row (so it can hold an icon, `SSpacer` and buttons). The `s_textAlign__*` classes, responsive ones included, also set the matching `justify-content` on it, so `class="s_textAlign__center"` centres the title. `s_justify__center` works too. A long title wraps between words; a single word wider than the card is split. (Before 1.20.0 `SCardTitle` ignored `s_textAlign__*`, so use `s_justify__*` there, and split titles at any letter.)
|
|
90
|
+
|
|
91
|
+
<!-- generated:api:start SCardTitle -->
|
|
92
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
93
|
+
|
|
94
|
+
**SCardTitle props**
|
|
95
|
+
|
|
96
|
+
| Prop | Type | Default | Required | Values |
|
|
97
|
+
| --- | --- | --- | --- | --- |
|
|
98
|
+
| `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` |
|
|
99
|
+
|
|
100
|
+
**SCardTitle slots**
|
|
101
|
+
|
|
102
|
+
| Slot | Slot props |
|
|
103
|
+
| --- | --- |
|
|
104
|
+
| `default` | `{}` |
|
|
105
|
+
|
|
106
|
+
**SCardTitle events**
|
|
107
|
+
|
|
108
|
+
None.
|
|
109
|
+
|
|
110
|
+
<!-- generated:api:end SCardTitle -->
|
|
111
|
+
|
|
112
|
+
<!-- generated:api:start SCardSubtitle -->
|
|
113
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
114
|
+
|
|
115
|
+
**SCardSubtitle props**
|
|
116
|
+
|
|
117
|
+
| Prop | Type | Default | Required | Values |
|
|
118
|
+
| --- | --- | --- | --- | --- |
|
|
119
|
+
| `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` |
|
|
120
|
+
|
|
121
|
+
**SCardSubtitle slots**
|
|
122
|
+
|
|
123
|
+
| Slot | Slot props |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| `default` | `{}` |
|
|
126
|
+
|
|
127
|
+
**SCardSubtitle events**
|
|
128
|
+
|
|
129
|
+
None.
|
|
130
|
+
|
|
131
|
+
<!-- generated:api:end SCardSubtitle -->
|
|
132
|
+
|
|
133
|
+
<!-- generated:api:start SCardText -->
|
|
134
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
135
|
+
|
|
136
|
+
**SCardText props**
|
|
137
|
+
|
|
138
|
+
| Prop | Type | Default | Required | Values |
|
|
139
|
+
| --- | --- | --- | --- | --- |
|
|
140
|
+
| `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` |
|
|
141
|
+
|
|
142
|
+
**SCardText slots**
|
|
143
|
+
|
|
144
|
+
| Slot | Slot props |
|
|
145
|
+
| --- | --- |
|
|
146
|
+
| `default` | `{}` |
|
|
147
|
+
|
|
148
|
+
**SCardText events**
|
|
149
|
+
|
|
150
|
+
None.
|
|
151
|
+
|
|
152
|
+
<!-- generated:api:end SCardText -->
|
|
153
|
+
|
|
154
|
+
<!-- generated:api:start SCardActions -->
|
|
155
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
156
|
+
|
|
157
|
+
**SCardActions props**
|
|
158
|
+
|
|
159
|
+
| Prop | Type | Default | Required | Values |
|
|
160
|
+
| --- | --- | --- | --- | --- |
|
|
161
|
+
| `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` |
|
|
162
|
+
|
|
163
|
+
**SCardActions slots**
|
|
164
|
+
|
|
165
|
+
| Slot | Slot props |
|
|
166
|
+
| --- | --- |
|
|
167
|
+
| `default` | `{}` |
|
|
168
|
+
|
|
169
|
+
**SCardActions events**
|
|
170
|
+
|
|
171
|
+
None.
|
|
172
|
+
|
|
173
|
+
<!-- generated:api:end SCardActions -->
|
|
174
|
+
|
|
58
175
|
---
|
|
59
176
|
|
|
60
177
|
## Usage
|
|
@@ -10,61 +10,126 @@ Types: `node_modules/@khsura/sui/@types/definitions/props/propsCarousel.d.ts`, `
|
|
|
10
10
|
|
|
11
11
|
## SCarousel
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
| `
|
|
24
|
-
| `
|
|
25
|
-
| `delimiterIcon` | `
|
|
26
|
-
| `
|
|
27
|
-
| `
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
13
|
+
<!-- generated:api:start SCarousel -->
|
|
14
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
15
|
+
|
|
16
|
+
**SCarousel props**
|
|
17
|
+
|
|
18
|
+
| Prop | Type | Default | Required | Values |
|
|
19
|
+
| --- | --- | --- | --- | --- |
|
|
20
|
+
| `color` | `string` | — | no | — |
|
|
21
|
+
| `colorThreshold` | `number` | — | no | — |
|
|
22
|
+
| `continuous` | `boolean` | — | no | — |
|
|
23
|
+
| `controlsBackgroundColor` | `string` | `"#0000004d"` | no | — |
|
|
24
|
+
| `cycle` | `boolean` | `true` | no | — |
|
|
25
|
+
| `delimiterIcon` | `string` | `"mdi-circle"` | no | — |
|
|
26
|
+
| `disabled` | `boolean \| null` | — | no | — |
|
|
27
|
+
| `height` | `string \| number` | `500` | no | — |
|
|
28
|
+
| `hideArrows` | `boolean` | — | no | — |
|
|
29
|
+
| `hideDelimiterBackground` | `boolean` | — | no | — |
|
|
30
|
+
| `hideDelimiters` | `boolean` | — | no | — |
|
|
31
|
+
| `interval` | `number` | `6000` | no | — |
|
|
32
|
+
| `modelValue` | `GroupItemValue` | — | no | — |
|
|
33
|
+
| `nextIcon` | `string` | `"mdi-chevron-right"` | no | — |
|
|
34
|
+
| `noAnimation` | `boolean` | `false` | no | — |
|
|
35
|
+
| `prevIcon` | `string` | `"mdi-chevron-left"` | no | — |
|
|
36
|
+
| `readonly` | `boolean \| null` | — | no | — |
|
|
37
|
+
| `selectedClass` | `string` | — | no | — |
|
|
38
|
+
| `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` |
|
|
39
|
+
| `theme` | `AppThemeType` | — | no | `dark`, `light` |
|
|
40
|
+
| `touch` | `boolean \| TouchHandlers` | `true` | no | — |
|
|
41
|
+
| `verticalDelimiters` | `boolean \| "left" \| "right"` | — | no | — |
|
|
42
|
+
|
|
43
|
+
**SCarousel slots**
|
|
44
|
+
|
|
45
|
+
| Slot | Slot props |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| `default` | `{}` |
|
|
48
|
+
|
|
49
|
+
**SCarousel events**
|
|
50
|
+
|
|
51
|
+
| Event | Payload |
|
|
52
|
+
| --- | --- |
|
|
53
|
+
| `update:modelValue` | `[value: GroupItemValue \| undefined]` |
|
|
54
|
+
|
|
55
|
+
<!-- generated:api:end SCarousel -->
|
|
56
|
+
|
|
57
|
+
**SCarousel notes**
|
|
58
|
+
|
|
59
|
+
- `modelValue`: Active slide's `value` (use `v-model`)
|
|
60
|
+
- `cycle`: Auto-advance through slides
|
|
61
|
+
- `interval`: Auto-advance interval in ms
|
|
62
|
+
- `height`: Carousel height (number = px)
|
|
63
|
+
- `color`: Color of the active delimiter dot
|
|
64
|
+
- `hideDelimiters`: Hide the navigation dots
|
|
65
|
+
- `hideDelimiterBackground`: Hide the dots' background strip
|
|
66
|
+
- `controlsBackgroundColor`: Background of the dots strip
|
|
67
|
+
- `delimiterIcon`: Dot icon
|
|
68
|
+
- `verticalDelimiters`: Stack dots vertically on the left/right edge
|
|
69
|
+
- `hideArrows`: Hide prev/next arrows
|
|
70
|
+
- `prevIcon`: Previous arrow icon
|
|
71
|
+
- `nextIcon`: Next arrow icon
|
|
72
|
+
- `touch`: Swipe gestures
|
|
73
|
+
- `noAnimation`: Disable the slide transition
|
|
74
|
+
- `selectedClass`: Class for the active item
|
|
75
|
+
- `tag`: Root HTML element (default: `'div'`)
|
|
76
|
+
- `default` (slot): `SCarouselItem` components
|
|
77
|
+
- `update:modelValue` (event): Active slide changed (arrows, dots, swipe, auto-play)
|
|
34
78
|
|
|
35
79
|
Always looping and always one slide selected (`continuous` + `mandatory` are hard-wired). The `continuous` and `disabled` props exist in the type but have no effect on SCarousel.
|
|
36
80
|
|
|
37
81
|
### Slots
|
|
38
82
|
|
|
39
|
-
| Slot | Description |
|
|
40
|
-
|------|-------------|
|
|
41
|
-
| `default` | `SCarouselItem` components |
|
|
42
|
-
|
|
43
83
|
No `prev`/`next` slots on SCarousel.
|
|
44
84
|
|
|
45
|
-
### Events
|
|
46
|
-
|
|
47
|
-
| Event | Payload | Description |
|
|
48
|
-
|-------|---------|-------------|
|
|
49
|
-
| `update:modelValue` | slide `value` | Active slide changed (arrows, dots, swipe, auto-play) |
|
|
50
|
-
|
|
51
85
|
---
|
|
52
86
|
|
|
53
87
|
## SCarouselItem
|
|
54
88
|
|
|
55
89
|
Each item renders an `SImage`. Your default-slot content is drawn as an overlay on top of the image.
|
|
56
90
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
|
63
|
-
|
|
|
64
|
-
|
|
65
|
-
|
|
|
66
|
-
|
|
67
|
-
| `
|
|
91
|
+
<!-- generated:api:start SCarouselItem -->
|
|
92
|
+
<!-- Generated from sui-api.json by `yarn sync:skills` (packages/app). Do not edit by hand. -->
|
|
93
|
+
|
|
94
|
+
**SCarouselItem props**
|
|
95
|
+
|
|
96
|
+
| Prop | Type | Default | Required | Values |
|
|
97
|
+
| --- | --- | --- | --- | --- |
|
|
98
|
+
| `activeClass` | `string \| null` | — | no | — |
|
|
99
|
+
| `alt` | `string \| null` | — | no | — |
|
|
100
|
+
| `aspectRatio` | `number \| null` | — | no | — |
|
|
101
|
+
| `height` | `string \| number \| null` | — | no | — |
|
|
102
|
+
| `lazyLoad` | `LazyLoad \| null` | — | no | — |
|
|
103
|
+
| `maxHeight` | `string \| number \| null` | — | no | — |
|
|
104
|
+
| `maxWidth` | `string \| number \| null` | — | no | — |
|
|
105
|
+
| `minHeight` | `string \| number \| null` | — | no | — |
|
|
106
|
+
| `minWidth` | `string \| number \| null` | — | no | — |
|
|
107
|
+
| `objectFit` | `"fill" \| "none" \| "contain" \| "cover" \| "scale-down"` | — | no | `contain`, `cover`, `fill`, `none`, `scale-down` |
|
|
108
|
+
| `selected` | `boolean` | — | no | — |
|
|
109
|
+
| `src` | `string \| null` | — | yes | — |
|
|
110
|
+
| `value` | `string \| number \| boolean` | — | no | — |
|
|
111
|
+
| `width` | `string \| number \| null` | — | no | — |
|
|
112
|
+
|
|
113
|
+
**SCarouselItem slots**
|
|
114
|
+
|
|
115
|
+
| Slot | Slot props |
|
|
116
|
+
| --- | --- |
|
|
117
|
+
| `default` | `{}` |
|
|
118
|
+
|
|
119
|
+
**SCarouselItem events**
|
|
120
|
+
|
|
121
|
+
None.
|
|
122
|
+
|
|
123
|
+
<!-- generated:api:end SCarouselItem -->
|
|
124
|
+
|
|
125
|
+
**SCarouselItem notes**
|
|
126
|
+
|
|
127
|
+
- `value`: Slide identifier matched against the carousel `v-model` (default: auto id)
|
|
128
|
+
- `src`: Image URL. Pass `:src="null"` for content-only slides (default: **required**)
|
|
129
|
+
- `alt`: Image alt text
|
|
130
|
+
- `objectFit`: Image fit
|
|
131
|
+
- `aspectRatio`: Image aspect ratio
|
|
132
|
+
- `default` (slot): Overlay content on top of the image
|
|
68
133
|
|
|
69
134
|
---
|
|
70
135
|
|