@youcan/celeste 0.14.0 → 0.14.1
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/ai/README.md +21 -0
- package/ai/component-registry.json +1817 -664
- package/ai/icons.json +12600 -0
- package/ai/tokens.json +2189 -0
- package/dist/celeste.css +15 -0
- package/package.json +3 -3
- package/src/components/modal/stories/modal.stories.ts +3 -3
- package/src/components/sidebar/sidebar-menu-action.vue +3 -0
- package/src/components/sidebar/sidebar-menu-button.vue +4 -0
- package/src/components/sidebar/sidebar-menu-sub-button.vue +3 -0
- package/src/components/sidebar/sidebar-menu-sub.vue +2 -0
- package/src/components/sidebar/sidebar-menu.vue +3 -0
- package/src/components/sidebar/stories/sidebar.stories.ts +2 -2
- package/ai/component-registry.md +0 -3518
- package/ai/icons.md +0 -142
- package/ai/tokens.md +0 -444
package/ai/component-registry.md
DELETED
|
@@ -1,3518 +0,0 @@
|
|
|
1
|
-
# Celeste Component Registry
|
|
2
|
-
|
|
3
|
-
> Generated from source for `@youcan/celeste@0.14.0`. Do not edit.
|
|
4
|
-
> Regenerate with `pnpm --filter @youcan/celeste codegen:registry`.
|
|
5
|
-
|
|
6
|
-
Every component below is imported from `@youcan/celeste`:
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
import { Badge, Button } from '@youcan/celeste';
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
**147 components** in 40 groups.
|
|
13
|
-
|
|
14
|
-
This file describes what each component _accepts_. For which component to
|
|
15
|
-
reach for when several look similar, see the `celeste-ui` skill.
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## alert
|
|
20
|
-
|
|
21
|
-
### Alert
|
|
22
|
-
|
|
23
|
-
**Props**
|
|
24
|
-
|
|
25
|
-
- `class`: `ClassValue`
|
|
26
|
-
- `dismissable`: `boolean` — default `false`
|
|
27
|
-
- `size`: `xs` | `sm` | `lg` — default `"xs"`
|
|
28
|
-
- `state`: `information` | `success` | `warning` | `error` | `feature` — default `"information"`
|
|
29
|
-
- `variant`: `fill` | `light` | `lighter` | `stroke` — default `"fill"`
|
|
30
|
-
|
|
31
|
-
**Events**
|
|
32
|
-
|
|
33
|
-
- `dismiss`: `any[]`
|
|
34
|
-
|
|
35
|
-
**Slots**
|
|
36
|
-
|
|
37
|
-
- `default`
|
|
38
|
-
- `title`
|
|
39
|
-
- `description`
|
|
40
|
-
- `primary`
|
|
41
|
-
- `secondary`
|
|
42
|
-
|
|
43
|
-
**Source:** `src/components/alert/alert.vue`
|
|
44
|
-
|
|
45
|
-
**Example:** `src/components/alert/stories/alert.stories.ts`
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## badge
|
|
50
|
-
|
|
51
|
-
### Badge
|
|
52
|
-
|
|
53
|
-
**Props**
|
|
54
|
-
|
|
55
|
-
- `class`: `ClassValue`
|
|
56
|
-
- `disabled`: `boolean`
|
|
57
|
-
- `icon`: `string`
|
|
58
|
-
- `label`: `string`
|
|
59
|
-
- `size`: `sm` | `md` — default `"md"`
|
|
60
|
-
- `state`: `information` | `success` | `warning` | `error` | `feature` | `faded` | `away` | `verified` | `highlighted` | `stable`
|
|
61
|
-
- `type`: `basic` | `dot` | `leading-icon` | `trailing-icon` — default `"basic"`
|
|
62
|
-
- `variant`: `fill` | `light` | `lighter` | `stroke` — default `"fill"`
|
|
63
|
-
|
|
64
|
-
**Composes with:** `StatusBadge`
|
|
65
|
-
|
|
66
|
-
**Source:** `src/components/badge/badge.vue`
|
|
67
|
-
|
|
68
|
-
**Example:** `src/components/badge/stories/badge.stories.ts`
|
|
69
|
-
|
|
70
|
-
### StatusBadge
|
|
71
|
-
|
|
72
|
-
**Props**
|
|
73
|
-
|
|
74
|
-
- `label`: `string` **(required)**
|
|
75
|
-
- `class`: `ClassValue`
|
|
76
|
-
- `dotted`: `boolean`
|
|
77
|
-
- `state`: `success` | `warning` | `error` | `faded` — default `"faded"`
|
|
78
|
-
- `variant`: `light` | `stroke` — default `"light"`
|
|
79
|
-
|
|
80
|
-
**Composes with:** `Badge`
|
|
81
|
-
|
|
82
|
-
**Source:** `src/components/badge/status-badge.vue`
|
|
83
|
-
|
|
84
|
-
**Example:** `src/components/badge/stories/status-badge.stories.ts`
|
|
85
|
-
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
## button
|
|
89
|
-
|
|
90
|
-
### Button
|
|
91
|
-
|
|
92
|
-
**Props**
|
|
93
|
-
|
|
94
|
-
- `as`: `AsTag | Component` — default `"button"` — Element or component to render as.
|
|
95
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
96
|
-
- `class`: `ClassValue`
|
|
97
|
-
- `intent`: `error` | `primary` | `neutral` — default `"primary"`
|
|
98
|
-
- `size`: `xs` | `sm` | `md` | `xxs` — default `"md"`
|
|
99
|
-
- `variant`: `fill` | `lighter` | `stroke` | `ghost` — default `"fill"`
|
|
100
|
-
|
|
101
|
-
**Slots**
|
|
102
|
-
|
|
103
|
-
- `default`
|
|
104
|
-
|
|
105
|
-
**Composes with:** `CompactButton`, `FancyButton`, `LinkButton`, `SocialButton`
|
|
106
|
-
|
|
107
|
-
**Source:** `src/components/button/button.vue`
|
|
108
|
-
|
|
109
|
-
**Example:** `src/components/button/stories/button.stories.ts`
|
|
110
|
-
|
|
111
|
-
### CompactButton
|
|
112
|
-
|
|
113
|
-
**Props**
|
|
114
|
-
|
|
115
|
-
- `icon`: `string` **(required)**
|
|
116
|
-
- `as`: `AsTag | Component` — default `"button"` — Element or component to render as.
|
|
117
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
118
|
-
- `class`: `ClassValue`
|
|
119
|
-
- `rounded`: `boolean`
|
|
120
|
-
- `size`: `lg` | `md` — default `"lg"`
|
|
121
|
-
- `variant`: `stroke` | `ghost` | `white` — default `"stroke"`
|
|
122
|
-
|
|
123
|
-
**Composes with:** `Button`, `FancyButton`, `LinkButton`, `SocialButton`
|
|
124
|
-
|
|
125
|
-
**Source:** `src/components/button/compact-button.vue`
|
|
126
|
-
|
|
127
|
-
**Example:** `src/components/button/stories/compact-button.stories.ts`
|
|
128
|
-
|
|
129
|
-
### FancyButton
|
|
130
|
-
|
|
131
|
-
**Props**
|
|
132
|
-
|
|
133
|
-
- `as`: `AsTag | Component` — default `"button"` — Element or component to render as.
|
|
134
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
135
|
-
- `class`: `ClassValue`
|
|
136
|
-
- `intent`: `error` | `basic` | `primary` | `neutral` — default `"primary"`
|
|
137
|
-
- `size`: `xs` | `sm` | `md` — default `"md"`
|
|
138
|
-
|
|
139
|
-
**Slots**
|
|
140
|
-
|
|
141
|
-
- `default`
|
|
142
|
-
|
|
143
|
-
**Composes with:** `Button`, `CompactButton`, `LinkButton`, `SocialButton`
|
|
144
|
-
|
|
145
|
-
**Source:** `src/components/button/fancy-button.vue`
|
|
146
|
-
|
|
147
|
-
**Example:** `src/components/button/stories/fancy-button.stories.ts`
|
|
148
|
-
|
|
149
|
-
### LinkButton
|
|
150
|
-
|
|
151
|
-
**Props**
|
|
152
|
-
|
|
153
|
-
- `as`: `AsTag | Component` — default `"a"` — Element or component to render as.
|
|
154
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
155
|
-
- `class`: `ClassValue`
|
|
156
|
-
- `disabled`: `boolean`
|
|
157
|
-
- `intent`: `error` | `primary` | `black` | `gray` — default `"primary"`
|
|
158
|
-
- `size`: `sm` | `md` — default `"md"`
|
|
159
|
-
- `underline`: `boolean`
|
|
160
|
-
|
|
161
|
-
**Slots**
|
|
162
|
-
|
|
163
|
-
- `default`
|
|
164
|
-
|
|
165
|
-
**Composes with:** `Button`, `CompactButton`, `FancyButton`, `SocialButton`
|
|
166
|
-
|
|
167
|
-
**Source:** `src/components/button/link-button.vue`
|
|
168
|
-
|
|
169
|
-
**Example:** `src/components/button/stories/link-button.stories.ts`
|
|
170
|
-
|
|
171
|
-
### SocialButton
|
|
172
|
-
|
|
173
|
-
**Props**
|
|
174
|
-
|
|
175
|
-
- `brand`: `apple` | `twitter` | `google` | `facebook` | `linkedin` | `github` **(required)**
|
|
176
|
-
- `class`: `string`
|
|
177
|
-
- `label`: `string`
|
|
178
|
-
- `variant`: `fill` | `stroke` — default `"stroke"`
|
|
179
|
-
|
|
180
|
-
**Composes with:** `Button`, `CompactButton`, `FancyButton`, `LinkButton`
|
|
181
|
-
|
|
182
|
-
**Source:** `src/components/button/social-button.vue`
|
|
183
|
-
|
|
184
|
-
**Example:** `src/components/button/stories/social-button.stories.ts`
|
|
185
|
-
|
|
186
|
-
---
|
|
187
|
-
|
|
188
|
-
## calendar
|
|
189
|
-
|
|
190
|
-
### Calendar
|
|
191
|
-
|
|
192
|
-
**Props**
|
|
193
|
-
|
|
194
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
195
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
196
|
-
- `calendarLabel`: `string` — The accessible label for the calendar
|
|
197
|
-
- `class`: `ClassValue`
|
|
198
|
-
- `defaultPlaceholder`: `DateValue` — The default placeholder date
|
|
199
|
-
- `defaultValue`: `DateValue` — The default value for the calendar
|
|
200
|
-
- `dir`: `Direction` — The reading direction of the calendar when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
201
|
-
- `disabled`: `boolean` — Whether the calendar is disabled
|
|
202
|
-
- `disableDaysOutsideCurrentView`: `boolean` — Whether or not to disable days outside the current view.
|
|
203
|
-
- `fixedWeeks`: `boolean` — default `true` — Whether or not to always display 6 weeks in the calendar
|
|
204
|
-
- `initialFocus`: `boolean` — If true, the calendar will focus the selected day, today, or the first day of the month depending on what is visible when the calendar is mounted
|
|
205
|
-
- `isDateDisabled`: `Matcher` — A function that returns whether or not a date is disabled
|
|
206
|
-
- `isDateUnavailable`: `Matcher` — A function that returns whether or not a date is unavailable
|
|
207
|
-
- `locale`: `string` — The locale to use for formatting dates
|
|
208
|
-
- `markedDates`: `DateValue[]`
|
|
209
|
-
- `maxValue`: `DateValue` — The maximum date that can be selected
|
|
210
|
-
- `minValue`: `DateValue` — The minimum date that can be selected
|
|
211
|
-
- `modelValue`: `DateValue | DateValue[] | null` — The controlled selected date value of the calendar. Can be bound as `v-model`.
|
|
212
|
-
- `multiple`: `boolean` — Whether multiple dates can be selected
|
|
213
|
-
- `nextPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the next page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
214
|
-
- `numberOfMonths`: `number` — The number of months to display at once
|
|
215
|
-
- `pagedNavigation`: `boolean` — This property causes the previous and next buttons to navigate by the number of months displayed at once, rather than one month
|
|
216
|
-
- `placeholder`: `DateValue` — The placeholder date, which is used to determine what month to display when no date is selected
|
|
217
|
-
- `preventDeselect`: `boolean` — Whether or not to prevent the user from deselecting a date without selecting another date first
|
|
218
|
-
- `prevPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the previous page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
219
|
-
- `readonly`: `boolean` — Whether the calendar is readonly
|
|
220
|
-
- `weekdayFormat`: `WeekDayFormat` — default `"short"` — The format to use for the weekday strings provided via the weekdays slot prop
|
|
221
|
-
- `weekStartsOn`: `WeekStartsOn` — default `1` — The day of the week to start the calendar on
|
|
222
|
-
|
|
223
|
-
**Events**
|
|
224
|
-
|
|
225
|
-
- `update:modelValue`: `[date: DateValue | undefined]`
|
|
226
|
-
- `update:placeholder`: `[date: DateValue]`
|
|
227
|
-
|
|
228
|
-
**Source:** `src/components/calendar/calendar.vue`
|
|
229
|
-
|
|
230
|
-
**Example:** `src/components/calendar/stories/calendar.stories.ts`
|
|
231
|
-
|
|
232
|
-
---
|
|
233
|
-
|
|
234
|
-
## chart
|
|
235
|
-
|
|
236
|
-
### BarChart
|
|
237
|
-
|
|
238
|
-
**Props**
|
|
239
|
-
|
|
240
|
-
- `category`: `string` **(required)**
|
|
241
|
-
- `data`: `BarDatum[]` **(required)**
|
|
242
|
-
- `series`: `BarSeries[]` **(required)**
|
|
243
|
-
- `ariaLabel`: `string`
|
|
244
|
-
- `class`: `unknown`
|
|
245
|
-
- `dense`: `boolean`
|
|
246
|
-
- `description`: `string`
|
|
247
|
-
- `format`: `ChartFormat` — default `formatNumber`
|
|
248
|
-
- `layout`: `stacked` | `grouped` — default `"stacked"`
|
|
249
|
-
- `legend`: `inline` | `chip` | `table` | `none`
|
|
250
|
-
- `radius`: `number` — default `5`
|
|
251
|
-
- `size`: `default` | `compact`
|
|
252
|
-
- `state`: `error` | `ready` | `loading` | `empty`
|
|
253
|
-
- `tableVisible`: `boolean`
|
|
254
|
-
- `tickFormat`: `ChartFormat` — default `formatCompact`
|
|
255
|
-
- `ticks`: `number` — default `4`
|
|
256
|
-
- `title`: `string`
|
|
257
|
-
- `total`: `boolean` — default `true`
|
|
258
|
-
- `totalLabel`: `string` — default `"Total"`
|
|
259
|
-
|
|
260
|
-
**Composes with:** `ChartCard`, `ChartLegend`, `ChartPlot`
|
|
261
|
-
|
|
262
|
-
**Source:** `src/components/chart/bar-chart.vue`
|
|
263
|
-
|
|
264
|
-
**Example:** `src/components/chart/stories/bar-chart.stories.ts`
|
|
265
|
-
|
|
266
|
-
### ChartCard
|
|
267
|
-
|
|
268
|
-
**Props**
|
|
269
|
-
|
|
270
|
-
- `title`: `string` **(required)**
|
|
271
|
-
- `caption`: `string`
|
|
272
|
-
- `class`: `ClassValue`
|
|
273
|
-
- `delta`: `{ value: string; direction: "up" | "down"; }`
|
|
274
|
-
- `value`: `string`
|
|
275
|
-
|
|
276
|
-
**Slots**
|
|
277
|
-
|
|
278
|
-
- `toolbar`
|
|
279
|
-
- `default`
|
|
280
|
-
|
|
281
|
-
**Composes with:** `BarChart`, `ChartLegend`, `ChartPlot`
|
|
282
|
-
|
|
283
|
-
**Source:** `src/components/chart/chart-card.vue`
|
|
284
|
-
|
|
285
|
-
**Example:** no story of its own — see `src/components/chart/stories/bar-chart.stories.ts` for the group.
|
|
286
|
-
|
|
287
|
-
### ChartLegend
|
|
288
|
-
|
|
289
|
-
**Props**
|
|
290
|
-
|
|
291
|
-
- `items`: `ChartLegendItem[]` **(required)**
|
|
292
|
-
- `class`: `ClassValue`
|
|
293
|
-
- `modelValue`: `string[]` — default `[]`
|
|
294
|
-
- `toggle`: `boolean` — default `true`
|
|
295
|
-
- `variant`: `inline` | `chip` | `table` — default `"inline"`
|
|
296
|
-
|
|
297
|
-
**Events**
|
|
298
|
-
|
|
299
|
-
- `update:modelValue`: `[value: string[]]`
|
|
300
|
-
|
|
301
|
-
**Composes with:** `BarChart`, `ChartCard`, `ChartPlot`
|
|
302
|
-
|
|
303
|
-
**Source:** `src/components/chart/chart-legend.vue`
|
|
304
|
-
|
|
305
|
-
**Example:** no story of its own — see `src/components/chart/stories/bar-chart.stories.ts` for the group.
|
|
306
|
-
|
|
307
|
-
### ChartPlot
|
|
308
|
-
|
|
309
|
-
**Props**
|
|
310
|
-
|
|
311
|
-
- `ariaLabel`: `string` **(required)**
|
|
312
|
-
- `class`: `ClassValue`
|
|
313
|
-
- `description`: `string`
|
|
314
|
-
- `size`: `default` | `compact` | `spark` — default `"default"`
|
|
315
|
-
- `state`: `error` | `ready` | `loading` | `empty` — default `"ready"`
|
|
316
|
-
- `table`: `ChartTable`
|
|
317
|
-
- `tableVisible`: `boolean`
|
|
318
|
-
- `title`: `string`
|
|
319
|
-
|
|
320
|
-
**Slots**
|
|
321
|
-
|
|
322
|
-
- `default`
|
|
323
|
-
- `action`
|
|
324
|
-
- `footer`
|
|
325
|
-
|
|
326
|
-
**Composes with:** `BarChart`, `ChartCard`, `ChartLegend`
|
|
327
|
-
|
|
328
|
-
**Source:** `src/components/chart/chart-plot.vue`
|
|
329
|
-
|
|
330
|
-
**Example:** no story of its own — see `src/components/chart/stories/bar-chart.stories.ts` for the group.
|
|
331
|
-
|
|
332
|
-
---
|
|
333
|
-
|
|
334
|
-
## checkbox
|
|
335
|
-
|
|
336
|
-
### Checkbox
|
|
337
|
-
|
|
338
|
-
**Props**
|
|
339
|
-
|
|
340
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
341
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
342
|
-
- `class`: `ClassValue`
|
|
343
|
-
- `defaultValue`: `boolean | "indeterminate"` — The value of the checkbox when it is initially rendered. Use when you do not need to control its value.
|
|
344
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the checkbox
|
|
345
|
-
- `falseValue`: `boolean` — The value used when the checkbox is unchecked. Defaults to `false`.
|
|
346
|
-
- `id`: `string` — Id of the element
|
|
347
|
-
- `modelValue`: `boolean | "indeterminate" | null` — The controlled value of the checkbox. Can be binded with v-model.
|
|
348
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
349
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
350
|
-
- `trueValue`: `boolean` — The value used when the checkbox is checked. Defaults to `true`.
|
|
351
|
-
- `value`: `AcceptableValue` — The value given as data when submitted with a `name`.
|
|
352
|
-
|
|
353
|
-
**Events**
|
|
354
|
-
|
|
355
|
-
- `update:modelValue`: `[value: boolean | "indeterminate"]`
|
|
356
|
-
|
|
357
|
-
**Composes with:** `CheckboxCard`, `CheckboxLabel`
|
|
358
|
-
|
|
359
|
-
**Source:** `src/components/checkbox/checkbox.vue`
|
|
360
|
-
|
|
361
|
-
**Example:** `src/components/checkbox/stories/checkbox.stories.ts`
|
|
362
|
-
|
|
363
|
-
### CheckboxCard
|
|
364
|
-
|
|
365
|
-
**Props**
|
|
366
|
-
|
|
367
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
368
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
369
|
-
- `class`: `ClassValue`
|
|
370
|
-
- `disabled`: `boolean`
|
|
371
|
-
- `for`: `string` — The id of the element the label is associated with.
|
|
372
|
-
- `required`: `boolean`
|
|
373
|
-
|
|
374
|
-
**Slots**
|
|
375
|
-
|
|
376
|
-
- `image` — scope `{ class: string; }`
|
|
377
|
-
- `icon`
|
|
378
|
-
- `label`
|
|
379
|
-
- `sublabel`
|
|
380
|
-
- `badge` — scope `{ disabled: boolean; }`
|
|
381
|
-
- `description`
|
|
382
|
-
- `default`
|
|
383
|
-
|
|
384
|
-
**Composes with:** `Checkbox`, `CheckboxLabel`
|
|
385
|
-
|
|
386
|
-
**Source:** `src/components/checkbox/checkbox-card.vue`
|
|
387
|
-
|
|
388
|
-
**Example:** `src/components/checkbox/stories/checkbox-card.stories.ts`
|
|
389
|
-
|
|
390
|
-
### CheckboxLabel
|
|
391
|
-
|
|
392
|
-
**Props**
|
|
393
|
-
|
|
394
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
395
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
396
|
-
- `class`: `ClassValue`
|
|
397
|
-
- `disabled`: `boolean`
|
|
398
|
-
- `for`: `string` — The id of the element the label is associated with.
|
|
399
|
-
- `required`: `boolean`
|
|
400
|
-
|
|
401
|
-
**Slots**
|
|
402
|
-
|
|
403
|
-
- `default`
|
|
404
|
-
- `label`
|
|
405
|
-
- `sublabel`
|
|
406
|
-
- `badge`
|
|
407
|
-
- `description`
|
|
408
|
-
- `linkButton`
|
|
409
|
-
|
|
410
|
-
**Composes with:** `Checkbox`, `CheckboxCard`
|
|
411
|
-
|
|
412
|
-
**Source:** `src/components/checkbox/checkbox-label.vue`
|
|
413
|
-
|
|
414
|
-
**Example:** no story of its own — see `src/components/checkbox/stories/checkbox.stories.ts` for the group.
|
|
415
|
-
|
|
416
|
-
---
|
|
417
|
-
|
|
418
|
-
## collapsible
|
|
419
|
-
|
|
420
|
-
### Collapsible
|
|
421
|
-
|
|
422
|
-
**Props**
|
|
423
|
-
|
|
424
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
425
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
426
|
-
- `class`: `unknown`
|
|
427
|
-
- `defaultOpen`: `boolean` — The open state of the collapsible when it is initially rendered. <br> Use when you do not need to control its open state.
|
|
428
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the collapsible.
|
|
429
|
-
- `open`: `boolean` — The controlled open state of the collapsible. Can be binded with `v-model`.
|
|
430
|
-
- `unmountOnHide`: `boolean` — When `true`, the element will be unmounted on closed state.
|
|
431
|
-
|
|
432
|
-
**Events**
|
|
433
|
-
|
|
434
|
-
- `update:open`: `[value: boolean]`
|
|
435
|
-
|
|
436
|
-
**Slots**
|
|
437
|
-
|
|
438
|
-
- `default` — scope `{ open: boolean; }`
|
|
439
|
-
|
|
440
|
-
**Composes with:** `CollapsibleContent`, `CollapsibleTrigger`
|
|
441
|
-
|
|
442
|
-
**Source:** `src/components/collapsible/collapsible.vue`
|
|
443
|
-
|
|
444
|
-
**Example:** `src/components/collapsible/stories/collapsible.stories.ts`
|
|
445
|
-
|
|
446
|
-
### CollapsibleContent
|
|
447
|
-
|
|
448
|
-
**Props**
|
|
449
|
-
|
|
450
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
451
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
452
|
-
- `class`: `ClassValue`
|
|
453
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
454
|
-
|
|
455
|
-
**Slots**
|
|
456
|
-
|
|
457
|
-
- `default`
|
|
458
|
-
|
|
459
|
-
**Composes with:** `Collapsible`, `CollapsibleTrigger`
|
|
460
|
-
|
|
461
|
-
**Source:** `src/components/collapsible/collapsible-content.vue`
|
|
462
|
-
|
|
463
|
-
**Example:** no story of its own — see `src/components/collapsible/stories/collapsible.stories.ts` for the group.
|
|
464
|
-
|
|
465
|
-
### CollapsibleTrigger
|
|
466
|
-
|
|
467
|
-
**Props**
|
|
468
|
-
|
|
469
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
470
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
471
|
-
- `class`: `unknown`
|
|
472
|
-
|
|
473
|
-
**Slots**
|
|
474
|
-
|
|
475
|
-
- `default`
|
|
476
|
-
|
|
477
|
-
**Composes with:** `Collapsible`, `CollapsibleContent`
|
|
478
|
-
|
|
479
|
-
**Source:** `src/components/collapsible/collapsible-trigger.vue`
|
|
480
|
-
|
|
481
|
-
**Example:** no story of its own — see `src/components/collapsible/stories/collapsible.stories.ts` for the group.
|
|
482
|
-
|
|
483
|
-
---
|
|
484
|
-
|
|
485
|
-
## color-picker
|
|
486
|
-
|
|
487
|
-
### AlphaSlider
|
|
488
|
-
|
|
489
|
-
**Props**
|
|
490
|
-
|
|
491
|
-
- `modelValue`: `tinycolor.Instance` **(required)**
|
|
492
|
-
- `class`: `unknown`
|
|
493
|
-
|
|
494
|
-
**Events**
|
|
495
|
-
|
|
496
|
-
- `update:modelValue`: `[value: string]`
|
|
497
|
-
|
|
498
|
-
**Composes with:** `ColorArea`, `ColorPicker`, `ColorSwatch`, `HueSlider`
|
|
499
|
-
|
|
500
|
-
**Source:** `src/components/color-picker/alpha-slider.vue`
|
|
501
|
-
|
|
502
|
-
**Example:** no story of its own — see `src/components/color-picker/stories/color-picker.stories.ts` for the group.
|
|
503
|
-
|
|
504
|
-
### ColorArea
|
|
505
|
-
|
|
506
|
-
**Props**
|
|
507
|
-
|
|
508
|
-
- `hue`: `number` **(required)**
|
|
509
|
-
- `modelValue`: `tinycolor.Instance` **(required)**
|
|
510
|
-
- `class`: `unknown`
|
|
511
|
-
|
|
512
|
-
**Composes with:** `AlphaSlider`, `ColorPicker`, `ColorSwatch`, `HueSlider`
|
|
513
|
-
|
|
514
|
-
**Source:** `src/components/color-picker/color-area.vue`
|
|
515
|
-
|
|
516
|
-
**Example:** no story of its own — see `src/components/color-picker/stories/color-picker.stories.ts` for the group.
|
|
517
|
-
|
|
518
|
-
### ColorPicker
|
|
519
|
-
|
|
520
|
-
**Props**
|
|
521
|
-
|
|
522
|
-
- `class`: `ClassValue`
|
|
523
|
-
- `colorSwatchLabel`: `string` — default `"Recommended Colors"`
|
|
524
|
-
- `defaultFormat`: `ColorFormat`
|
|
525
|
-
- `formats`: `ColorFormat[]` — default `["hex", "rgb", "hsl", "hsb"]`
|
|
526
|
-
- `label`: `string` — default `"Pick Color"`
|
|
527
|
-
- `modelValue`: `tinycolor.ColorInput` — default `"hsl(240, 100%, 50%)"`
|
|
528
|
-
|
|
529
|
-
**Events**
|
|
530
|
-
|
|
531
|
-
- `update:modelValue`: `[value: string]`
|
|
532
|
-
|
|
533
|
-
**Slots**
|
|
534
|
-
|
|
535
|
-
- `swatches`
|
|
536
|
-
|
|
537
|
-
**Composes with:** `AlphaSlider`, `ColorArea`, `ColorSwatch`, `HueSlider`
|
|
538
|
-
|
|
539
|
-
**Source:** `src/components/color-picker/color-picker.vue`
|
|
540
|
-
|
|
541
|
-
**Example:** `src/components/color-picker/stories/color-picker.stories.ts`
|
|
542
|
-
|
|
543
|
-
### ColorSwatch
|
|
544
|
-
|
|
545
|
-
**Props**
|
|
546
|
-
|
|
547
|
-
- `label`: `string` **(required)**
|
|
548
|
-
- `modelValue`: `tinycolor.Instance` **(required)**
|
|
549
|
-
- `class`: `unknown`
|
|
550
|
-
- `defaultColor`: `string`
|
|
551
|
-
- `swatch`: `string[]` — default `DEFAULT_SWATCH`
|
|
552
|
-
|
|
553
|
-
**Events**
|
|
554
|
-
|
|
555
|
-
- `update:modelValue`: `[value: string]`
|
|
556
|
-
|
|
557
|
-
**Composes with:** `AlphaSlider`, `ColorArea`, `ColorPicker`, `HueSlider`
|
|
558
|
-
|
|
559
|
-
**Source:** `src/components/color-picker/color-swatch.vue`
|
|
560
|
-
|
|
561
|
-
**Example:** no story of its own — see `src/components/color-picker/stories/color-picker.stories.ts` for the group.
|
|
562
|
-
|
|
563
|
-
### HueSlider
|
|
564
|
-
|
|
565
|
-
**Props**
|
|
566
|
-
|
|
567
|
-
- `class`: `unknown`
|
|
568
|
-
- `modelValue`: `number` — default `0`
|
|
569
|
-
|
|
570
|
-
**Events**
|
|
571
|
-
|
|
572
|
-
- `update:modelValue`: `[value: number]`
|
|
573
|
-
|
|
574
|
-
**Composes with:** `AlphaSlider`, `ColorArea`, `ColorPicker`, `ColorSwatch`
|
|
575
|
-
|
|
576
|
-
**Source:** `src/components/color-picker/hue-slider.vue`
|
|
577
|
-
|
|
578
|
-
**Example:** no story of its own — see `src/components/color-picker/stories/color-picker.stories.ts` for the group.
|
|
579
|
-
|
|
580
|
-
---
|
|
581
|
-
|
|
582
|
-
## combobox
|
|
583
|
-
|
|
584
|
-
### Combobox
|
|
585
|
-
|
|
586
|
-
**Props**
|
|
587
|
-
|
|
588
|
-
- `options`: `ComboboxItemPropsType[]` **(required)**
|
|
589
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
590
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
591
|
-
- `badgeProps`: `BadgeProps`
|
|
592
|
-
- `by`: `string | ((a: AcceptableValue, b: AcceptableValue) => boolean)` — Use this to compare objects by a particular field, or pass your own comparison function for complete control over how objects are compared.
|
|
593
|
-
- `class`: `string`
|
|
594
|
-
- `defaultOpen`: `boolean` — The open state of the combobox when it is initially rendered. <br> Use when you do not need to control its open state.
|
|
595
|
-
- `defaultValue`: `AcceptableValue | AcceptableValue[]` — The value of the listbox when initially rendered. Use when you do not need to control the state of the Listbox
|
|
596
|
-
- `dir`: `Direction` — The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
597
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with listbox
|
|
598
|
-
- `emptyLabel`: `string`
|
|
599
|
-
- `highlightOnHover`: `boolean` — When `true`, hover over item will trigger highlight
|
|
600
|
-
- `ignoreFilter`: `boolean` — When `true`, disable the default filters
|
|
601
|
-
- `labelBy`: `string`
|
|
602
|
-
- `modelValue`: `AcceptableValue | AcceptableValue[]` — The controlled value of the listbox. Can be binded with `v-model`.
|
|
603
|
-
- `multiple`: `boolean` — Whether multiple options can be selected or not.
|
|
604
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
605
|
-
- `open`: `boolean` — The controlled open state of the Combobox. Can be binded with `v-model:open`.
|
|
606
|
-
- `openOnClick`: `boolean` — Whether to open the combobox when the input is clicked
|
|
607
|
-
- `openOnFocus`: `boolean` — Whether to open the combobox when the input is focused
|
|
608
|
-
- `placeholder`: `string` — default `"Select"`
|
|
609
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
610
|
-
- `resetModelValueOnClear`: `boolean` — When `true` the `modelValue` will be reset to `null` (or `[]` if `multiple`)
|
|
611
|
-
- `resetSearchTermOnBlur`: `boolean` — Whether to reset the searchTerm when the Combobox input blurred
|
|
612
|
-
- `resetSearchTermOnSelect`: `boolean` — Whether to reset the searchTerm when the Combobox value is selected
|
|
613
|
-
- `searchable`: `boolean`
|
|
614
|
-
- `searchPlaceholder`: `string`
|
|
615
|
-
- `size`: `xs` | `sm` | `md` — default `"md"`
|
|
616
|
-
- `type`: `compact` | `inline` | `normal` | `compact-input`
|
|
617
|
-
- `valueBy`: `string`
|
|
618
|
-
|
|
619
|
-
**Events**
|
|
620
|
-
|
|
621
|
-
- `update:modelValue`: `[value: AcceptableValue]`
|
|
622
|
-
- `update:open`: `[value: boolean]`
|
|
623
|
-
- `highlight`: `[payload: { ref: HTMLElement; value: AcceptableValue; } | undefined]`
|
|
624
|
-
|
|
625
|
-
**Slots**
|
|
626
|
-
|
|
627
|
-
- `image` — scope `{ selected: ComboboxItemPropsType; }`
|
|
628
|
-
- `prefix` — scope `{ class: string; }`
|
|
629
|
-
|
|
630
|
-
**Composes with:** `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
631
|
-
|
|
632
|
-
**Source:** `src/components/combobox/combobox.vue`
|
|
633
|
-
|
|
634
|
-
**Example:** `src/components/combobox/stories/combobox.stories.ts`
|
|
635
|
-
|
|
636
|
-
### ComboboxAnchor
|
|
637
|
-
|
|
638
|
-
**Props**
|
|
639
|
-
|
|
640
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
641
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
642
|
-
- `class`: `ClassValue`
|
|
643
|
-
- `reference`: `ReferenceElement` — The reference (or anchor) element that is being referred to for positioning. If not provided will use the current component as anchor.
|
|
644
|
-
|
|
645
|
-
**Slots**
|
|
646
|
-
|
|
647
|
-
- `default`
|
|
648
|
-
|
|
649
|
-
**Composes with:** `Combobox`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
650
|
-
|
|
651
|
-
**Source:** `src/components/combobox/combobox-anchor.vue`
|
|
652
|
-
|
|
653
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
654
|
-
|
|
655
|
-
### ComboboxEmpty
|
|
656
|
-
|
|
657
|
-
**Props**
|
|
658
|
-
|
|
659
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
660
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
661
|
-
- `class`: `ClassValue`
|
|
662
|
-
|
|
663
|
-
**Slots**
|
|
664
|
-
|
|
665
|
-
- `default`
|
|
666
|
-
|
|
667
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
668
|
-
|
|
669
|
-
**Source:** `src/components/combobox/combobox-empty.vue`
|
|
670
|
-
|
|
671
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
672
|
-
|
|
673
|
-
### ComboboxGroup
|
|
674
|
-
|
|
675
|
-
**Props**
|
|
676
|
-
|
|
677
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
678
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
679
|
-
- `class`: `ClassValue`
|
|
680
|
-
- `heading`: `string`
|
|
681
|
-
|
|
682
|
-
**Slots**
|
|
683
|
-
|
|
684
|
-
- `default`
|
|
685
|
-
|
|
686
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
687
|
-
|
|
688
|
-
**Source:** `src/components/combobox/combobox-group.vue`
|
|
689
|
-
|
|
690
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
691
|
-
|
|
692
|
-
### ComboboxInput
|
|
693
|
-
|
|
694
|
-
**Props**
|
|
695
|
-
|
|
696
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
697
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
698
|
-
- `autoFocus`: `boolean` — Focus on element when mounted.
|
|
699
|
-
- `class`: `ClassValue`
|
|
700
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with item
|
|
701
|
-
- `displayValue`: `((val: any) => string)` — The display value of input for selected item. Does not work with `multiple`.
|
|
702
|
-
- `modelValue`: `string` — The controlled value of the filter. Can be binded with v-model.
|
|
703
|
-
- `placeholder`: `string`
|
|
704
|
-
- `searchable`: `boolean`
|
|
705
|
-
- `textInputProps`: `Partial<TextInputProps>`
|
|
706
|
-
|
|
707
|
-
**Events**
|
|
708
|
-
|
|
709
|
-
- `update:modelValue`: `[value: string | undefined]`
|
|
710
|
-
|
|
711
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
712
|
-
|
|
713
|
-
**Source:** `src/components/combobox/combobox-input.vue`
|
|
714
|
-
|
|
715
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
716
|
-
|
|
717
|
-
### ComboboxItem
|
|
718
|
-
|
|
719
|
-
**Props**
|
|
720
|
-
|
|
721
|
-
- `label`: `string` **(required)**
|
|
722
|
-
- `value`: `string | number | boolean | Record<string, any>` **(required)**
|
|
723
|
-
- `checkbox`: `boolean`
|
|
724
|
-
- `class`: `ClassValue`
|
|
725
|
-
- `description`: `string`
|
|
726
|
-
- `disabled`: `boolean`
|
|
727
|
-
- `focused`: `boolean`
|
|
728
|
-
- `icon`: `string`
|
|
729
|
-
- `image`: `string`
|
|
730
|
-
- `selected`: `boolean | "indeterminate"`
|
|
731
|
-
- `size`: `sm` | `lg` — default `"sm"`
|
|
732
|
-
- `sublabel`: `string`
|
|
733
|
-
|
|
734
|
-
**Events**
|
|
735
|
-
|
|
736
|
-
- `select`: `[event: SelectEvent$3<AcceptableValue>]`
|
|
737
|
-
|
|
738
|
-
**Slots**
|
|
739
|
-
|
|
740
|
-
- `prefix`
|
|
741
|
-
- `suffix`
|
|
742
|
-
|
|
743
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
744
|
-
|
|
745
|
-
**Source:** `src/components/combobox/combobox-item.vue`
|
|
746
|
-
|
|
747
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
748
|
-
|
|
749
|
-
### ComboboxList
|
|
750
|
-
|
|
751
|
-
**Props**
|
|
752
|
-
|
|
753
|
-
- `align`: `start` | `center` | `end` — default `"start"` — The preferred alignment against the trigger. May change when collisions occur.
|
|
754
|
-
- `alignFlip`: `boolean` — Flip alignment when colliding with boundary. May only occur when `prioritizePosition` is true.
|
|
755
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
756
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
757
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
758
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
759
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
760
|
-
- `bodyLock`: `boolean` — The document.body will be lock, and scrolling will be disabled.
|
|
761
|
-
- `class`: `ClassValue`
|
|
762
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
763
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
764
|
-
- `dir`: `Direction` — The reading direction of the popper content when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
765
|
-
- `disableOutsidePointerEvents`: `boolean` — When `true`, hover/focus/click interactions will be disabled on elements outside the `DismissableLayer`. Users will need to click twice on outside elements to interact with them: once to close the `DismissableLayer`, and again to trigger the element.
|
|
766
|
-
- `disableUpdateOnLayoutShift`: `boolean` — Whether to disable the update position for the content when the layout shifted.
|
|
767
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
768
|
-
- `hideShiftedArrow`: `boolean` — When `true`, hides the arrow when it cannot be centered to the reference element.
|
|
769
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
770
|
-
- `hideWhenEmpty`: `boolean` — When `true`, hides the content when there are no items matching the filter.
|
|
771
|
-
- `memoDependencies`: `unknown[]` — Reactive dependencies that should invalidate the memoized content subtree.
|
|
772
|
-
- `position`: `inline` | `popper` — default `"popper"` — The positioning mode to use, <br> `inline` is the default and you can control the position using CSS. <br> `popper` positions content in the same way as our other primitives, for example `Popover` or `DropdownMenu`.
|
|
773
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
774
|
-
- `prioritizePosition`: `boolean` — Force content to be position within the viewport. Might overlap the reference element, which may not be desired.
|
|
775
|
-
- `reference`: `ReferenceElement` — The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
|
|
776
|
-
- `side`: `top` | `right` | `bottom` | `left` — The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
|
|
777
|
-
- `sideFlip`: `boolean` — Flip to the opposite side when colliding with boundary.
|
|
778
|
-
- `sideOffset`: `number` — default `4` — The distance in pixels from the trigger.
|
|
779
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
780
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
781
|
-
|
|
782
|
-
**Events**
|
|
783
|
-
|
|
784
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
785
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
786
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
787
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
788
|
-
|
|
789
|
-
**Slots**
|
|
790
|
-
|
|
791
|
-
- `default`
|
|
792
|
-
|
|
793
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxRoot`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
794
|
-
|
|
795
|
-
**Source:** `src/components/combobox/combobox-list.vue`
|
|
796
|
-
|
|
797
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
798
|
-
|
|
799
|
-
### ComboboxRoot
|
|
800
|
-
|
|
801
|
-
**Props**
|
|
802
|
-
|
|
803
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
804
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
805
|
-
- `by`: `string | ((a: AcceptableValue, b: AcceptableValue) => boolean)` — Use this to compare objects by a particular field, or pass your own comparison function for complete control over how objects are compared.
|
|
806
|
-
- `class`: `unknown`
|
|
807
|
-
- `defaultOpen`: `boolean` — The open state of the combobox when it is initially rendered. <br> Use when you do not need to control its open state.
|
|
808
|
-
- `defaultValue`: `AcceptableValue | AcceptableValue[]` — The value of the listbox when initially rendered. Use when you do not need to control the state of the Listbox
|
|
809
|
-
- `dir`: `Direction` — The reading direction of the listbox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
810
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with listbox
|
|
811
|
-
- `highlightOnHover`: `boolean` — When `true`, hover over item will trigger highlight
|
|
812
|
-
- `ignoreFilter`: `boolean` — When `true`, disable the default filters
|
|
813
|
-
- `modelValue`: `AcceptableValue | AcceptableValue[]` — The controlled value of the listbox. Can be binded with `v-model`.
|
|
814
|
-
- `multiple`: `boolean` — Whether multiple options can be selected or not.
|
|
815
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
816
|
-
- `open`: `boolean` — The controlled open state of the Combobox. Can be binded with `v-model:open`.
|
|
817
|
-
- `openOnClick`: `boolean` — Whether to open the combobox when the input is clicked
|
|
818
|
-
- `openOnFocus`: `boolean` — Whether to open the combobox when the input is focused
|
|
819
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
820
|
-
- `resetModelValueOnClear`: `boolean` — When `true` the `modelValue` will be reset to `null` (or `[]` if `multiple`)
|
|
821
|
-
- `resetSearchTermOnBlur`: `boolean` — Whether to reset the searchTerm when the Combobox input blurred
|
|
822
|
-
- `resetSearchTermOnSelect`: `boolean` — Whether to reset the searchTerm when the Combobox value is selected
|
|
823
|
-
|
|
824
|
-
**Events**
|
|
825
|
-
|
|
826
|
-
- `update:modelValue`: `[value: AcceptableValue]`
|
|
827
|
-
- `update:open`: `[value: boolean]`
|
|
828
|
-
- `highlight`: `[payload: { ref: HTMLElement; value: AcceptableValue; } | undefined]`
|
|
829
|
-
|
|
830
|
-
**Slots**
|
|
831
|
-
|
|
832
|
-
- `default`
|
|
833
|
-
|
|
834
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxSeparator`, `ComboboxTrigger`
|
|
835
|
-
|
|
836
|
-
**Source:** `src/components/combobox/combobox-root.vue`
|
|
837
|
-
|
|
838
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
839
|
-
|
|
840
|
-
### ComboboxSeparator
|
|
841
|
-
|
|
842
|
-
**Props**
|
|
843
|
-
|
|
844
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
845
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
846
|
-
- `class`: `ClassValue`
|
|
847
|
-
|
|
848
|
-
**Slots**
|
|
849
|
-
|
|
850
|
-
- `default`
|
|
851
|
-
|
|
852
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxTrigger`
|
|
853
|
-
|
|
854
|
-
**Source:** `src/components/combobox/combobox-separator.vue`
|
|
855
|
-
|
|
856
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
857
|
-
|
|
858
|
-
### ComboboxTrigger
|
|
859
|
-
|
|
860
|
-
**Props**
|
|
861
|
-
|
|
862
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
863
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
864
|
-
- `class`: `ClassValue`
|
|
865
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with item
|
|
866
|
-
- `error`: `boolean`
|
|
867
|
-
- `filled`: `boolean`
|
|
868
|
-
- `size`: `xs` | `sm` | `md`
|
|
869
|
-
- `type`: `compact` | `inline` | `normal` | `compact-input` — default `"normal"`
|
|
870
|
-
|
|
871
|
-
**Slots**
|
|
872
|
-
|
|
873
|
-
- `default`
|
|
874
|
-
|
|
875
|
-
**Composes with:** `Combobox`, `ComboboxAnchor`, `ComboboxEmpty`, `ComboboxGroup`, `ComboboxInput`, `ComboboxItem`, `ComboboxList`, `ComboboxRoot`, `ComboboxSeparator`
|
|
876
|
-
|
|
877
|
-
**Source:** `src/components/combobox/combobox-trigger.vue`
|
|
878
|
-
|
|
879
|
-
**Example:** no story of its own — see `src/components/combobox/stories/combobox.stories.ts` for the group.
|
|
880
|
-
|
|
881
|
-
---
|
|
882
|
-
|
|
883
|
-
## content-divider
|
|
884
|
-
|
|
885
|
-
### ContentDivider
|
|
886
|
-
|
|
887
|
-
**Props**
|
|
888
|
-
|
|
889
|
-
- `class`: `ClassValue`
|
|
890
|
-
- `text`: `string`
|
|
891
|
-
- `type`: `line` | `text` | `text-line` | `solid-text` — default `"line"`
|
|
892
|
-
|
|
893
|
-
**Source:** `src/components/content-divider/content-divider.vue`
|
|
894
|
-
|
|
895
|
-
**Example:** `src/components/content-divider/stories/content-divider.stories.ts`
|
|
896
|
-
|
|
897
|
-
---
|
|
898
|
-
|
|
899
|
-
## counter-input
|
|
900
|
-
|
|
901
|
-
### CounterInput
|
|
902
|
-
|
|
903
|
-
**Props**
|
|
904
|
-
|
|
905
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
906
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
907
|
-
- `class`: `ClassValue`
|
|
908
|
-
- `defaultValue`: `number` — default `0`
|
|
909
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the Number Field.
|
|
910
|
-
- `disableWheelChange`: `boolean` — When `true`, prevents the value from changing on wheel scroll.
|
|
911
|
-
- `focusOnChange`: `boolean` — When `true`, the input will be focused when the value changes.
|
|
912
|
-
- `formatOptions`: `Intl.NumberFormatOptions` — Formatting options for the value displayed in the number field. This also affects what characters are allowed to be typed by the user.
|
|
913
|
-
- `hasError`: `boolean` — default `false`
|
|
914
|
-
- `id`: `string` — Id of the element
|
|
915
|
-
- `invertWheelChange`: `boolean` — When `true`, inverts the direction of the wheel change.
|
|
916
|
-
- `locale`: `string` — The locale to use for formatting and currencies
|
|
917
|
-
- `max`: `number` — The largest value allowed for the input.
|
|
918
|
-
- `min`: `number` — The smallest value allowed for the input.
|
|
919
|
-
- `modelValue`: `number | null`
|
|
920
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
921
|
-
- `readonly`: `boolean` — When `true`, the Number Field is read-only.
|
|
922
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
923
|
-
- `size`: `xs` | `sm` | `md` — default `"md"`
|
|
924
|
-
- `step`: `number` — The amount that the input value changes with each increment or decrement "tick".
|
|
925
|
-
- `stepSnapping`: `boolean` — When `false`, prevents the value from snapping to the nearest increment of the step value
|
|
926
|
-
|
|
927
|
-
**Events**
|
|
928
|
-
|
|
929
|
-
- `update:modelValue`: `[val: number]`
|
|
930
|
-
|
|
931
|
-
**Source:** `src/components/counter-input/counter-input.vue`
|
|
932
|
-
|
|
933
|
-
**Example:** `src/components/counter-input/stories/counter-input.stories.ts`
|
|
934
|
-
|
|
935
|
-
---
|
|
936
|
-
|
|
937
|
-
## date-picker
|
|
938
|
-
|
|
939
|
-
### DatePicker
|
|
940
|
-
|
|
941
|
-
**Props**
|
|
942
|
-
|
|
943
|
-
- `applyLabel`: `string` — default `"Apply"`
|
|
944
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
945
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
946
|
-
- `calendarLabel`: `string` — The accessible label for the calendar
|
|
947
|
-
- `cancelLabel`: `string` — default `"Cancel"`
|
|
948
|
-
- `class`: `ClassValue`
|
|
949
|
-
- `defaultPlaceholder`: `DateValue` — The default placeholder date
|
|
950
|
-
- `defaultValue`: `DateValue` — The default value for the calendar
|
|
951
|
-
- `dir`: `Direction` — The reading direction of the calendar when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
952
|
-
- `disabled`: `boolean` — Whether the calendar is disabled
|
|
953
|
-
- `disableDaysOutsideCurrentView`: `boolean` — Whether or not to disable days outside the current view.
|
|
954
|
-
- `fixedWeeks`: `boolean` — Whether or not to always display 6 weeks in the calendar
|
|
955
|
-
- `footer`: `boolean` — default `true`
|
|
956
|
-
- `initialFocus`: `boolean` — If true, the calendar will focus the selected day, today, or the first day of the month depending on what is visible when the calendar is mounted
|
|
957
|
-
- `isDateDisabled`: `Matcher` — A function that returns whether or not a date is disabled
|
|
958
|
-
- `isDateUnavailable`: `Matcher` — A function that returns whether or not a date is unavailable
|
|
959
|
-
- `locale`: `string` — The locale to use for formatting dates
|
|
960
|
-
- `markedDates`: `DateValue[]`
|
|
961
|
-
- `maxValue`: `DateValue` — The maximum date that can be selected
|
|
962
|
-
- `minValue`: `DateValue` — The minimum date that can be selected
|
|
963
|
-
- `modelValue`: `DateValue`
|
|
964
|
-
- `multiple`: `boolean` — Whether multiple dates can be selected
|
|
965
|
-
- `nextPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the next page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
966
|
-
- `numberOfMonths`: `number` — The number of months to display at once
|
|
967
|
-
- `pagedNavigation`: `boolean` — This property causes the previous and next buttons to navigate by the number of months displayed at once, rather than one month
|
|
968
|
-
- `placeholder`: `DateValue` — The placeholder date, which is used to determine what month to display when no date is selected
|
|
969
|
-
- `preventDeselect`: `boolean` — Whether or not to prevent the user from deselecting a date without selecting another date first
|
|
970
|
-
- `prevPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the previous page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
971
|
-
- `readonly`: `boolean` — Whether the calendar is readonly
|
|
972
|
-
- `weekdayFormat`: `WeekDayFormat` — The format to use for the weekday strings provided via the weekdays slot prop
|
|
973
|
-
- `weekStartsOn`: `WeekStartsOn` — The day of the week to start the calendar on
|
|
974
|
-
|
|
975
|
-
**Events**
|
|
976
|
-
|
|
977
|
-
- `update:modelValue`: `[value: DateValue | undefined]`
|
|
978
|
-
- `apply`: `[value: DateValue | undefined]`
|
|
979
|
-
- `cancel`: `[]`
|
|
980
|
-
|
|
981
|
-
**Source:** `src/components/date-picker/date-picker.vue`
|
|
982
|
-
|
|
983
|
-
**Example:** `src/components/date-picker/stories/date-picker.stories.ts`
|
|
984
|
-
|
|
985
|
-
---
|
|
986
|
-
|
|
987
|
-
## digit-input
|
|
988
|
-
|
|
989
|
-
### DigitInput
|
|
990
|
-
|
|
991
|
-
**Props**
|
|
992
|
-
|
|
993
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
994
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
995
|
-
- `class`: `ClassValue`
|
|
996
|
-
- `defaultValue`: `PinInputValue<Type>` — The default value of the pin inputs when it is initially rendered. Use when you do not need to control its checked state.
|
|
997
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
998
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the pin input
|
|
999
|
-
- `hasError`: `boolean` — default `false`
|
|
1000
|
-
- `id`: `string` — Id of the element
|
|
1001
|
-
- `mask`: `boolean` — When `true`, pin inputs will be treated as password.
|
|
1002
|
-
- `modelValue`: `PinInputValue<Type> | null` — default `[] as any` — The controlled checked state of the pin input. Can be binded as `v-model`.
|
|
1003
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
1004
|
-
- `otp`: `boolean` — When `true`, mobile devices will autodetect the OTP from messages or clipboard, and enable the autocomplete field.
|
|
1005
|
-
- `placeholder`: `string` — The placeholder character to use for empty pin-inputs.
|
|
1006
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
1007
|
-
- `type`: `Type` — Input type for the inputs.
|
|
1008
|
-
|
|
1009
|
-
**Events**
|
|
1010
|
-
|
|
1011
|
-
- `update:modelValue`: `[value: PinInputValue<Type>]`
|
|
1012
|
-
- `complete`: `[value: PinInputValue<Type>]`
|
|
1013
|
-
|
|
1014
|
-
**Slots**
|
|
1015
|
-
|
|
1016
|
-
- `default`
|
|
1017
|
-
|
|
1018
|
-
**Composes with:** `DigitInputGroup`, `DigitInputSlot`
|
|
1019
|
-
|
|
1020
|
-
**Source:** `src/components/digit-input/digit-input.vue`
|
|
1021
|
-
|
|
1022
|
-
**Example:** `src/components/digit-input/stories/digit-input.stories.ts`
|
|
1023
|
-
|
|
1024
|
-
### DigitInputGroup
|
|
1025
|
-
|
|
1026
|
-
**Props**
|
|
1027
|
-
|
|
1028
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1029
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1030
|
-
- `class`: `ClassValue`
|
|
1031
|
-
|
|
1032
|
-
**Slots**
|
|
1033
|
-
|
|
1034
|
-
- `default`
|
|
1035
|
-
|
|
1036
|
-
**Composes with:** `DigitInput`, `DigitInputSlot`
|
|
1037
|
-
|
|
1038
|
-
**Source:** `src/components/digit-input/digit-input-group.vue`
|
|
1039
|
-
|
|
1040
|
-
**Example:** no story of its own — see `src/components/digit-input/stories/digit-input.stories.ts` for the group.
|
|
1041
|
-
|
|
1042
|
-
### DigitInputSlot
|
|
1043
|
-
|
|
1044
|
-
**Props**
|
|
1045
|
-
|
|
1046
|
-
- `index`: `number` **(required)** — Position of the value this input binds to.
|
|
1047
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1048
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1049
|
-
- `class`: `ClassValue`
|
|
1050
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the pin input
|
|
1051
|
-
|
|
1052
|
-
**Composes with:** `DigitInput`, `DigitInputGroup`
|
|
1053
|
-
|
|
1054
|
-
**Source:** `src/components/digit-input/digit-input-slot.vue`
|
|
1055
|
-
|
|
1056
|
-
**Example:** no story of its own — see `src/components/digit-input/stories/digit-input.stories.ts` for the group.
|
|
1057
|
-
|
|
1058
|
-
---
|
|
1059
|
-
|
|
1060
|
-
## dropdown-menu
|
|
1061
|
-
|
|
1062
|
-
### DropdownMenu
|
|
1063
|
-
|
|
1064
|
-
**Props**
|
|
1065
|
-
|
|
1066
|
-
- `class`: `ClassValue`
|
|
1067
|
-
- `defaultOpen`: `boolean` — The open state of the dropdown menu when it is initially rendered. Use when you do not need to control its open state.
|
|
1068
|
-
- `dir`: `Direction$4` — The reading direction of the combobox when applicable. If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
1069
|
-
- `modal`: `boolean` — The modality of the dropdown menu. When set to `true`, interaction with outside elements will be disabled and only menu content will be visible to screen readers.
|
|
1070
|
-
- `open`: `boolean` — The controlled open state of the menu. Can be used as `v-model:open`.
|
|
1071
|
-
|
|
1072
|
-
**Events**
|
|
1073
|
-
|
|
1074
|
-
- `update:open`: `[payload: boolean]`
|
|
1075
|
-
|
|
1076
|
-
**Slots**
|
|
1077
|
-
|
|
1078
|
-
- `default`
|
|
1079
|
-
|
|
1080
|
-
**Composes with:** `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1081
|
-
|
|
1082
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu.vue`
|
|
1083
|
-
|
|
1084
|
-
**Example:** `src/components/dropdown-menu/stories/dropdown-menu.stories.ts`
|
|
1085
|
-
|
|
1086
|
-
### DropdownMenuContent
|
|
1087
|
-
|
|
1088
|
-
**Props**
|
|
1089
|
-
|
|
1090
|
-
- `align`: `start` | `center` | `end` — The preferred alignment against the trigger. May change when collisions occur.
|
|
1091
|
-
- `alignFlip`: `boolean` — Flip alignment when colliding with boundary. May only occur when `prioritizePosition` is true.
|
|
1092
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
1093
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
1094
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1095
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1096
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
1097
|
-
- `class`: `ClassValue`
|
|
1098
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
1099
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
1100
|
-
- `disableUpdateOnLayoutShift`: `boolean` — Whether to disable the update position for the content when the layout shifted.
|
|
1101
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
1102
|
-
- `hideShiftedArrow`: `boolean` — When `true`, hides the arrow when it cannot be centered to the reference element.
|
|
1103
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
1104
|
-
- `loop`: `boolean` — When `true`, keyboard navigation will loop from last item to first, and vice versa.
|
|
1105
|
-
- `memoDependencies`: `unknown[]` — Reactive dependencies that should invalidate the memoized content subtree.
|
|
1106
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
1107
|
-
- `prioritizePosition`: `boolean` — Force content to be position within the viewport. Might overlap the reference element, which may not be desired.
|
|
1108
|
-
- `reference`: `ReferenceElement` — The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
|
|
1109
|
-
- `side`: `top` | `right` | `bottom` | `left` — The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
|
|
1110
|
-
- `sideFlip`: `boolean` — Flip to the opposite side when colliding with boundary.
|
|
1111
|
-
- `sideOffset`: `number` — default `4` — The distance in pixels from the trigger.
|
|
1112
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
1113
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
1114
|
-
|
|
1115
|
-
**Events**
|
|
1116
|
-
|
|
1117
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
1118
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
1119
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
1120
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
1121
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
1122
|
-
|
|
1123
|
-
**Slots**
|
|
1124
|
-
|
|
1125
|
-
- `default`
|
|
1126
|
-
|
|
1127
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1128
|
-
|
|
1129
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-content.vue`
|
|
1130
|
-
|
|
1131
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1132
|
-
|
|
1133
|
-
### DropdownMenuGroup
|
|
1134
|
-
|
|
1135
|
-
**Props**
|
|
1136
|
-
|
|
1137
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1138
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1139
|
-
- `class`: `unknown`
|
|
1140
|
-
|
|
1141
|
-
**Slots**
|
|
1142
|
-
|
|
1143
|
-
- `default`
|
|
1144
|
-
|
|
1145
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1146
|
-
|
|
1147
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-group.vue`
|
|
1148
|
-
|
|
1149
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1150
|
-
|
|
1151
|
-
### DropdownMenuItem
|
|
1152
|
-
|
|
1153
|
-
**Props**
|
|
1154
|
-
|
|
1155
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1156
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1157
|
-
- `class`: `ClassValue`
|
|
1158
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the item.
|
|
1159
|
-
- `textValue`: `string` — Optional text used for typeahead purposes. By default the typeahead behavior will use the `.textContent` of the item. <br> Use this when the content is complex, or you have non-textual content inside.
|
|
1160
|
-
|
|
1161
|
-
**Slots**
|
|
1162
|
-
|
|
1163
|
-
- `prefix`
|
|
1164
|
-
- `default`
|
|
1165
|
-
- `suffix`
|
|
1166
|
-
|
|
1167
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1168
|
-
|
|
1169
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-item.vue`
|
|
1170
|
-
|
|
1171
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1172
|
-
|
|
1173
|
-
### DropdownMenuLabel
|
|
1174
|
-
|
|
1175
|
-
**Props**
|
|
1176
|
-
|
|
1177
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1178
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1179
|
-
- `class`: `ClassValue`
|
|
1180
|
-
|
|
1181
|
-
**Slots**
|
|
1182
|
-
|
|
1183
|
-
- `default`
|
|
1184
|
-
|
|
1185
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1186
|
-
|
|
1187
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-label.vue`
|
|
1188
|
-
|
|
1189
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1190
|
-
|
|
1191
|
-
### DropdownMenuSeparator
|
|
1192
|
-
|
|
1193
|
-
**Props**
|
|
1194
|
-
|
|
1195
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1196
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1197
|
-
- `class`: `ClassValue`
|
|
1198
|
-
|
|
1199
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1200
|
-
|
|
1201
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-separator.vue`
|
|
1202
|
-
|
|
1203
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1204
|
-
|
|
1205
|
-
### DropdownMenuSub
|
|
1206
|
-
|
|
1207
|
-
**Props**
|
|
1208
|
-
|
|
1209
|
-
- `class`: `unknown`
|
|
1210
|
-
- `defaultOpen`: `boolean` — The open state of the dropdown menu when it is initially rendered. Use when you do not need to control its open state.
|
|
1211
|
-
- `open`: `boolean` — The controlled open state of the menu. Can be used as `v-model:open`.
|
|
1212
|
-
|
|
1213
|
-
**Events**
|
|
1214
|
-
|
|
1215
|
-
- `update:open`: `[payload: boolean]`
|
|
1216
|
-
|
|
1217
|
-
**Slots**
|
|
1218
|
-
|
|
1219
|
-
- `default`
|
|
1220
|
-
|
|
1221
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1222
|
-
|
|
1223
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-sub.vue`
|
|
1224
|
-
|
|
1225
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1226
|
-
|
|
1227
|
-
### DropdownMenuSubContent
|
|
1228
|
-
|
|
1229
|
-
**Props**
|
|
1230
|
-
|
|
1231
|
-
- `alignFlip`: `boolean` — Flip alignment when colliding with boundary. May only occur when `prioritizePosition` is true.
|
|
1232
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
1233
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
1234
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1235
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1236
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
1237
|
-
- `class`: `ClassValue`
|
|
1238
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
1239
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
1240
|
-
- `disableUpdateOnLayoutShift`: `boolean` — Whether to disable the update position for the content when the layout shifted.
|
|
1241
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
1242
|
-
- `hideShiftedArrow`: `boolean` — When `true`, hides the arrow when it cannot be centered to the reference element.
|
|
1243
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
1244
|
-
- `loop`: `boolean` — When `true`, keyboard navigation will loop from last item to first, and vice versa.
|
|
1245
|
-
- `memoDependencies`: `unknown[]` — Reactive dependencies that should invalidate the memoized content subtree.
|
|
1246
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
1247
|
-
- `prioritizePosition`: `boolean` — Force content to be position within the viewport. Might overlap the reference element, which may not be desired.
|
|
1248
|
-
- `reference`: `ReferenceElement` — The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
|
|
1249
|
-
- `sideFlip`: `boolean` — Flip to the opposite side when colliding with boundary.
|
|
1250
|
-
- `sideOffset`: `number` — The distance in pixels from the trigger.
|
|
1251
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
1252
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
1253
|
-
|
|
1254
|
-
**Events**
|
|
1255
|
-
|
|
1256
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
1257
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
1258
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
1259
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
1260
|
-
- `entryFocus`: `[event: Event]`
|
|
1261
|
-
- `openAutoFocus`: `[event: Event]`
|
|
1262
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
1263
|
-
|
|
1264
|
-
**Slots**
|
|
1265
|
-
|
|
1266
|
-
- `default`
|
|
1267
|
-
|
|
1268
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubTrigger`, `DropdownMenuTrigger`
|
|
1269
|
-
|
|
1270
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-sub-content.vue`
|
|
1271
|
-
|
|
1272
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1273
|
-
|
|
1274
|
-
### DropdownMenuSubTrigger
|
|
1275
|
-
|
|
1276
|
-
**Props**
|
|
1277
|
-
|
|
1278
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1279
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1280
|
-
- `class`: `ClassValue`
|
|
1281
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the item.
|
|
1282
|
-
- `textValue`: `string` — Optional text used for typeahead purposes. By default the typeahead behavior will use the `.textContent` of the item. <br> Use this when the content is complex, or you have non-textual content inside.
|
|
1283
|
-
|
|
1284
|
-
**Slots**
|
|
1285
|
-
|
|
1286
|
-
- `prefix`
|
|
1287
|
-
- `default`
|
|
1288
|
-
|
|
1289
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuTrigger`
|
|
1290
|
-
|
|
1291
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-sub-trigger.vue`
|
|
1292
|
-
|
|
1293
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1294
|
-
|
|
1295
|
-
### DropdownMenuTrigger
|
|
1296
|
-
|
|
1297
|
-
**Props**
|
|
1298
|
-
|
|
1299
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1300
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1301
|
-
- `class`: `unknown`
|
|
1302
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with item
|
|
1303
|
-
|
|
1304
|
-
**Slots**
|
|
1305
|
-
|
|
1306
|
-
- `default`
|
|
1307
|
-
|
|
1308
|
-
**Composes with:** `DropdownMenu`, `DropdownMenuContent`, `DropdownMenuGroup`, `DropdownMenuItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuSub`, `DropdownMenuSubContent`, `DropdownMenuSubTrigger`
|
|
1309
|
-
|
|
1310
|
-
**Source:** `src/components/dropdown-menu/dropdown-menu-trigger.vue`
|
|
1311
|
-
|
|
1312
|
-
**Example:** no story of its own — see `src/components/dropdown-menu/stories/dropdown-menu.stories.ts` for the group.
|
|
1313
|
-
|
|
1314
|
-
---
|
|
1315
|
-
|
|
1316
|
-
## file-upload
|
|
1317
|
-
|
|
1318
|
-
### FileUploadArea
|
|
1319
|
-
|
|
1320
|
-
**Props**
|
|
1321
|
-
|
|
1322
|
-
- `accept`: `string`
|
|
1323
|
-
- `class`: `ClassValue`
|
|
1324
|
-
- `description`: `string` — default `"JPEG, PNG, PDF, and MP4 formats, up to 50 MB."`
|
|
1325
|
-
- `icon`: `string` — default `"i-celeste-upload-cloud-2-line"`
|
|
1326
|
-
- `label`: `string` — default `"Choose a file or drag & drop it here."`
|
|
1327
|
-
- `labelOnDrop`: `string` — default `"Drop file to upload"`
|
|
1328
|
-
- `maxFiles`: `number` — default `5`
|
|
1329
|
-
- `maxSize`: `number` — default `2000`
|
|
1330
|
-
- `modelValue`: `File[]` — default `[]`
|
|
1331
|
-
- `multiple`: `boolean` — default `false`
|
|
1332
|
-
- `onTriggerClick`: `(() => void)`
|
|
1333
|
-
- `triggerLabel`: `string` — default `"Browse Files"`
|
|
1334
|
-
|
|
1335
|
-
**Events**
|
|
1336
|
-
|
|
1337
|
-
- `error`: `[error: FileError]`
|
|
1338
|
-
- `update:modelValue`: `[value: File[]]`
|
|
1339
|
-
|
|
1340
|
-
**Source:** `src/components/file-upload/file-upload-area.vue`
|
|
1341
|
-
|
|
1342
|
-
**Example:** `src/components/file-upload/stories/file-upload-area.stories.ts`
|
|
1343
|
-
|
|
1344
|
-
---
|
|
1345
|
-
|
|
1346
|
-
## hint-text
|
|
1347
|
-
|
|
1348
|
-
### HintText
|
|
1349
|
-
|
|
1350
|
-
**Props**
|
|
1351
|
-
|
|
1352
|
-
- `class`: `ClassValue`
|
|
1353
|
-
- `icon`: `string`
|
|
1354
|
-
- `state`: `default` | `error` | `disabled` — default `"default"`
|
|
1355
|
-
- `text`: `string`
|
|
1356
|
-
|
|
1357
|
-
**Source:** `src/components/hint-text/hint-text.vue`
|
|
1358
|
-
|
|
1359
|
-
**Example:** `src/components/hint-text/stories/hint-text.stories.ts`
|
|
1360
|
-
|
|
1361
|
-
---
|
|
1362
|
-
|
|
1363
|
-
## label
|
|
1364
|
-
|
|
1365
|
-
### Label
|
|
1366
|
-
|
|
1367
|
-
**Props**
|
|
1368
|
-
|
|
1369
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1370
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1371
|
-
- `class`: `ClassValue`
|
|
1372
|
-
- `disabled`: `boolean`
|
|
1373
|
-
- `for`: `string` — The id of the element the label is associated with.
|
|
1374
|
-
- `information`: `string`
|
|
1375
|
-
- `required`: `boolean`
|
|
1376
|
-
- `sublabel`: `string`
|
|
1377
|
-
|
|
1378
|
-
**Slots**
|
|
1379
|
-
|
|
1380
|
-
- `default`
|
|
1381
|
-
- `button`
|
|
1382
|
-
|
|
1383
|
-
**Source:** `src/components/label/label.vue`
|
|
1384
|
-
|
|
1385
|
-
**Example:** `src/components/label/stories/label.stories.ts`
|
|
1386
|
-
|
|
1387
|
-
---
|
|
1388
|
-
|
|
1389
|
-
## mochi
|
|
1390
|
-
|
|
1391
|
-
### Mochi
|
|
1392
|
-
|
|
1393
|
-
**Props**
|
|
1394
|
-
|
|
1395
|
-
- `animate`: `boolean` — default `false`
|
|
1396
|
-
- `class`: `ClassValue`
|
|
1397
|
-
- `idle`: `boolean` — default `false`
|
|
1398
|
-
- `size`: `number` — default `40`
|
|
1399
|
-
- `thinking`: `boolean` — default `false`
|
|
1400
|
-
|
|
1401
|
-
**Events**
|
|
1402
|
-
|
|
1403
|
-
- `update:idle`: `[value: boolean]`
|
|
1404
|
-
|
|
1405
|
-
**Source:** `src/components/mochi/mochi.vue`
|
|
1406
|
-
|
|
1407
|
-
**Example:** `src/components/mochi/stories/mochi.stories.ts`
|
|
1408
|
-
|
|
1409
|
-
---
|
|
1410
|
-
|
|
1411
|
-
## modal
|
|
1412
|
-
|
|
1413
|
-
### Modal
|
|
1414
|
-
|
|
1415
|
-
**Props**
|
|
1416
|
-
|
|
1417
|
-
- `class`: `unknown`
|
|
1418
|
-
- `defaultOpen`: `boolean` — The open state of the dialog when it is initially rendered. Use when you do not need to control its open state.
|
|
1419
|
-
- `modal`: `boolean` — The modality of the dialog When set to `true`, <br> interaction with outside elements will be disabled and only dialog content will be visible to screen readers.
|
|
1420
|
-
- `open`: `boolean` — The controlled open state of the dialog. Can be binded as `v-model:open`.
|
|
1421
|
-
- `unmountOnHide`: `boolean` — When set to `false`, the dialog content will not be unmounted when closed, but instead hidden with CSS. <br> Useful for SEO or when you want to improve performance by not remounting the component on every open.
|
|
1422
|
-
|
|
1423
|
-
**Events**
|
|
1424
|
-
|
|
1425
|
-
- `update:open`: `[value: boolean]`
|
|
1426
|
-
|
|
1427
|
-
**Slots**
|
|
1428
|
-
|
|
1429
|
-
- `default`
|
|
1430
|
-
|
|
1431
|
-
**Composes with:** `ModalBody`, `ModalClose`, `ModalContent`, `ModalFooter`, `ModalHeader`, `ModalTrigger`
|
|
1432
|
-
|
|
1433
|
-
**Source:** `src/components/modal/modal.vue`
|
|
1434
|
-
|
|
1435
|
-
**Example:** `src/components/modal/stories/modal.stories.ts`
|
|
1436
|
-
|
|
1437
|
-
### ModalBody
|
|
1438
|
-
|
|
1439
|
-
**Props**
|
|
1440
|
-
|
|
1441
|
-
- `class`: `ClassValue`
|
|
1442
|
-
|
|
1443
|
-
**Slots**
|
|
1444
|
-
|
|
1445
|
-
- `default`
|
|
1446
|
-
|
|
1447
|
-
**Composes with:** `Modal`, `ModalClose`, `ModalContent`, `ModalFooter`, `ModalHeader`, `ModalTrigger`
|
|
1448
|
-
|
|
1449
|
-
**Source:** `src/components/modal/modal-body.vue`
|
|
1450
|
-
|
|
1451
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1452
|
-
|
|
1453
|
-
### ModalClose
|
|
1454
|
-
|
|
1455
|
-
**Props**
|
|
1456
|
-
|
|
1457
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1458
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1459
|
-
- `class`: `unknown`
|
|
1460
|
-
|
|
1461
|
-
**Slots**
|
|
1462
|
-
|
|
1463
|
-
- `default`
|
|
1464
|
-
|
|
1465
|
-
**Composes with:** `Modal`, `ModalBody`, `ModalContent`, `ModalFooter`, `ModalHeader`, `ModalTrigger`
|
|
1466
|
-
|
|
1467
|
-
**Source:** `src/components/modal/modal-close.vue`
|
|
1468
|
-
|
|
1469
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1470
|
-
|
|
1471
|
-
### ModalContent
|
|
1472
|
-
|
|
1473
|
-
**Props**
|
|
1474
|
-
|
|
1475
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1476
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1477
|
-
- `class`: `ClassValue`
|
|
1478
|
-
- `disableOutsidePointerEvents`: `boolean` — When `true`, hover/focus/click interactions will be disabled on elements outside the `DismissableLayer`. Users will need to click twice on outside elements to interact with them: once to close the `DismissableLayer`, and again to trigger the element.
|
|
1479
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
1480
|
-
|
|
1481
|
-
**Events**
|
|
1482
|
-
|
|
1483
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
1484
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
1485
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
1486
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
1487
|
-
- `openAutoFocus`: `[event: Event]`
|
|
1488
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
1489
|
-
|
|
1490
|
-
**Slots**
|
|
1491
|
-
|
|
1492
|
-
- `default`
|
|
1493
|
-
|
|
1494
|
-
**Composes with:** `Modal`, `ModalBody`, `ModalClose`, `ModalFooter`, `ModalHeader`, `ModalTrigger`
|
|
1495
|
-
|
|
1496
|
-
**Source:** `src/components/modal/modal-content.vue`
|
|
1497
|
-
|
|
1498
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1499
|
-
|
|
1500
|
-
### ModalFooter
|
|
1501
|
-
|
|
1502
|
-
**Props**
|
|
1503
|
-
|
|
1504
|
-
- `class`: `ClassValue`
|
|
1505
|
-
|
|
1506
|
-
**Slots**
|
|
1507
|
-
|
|
1508
|
-
- `default`
|
|
1509
|
-
|
|
1510
|
-
**Composes with:** `Modal`, `ModalBody`, `ModalClose`, `ModalContent`, `ModalHeader`, `ModalTrigger`
|
|
1511
|
-
|
|
1512
|
-
**Source:** `src/components/modal/modal-footer.vue`
|
|
1513
|
-
|
|
1514
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1515
|
-
|
|
1516
|
-
### ModalHeader
|
|
1517
|
-
|
|
1518
|
-
**Props**
|
|
1519
|
-
|
|
1520
|
-
- `title`: `string` **(required)**
|
|
1521
|
-
- `alignment`: `horizontal` | `vertical` — default `"horizontal"`
|
|
1522
|
-
- `class`: `ClassValue`
|
|
1523
|
-
- `description`: `string`
|
|
1524
|
-
- `dismissible`: `boolean` — default `true`
|
|
1525
|
-
- `icon`: `string`
|
|
1526
|
-
- `type`: `information` | `default` | `success` | `warning` | `error` — default `"default"`
|
|
1527
|
-
|
|
1528
|
-
**Composes with:** `Modal`, `ModalBody`, `ModalClose`, `ModalContent`, `ModalFooter`, `ModalTrigger`
|
|
1529
|
-
|
|
1530
|
-
**Source:** `src/components/modal/modal-header.vue`
|
|
1531
|
-
|
|
1532
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1533
|
-
|
|
1534
|
-
### ModalTrigger
|
|
1535
|
-
|
|
1536
|
-
**Props**
|
|
1537
|
-
|
|
1538
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1539
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1540
|
-
- `class`: `unknown`
|
|
1541
|
-
|
|
1542
|
-
**Slots**
|
|
1543
|
-
|
|
1544
|
-
- `default`
|
|
1545
|
-
|
|
1546
|
-
**Composes with:** `Modal`, `ModalBody`, `ModalClose`, `ModalContent`, `ModalFooter`, `ModalHeader`
|
|
1547
|
-
|
|
1548
|
-
**Source:** `src/components/modal/modal-trigger.vue`
|
|
1549
|
-
|
|
1550
|
-
**Example:** no story of its own — see `src/components/modal/stories/modal.stories.ts` for the group.
|
|
1551
|
-
|
|
1552
|
-
---
|
|
1553
|
-
|
|
1554
|
-
## pagination
|
|
1555
|
-
|
|
1556
|
-
### Pagination
|
|
1557
|
-
|
|
1558
|
-
**Props**
|
|
1559
|
-
|
|
1560
|
-
- `itemsPerPage`: `number` **(required)** — Number of items per page
|
|
1561
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1562
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1563
|
-
- `class`: `ClassValue`
|
|
1564
|
-
- `defaultPage`: `number` — The value of the page that should be active when initially rendered. Use when you do not need to control the value state.
|
|
1565
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with item
|
|
1566
|
-
- `page`: `number` — The controlled value of the current page. Can be binded as `v-model:page`.
|
|
1567
|
-
- `showEdges`: `boolean` — When `true`, always show first page, last page, and ellipsis
|
|
1568
|
-
- `siblingCount`: `number` — Number of sibling should be shown around the current page
|
|
1569
|
-
- `total`: `number` — Number of items in your list
|
|
1570
|
-
- `variant`: `basic` | `rounded` | `group` — default `"basic"`
|
|
1571
|
-
|
|
1572
|
-
**Events**
|
|
1573
|
-
|
|
1574
|
-
- `update:page`: `[value: number]`
|
|
1575
|
-
|
|
1576
|
-
**Slots**
|
|
1577
|
-
|
|
1578
|
-
- `leading` — scope `{ page: number; pageCount: number; }`
|
|
1579
|
-
- `default` — scope `{ page: number; pageCount: number; }`
|
|
1580
|
-
- `trailing` — scope `{ page: number; pageCount: number; }`
|
|
1581
|
-
|
|
1582
|
-
**Composes with:** `PaginationContent`, `PaginationEllipsis`, `PaginationFirst`, `PaginationItem`, `PaginationLast`, `PaginationNext`, `PaginationPrevious`
|
|
1583
|
-
|
|
1584
|
-
**Source:** `src/components/pagination/pagination.vue`
|
|
1585
|
-
|
|
1586
|
-
**Example:** `src/components/pagination/stories/pagination.stories.ts`
|
|
1587
|
-
|
|
1588
|
-
### PaginationContent
|
|
1589
|
-
|
|
1590
|
-
**Props**
|
|
1591
|
-
|
|
1592
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1593
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1594
|
-
- `class`: `ClassValue`
|
|
1595
|
-
|
|
1596
|
-
**Slots**
|
|
1597
|
-
|
|
1598
|
-
- `default` — scope `{ items: ({ type: "ellipsis"; } | { type: "page"; value: number; })[]; }`
|
|
1599
|
-
|
|
1600
|
-
**Composes with:** `Pagination`, `PaginationEllipsis`, `PaginationFirst`, `PaginationItem`, `PaginationLast`, `PaginationNext`, `PaginationPrevious`
|
|
1601
|
-
|
|
1602
|
-
**Source:** `src/components/pagination/pagination-content.vue`
|
|
1603
|
-
|
|
1604
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1605
|
-
|
|
1606
|
-
### PaginationEllipsis
|
|
1607
|
-
|
|
1608
|
-
**Props**
|
|
1609
|
-
|
|
1610
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1611
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1612
|
-
- `class`: `ClassValue`
|
|
1613
|
-
|
|
1614
|
-
**Slots**
|
|
1615
|
-
|
|
1616
|
-
- `default`
|
|
1617
|
-
|
|
1618
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationFirst`, `PaginationItem`, `PaginationLast`, `PaginationNext`, `PaginationPrevious`
|
|
1619
|
-
|
|
1620
|
-
**Source:** `src/components/pagination/pagination-ellipsis.vue`
|
|
1621
|
-
|
|
1622
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1623
|
-
|
|
1624
|
-
### PaginationFirst
|
|
1625
|
-
|
|
1626
|
-
**Props**
|
|
1627
|
-
|
|
1628
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1629
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1630
|
-
- `class`: `ClassValue`
|
|
1631
|
-
|
|
1632
|
-
**Slots**
|
|
1633
|
-
|
|
1634
|
-
- `default`
|
|
1635
|
-
|
|
1636
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationEllipsis`, `PaginationItem`, `PaginationLast`, `PaginationNext`, `PaginationPrevious`
|
|
1637
|
-
|
|
1638
|
-
**Source:** `src/components/pagination/pagination-first.vue`
|
|
1639
|
-
|
|
1640
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1641
|
-
|
|
1642
|
-
### PaginationItem
|
|
1643
|
-
|
|
1644
|
-
**Props**
|
|
1645
|
-
|
|
1646
|
-
- `value`: `number` **(required)** — Value for the page
|
|
1647
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1648
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1649
|
-
- `class`: `ClassValue`
|
|
1650
|
-
- `disabled`: `boolean`
|
|
1651
|
-
- `isActive`: `boolean`
|
|
1652
|
-
|
|
1653
|
-
**Slots**
|
|
1654
|
-
|
|
1655
|
-
- `default`
|
|
1656
|
-
|
|
1657
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationEllipsis`, `PaginationFirst`, `PaginationLast`, `PaginationNext`, `PaginationPrevious`
|
|
1658
|
-
|
|
1659
|
-
**Source:** `src/components/pagination/pagination-item.vue`
|
|
1660
|
-
|
|
1661
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1662
|
-
|
|
1663
|
-
### PaginationLast
|
|
1664
|
-
|
|
1665
|
-
**Props**
|
|
1666
|
-
|
|
1667
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1668
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1669
|
-
- `class`: `ClassValue`
|
|
1670
|
-
|
|
1671
|
-
**Slots**
|
|
1672
|
-
|
|
1673
|
-
- `default`
|
|
1674
|
-
|
|
1675
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationEllipsis`, `PaginationFirst`, `PaginationItem`, `PaginationNext`, `PaginationPrevious`
|
|
1676
|
-
|
|
1677
|
-
**Source:** `src/components/pagination/pagination-last.vue`
|
|
1678
|
-
|
|
1679
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1680
|
-
|
|
1681
|
-
### PaginationNext
|
|
1682
|
-
|
|
1683
|
-
**Props**
|
|
1684
|
-
|
|
1685
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1686
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1687
|
-
- `class`: `ClassValue`
|
|
1688
|
-
|
|
1689
|
-
**Slots**
|
|
1690
|
-
|
|
1691
|
-
- `default`
|
|
1692
|
-
|
|
1693
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationEllipsis`, `PaginationFirst`, `PaginationItem`, `PaginationLast`, `PaginationPrevious`
|
|
1694
|
-
|
|
1695
|
-
**Source:** `src/components/pagination/pagination-next.vue`
|
|
1696
|
-
|
|
1697
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1698
|
-
|
|
1699
|
-
### PaginationPrevious
|
|
1700
|
-
|
|
1701
|
-
**Props**
|
|
1702
|
-
|
|
1703
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1704
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1705
|
-
- `class`: `ClassValue`
|
|
1706
|
-
|
|
1707
|
-
**Slots**
|
|
1708
|
-
|
|
1709
|
-
- `default`
|
|
1710
|
-
|
|
1711
|
-
**Composes with:** `Pagination`, `PaginationContent`, `PaginationEllipsis`, `PaginationFirst`, `PaginationItem`, `PaginationLast`, `PaginationNext`
|
|
1712
|
-
|
|
1713
|
-
**Source:** `src/components/pagination/pagination-previous.vue`
|
|
1714
|
-
|
|
1715
|
-
**Example:** no story of its own — see `src/components/pagination/stories/pagination.stories.ts` for the group.
|
|
1716
|
-
|
|
1717
|
-
---
|
|
1718
|
-
|
|
1719
|
-
## popover
|
|
1720
|
-
|
|
1721
|
-
### Popover
|
|
1722
|
-
|
|
1723
|
-
**Props**
|
|
1724
|
-
|
|
1725
|
-
- `class`: `unknown`
|
|
1726
|
-
- `defaultOpen`: `boolean` — The open state of the popover when it is initially rendered. Use when you do not need to control its open state.
|
|
1727
|
-
- `modal`: `boolean` — The modality of the popover. When set to true, interaction with outside elements will be disabled and only popover content will be visible to screen readers.
|
|
1728
|
-
- `open`: `boolean` — The controlled open state of the popover.
|
|
1729
|
-
|
|
1730
|
-
**Events**
|
|
1731
|
-
|
|
1732
|
-
- `update:open`: `[value: boolean]`
|
|
1733
|
-
|
|
1734
|
-
**Slots**
|
|
1735
|
-
|
|
1736
|
-
- `default`
|
|
1737
|
-
|
|
1738
|
-
**Composes with:** `PopoverContent`, `PopoverTrigger`
|
|
1739
|
-
|
|
1740
|
-
**Source:** `src/components/popover/popover.vue`
|
|
1741
|
-
|
|
1742
|
-
**Example:** `src/components/popover/stories/popover.stories.ts`
|
|
1743
|
-
|
|
1744
|
-
### PopoverContent
|
|
1745
|
-
|
|
1746
|
-
**Props**
|
|
1747
|
-
|
|
1748
|
-
- `align`: `start` | `center` | `end`
|
|
1749
|
-
- `alignOffset`: `number`
|
|
1750
|
-
- `class`: `ClassValue`
|
|
1751
|
-
- `description`: `string`
|
|
1752
|
-
- `dismissible`: `boolean` — default `true`
|
|
1753
|
-
- `icon`: `string`
|
|
1754
|
-
- `iconSize`: `sm` | `lg` | `md` | `xl` | `xxl` — default `"lg"`
|
|
1755
|
-
- `showTail`: `boolean` — default `true`
|
|
1756
|
-
- `side`: `top` | `right` | `bottom` | `left` — default `"bottom"`
|
|
1757
|
-
- `sideOffset`: `number`
|
|
1758
|
-
- `title`: `string`
|
|
1759
|
-
|
|
1760
|
-
**Events**
|
|
1761
|
-
|
|
1762
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
1763
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
1764
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
1765
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
1766
|
-
- `openAutoFocus`: `[event: Event]`
|
|
1767
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
1768
|
-
|
|
1769
|
-
**Slots**
|
|
1770
|
-
|
|
1771
|
-
- `default`
|
|
1772
|
-
- `footer`
|
|
1773
|
-
|
|
1774
|
-
**Composes with:** `Popover`, `PopoverTrigger`
|
|
1775
|
-
|
|
1776
|
-
**Source:** `src/components/popover/popover-content.vue`
|
|
1777
|
-
|
|
1778
|
-
**Example:** no story of its own — see `src/components/popover/stories/popover.stories.ts` for the group.
|
|
1779
|
-
|
|
1780
|
-
### PopoverTrigger
|
|
1781
|
-
|
|
1782
|
-
**Props**
|
|
1783
|
-
|
|
1784
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1785
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1786
|
-
- `class`: `unknown`
|
|
1787
|
-
|
|
1788
|
-
**Slots**
|
|
1789
|
-
|
|
1790
|
-
- `default`
|
|
1791
|
-
|
|
1792
|
-
**Composes with:** `Popover`, `PopoverContent`
|
|
1793
|
-
|
|
1794
|
-
**Source:** `src/components/popover/popover-trigger.vue`
|
|
1795
|
-
|
|
1796
|
-
**Example:** no story of its own — see `src/components/popover/stories/popover.stories.ts` for the group.
|
|
1797
|
-
|
|
1798
|
-
---
|
|
1799
|
-
|
|
1800
|
-
## progress
|
|
1801
|
-
|
|
1802
|
-
### ProgressBar
|
|
1803
|
-
|
|
1804
|
-
**Props**
|
|
1805
|
-
|
|
1806
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1807
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1808
|
-
- `class`: `ClassValue`
|
|
1809
|
-
- `color`: `primary` | `blue` | `red` | `orange` | `green` — default `"primary"`
|
|
1810
|
-
- `getValueLabel`: `((value: number | null | undefined, max: number) => string | undefined)` — A function to get the accessible label text in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value.
|
|
1811
|
-
- `getValueText`: `((value: number | null | undefined, max: number) => string | undefined)` — A function to get the accessible value text representing the current value in a human-readable format.
|
|
1812
|
-
- `layout`: `default` | `inline` | `bare` | `no-description` — default `"bare"`
|
|
1813
|
-
- `max`: `number` — default `100` — The maximum progress value.
|
|
1814
|
-
- `modelValue`: `number | null` — default `0` — The progress value. Can be bind as `v-model`.
|
|
1815
|
-
- `title`: `string`
|
|
1816
|
-
|
|
1817
|
-
**Slots**
|
|
1818
|
-
|
|
1819
|
-
- `label`
|
|
1820
|
-
- `description`
|
|
1821
|
-
|
|
1822
|
-
**Composes with:** `ProgressCircle`
|
|
1823
|
-
|
|
1824
|
-
**Source:** `src/components/progress/progress-bar.vue`
|
|
1825
|
-
|
|
1826
|
-
**Example:** `src/components/progress/stories/progress-bar.stories.ts`
|
|
1827
|
-
|
|
1828
|
-
### ProgressCircle
|
|
1829
|
-
|
|
1830
|
-
**Props**
|
|
1831
|
-
|
|
1832
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1833
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1834
|
-
- `class`: `ClassValue`
|
|
1835
|
-
- `getValueLabel`: `((value: number | null | undefined, max: number) => string | undefined)` — A function to get the accessible label text in a human-readable format. If not provided, the value label will be read as the numeric value as a percentage of the max value.
|
|
1836
|
-
- `getValueText`: `((value: number | null | undefined, max: number) => string | undefined)` — A function to get the accessible value text representing the current value in a human-readable format.
|
|
1837
|
-
- `max`: `number` — default `100` — The maximum progress value.
|
|
1838
|
-
- `modelValue`: `number | null` — default `0` — The progress value. Can be bind as `v-model`.
|
|
1839
|
-
- `size`: `80 | 72 | 64 | 56 | 48` — default `80`
|
|
1840
|
-
|
|
1841
|
-
**Slots**
|
|
1842
|
-
|
|
1843
|
-
- `default`
|
|
1844
|
-
|
|
1845
|
-
**Composes with:** `ProgressBar`
|
|
1846
|
-
|
|
1847
|
-
**Source:** `src/components/progress/progress-circle.vue`
|
|
1848
|
-
|
|
1849
|
-
**Example:** no story of its own — see `src/components/progress/stories/progress-bar.stories.ts` for the group.
|
|
1850
|
-
|
|
1851
|
-
---
|
|
1852
|
-
|
|
1853
|
-
## radio-group
|
|
1854
|
-
|
|
1855
|
-
### RadioGroup
|
|
1856
|
-
|
|
1857
|
-
**Props**
|
|
1858
|
-
|
|
1859
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1860
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1861
|
-
- `class`: `ClassValue`
|
|
1862
|
-
- `defaultValue`: `AcceptableValue` — The value of the radio item that should be checked when initially rendered. Use when you do not need to control the state of the radio items.
|
|
1863
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
1864
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with radio items.
|
|
1865
|
-
- `loop`: `boolean` — When `true`, keyboard navigation will loop from last item to first, and vice versa.
|
|
1866
|
-
- `modelValue`: `AcceptableValue` — The controlled value of the radio item to check. Can be binded as `v-model`.
|
|
1867
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
1868
|
-
- `orientation`: `DataOrientation` — The orientation of the component.
|
|
1869
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
1870
|
-
|
|
1871
|
-
**Events**
|
|
1872
|
-
|
|
1873
|
-
- `update:modelValue`: `[payload: AcceptableValue]`
|
|
1874
|
-
|
|
1875
|
-
**Slots**
|
|
1876
|
-
|
|
1877
|
-
- `default`
|
|
1878
|
-
|
|
1879
|
-
**Composes with:** `RadioGroupCard`, `RadioGroupItem`, `RadioGroupLabel`
|
|
1880
|
-
|
|
1881
|
-
**Source:** `src/components/radio-group/radio-group.vue`
|
|
1882
|
-
|
|
1883
|
-
**Example:** `src/components/radio-group/stories/radio-group.stories.ts`
|
|
1884
|
-
|
|
1885
|
-
### RadioGroupCard
|
|
1886
|
-
|
|
1887
|
-
**Props**
|
|
1888
|
-
|
|
1889
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1890
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1891
|
-
- `class`: `ClassValue`
|
|
1892
|
-
- `disabled`: `boolean`
|
|
1893
|
-
- `for`: `string` — The id of the element the label is associated with.
|
|
1894
|
-
- `required`: `boolean`
|
|
1895
|
-
|
|
1896
|
-
**Slots**
|
|
1897
|
-
|
|
1898
|
-
- `image` — scope `{ class: string; }`
|
|
1899
|
-
- `icon`
|
|
1900
|
-
- `label`
|
|
1901
|
-
- `sublabel`
|
|
1902
|
-
- `badge` — scope `{ disabled: boolean; }`
|
|
1903
|
-
- `description`
|
|
1904
|
-
- `default`
|
|
1905
|
-
|
|
1906
|
-
**Composes with:** `RadioGroup`, `RadioGroupItem`, `RadioGroupLabel`
|
|
1907
|
-
|
|
1908
|
-
**Source:** `src/components/radio-group/radio-group-card.vue`
|
|
1909
|
-
|
|
1910
|
-
**Example:** `src/components/radio-group/stories/radio-group-card.stories.ts`
|
|
1911
|
-
|
|
1912
|
-
### RadioGroupItem
|
|
1913
|
-
|
|
1914
|
-
**Props**
|
|
1915
|
-
|
|
1916
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1917
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1918
|
-
- `class`: `ClassValue`
|
|
1919
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the radio item.
|
|
1920
|
-
- `id`: `string`
|
|
1921
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
1922
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
1923
|
-
- `value`: `AcceptableValue` — The value given as data when submitted with a `name`.
|
|
1924
|
-
|
|
1925
|
-
**Composes with:** `RadioGroup`, `RadioGroupCard`, `RadioGroupLabel`
|
|
1926
|
-
|
|
1927
|
-
**Source:** `src/components/radio-group/radio-group-item.vue`
|
|
1928
|
-
|
|
1929
|
-
**Example:** no story of its own — see `src/components/radio-group/stories/radio-group.stories.ts` for the group.
|
|
1930
|
-
|
|
1931
|
-
### RadioGroupLabel
|
|
1932
|
-
|
|
1933
|
-
**Props**
|
|
1934
|
-
|
|
1935
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1936
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1937
|
-
- `class`: `ClassValue`
|
|
1938
|
-
- `disabled`: `boolean`
|
|
1939
|
-
- `for`: `string` — The id of the element the label is associated with.
|
|
1940
|
-
- `required`: `boolean`
|
|
1941
|
-
|
|
1942
|
-
**Slots**
|
|
1943
|
-
|
|
1944
|
-
- `default`
|
|
1945
|
-
- `label`
|
|
1946
|
-
- `sublabel`
|
|
1947
|
-
- `badge`
|
|
1948
|
-
- `description`
|
|
1949
|
-
- `linkButton`
|
|
1950
|
-
|
|
1951
|
-
**Composes with:** `RadioGroup`, `RadioGroupCard`, `RadioGroupItem`
|
|
1952
|
-
|
|
1953
|
-
**Source:** `src/components/radio-group/radio-group-label.vue`
|
|
1954
|
-
|
|
1955
|
-
**Example:** no story of its own — see `src/components/radio-group/stories/radio-group.stories.ts` for the group.
|
|
1956
|
-
|
|
1957
|
-
---
|
|
1958
|
-
|
|
1959
|
-
## range-calendar
|
|
1960
|
-
|
|
1961
|
-
### RangeCalendar
|
|
1962
|
-
|
|
1963
|
-
**Props**
|
|
1964
|
-
|
|
1965
|
-
- `allowNonContiguousRanges`: `boolean` — When combined with `isDateUnavailable`, determines whether non-contiguous ranges, i.e. ranges containing unavailable dates, may be selected.
|
|
1966
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
1967
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
1968
|
-
- `calendarLabel`: `string` — The accessible label for the calendar
|
|
1969
|
-
- `class`: `ClassValue`
|
|
1970
|
-
- `defaultPlaceholder`: `DateValue` — The default placeholder date
|
|
1971
|
-
- `defaultValue`: `DateRange` — The default value for the calendar
|
|
1972
|
-
- `dir`: `Direction` — The reading direction of the calendar when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
1973
|
-
- `disabled`: `boolean` — Whether or not the calendar is disabled
|
|
1974
|
-
- `disableDaysOutsideCurrentView`: `boolean` — Whether or not to disable days outside the current view.
|
|
1975
|
-
- `fixedDate`: `start` | `end` — Which part of the range should be fixed
|
|
1976
|
-
- `fixedWeeks`: `boolean` — default `true` — Whether or not to always display 6 weeks in the calendar
|
|
1977
|
-
- `initialFocus`: `boolean` — If true, the calendar will focus the selected day, today, or the first day of the month depending on what is visible when the calendar is mounted
|
|
1978
|
-
- `isDateDisabled`: `Matcher` — A function that returns whether or not a date is disabled
|
|
1979
|
-
- `isDateHighlightable`: `Matcher` — A function that returns whether or not a date is hightable
|
|
1980
|
-
- `isDateUnavailable`: `Matcher` — A function that returns whether or not a date is unavailable
|
|
1981
|
-
- `locale`: `string` — The locale to use for formatting dates
|
|
1982
|
-
- `markedDates`: `DateValue[]`
|
|
1983
|
-
- `maximumDays`: `number` — The maximum number of days that can be selected in a range
|
|
1984
|
-
- `maxValue`: `DateValue` — The maximum date that can be selected
|
|
1985
|
-
- `minValue`: `DateValue` — The minimum date that can be selected
|
|
1986
|
-
- `modelValue`: `DateRange | null` — The controlled selected date range of the calendar. Can be bound as `v-model`.
|
|
1987
|
-
- `nextPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the next page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
1988
|
-
- `numberOfMonths`: `number` — default `2` — The number of months to display at once
|
|
1989
|
-
- `pagedNavigation`: `boolean` — This property causes the previous and next buttons to navigate by the number of months displayed at once, rather than one month
|
|
1990
|
-
- `placeholder`: `DateValue` — The placeholder date, which is used to determine what month to display when no date is selected. This updates as the user navigates the calendar and can be used to programmatically control the calendar view
|
|
1991
|
-
- `preventDeselect`: `boolean` — Whether or not to prevent the user from deselecting a date without selecting another date first
|
|
1992
|
-
- `prevPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the previous page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
1993
|
-
- `readonly`: `boolean` — Whether or not the calendar is readonly
|
|
1994
|
-
- `weekdayFormat`: `WeekDayFormat` — default `"short"` — The format to use for the weekday strings provided via the weekdays slot prop
|
|
1995
|
-
- `weekStartsOn`: `WeekStartsOn` — default `1` — The day of the week to start the calendar on
|
|
1996
|
-
|
|
1997
|
-
**Events**
|
|
1998
|
-
|
|
1999
|
-
- `update:modelValue`: `[date: DateRange]`
|
|
2000
|
-
- `update:placeholder`: `[date: DateValue]`
|
|
2001
|
-
- `update:validModelValue`: `[date: DateRange]`
|
|
2002
|
-
- `update:startValue`: `[date: DateValue | undefined]`
|
|
2003
|
-
|
|
2004
|
-
**Source:** `src/components/range-calendar/range-calendar.vue`
|
|
2005
|
-
|
|
2006
|
-
**Example:** `src/components/range-calendar/stories/range-calendar.stories.ts`
|
|
2007
|
-
|
|
2008
|
-
---
|
|
2009
|
-
|
|
2010
|
-
## range-picker
|
|
2011
|
-
|
|
2012
|
-
### RangePicker
|
|
2013
|
-
|
|
2014
|
-
**Props**
|
|
2015
|
-
|
|
2016
|
-
- `allowNonContiguousRanges`: `boolean` — When combined with `isDateUnavailable`, determines whether non-contiguous ranges, i.e. ranges containing unavailable dates, may be selected.
|
|
2017
|
-
- `applyLabel`: `string` — default `"Apply"`
|
|
2018
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2019
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2020
|
-
- `calendarLabel`: `string` — The accessible label for the calendar
|
|
2021
|
-
- `cancelLabel`: `string` — default `"Cancel"`
|
|
2022
|
-
- `class`: `ClassValue`
|
|
2023
|
-
- `defaultPlaceholder`: `DateValue` — The default placeholder date
|
|
2024
|
-
- `defaultValue`: `DateRange` — The default value for the calendar
|
|
2025
|
-
- `dir`: `Direction` — The reading direction of the calendar when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2026
|
-
- `disabled`: `boolean` — Whether or not the calendar is disabled
|
|
2027
|
-
- `disableDaysOutsideCurrentView`: `boolean` — Whether or not to disable days outside the current view.
|
|
2028
|
-
- `fixedDate`: `start` | `end` — Which part of the range should be fixed
|
|
2029
|
-
- `fixedWeeks`: `boolean` — Whether or not to always display 6 weeks in the calendar
|
|
2030
|
-
- `footer`: `boolean` — default `true`
|
|
2031
|
-
- `initialFocus`: `boolean` — If true, the calendar will focus the selected day, today, or the first day of the month depending on what is visible when the calendar is mounted
|
|
2032
|
-
- `isDateDisabled`: `Matcher` — A function that returns whether or not a date is disabled
|
|
2033
|
-
- `isDateHighlightable`: `Matcher` — A function that returns whether or not a date is hightable
|
|
2034
|
-
- `isDateUnavailable`: `Matcher` — A function that returns whether or not a date is unavailable
|
|
2035
|
-
- `locale`: `string` — The locale to use for formatting dates
|
|
2036
|
-
- `markedDates`: `DateValue[]`
|
|
2037
|
-
- `maximumDays`: `number` — The maximum number of days that can be selected in a range
|
|
2038
|
-
- `maxValue`: `DateValue` — The maximum date that can be selected
|
|
2039
|
-
- `minValue`: `DateValue` — The minimum date that can be selected
|
|
2040
|
-
- `modelValue`: `DateRange` — default `{ start: undefined, end: undefined }`
|
|
2041
|
-
- `nextPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the next page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
2042
|
-
- `numberOfMonths`: `number` — The number of months to display at once
|
|
2043
|
-
- `pagedNavigation`: `boolean` — This property causes the previous and next buttons to navigate by the number of months displayed at once, rather than one month
|
|
2044
|
-
- `placeholder`: `DateValue` — The placeholder date, which is used to determine what month to display when no date is selected. This updates as the user navigates the calendar and can be used to programmatically control the calendar view
|
|
2045
|
-
- `placeholderLabel`: `string` — default `"Select a range"`
|
|
2046
|
-
- `presets`: `RangePickerPreset[]`
|
|
2047
|
-
- `preventDeselect`: `boolean` — Whether or not to prevent the user from deselecting a date without selecting another date first
|
|
2048
|
-
- `prevPage`: `((placeholder: DateValue) => DateValue)` — A function that returns the previous page of the calendar. It receives the current placeholder as an argument inside the component.
|
|
2049
|
-
- `rangeLabel`: `string` — default `"Range:"`
|
|
2050
|
-
- `readonly`: `boolean` — Whether or not the calendar is readonly
|
|
2051
|
-
- `showPresets`: `boolean` — default `true`
|
|
2052
|
-
- `weekdayFormat`: `WeekDayFormat` — The format to use for the weekday strings provided via the weekdays slot prop
|
|
2053
|
-
- `weekStartsOn`: `WeekStartsOn` — The day of the week to start the calendar on
|
|
2054
|
-
|
|
2055
|
-
**Events**
|
|
2056
|
-
|
|
2057
|
-
- `update:modelValue`: `[value: DateRange]`
|
|
2058
|
-
- `apply`: `[value: DateRange]`
|
|
2059
|
-
- `cancel`: `[]`
|
|
2060
|
-
|
|
2061
|
-
**Source:** `src/components/range-picker/range-picker.vue`
|
|
2062
|
-
|
|
2063
|
-
**Example:** `src/components/range-picker/stories/range-picker.stories.ts`
|
|
2064
|
-
|
|
2065
|
-
---
|
|
2066
|
-
|
|
2067
|
-
## rich-editor
|
|
2068
|
-
|
|
2069
|
-
### RichEditor
|
|
2070
|
-
|
|
2071
|
-
**Props**
|
|
2072
|
-
|
|
2073
|
-
- `class`: `unknown`
|
|
2074
|
-
- `customToolbar`: `string[]` — default `[]`
|
|
2075
|
-
- `maxLimit`: `number` — default `null`
|
|
2076
|
-
- `modelValue`: `string` — default `''`
|
|
2077
|
-
- `placeholder`: `string` — default `''`
|
|
2078
|
-
- `showExtraSettings`: `boolean` — default `true`
|
|
2079
|
-
|
|
2080
|
-
**Events**
|
|
2081
|
-
|
|
2082
|
-
- `update:modelValue`: `any[]`
|
|
2083
|
-
|
|
2084
|
-
**Source:** `src/components/rich-editor/rich-editor.vue`
|
|
2085
|
-
|
|
2086
|
-
**Example:** `src/components/rich-editor/stories/rich-editor.stories.ts`
|
|
2087
|
-
|
|
2088
|
-
---
|
|
2089
|
-
|
|
2090
|
-
## scroll-area
|
|
2091
|
-
|
|
2092
|
-
### ScrollArea
|
|
2093
|
-
|
|
2094
|
-
**Props**
|
|
2095
|
-
|
|
2096
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2097
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2098
|
-
- `class`: `ClassValue`
|
|
2099
|
-
- `dir`: `Direction$2` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2100
|
-
- `scrollHideDelay`: `number` — If type is set to either `scroll` or `hover`, this prop determines the length of time, in milliseconds, <br> before the scrollbars are hidden after the user stops interacting with scrollbars.
|
|
2101
|
-
- `type`: `ScrollType` — Describes the nature of scrollbar visibility, similar to how the scrollbar preferences in MacOS control visibility of native scrollbars. `auto` - means that scrollbars are visible when content is overflowing on the corresponding orientation. <br> `always` - means that scrollbars are always visible regardless of whether the content is overflowing.<br> `scroll` - means that scrollbars are visible when the user is scrolling along its corresponding orientation.<br> `hover` - when the user is scrolling along its corresponding orientation and when the user is hovering over the scroll area.<br> `glimpse` - a hybrid approach that briefly shows scrollbars when the user enters the scroll area, then hides them until further interaction.
|
|
2102
|
-
|
|
2103
|
-
**Slots**
|
|
2104
|
-
|
|
2105
|
-
- `default`
|
|
2106
|
-
|
|
2107
|
-
**Source:** `src/components/scroll-area/scroll-area.vue`
|
|
2108
|
-
|
|
2109
|
-
**Example:** `src/components/scroll-area/stories/scroll-area.stories.ts`
|
|
2110
|
-
|
|
2111
|
-
---
|
|
2112
|
-
|
|
2113
|
-
## segmented-control
|
|
2114
|
-
|
|
2115
|
-
### SegmentedControl
|
|
2116
|
-
|
|
2117
|
-
**Props**
|
|
2118
|
-
|
|
2119
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2120
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2121
|
-
- `class`: `ClassValue`
|
|
2122
|
-
- `defaultValue`: `AcceptableValue | AcceptableValue[]` — The default active value of the item(s). Use when you do not need to control the state of the item(s).
|
|
2123
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2124
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the toggle group and all its items.
|
|
2125
|
-
- `loop`: `boolean` — When `loop` and `rovingFocus` is `true`, keyboard navigation will loop from last item to first, and vice versa.
|
|
2126
|
-
- `modelValue`: `AcceptableValue | AcceptableValue[]` — The controlled value of the active item(s). Use this when you need to control the state of the items. Can be binded with `v-model`
|
|
2127
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
2128
|
-
- `orientation`: `DataOrientation` — The orientation of the component, which determines how focus moves: `horizontal` for left/right arrows and `vertical` for up/down arrows.
|
|
2129
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
2130
|
-
- `rovingFocus`: `boolean` — When `false`, navigating through the items using arrow keys will be disabled.
|
|
2131
|
-
|
|
2132
|
-
**Events**
|
|
2133
|
-
|
|
2134
|
-
- `update:modelValue`: `[payload: AcceptableValue | AcceptableValue[]]`
|
|
2135
|
-
|
|
2136
|
-
**Slots**
|
|
2137
|
-
|
|
2138
|
-
- `default`
|
|
2139
|
-
|
|
2140
|
-
**Composes with:** `SegmentedControlItem`
|
|
2141
|
-
|
|
2142
|
-
**Source:** `src/components/segmented-control/segmented-control.vue`
|
|
2143
|
-
|
|
2144
|
-
**Example:** `src/components/segmented-control/stories/segmented-control.stories.ts`
|
|
2145
|
-
|
|
2146
|
-
### SegmentedControlItem
|
|
2147
|
-
|
|
2148
|
-
**Props**
|
|
2149
|
-
|
|
2150
|
-
- `value`: `AcceptableValue` **(required)** — A string value for the toggle group item. All items within a toggle group should use a unique value.
|
|
2151
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2152
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2153
|
-
- `class`: `ClassValue`
|
|
2154
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the toggle.
|
|
2155
|
-
|
|
2156
|
-
**Slots**
|
|
2157
|
-
|
|
2158
|
-
- `default`
|
|
2159
|
-
|
|
2160
|
-
**Composes with:** `SegmentedControl`
|
|
2161
|
-
|
|
2162
|
-
**Source:** `src/components/segmented-control/segmented-control-item.vue`
|
|
2163
|
-
|
|
2164
|
-
**Example:** no story of its own — see `src/components/segmented-control/stories/segmented-control.stories.ts` for the group.
|
|
2165
|
-
|
|
2166
|
-
---
|
|
2167
|
-
|
|
2168
|
-
## select
|
|
2169
|
-
|
|
2170
|
-
### Select
|
|
2171
|
-
|
|
2172
|
-
**Props**
|
|
2173
|
-
|
|
2174
|
-
- `autocomplete`: `string` — Native html input `autocomplete` attribute.
|
|
2175
|
-
- `by`: `string | ((a: AcceptableValue, b: AcceptableValue) => boolean)` — Use this to compare objects by a particular field, or pass your own comparison function for complete control over how objects are compared.
|
|
2176
|
-
- `class`: `ClassValue`
|
|
2177
|
-
- `defaultOpen`: `boolean` — The open state of the select when it is initially rendered. Use when you do not need to control its open state.
|
|
2178
|
-
- `defaultValue`: `AcceptableValue | AcceptableValue[]` — The value of the select when initially rendered. Use when you do not need to control the state of the Select
|
|
2179
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2180
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with Select
|
|
2181
|
-
- `modelValue`: `AcceptableValue | AcceptableValue[]` — The controlled value of the Select. Can be bind as `v-model`.
|
|
2182
|
-
- `multiple`: `boolean` — Whether multiple options can be selected or not.
|
|
2183
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
2184
|
-
- `nullableValue`: `string` — The value of the hidden native select option when the model value is nullish.
|
|
2185
|
-
- `open`: `boolean` — The controlled open state of the Select. Can be bind as `v-model:open`.
|
|
2186
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
2187
|
-
|
|
2188
|
-
**Events**
|
|
2189
|
-
|
|
2190
|
-
- `update:modelValue`: `[value: AcceptableValue]`
|
|
2191
|
-
- `update:open`: `[value: boolean]`
|
|
2192
|
-
|
|
2193
|
-
**Slots**
|
|
2194
|
-
|
|
2195
|
-
- `default`
|
|
2196
|
-
|
|
2197
|
-
**Composes with:** `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2198
|
-
|
|
2199
|
-
**Source:** `src/components/select/select.vue`
|
|
2200
|
-
|
|
2201
|
-
**Example:** `src/components/select/stories/select.stories.ts`
|
|
2202
|
-
|
|
2203
|
-
### SelectContent
|
|
2204
|
-
|
|
2205
|
-
**Props**
|
|
2206
|
-
|
|
2207
|
-
- `align`: `start` | `center` | `end` — The preferred alignment against the trigger. May change when collisions occur.
|
|
2208
|
-
- `alignFlip`: `boolean` — Flip alignment when colliding with boundary. May only occur when `prioritizePosition` is true.
|
|
2209
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
2210
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
2211
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2212
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2213
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
2214
|
-
- `bodyLock`: `boolean` — The document.body will be lock, and scrolling will be disabled.
|
|
2215
|
-
- `class`: `ClassValue`
|
|
2216
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
2217
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
2218
|
-
- `dir`: `Direction` — The reading direction of the popper content when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2219
|
-
- `disableOutsidePointerEvents`: `boolean` — When `true`, hover/focus/click interactions will be disabled on elements outside the `DismissableLayer`. Users will need to click twice on outside elements to interact with them: once to close the `DismissableLayer`, and again to trigger the element.
|
|
2220
|
-
- `disableUpdateOnLayoutShift`: `boolean` — Whether to disable the update position for the content when the layout shifted.
|
|
2221
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
2222
|
-
- `hideShiftedArrow`: `boolean` — When `true`, hides the arrow when it cannot be centered to the reference element.
|
|
2223
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
2224
|
-
- `memoDependencies`: `unknown[]` — Reactive dependencies that should invalidate the memoized content subtree.
|
|
2225
|
-
- `position`: `popper` | `item-aligned` — The positioning mode to use `item-aligned (default)` - behaves similarly to a native MacOS menu by positioning content relative to the active item. <br> `popper` - positions content in the same way as our other primitives, for example `Popover` or `DropdownMenu`.
|
|
2226
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
2227
|
-
- `prioritizePosition`: `boolean` — Force content to be position within the viewport. Might overlap the reference element, which may not be desired.
|
|
2228
|
-
- `reference`: `ReferenceElement` — The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
|
|
2229
|
-
- `side`: `top` | `right` | `bottom` | `left` — The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
|
|
2230
|
-
- `sideFlip`: `boolean` — Flip to the opposite side when colliding with boundary.
|
|
2231
|
-
- `sideOffset`: `number` — The distance in pixels from the trigger.
|
|
2232
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
2233
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
2234
|
-
- `width`: `full` | `fit` — default `"full"`
|
|
2235
|
-
|
|
2236
|
-
**Events**
|
|
2237
|
-
|
|
2238
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
2239
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
2240
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
2241
|
-
|
|
2242
|
-
**Slots**
|
|
2243
|
-
|
|
2244
|
-
- `default`
|
|
2245
|
-
|
|
2246
|
-
**Composes with:** `Select`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2247
|
-
|
|
2248
|
-
**Source:** `src/components/select/select-content.vue`
|
|
2249
|
-
|
|
2250
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2251
|
-
|
|
2252
|
-
### SelectGroup
|
|
2253
|
-
|
|
2254
|
-
**Props**
|
|
2255
|
-
|
|
2256
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2257
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2258
|
-
- `class`: `unknown`
|
|
2259
|
-
|
|
2260
|
-
**Slots**
|
|
2261
|
-
|
|
2262
|
-
- `default`
|
|
2263
|
-
|
|
2264
|
-
**Composes with:** `Select`, `SelectContent`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2265
|
-
|
|
2266
|
-
**Source:** `src/components/select/select-group.vue`
|
|
2267
|
-
|
|
2268
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2269
|
-
|
|
2270
|
-
### SelectIcon
|
|
2271
|
-
|
|
2272
|
-
**Props**
|
|
2273
|
-
|
|
2274
|
-
- `class`: `ClassValue`
|
|
2275
|
-
|
|
2276
|
-
**Slots**
|
|
2277
|
-
|
|
2278
|
-
- `default`
|
|
2279
|
-
|
|
2280
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2281
|
-
|
|
2282
|
-
**Source:** `src/components/select/select-icon.vue`
|
|
2283
|
-
|
|
2284
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2285
|
-
|
|
2286
|
-
### SelectItem
|
|
2287
|
-
|
|
2288
|
-
**Props**
|
|
2289
|
-
|
|
2290
|
-
- `value`: `AcceptableValue` **(required)** — The value given as data when submitted with a `name`.
|
|
2291
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2292
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2293
|
-
- `class`: `ClassValue`
|
|
2294
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the item.
|
|
2295
|
-
- `textValue`: `string` — Optional text used for typeahead purposes. By default the typeahead behavior will use the `.textContent` of the `SelectItemText` part. Use this when the content is complex, or you have non-textual content inside.
|
|
2296
|
-
|
|
2297
|
-
**Slots**
|
|
2298
|
-
|
|
2299
|
-
- `default`
|
|
2300
|
-
|
|
2301
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2302
|
-
|
|
2303
|
-
**Source:** `src/components/select/select-item.vue`
|
|
2304
|
-
|
|
2305
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2306
|
-
|
|
2307
|
-
### SelectLabel
|
|
2308
|
-
|
|
2309
|
-
**Props**
|
|
2310
|
-
|
|
2311
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2312
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2313
|
-
- `class`: `ClassValue`
|
|
2314
|
-
- `for`: `string`
|
|
2315
|
-
|
|
2316
|
-
**Slots**
|
|
2317
|
-
|
|
2318
|
-
- `default`
|
|
2319
|
-
|
|
2320
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectSeparator`, `SelectTrigger`, `SelectValue`
|
|
2321
|
-
|
|
2322
|
-
**Source:** `src/components/select/select-label.vue`
|
|
2323
|
-
|
|
2324
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2325
|
-
|
|
2326
|
-
### SelectSeparator
|
|
2327
|
-
|
|
2328
|
-
**Props**
|
|
2329
|
-
|
|
2330
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2331
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2332
|
-
- `class`: `ClassValue`
|
|
2333
|
-
|
|
2334
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectTrigger`, `SelectValue`
|
|
2335
|
-
|
|
2336
|
-
**Source:** `src/components/select/select-separator.vue`
|
|
2337
|
-
|
|
2338
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2339
|
-
|
|
2340
|
-
### SelectTrigger
|
|
2341
|
-
|
|
2342
|
-
**Props**
|
|
2343
|
-
|
|
2344
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2345
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2346
|
-
- `class`: `ClassValue`
|
|
2347
|
-
- `disabled`: `boolean`
|
|
2348
|
-
- `hasError`: `boolean`
|
|
2349
|
-
- `reference`: `ReferenceElement` — The reference (or anchor) element that is being referred to for positioning. If not provided will use the current component as anchor.
|
|
2350
|
-
- `size`: `xs` | `sm` | `md` — default `"md"`
|
|
2351
|
-
- `variant`: `default` | `compact` | `inline` — default `"default"`
|
|
2352
|
-
|
|
2353
|
-
**Slots**
|
|
2354
|
-
|
|
2355
|
-
- `default`
|
|
2356
|
-
|
|
2357
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectValue`
|
|
2358
|
-
|
|
2359
|
-
**Source:** `src/components/select/select-trigger.vue`
|
|
2360
|
-
|
|
2361
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2362
|
-
|
|
2363
|
-
### SelectValue
|
|
2364
|
-
|
|
2365
|
-
**Props**
|
|
2366
|
-
|
|
2367
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2368
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2369
|
-
- `class`: `ClassValue`
|
|
2370
|
-
- `placeholder`: `string` — The content that will be rendered inside the `SelectValue` when no `value` or `defaultValue` is set.
|
|
2371
|
-
|
|
2372
|
-
**Slots**
|
|
2373
|
-
|
|
2374
|
-
- `default`
|
|
2375
|
-
|
|
2376
|
-
**Composes with:** `Select`, `SelectContent`, `SelectGroup`, `SelectIcon`, `SelectItem`, `SelectLabel`, `SelectSeparator`, `SelectTrigger`
|
|
2377
|
-
|
|
2378
|
-
**Source:** `src/components/select/select-value.vue`
|
|
2379
|
-
|
|
2380
|
-
**Example:** no story of its own — see `src/components/select/stories/select.stories.ts` for the group.
|
|
2381
|
-
|
|
2382
|
-
---
|
|
2383
|
-
|
|
2384
|
-
## sheet
|
|
2385
|
-
|
|
2386
|
-
### Sheet
|
|
2387
|
-
|
|
2388
|
-
**Props**
|
|
2389
|
-
|
|
2390
|
-
- `class`: `unknown`
|
|
2391
|
-
- `defaultOpen`: `boolean` — The open state of the dialog when it is initially rendered. Use when you do not need to control its open state.
|
|
2392
|
-
- `modal`: `boolean` — The modality of the dialog When set to `true`, <br> interaction with outside elements will be disabled and only dialog content will be visible to screen readers.
|
|
2393
|
-
- `open`: `boolean` — The controlled open state of the dialog. Can be binded as `v-model:open`.
|
|
2394
|
-
- `unmountOnHide`: `boolean` — When set to `false`, the dialog content will not be unmounted when closed, but instead hidden with CSS. <br> Useful for SEO or when you want to improve performance by not remounting the component on every open.
|
|
2395
|
-
|
|
2396
|
-
**Events**
|
|
2397
|
-
|
|
2398
|
-
- `update:open`: `[value: boolean]`
|
|
2399
|
-
|
|
2400
|
-
**Slots**
|
|
2401
|
-
|
|
2402
|
-
- `default`
|
|
2403
|
-
|
|
2404
|
-
**Composes with:** `SheetClose`, `SheetContent`, `SheetDescription`, `SheetFooter`, `SheetHeader`, `SheetTitle`, `SheetTrigger`
|
|
2405
|
-
|
|
2406
|
-
**Source:** `src/components/sheet/sheet.vue`
|
|
2407
|
-
|
|
2408
|
-
**Example:** `src/components/sheet/stories/sheet.stories.ts`
|
|
2409
|
-
|
|
2410
|
-
### SheetClose
|
|
2411
|
-
|
|
2412
|
-
**Props**
|
|
2413
|
-
|
|
2414
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2415
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2416
|
-
- `class`: `ClassValue`
|
|
2417
|
-
|
|
2418
|
-
**Slots**
|
|
2419
|
-
|
|
2420
|
-
- `default`
|
|
2421
|
-
|
|
2422
|
-
**Composes with:** `Sheet`, `SheetContent`, `SheetDescription`, `SheetFooter`, `SheetHeader`, `SheetTitle`, `SheetTrigger`
|
|
2423
|
-
|
|
2424
|
-
**Source:** `src/components/sheet/sheet-close.vue`
|
|
2425
|
-
|
|
2426
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2427
|
-
|
|
2428
|
-
### SheetContent
|
|
2429
|
-
|
|
2430
|
-
**Props**
|
|
2431
|
-
|
|
2432
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2433
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2434
|
-
- `class`: `ClassValue`
|
|
2435
|
-
- `disableOutsidePointerEvents`: `boolean` — When `true`, hover/focus/click interactions will be disabled on elements outside the `DismissableLayer`. Users will need to click twice on outside elements to interact with them: once to close the `DismissableLayer`, and again to trigger the element.
|
|
2436
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
2437
|
-
- `side`: `top` | `right` | `bottom` | `left` — default `"right"`
|
|
2438
|
-
|
|
2439
|
-
**Events**
|
|
2440
|
-
|
|
2441
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
2442
|
-
- `pointerDownOutside`: `[event: PointerDownOutsideEvent]`
|
|
2443
|
-
- `focusOutside`: `[event: FocusOutsideEvent]`
|
|
2444
|
-
- `interactOutside`: `[event: PointerDownOutsideEvent | FocusOutsideEvent]`
|
|
2445
|
-
- `openAutoFocus`: `[event: Event]`
|
|
2446
|
-
- `closeAutoFocus`: `[event: Event]`
|
|
2447
|
-
|
|
2448
|
-
**Slots**
|
|
2449
|
-
|
|
2450
|
-
- `default`
|
|
2451
|
-
|
|
2452
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetDescription`, `SheetFooter`, `SheetHeader`, `SheetTitle`, `SheetTrigger`
|
|
2453
|
-
|
|
2454
|
-
**Source:** `src/components/sheet/sheet-content.vue`
|
|
2455
|
-
|
|
2456
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2457
|
-
|
|
2458
|
-
### SheetDescription
|
|
2459
|
-
|
|
2460
|
-
**Props**
|
|
2461
|
-
|
|
2462
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2463
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2464
|
-
- `class`: `ClassValue`
|
|
2465
|
-
|
|
2466
|
-
**Slots**
|
|
2467
|
-
|
|
2468
|
-
- `default`
|
|
2469
|
-
|
|
2470
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetContent`, `SheetFooter`, `SheetHeader`, `SheetTitle`, `SheetTrigger`
|
|
2471
|
-
|
|
2472
|
-
**Source:** `src/components/sheet/sheet-description.vue`
|
|
2473
|
-
|
|
2474
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2475
|
-
|
|
2476
|
-
### SheetFooter
|
|
2477
|
-
|
|
2478
|
-
**Props**
|
|
2479
|
-
|
|
2480
|
-
- `class`: `ClassValue`
|
|
2481
|
-
|
|
2482
|
-
**Slots**
|
|
2483
|
-
|
|
2484
|
-
- `default`
|
|
2485
|
-
|
|
2486
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetContent`, `SheetDescription`, `SheetHeader`, `SheetTitle`, `SheetTrigger`
|
|
2487
|
-
|
|
2488
|
-
**Source:** `src/components/sheet/sheet-footer.vue`
|
|
2489
|
-
|
|
2490
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2491
|
-
|
|
2492
|
-
### SheetHeader
|
|
2493
|
-
|
|
2494
|
-
**Props**
|
|
2495
|
-
|
|
2496
|
-
- `class`: `ClassValue`
|
|
2497
|
-
|
|
2498
|
-
**Slots**
|
|
2499
|
-
|
|
2500
|
-
- `default`
|
|
2501
|
-
|
|
2502
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetContent`, `SheetDescription`, `SheetFooter`, `SheetTitle`, `SheetTrigger`
|
|
2503
|
-
|
|
2504
|
-
**Source:** `src/components/sheet/sheet-header.vue`
|
|
2505
|
-
|
|
2506
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2507
|
-
|
|
2508
|
-
### SheetTitle
|
|
2509
|
-
|
|
2510
|
-
**Props**
|
|
2511
|
-
|
|
2512
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2513
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2514
|
-
- `class`: `ClassValue`
|
|
2515
|
-
|
|
2516
|
-
**Slots**
|
|
2517
|
-
|
|
2518
|
-
- `default`
|
|
2519
|
-
|
|
2520
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetContent`, `SheetDescription`, `SheetFooter`, `SheetHeader`, `SheetTrigger`
|
|
2521
|
-
|
|
2522
|
-
**Source:** `src/components/sheet/sheet-title.vue`
|
|
2523
|
-
|
|
2524
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2525
|
-
|
|
2526
|
-
### SheetTrigger
|
|
2527
|
-
|
|
2528
|
-
**Props**
|
|
2529
|
-
|
|
2530
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2531
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2532
|
-
- `class`: `unknown`
|
|
2533
|
-
|
|
2534
|
-
**Slots**
|
|
2535
|
-
|
|
2536
|
-
- `default`
|
|
2537
|
-
|
|
2538
|
-
**Composes with:** `Sheet`, `SheetClose`, `SheetContent`, `SheetDescription`, `SheetFooter`, `SheetHeader`, `SheetTitle`
|
|
2539
|
-
|
|
2540
|
-
**Source:** `src/components/sheet/sheet-trigger.vue`
|
|
2541
|
-
|
|
2542
|
-
**Example:** no story of its own — see `src/components/sheet/stories/sheet.stories.ts` for the group.
|
|
2543
|
-
|
|
2544
|
-
---
|
|
2545
|
-
|
|
2546
|
-
## sidebar
|
|
2547
|
-
|
|
2548
|
-
### Sidebar
|
|
2549
|
-
|
|
2550
|
-
**Props**
|
|
2551
|
-
|
|
2552
|
-
- `class`: `ClassValue`
|
|
2553
|
-
- `collapsible`: `icon` | `none` | `offcanvas` — default `"offcanvas"`
|
|
2554
|
-
- `variant`: `sidebar` | `floating` | `inset` — default `"sidebar"`
|
|
2555
|
-
|
|
2556
|
-
**Slots**
|
|
2557
|
-
|
|
2558
|
-
- `default`
|
|
2559
|
-
|
|
2560
|
-
**Composes with:** `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2561
|
-
|
|
2562
|
-
**Source:** `src/components/sidebar/sidebar.vue`
|
|
2563
|
-
|
|
2564
|
-
**Example:** `src/components/sidebar/stories/sidebar.stories.ts`
|
|
2565
|
-
|
|
2566
|
-
### SidebarContent
|
|
2567
|
-
|
|
2568
|
-
**Props**
|
|
2569
|
-
|
|
2570
|
-
- `class`: `ClassValue`
|
|
2571
|
-
|
|
2572
|
-
**Slots**
|
|
2573
|
-
|
|
2574
|
-
- `default`
|
|
2575
|
-
|
|
2576
|
-
**Composes with:** `Sidebar`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2577
|
-
|
|
2578
|
-
**Source:** `src/components/sidebar/sidebar-content.vue`
|
|
2579
|
-
|
|
2580
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2581
|
-
|
|
2582
|
-
### SidebarElement
|
|
2583
|
-
|
|
2584
|
-
**Props**
|
|
2585
|
-
|
|
2586
|
-
- `as`: `AsTag | Component` — default `"div"` — Element or component to render as.
|
|
2587
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2588
|
-
- `class`: `ClassValue`
|
|
2589
|
-
|
|
2590
|
-
**Slots**
|
|
2591
|
-
|
|
2592
|
-
- `default`
|
|
2593
|
-
|
|
2594
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2595
|
-
|
|
2596
|
-
**Source:** `src/components/sidebar/sidebar-element.vue`
|
|
2597
|
-
|
|
2598
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2599
|
-
|
|
2600
|
-
### SidebarFooter
|
|
2601
|
-
|
|
2602
|
-
**Props**
|
|
2603
|
-
|
|
2604
|
-
- `class`: `ClassValue`
|
|
2605
|
-
|
|
2606
|
-
**Slots**
|
|
2607
|
-
|
|
2608
|
-
- `default`
|
|
2609
|
-
|
|
2610
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2611
|
-
|
|
2612
|
-
**Source:** `src/components/sidebar/sidebar-footer.vue`
|
|
2613
|
-
|
|
2614
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2615
|
-
|
|
2616
|
-
### SidebarGroup
|
|
2617
|
-
|
|
2618
|
-
**Props**
|
|
2619
|
-
|
|
2620
|
-
- `class`: `ClassValue`
|
|
2621
|
-
|
|
2622
|
-
**Slots**
|
|
2623
|
-
|
|
2624
|
-
- `default`
|
|
2625
|
-
|
|
2626
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2627
|
-
|
|
2628
|
-
**Source:** `src/components/sidebar/sidebar-group.vue`
|
|
2629
|
-
|
|
2630
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2631
|
-
|
|
2632
|
-
### SidebarGroupContent
|
|
2633
|
-
|
|
2634
|
-
**Props**
|
|
2635
|
-
|
|
2636
|
-
- `class`: `ClassValue`
|
|
2637
|
-
|
|
2638
|
-
**Slots**
|
|
2639
|
-
|
|
2640
|
-
- `default`
|
|
2641
|
-
|
|
2642
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2643
|
-
|
|
2644
|
-
**Source:** `src/components/sidebar/sidebar-group-content.vue`
|
|
2645
|
-
|
|
2646
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2647
|
-
|
|
2648
|
-
### SidebarGroupLabel
|
|
2649
|
-
|
|
2650
|
-
**Props**
|
|
2651
|
-
|
|
2652
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2653
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2654
|
-
- `class`: `ClassValue`
|
|
2655
|
-
|
|
2656
|
-
**Slots**
|
|
2657
|
-
|
|
2658
|
-
- `default`
|
|
2659
|
-
|
|
2660
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2661
|
-
|
|
2662
|
-
**Source:** `src/components/sidebar/sidebar-group-label.vue`
|
|
2663
|
-
|
|
2664
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2665
|
-
|
|
2666
|
-
### SidebarHeader
|
|
2667
|
-
|
|
2668
|
-
**Props**
|
|
2669
|
-
|
|
2670
|
-
- `class`: `ClassValue`
|
|
2671
|
-
|
|
2672
|
-
**Slots**
|
|
2673
|
-
|
|
2674
|
-
- `default`
|
|
2675
|
-
|
|
2676
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2677
|
-
|
|
2678
|
-
**Source:** `src/components/sidebar/sidebar-header.vue`
|
|
2679
|
-
|
|
2680
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2681
|
-
|
|
2682
|
-
### SidebarMenu
|
|
2683
|
-
|
|
2684
|
-
**Props**
|
|
2685
|
-
|
|
2686
|
-
- `class`: `ClassValue`
|
|
2687
|
-
|
|
2688
|
-
**Slots**
|
|
2689
|
-
|
|
2690
|
-
- `default`
|
|
2691
|
-
|
|
2692
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2693
|
-
|
|
2694
|
-
**Source:** `src/components/sidebar/sidebar-menu.vue`
|
|
2695
|
-
|
|
2696
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2697
|
-
|
|
2698
|
-
### SidebarMenuAction
|
|
2699
|
-
|
|
2700
|
-
**Props**
|
|
2701
|
-
|
|
2702
|
-
- `as`: `AsTag | Component` — default `"button"` — Element or component to render as.
|
|
2703
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2704
|
-
- `class`: `ClassValue`
|
|
2705
|
-
- `showOnHover`: `boolean`
|
|
2706
|
-
|
|
2707
|
-
**Slots**
|
|
2708
|
-
|
|
2709
|
-
- `default`
|
|
2710
|
-
|
|
2711
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2712
|
-
|
|
2713
|
-
**Source:** `src/components/sidebar/sidebar-menu-action.vue`
|
|
2714
|
-
|
|
2715
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2716
|
-
|
|
2717
|
-
### SidebarMenuBadge
|
|
2718
|
-
|
|
2719
|
-
**Props**
|
|
2720
|
-
|
|
2721
|
-
- `class`: `ClassValue`
|
|
2722
|
-
- `label`: `string`
|
|
2723
|
-
- `size`: `sm` | `md` — default `"sm"`
|
|
2724
|
-
- `state`: `information` | `success` | `warning` | `error` | `feature` | `faded` | `away` | `verified` | `highlighted` | `stable` — default `"faded"`
|
|
2725
|
-
- `variant`: `fill` | `light` | `lighter` | `stroke` — default `"lighter"`
|
|
2726
|
-
|
|
2727
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2728
|
-
|
|
2729
|
-
**Source:** `src/components/sidebar/sidebar-menu-badge.vue`
|
|
2730
|
-
|
|
2731
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2732
|
-
|
|
2733
|
-
### SidebarMenuButton
|
|
2734
|
-
|
|
2735
|
-
**Props**
|
|
2736
|
-
|
|
2737
|
-
- `as`: `AsTag | Component` — default `"button"` — Element or component to render as.
|
|
2738
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2739
|
-
- `class`: `ClassValue`
|
|
2740
|
-
- `isActive`: `boolean` — default `false`
|
|
2741
|
-
- `variant`: `default` | `outline` — default `"default"`
|
|
2742
|
-
|
|
2743
|
-
**Slots**
|
|
2744
|
-
|
|
2745
|
-
- `default`
|
|
2746
|
-
|
|
2747
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2748
|
-
|
|
2749
|
-
**Source:** `src/components/sidebar/sidebar-menu-button.vue`
|
|
2750
|
-
|
|
2751
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2752
|
-
|
|
2753
|
-
### SidebarMenuItem
|
|
2754
|
-
|
|
2755
|
-
**Props**
|
|
2756
|
-
|
|
2757
|
-
- `class`: `ClassValue`
|
|
2758
|
-
|
|
2759
|
-
**Slots**
|
|
2760
|
-
|
|
2761
|
-
- `default`
|
|
2762
|
-
|
|
2763
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2764
|
-
|
|
2765
|
-
**Source:** `src/components/sidebar/sidebar-menu-item.vue`
|
|
2766
|
-
|
|
2767
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2768
|
-
|
|
2769
|
-
### SidebarMenuSub
|
|
2770
|
-
|
|
2771
|
-
**Props**
|
|
2772
|
-
|
|
2773
|
-
- `class`: `ClassValue`
|
|
2774
|
-
|
|
2775
|
-
**Slots**
|
|
2776
|
-
|
|
2777
|
-
- `default`
|
|
2778
|
-
|
|
2779
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2780
|
-
|
|
2781
|
-
**Source:** `src/components/sidebar/sidebar-menu-sub.vue`
|
|
2782
|
-
|
|
2783
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2784
|
-
|
|
2785
|
-
### SidebarMenuSubButton
|
|
2786
|
-
|
|
2787
|
-
**Props**
|
|
2788
|
-
|
|
2789
|
-
- `as`: `AsTag | Component` — default `"a"` — Element or component to render as.
|
|
2790
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2791
|
-
- `class`: `ClassValue`
|
|
2792
|
-
- `isActive`: `boolean` — default `false`
|
|
2793
|
-
- `size`: `sm` | `md` — default `"md"`
|
|
2794
|
-
|
|
2795
|
-
**Slots**
|
|
2796
|
-
|
|
2797
|
-
- `default`
|
|
2798
|
-
|
|
2799
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2800
|
-
|
|
2801
|
-
**Source:** `src/components/sidebar/sidebar-menu-sub-button.vue`
|
|
2802
|
-
|
|
2803
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2804
|
-
|
|
2805
|
-
### SidebarMenuSubItem
|
|
2806
|
-
|
|
2807
|
-
**Props**
|
|
2808
|
-
|
|
2809
|
-
- `class`: `ClassValue`
|
|
2810
|
-
|
|
2811
|
-
**Slots**
|
|
2812
|
-
|
|
2813
|
-
- `default`
|
|
2814
|
-
|
|
2815
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarProvider`, `SidebarSeparator`, `SidebarTrigger`
|
|
2816
|
-
|
|
2817
|
-
**Source:** `src/components/sidebar/sidebar-menu-sub-item.vue`
|
|
2818
|
-
|
|
2819
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2820
|
-
|
|
2821
|
-
### SidebarProvider
|
|
2822
|
-
|
|
2823
|
-
**Props**
|
|
2824
|
-
|
|
2825
|
-
- `class`: `ClassValue`
|
|
2826
|
-
- `defaultOpen`: `boolean` — default `!defaultDocument?.cookie.includes(`${SIDEBAR_COOKIE_NAME}=false`)`
|
|
2827
|
-
- `open`: `boolean` — default `undefined`
|
|
2828
|
-
|
|
2829
|
-
**Events**
|
|
2830
|
-
|
|
2831
|
-
- `update:open`: `[open: boolean]`
|
|
2832
|
-
|
|
2833
|
-
**Slots**
|
|
2834
|
-
|
|
2835
|
-
- `default`
|
|
2836
|
-
|
|
2837
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarSeparator`, `SidebarTrigger`
|
|
2838
|
-
|
|
2839
|
-
**Source:** `src/components/sidebar/sidebar-provider.vue`
|
|
2840
|
-
|
|
2841
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2842
|
-
|
|
2843
|
-
### SidebarSeparator
|
|
2844
|
-
|
|
2845
|
-
**Props**
|
|
2846
|
-
|
|
2847
|
-
- `class`: `ClassValue`
|
|
2848
|
-
|
|
2849
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarTrigger`
|
|
2850
|
-
|
|
2851
|
-
**Source:** `src/components/sidebar/sidebar-separator.vue`
|
|
2852
|
-
|
|
2853
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2854
|
-
|
|
2855
|
-
### SidebarTrigger
|
|
2856
|
-
|
|
2857
|
-
**Props**
|
|
2858
|
-
|
|
2859
|
-
- `class`: `ClassValue`
|
|
2860
|
-
|
|
2861
|
-
**Composes with:** `Sidebar`, `SidebarContent`, `SidebarElement`, `SidebarFooter`, `SidebarGroup`, `SidebarGroupContent`, `SidebarGroupLabel`, `SidebarHeader`, `SidebarMenu`, `SidebarMenuAction`, `SidebarMenuBadge`, `SidebarMenuButton`, `SidebarMenuItem`, `SidebarMenuSub`, `SidebarMenuSubButton`, `SidebarMenuSubItem`, `SidebarProvider`, `SidebarSeparator`
|
|
2862
|
-
|
|
2863
|
-
**Source:** `src/components/sidebar/sidebar-trigger.vue`
|
|
2864
|
-
|
|
2865
|
-
**Example:** no story of its own — see `src/components/sidebar/stories/sidebar.stories.ts` for the group.
|
|
2866
|
-
|
|
2867
|
-
---
|
|
2868
|
-
|
|
2869
|
-
## slider
|
|
2870
|
-
|
|
2871
|
-
### Slider
|
|
2872
|
-
|
|
2873
|
-
**Props**
|
|
2874
|
-
|
|
2875
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2876
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2877
|
-
- `class`: `ClassValue`
|
|
2878
|
-
- `defaultValue`: `number[]` — The value of the slider when initially rendered. Use when you do not need to control the state of the slider.
|
|
2879
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2880
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the slider.
|
|
2881
|
-
- `inverted`: `boolean` — Whether the slider is visually inverted.
|
|
2882
|
-
- `max`: `number` — The maximum value for the range.
|
|
2883
|
-
- `min`: `number` — The minimum value for the range.
|
|
2884
|
-
- `minStepsBetweenThumbs`: `number` — The minimum permitted steps between multiple thumbs.
|
|
2885
|
-
- `modelValue`: `number[] | null` — The controlled value of the slider. Can be bind as `v-model`.
|
|
2886
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
2887
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
2888
|
-
- `step`: `number` — The stepping interval.
|
|
2889
|
-
- `thumbAlignment`: `ThumbAlignment` — The alignment of the slider thumb. - `contain`: thumbs will be contained within the bounds of the track. - `overflow`: thumbs will not be bound by the track. No extra offset will be added.
|
|
2890
|
-
|
|
2891
|
-
**Events**
|
|
2892
|
-
|
|
2893
|
-
- `update:modelValue`: `[payload: number[] | undefined]`
|
|
2894
|
-
- `valueCommit`: `[payload: number[]]`
|
|
2895
|
-
|
|
2896
|
-
**Source:** `src/components/slider/slider.vue`
|
|
2897
|
-
|
|
2898
|
-
**Example:** `src/components/slider/stories/slider.stories.ts`
|
|
2899
|
-
|
|
2900
|
-
---
|
|
2901
|
-
|
|
2902
|
-
## sonner
|
|
2903
|
-
|
|
2904
|
-
### Sonner
|
|
2905
|
-
|
|
2906
|
-
**Props**
|
|
2907
|
-
|
|
2908
|
-
- `class`: `string`
|
|
2909
|
-
- `closeButton`: `boolean`
|
|
2910
|
-
- `closeButtonPosition`: `CloseButtonPosition`
|
|
2911
|
-
- `containerAriaLabel`: `string`
|
|
2912
|
-
- `dir`: `ltr` | `rtl` | `auto`
|
|
2913
|
-
- `duration`: `number`
|
|
2914
|
-
- `expand`: `boolean`
|
|
2915
|
-
- `gap`: `number`
|
|
2916
|
-
- `hotkey`: `string[]`
|
|
2917
|
-
- `icons`: `ToastIcons`
|
|
2918
|
-
- `id`: `string`
|
|
2919
|
-
- `invert`: `boolean`
|
|
2920
|
-
- `mobileOffset`: `Offset`
|
|
2921
|
-
- `offset`: `Offset`
|
|
2922
|
-
- `position`: `Position`
|
|
2923
|
-
- `richColors`: `boolean`
|
|
2924
|
-
- `swipeDirections`: `SwipeDirection[]`
|
|
2925
|
-
- `theme`: `Theme`
|
|
2926
|
-
- `toastOptions`: `ToastOptions`
|
|
2927
|
-
- `visibleToasts`: `number`
|
|
2928
|
-
|
|
2929
|
-
**Composes with:** `SonnerAlert`
|
|
2930
|
-
|
|
2931
|
-
**Source:** `src/components/sonner/sonner.vue`
|
|
2932
|
-
|
|
2933
|
-
**Example:** `src/components/sonner/stories/sonner.stories.ts`
|
|
2934
|
-
|
|
2935
|
-
### SonnerAlert
|
|
2936
|
-
|
|
2937
|
-
**Props**
|
|
2938
|
-
|
|
2939
|
-
- `title`: `string` **(required)**
|
|
2940
|
-
- `class`: `ClassValue`
|
|
2941
|
-
- `description`: `string`
|
|
2942
|
-
- `dismissable`: `boolean` — default `true`
|
|
2943
|
-
- `onDismiss`: `(() => void)`
|
|
2944
|
-
- `size`: `xs` | `sm` | `lg` — default `"lg"`
|
|
2945
|
-
- `state`: `information` | `success` | `warning` | `error` | `feature` — default `"success"`
|
|
2946
|
-
- `variant`: `fill` | `light` | `lighter` | `stroke` — default `"stroke"`
|
|
2947
|
-
|
|
2948
|
-
**Composes with:** `Sonner`
|
|
2949
|
-
|
|
2950
|
-
**Source:** `src/components/sonner/sonner-alert.vue`
|
|
2951
|
-
|
|
2952
|
-
**Example:** no story of its own — see `src/components/sonner/stories/sonner.stories.ts` for the group.
|
|
2953
|
-
|
|
2954
|
-
---
|
|
2955
|
-
|
|
2956
|
-
## switch
|
|
2957
|
-
|
|
2958
|
-
### Switch
|
|
2959
|
-
|
|
2960
|
-
**Props**
|
|
2961
|
-
|
|
2962
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2963
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2964
|
-
- `class`: `ClassValue`
|
|
2965
|
-
- `defaultValue`: `boolean` — The state of the switch when it is initially rendered. Use when you do not need to control its state.
|
|
2966
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the switch.
|
|
2967
|
-
- `falseValue`: `boolean` — The value used when the switch is off. Defaults to `false`.
|
|
2968
|
-
- `id`: `string`
|
|
2969
|
-
- `modelValue`: `boolean | null` — The controlled state of the switch. Can be bind as `v-model`.
|
|
2970
|
-
- `name`: `string` — The name of the field. Submitted with its owning form as part of a name/value pair.
|
|
2971
|
-
- `required`: `boolean` — When `true`, indicates that the user must set the value before the owning form can be submitted.
|
|
2972
|
-
- `trueValue`: `boolean` — The value used when the switch is on. Defaults to `true`.
|
|
2973
|
-
- `value`: `string` — The value given as data when submitted with a `name`.
|
|
2974
|
-
|
|
2975
|
-
**Events**
|
|
2976
|
-
|
|
2977
|
-
- `update:modelValue`: `[payload: boolean]`
|
|
2978
|
-
|
|
2979
|
-
**Source:** `src/components/switch/switch.vue`
|
|
2980
|
-
|
|
2981
|
-
**Example:** `src/components/switch/stories/switch.stories.ts`
|
|
2982
|
-
|
|
2983
|
-
---
|
|
2984
|
-
|
|
2985
|
-
## tab-menu
|
|
2986
|
-
|
|
2987
|
-
### TabMenu
|
|
2988
|
-
|
|
2989
|
-
**Props**
|
|
2990
|
-
|
|
2991
|
-
- `activationMode`: `automatic` | `manual` — Whether a tab is activated automatically (on focus) or manually (on click).
|
|
2992
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
2993
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
2994
|
-
- `class`: `unknown`
|
|
2995
|
-
- `defaultValue`: `StringOrNumber` — The value of the tab that should be active when initially rendered. Use when you do not need to control the state of the tabs
|
|
2996
|
-
- `dir`: `Direction` — The reading direction of the combobox when applicable. <br> If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
|
|
2997
|
-
- `modelValue`: `StringOrNumber` — The controlled value of the tab to activate. Can be bind as `v-model`.
|
|
2998
|
-
- `orientation`: `DataOrientation` — The orientation the tabs are laid out. Mainly so arrow navigation is done accordingly (left & right vs. up & down)
|
|
2999
|
-
- `unmountOnHide`: `boolean` — When `true`, the element will be unmounted on closed state.
|
|
3000
|
-
|
|
3001
|
-
**Events**
|
|
3002
|
-
|
|
3003
|
-
- `update:modelValue`: `[payload: StringOrNumber]`
|
|
3004
|
-
|
|
3005
|
-
**Slots**
|
|
3006
|
-
|
|
3007
|
-
- `default`
|
|
3008
|
-
|
|
3009
|
-
**Composes with:** `TabMenuContent`, `TabMenuItem`, `TabMenuList`
|
|
3010
|
-
|
|
3011
|
-
**Source:** `src/components/tab-menu/tab-menu.vue`
|
|
3012
|
-
|
|
3013
|
-
**Example:** `src/components/tab-menu/stories/tab-menu.stories.ts`
|
|
3014
|
-
|
|
3015
|
-
### TabMenuContent
|
|
3016
|
-
|
|
3017
|
-
**Props**
|
|
3018
|
-
|
|
3019
|
-
- `value`: `StringOrNumber` **(required)** — A unique value that associates the content with a trigger.
|
|
3020
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3021
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3022
|
-
- `class`: `ClassValue`
|
|
3023
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
3024
|
-
|
|
3025
|
-
**Slots**
|
|
3026
|
-
|
|
3027
|
-
- `default`
|
|
3028
|
-
|
|
3029
|
-
**Composes with:** `TabMenu`, `TabMenuItem`, `TabMenuList`
|
|
3030
|
-
|
|
3031
|
-
**Source:** `src/components/tab-menu/tab-menu-content.vue`
|
|
3032
|
-
|
|
3033
|
-
**Example:** no story of its own — see `src/components/tab-menu/stories/tab-menu.stories.ts` for the group.
|
|
3034
|
-
|
|
3035
|
-
### TabMenuItem
|
|
3036
|
-
|
|
3037
|
-
**Props**
|
|
3038
|
-
|
|
3039
|
-
- `value`: `StringOrNumber` **(required)** — A unique value that associates the trigger with a content.
|
|
3040
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3041
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3042
|
-
- `class`: `ClassValue`
|
|
3043
|
-
- `disabled`: `boolean` — When `true`, prevents the user from interacting with the tab.
|
|
3044
|
-
|
|
3045
|
-
**Slots**
|
|
3046
|
-
|
|
3047
|
-
- `prefix`
|
|
3048
|
-
- `default`
|
|
3049
|
-
- `postfix`
|
|
3050
|
-
|
|
3051
|
-
**Composes with:** `TabMenu`, `TabMenuContent`, `TabMenuList`
|
|
3052
|
-
|
|
3053
|
-
**Source:** `src/components/tab-menu/tab-menu-item.vue`
|
|
3054
|
-
|
|
3055
|
-
**Example:** no story of its own — see `src/components/tab-menu/stories/tab-menu.stories.ts` for the group.
|
|
3056
|
-
|
|
3057
|
-
### TabMenuList
|
|
3058
|
-
|
|
3059
|
-
**Props**
|
|
3060
|
-
|
|
3061
|
-
- `align`: `start` | `center` — default `"start"`
|
|
3062
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3063
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3064
|
-
- `bordered`: `boolean` — default `true`
|
|
3065
|
-
- `class`: `ClassValue`
|
|
3066
|
-
- `fill`: `boolean` — default `false`
|
|
3067
|
-
- `loop`: `boolean` — When `true`, keyboard navigation will loop from last tab to first, and vice versa.
|
|
3068
|
-
- `scrollable`: `boolean` — default `false`
|
|
3069
|
-
|
|
3070
|
-
**Slots**
|
|
3071
|
-
|
|
3072
|
-
- `default`
|
|
3073
|
-
|
|
3074
|
-
**Composes with:** `TabMenu`, `TabMenuContent`, `TabMenuItem`
|
|
3075
|
-
|
|
3076
|
-
**Source:** `src/components/tab-menu/tab-menu-list.vue`
|
|
3077
|
-
|
|
3078
|
-
**Example:** no story of its own — see `src/components/tab-menu/stories/tab-menu.stories.ts` for the group.
|
|
3079
|
-
|
|
3080
|
-
---
|
|
3081
|
-
|
|
3082
|
-
## table
|
|
3083
|
-
|
|
3084
|
-
### Table
|
|
3085
|
-
|
|
3086
|
-
**Props**
|
|
3087
|
-
|
|
3088
|
-
- `class`: `ClassValue`
|
|
3089
|
-
|
|
3090
|
-
**Slots**
|
|
3091
|
-
|
|
3092
|
-
- `default`
|
|
3093
|
-
|
|
3094
|
-
**Composes with:** `TableBody`, `TableCaption`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHead`, `TableHeader`, `TableRow`
|
|
3095
|
-
|
|
3096
|
-
**Source:** `src/components/table/table.vue`
|
|
3097
|
-
|
|
3098
|
-
**Example:** `src/components/table/stories/table.stories.ts`
|
|
3099
|
-
|
|
3100
|
-
### TableBody
|
|
3101
|
-
|
|
3102
|
-
**Props**
|
|
3103
|
-
|
|
3104
|
-
- `class`: `ClassValue`
|
|
3105
|
-
|
|
3106
|
-
**Slots**
|
|
3107
|
-
|
|
3108
|
-
- `default`
|
|
3109
|
-
|
|
3110
|
-
**Composes with:** `Table`, `TableCaption`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHead`, `TableHeader`, `TableRow`
|
|
3111
|
-
|
|
3112
|
-
**Source:** `src/components/table/table-body.vue`
|
|
3113
|
-
|
|
3114
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3115
|
-
|
|
3116
|
-
### TableCaption
|
|
3117
|
-
|
|
3118
|
-
**Props**
|
|
3119
|
-
|
|
3120
|
-
- `class`: `ClassValue`
|
|
3121
|
-
|
|
3122
|
-
**Slots**
|
|
3123
|
-
|
|
3124
|
-
- `default`
|
|
3125
|
-
|
|
3126
|
-
**Composes with:** `Table`, `TableBody`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHead`, `TableHeader`, `TableRow`
|
|
3127
|
-
|
|
3128
|
-
**Source:** `src/components/table/table-caption.vue`
|
|
3129
|
-
|
|
3130
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3131
|
-
|
|
3132
|
-
### TableCell
|
|
3133
|
-
|
|
3134
|
-
**Props**
|
|
3135
|
-
|
|
3136
|
-
- `class`: `ClassValue`
|
|
3137
|
-
- `end`: `boolean` — default `false`
|
|
3138
|
-
|
|
3139
|
-
**Slots**
|
|
3140
|
-
|
|
3141
|
-
- `default`
|
|
3142
|
-
|
|
3143
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableEmpty`, `TableFooter`, `TableHead`, `TableHeader`, `TableRow`
|
|
3144
|
-
|
|
3145
|
-
**Source:** `src/components/table/table-cell.vue`
|
|
3146
|
-
|
|
3147
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3148
|
-
|
|
3149
|
-
### TableEmpty
|
|
3150
|
-
|
|
3151
|
-
**Props**
|
|
3152
|
-
|
|
3153
|
-
- `class`: `ClassValue`
|
|
3154
|
-
- `colspan`: `number` — default `1`
|
|
3155
|
-
|
|
3156
|
-
**Slots**
|
|
3157
|
-
|
|
3158
|
-
- `default`
|
|
3159
|
-
|
|
3160
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableCell`, `TableFooter`, `TableHead`, `TableHeader`, `TableRow`
|
|
3161
|
-
|
|
3162
|
-
**Source:** `src/components/table/table-empty.vue`
|
|
3163
|
-
|
|
3164
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3165
|
-
|
|
3166
|
-
### TableFooter
|
|
3167
|
-
|
|
3168
|
-
**Props**
|
|
3169
|
-
|
|
3170
|
-
- `class`: `ClassValue`
|
|
3171
|
-
|
|
3172
|
-
**Slots**
|
|
3173
|
-
|
|
3174
|
-
- `default`
|
|
3175
|
-
|
|
3176
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableCell`, `TableEmpty`, `TableHead`, `TableHeader`, `TableRow`
|
|
3177
|
-
|
|
3178
|
-
**Source:** `src/components/table/table-footer.vue`
|
|
3179
|
-
|
|
3180
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3181
|
-
|
|
3182
|
-
### TableHead
|
|
3183
|
-
|
|
3184
|
-
**Props**
|
|
3185
|
-
|
|
3186
|
-
- `class`: `ClassValue`
|
|
3187
|
-
- `end`: `boolean` — default `false`
|
|
3188
|
-
|
|
3189
|
-
**Slots**
|
|
3190
|
-
|
|
3191
|
-
- `default`
|
|
3192
|
-
|
|
3193
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHeader`, `TableRow`
|
|
3194
|
-
|
|
3195
|
-
**Source:** `src/components/table/table-head.vue`
|
|
3196
|
-
|
|
3197
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3198
|
-
|
|
3199
|
-
### TableHeader
|
|
3200
|
-
|
|
3201
|
-
**Props**
|
|
3202
|
-
|
|
3203
|
-
- `class`: `ClassValue`
|
|
3204
|
-
|
|
3205
|
-
**Slots**
|
|
3206
|
-
|
|
3207
|
-
- `default`
|
|
3208
|
-
|
|
3209
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHead`, `TableRow`
|
|
3210
|
-
|
|
3211
|
-
**Source:** `src/components/table/table-header.vue`
|
|
3212
|
-
|
|
3213
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3214
|
-
|
|
3215
|
-
### TableRow
|
|
3216
|
-
|
|
3217
|
-
**Props**
|
|
3218
|
-
|
|
3219
|
-
- `class`: `ClassValue`
|
|
3220
|
-
- `hoverable`: `boolean` — default `true`
|
|
3221
|
-
|
|
3222
|
-
**Slots**
|
|
3223
|
-
|
|
3224
|
-
- `default`
|
|
3225
|
-
|
|
3226
|
-
**Composes with:** `Table`, `TableBody`, `TableCaption`, `TableCell`, `TableEmpty`, `TableFooter`, `TableHead`, `TableHeader`
|
|
3227
|
-
|
|
3228
|
-
**Source:** `src/components/table/table-row.vue`
|
|
3229
|
-
|
|
3230
|
-
**Example:** no story of its own — see `src/components/table/stories/table.stories.ts` for the group.
|
|
3231
|
-
|
|
3232
|
-
---
|
|
3233
|
-
|
|
3234
|
-
## tag
|
|
3235
|
-
|
|
3236
|
-
### Tag
|
|
3237
|
-
|
|
3238
|
-
**Props**
|
|
3239
|
-
|
|
3240
|
-
- `as`: `AsTag | Component` — default `"div"` — Element or component to render as.
|
|
3241
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3242
|
-
- `class`: `ClassValue`
|
|
3243
|
-
- `disabled`: `boolean`
|
|
3244
|
-
- `dismissable`: `boolean` — default `false`
|
|
3245
|
-
- `variant`: `stroke` | `gray` — default `"stroke"`
|
|
3246
|
-
|
|
3247
|
-
**Events**
|
|
3248
|
-
|
|
3249
|
-
- `dismiss`: `[]`
|
|
3250
|
-
|
|
3251
|
-
**Slots**
|
|
3252
|
-
|
|
3253
|
-
- `default`
|
|
3254
|
-
|
|
3255
|
-
**Source:** `src/components/tag/tag.vue`
|
|
3256
|
-
|
|
3257
|
-
**Example:** `src/components/tag/stories/tag.stories.ts`
|
|
3258
|
-
|
|
3259
|
-
---
|
|
3260
|
-
|
|
3261
|
-
## text-input
|
|
3262
|
-
|
|
3263
|
-
### TextInput
|
|
3264
|
-
|
|
3265
|
-
**Props**
|
|
3266
|
-
|
|
3267
|
-
- `autocomplete`: `string`
|
|
3268
|
-
- `class`: `ClassValue`
|
|
3269
|
-
- `hasError`: `boolean` — default `false`
|
|
3270
|
-
- `modelValue`: `string | number`
|
|
3271
|
-
- `size`: `xs` | `sm` | `md` — default `"md"`
|
|
3272
|
-
- `type`: `search` | `text` | `email` | `password` | `tel` | `url` | `date` — default `"text"`
|
|
3273
|
-
|
|
3274
|
-
**Events**
|
|
3275
|
-
|
|
3276
|
-
- `update:modelValue`: `[value: string | number | undefined]`
|
|
3277
|
-
|
|
3278
|
-
**Slots**
|
|
3279
|
-
|
|
3280
|
-
- `leadingIcon`
|
|
3281
|
-
- `leadingNode`
|
|
3282
|
-
- `leadingInlineNode`
|
|
3283
|
-
- `trailingIcon`
|
|
3284
|
-
- `trailingNode`
|
|
3285
|
-
- `trailingInlineNode`
|
|
3286
|
-
|
|
3287
|
-
**Composes with:** `TextInputAffix`, `TextInputButton`
|
|
3288
|
-
|
|
3289
|
-
**Source:** `src/components/text-input/text-input.vue`
|
|
3290
|
-
|
|
3291
|
-
**Example:** `src/components/text-input/stories/text-input.stories.ts`
|
|
3292
|
-
|
|
3293
|
-
### TextInputAffix
|
|
3294
|
-
|
|
3295
|
-
**Props**
|
|
3296
|
-
|
|
3297
|
-
- `asKbd`: `boolean`
|
|
3298
|
-
- `class`: `ClassValue`
|
|
3299
|
-
- `inline`: `boolean`
|
|
3300
|
-
|
|
3301
|
-
**Slots**
|
|
3302
|
-
|
|
3303
|
-
- `default`
|
|
3304
|
-
|
|
3305
|
-
**Composes with:** `TextInput`, `TextInputButton`
|
|
3306
|
-
|
|
3307
|
-
**Source:** `src/components/text-input/text-input-affix.vue`
|
|
3308
|
-
|
|
3309
|
-
**Example:** no story of its own — see `src/components/text-input/stories/text-input.stories.ts` for the group.
|
|
3310
|
-
|
|
3311
|
-
### TextInputButton
|
|
3312
|
-
|
|
3313
|
-
**Props**
|
|
3314
|
-
|
|
3315
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3316
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3317
|
-
- `class`: `ClassValue`
|
|
3318
|
-
- `inline`: `boolean` — default `false`
|
|
3319
|
-
- `intent`: `error` | `primary` | `neutral`
|
|
3320
|
-
|
|
3321
|
-
**Slots**
|
|
3322
|
-
|
|
3323
|
-
- `default`
|
|
3324
|
-
|
|
3325
|
-
**Composes with:** `TextInput`, `TextInputAffix`
|
|
3326
|
-
|
|
3327
|
-
**Source:** `src/components/text-input/text-input-button.vue`
|
|
3328
|
-
|
|
3329
|
-
**Example:** no story of its own — see `src/components/text-input/stories/text-input.stories.ts` for the group.
|
|
3330
|
-
|
|
3331
|
-
---
|
|
3332
|
-
|
|
3333
|
-
## textarea
|
|
3334
|
-
|
|
3335
|
-
### Textarea
|
|
3336
|
-
|
|
3337
|
-
**Props**
|
|
3338
|
-
|
|
3339
|
-
- `class`: `ClassValue`
|
|
3340
|
-
- `disabled`: `boolean` — default `false`
|
|
3341
|
-
- `maxLength`: `Numberish`
|
|
3342
|
-
- `modelValue`: `string`
|
|
3343
|
-
- `placeholder`: `string` — default `"Placeholder"`
|
|
3344
|
-
- `showCount`: `boolean` — default `true`
|
|
3345
|
-
|
|
3346
|
-
**Events**
|
|
3347
|
-
|
|
3348
|
-
- `update:modelValue`: `[value: string | undefined]`
|
|
3349
|
-
|
|
3350
|
-
**Source:** `src/components/textarea/textarea.vue`
|
|
3351
|
-
|
|
3352
|
-
**Example:** `src/components/textarea/stories/textarea.stories.ts`
|
|
3353
|
-
|
|
3354
|
-
---
|
|
3355
|
-
|
|
3356
|
-
## tooltip
|
|
3357
|
-
|
|
3358
|
-
### Tooltip
|
|
3359
|
-
|
|
3360
|
-
**Props**
|
|
3361
|
-
|
|
3362
|
-
- `align`: `start` | `center` | `end` — The preferred alignment against the trigger. May change when collisions occur.
|
|
3363
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
3364
|
-
- `ariaLabel`: `string` — By default, screenreaders will announce the content inside the component. If this is not descriptive enough, or you have content that cannot be announced, use aria-label as a more descriptive label.
|
|
3365
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
3366
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3367
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3368
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
3369
|
-
- `class`: `ClassValue`
|
|
3370
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
3371
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
3372
|
-
- `defaultOpen`: `boolean` — The open state of the tooltip when it is initially rendered. Use when you do not need to control its open state.
|
|
3373
|
-
- `delayDuration`: `number` — default `0` — Override the duration given to the `Provider` to customise the open delay for a specific tooltip.
|
|
3374
|
-
- `description`: `string`
|
|
3375
|
-
- `disableClosingTrigger`: `boolean` — When `true`, clicking on trigger will not close the content.
|
|
3376
|
-
- `disabled`: `boolean` — When `true`, disable tooltip
|
|
3377
|
-
- `disableHoverableContent`: `boolean` — Prevents Tooltip.Content from remaining open when hovering. Disabling this has accessibility consequences. Inherits from Tooltip.Provider.
|
|
3378
|
-
- `dismissible`: `boolean`
|
|
3379
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
3380
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
3381
|
-
- `icon`: `string`
|
|
3382
|
-
- `ignoreNonKeyboardFocus`: `boolean` — Prevent the tooltip from opening if the focus did not come from the keyboard by matching against the `:focus-visible` selector. This is useful if you want to avoid opening it when switching browser tabs or closing a dialog.
|
|
3383
|
-
- `open`: `boolean` — The controlled open state of the tooltip.
|
|
3384
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
3385
|
-
- `side`: `top` | `right` | `bottom` | `left` — The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
|
|
3386
|
-
- `sideOffset`: `number` — default `12` — The distance in pixels from the trigger.
|
|
3387
|
-
- `size`: `xs` | `sm` | `md` — default `"sm"`
|
|
3388
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
3389
|
-
- `title`: `string`
|
|
3390
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
3391
|
-
- `variant`: `light` | `dark` — default `"light"`
|
|
3392
|
-
|
|
3393
|
-
**Events**
|
|
3394
|
-
|
|
3395
|
-
- `update:open`: `[value: boolean]`
|
|
3396
|
-
|
|
3397
|
-
**Slots**
|
|
3398
|
-
|
|
3399
|
-
- `default`
|
|
3400
|
-
|
|
3401
|
-
**Composes with:** `TooltipContent`, `TooltipProvider`, `TooltipRoot`, `TooltipTrigger`
|
|
3402
|
-
|
|
3403
|
-
**Source:** `src/components/tooltip/tooltip.vue`
|
|
3404
|
-
|
|
3405
|
-
**Example:** `src/components/tooltip/stories/tooltip.stories.ts`
|
|
3406
|
-
|
|
3407
|
-
### TooltipContent
|
|
3408
|
-
|
|
3409
|
-
**Props**
|
|
3410
|
-
|
|
3411
|
-
- `align`: `start` | `center` | `end` — The preferred alignment against the trigger. May change when collisions occur.
|
|
3412
|
-
- `alignOffset`: `number` — An offset in pixels from the `start` or `end` alignment options.
|
|
3413
|
-
- `ariaLabel`: `string` — By default, screenreaders will announce the content inside the component. If this is not descriptive enough, or you have content that cannot be announced, use aria-label as a more descriptive label.
|
|
3414
|
-
- `arrowPadding`: `number` — The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
|
|
3415
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3416
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3417
|
-
- `avoidCollisions`: `boolean` — When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
|
|
3418
|
-
- `class`: `ClassValue`
|
|
3419
|
-
- `collisionBoundary`: `Element | (Element | null)[] | null` — The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
|
|
3420
|
-
- `collisionPadding`: `number | Partial<Record<"top" | "right" | "bottom" | "left", number>>` — The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: { top: 20, left: 20 }.
|
|
3421
|
-
- `description`: `string`
|
|
3422
|
-
- `dismissible`: `boolean`
|
|
3423
|
-
- `forceMount`: `boolean` — Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
|
|
3424
|
-
- `hideWhenDetached`: `boolean` — Whether to hide the content when the trigger becomes fully occluded.
|
|
3425
|
-
- `icon`: `string`
|
|
3426
|
-
- `onDismiss`: `(() => void)`
|
|
3427
|
-
- `positionStrategy`: `fixed` | `absolute` — The type of CSS position property to use.
|
|
3428
|
-
- `side`: `top` | `right` | `bottom` | `left` — The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
|
|
3429
|
-
- `sideOffset`: `number` — default `12` — The distance in pixels from the trigger.
|
|
3430
|
-
- `size`: `xs` | `sm` | `md` — default `"sm"`
|
|
3431
|
-
- `sticky`: `partial` | `always` — The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
|
|
3432
|
-
- `title`: `string`
|
|
3433
|
-
- `updatePositionStrategy`: `always` | `optimized` — Strategy to update the position of the floating element on every animation frame.
|
|
3434
|
-
- `variant`: `light` | `dark` — default `"light"`
|
|
3435
|
-
|
|
3436
|
-
**Events**
|
|
3437
|
-
|
|
3438
|
-
- `escapeKeyDown`: `[event: KeyboardEvent]`
|
|
3439
|
-
- `pointerDownOutside`: `[event: Event]`
|
|
3440
|
-
|
|
3441
|
-
**Slots**
|
|
3442
|
-
|
|
3443
|
-
- `default`
|
|
3444
|
-
|
|
3445
|
-
**Composes with:** `Tooltip`, `TooltipProvider`, `TooltipRoot`, `TooltipTrigger`
|
|
3446
|
-
|
|
3447
|
-
**Source:** `src/components/tooltip/tooltip-content.vue`
|
|
3448
|
-
|
|
3449
|
-
**Example:** no story of its own — see `src/components/tooltip/stories/tooltip.stories.ts` for the group.
|
|
3450
|
-
|
|
3451
|
-
### TooltipProvider
|
|
3452
|
-
|
|
3453
|
-
**Props**
|
|
3454
|
-
|
|
3455
|
-
- `class`: `unknown`
|
|
3456
|
-
- `content`: `TooltipContentProps` — Default settings that will be used by all tooltip components.
|
|
3457
|
-
- `delayDuration`: `number` — default `0` — The duration from when the pointer enters the trigger until the tooltip gets opened.
|
|
3458
|
-
- `disableClosingTrigger`: `boolean` — When `true`, clicking on trigger will not close the content.
|
|
3459
|
-
- `disabled`: `boolean` — When `true`, disable tooltip
|
|
3460
|
-
- `disableHoverableContent`: `boolean` — When `true`, trying to hover the content will result in the tooltip closing as the pointer leaves the trigger.
|
|
3461
|
-
- `ignoreNonKeyboardFocus`: `boolean` — Prevent the tooltip from opening if the focus did not come from the keyboard by matching against the `:focus-visible` selector. This is useful if you want to avoid opening it when switching browser tabs or closing a dialog.
|
|
3462
|
-
- `skipDelayDuration`: `number` — How much time a user has to enter another trigger without incurring a delay again.
|
|
3463
|
-
|
|
3464
|
-
**Slots**
|
|
3465
|
-
|
|
3466
|
-
- `default`
|
|
3467
|
-
|
|
3468
|
-
**Composes with:** `Tooltip`, `TooltipContent`, `TooltipRoot`, `TooltipTrigger`
|
|
3469
|
-
|
|
3470
|
-
**Source:** `src/components/tooltip/tooltip-provider.vue`
|
|
3471
|
-
|
|
3472
|
-
**Example:** no story of its own — see `src/components/tooltip/stories/tooltip.stories.ts` for the group.
|
|
3473
|
-
|
|
3474
|
-
### TooltipRoot
|
|
3475
|
-
|
|
3476
|
-
**Props**
|
|
3477
|
-
|
|
3478
|
-
- `class`: `unknown`
|
|
3479
|
-
- `defaultOpen`: `boolean` — The open state of the tooltip when it is initially rendered. Use when you do not need to control its open state.
|
|
3480
|
-
- `delayDuration`: `number` — Override the duration given to the `Provider` to customise the open delay for a specific tooltip.
|
|
3481
|
-
- `disableClosingTrigger`: `boolean` — When `true`, clicking on trigger will not close the content.
|
|
3482
|
-
- `disabled`: `boolean` — When `true`, disable tooltip
|
|
3483
|
-
- `disableHoverableContent`: `boolean` — Prevents Tooltip.Content from remaining open when hovering. Disabling this has accessibility consequences. Inherits from Tooltip.Provider.
|
|
3484
|
-
- `ignoreNonKeyboardFocus`: `boolean` — Prevent the tooltip from opening if the focus did not come from the keyboard by matching against the `:focus-visible` selector. This is useful if you want to avoid opening it when switching browser tabs or closing a dialog.
|
|
3485
|
-
- `open`: `boolean` — The controlled open state of the tooltip.
|
|
3486
|
-
|
|
3487
|
-
**Events**
|
|
3488
|
-
|
|
3489
|
-
- `update:open`: `[value: boolean]`
|
|
3490
|
-
|
|
3491
|
-
**Slots**
|
|
3492
|
-
|
|
3493
|
-
- `default`
|
|
3494
|
-
|
|
3495
|
-
**Composes with:** `Tooltip`, `TooltipContent`, `TooltipProvider`, `TooltipTrigger`
|
|
3496
|
-
|
|
3497
|
-
**Source:** `src/components/tooltip/tooltip-root.vue`
|
|
3498
|
-
|
|
3499
|
-
**Example:** no story of its own — see `src/components/tooltip/stories/tooltip.stories.ts` for the group.
|
|
3500
|
-
|
|
3501
|
-
### TooltipTrigger
|
|
3502
|
-
|
|
3503
|
-
**Props**
|
|
3504
|
-
|
|
3505
|
-
- `as`: `AsTag | Component` — Element or component to render as.
|
|
3506
|
-
- `asChild`: `boolean` — Render the child element instead of this component's own, merging props onto it.
|
|
3507
|
-
- `class`: `unknown`
|
|
3508
|
-
- `reference`: `ReferenceElement` — The reference (or anchor) element that is being referred to for positioning. If not provided will use the current component as anchor.
|
|
3509
|
-
|
|
3510
|
-
**Slots**
|
|
3511
|
-
|
|
3512
|
-
- `default`
|
|
3513
|
-
|
|
3514
|
-
**Composes with:** `Tooltip`, `TooltipContent`, `TooltipProvider`, `TooltipRoot`
|
|
3515
|
-
|
|
3516
|
-
**Source:** `src/components/tooltip/tooltip-trigger.vue`
|
|
3517
|
-
|
|
3518
|
-
**Example:** no story of its own — see `src/components/tooltip/stories/tooltip.stories.ts` for the group.
|