-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.d.ts
11400 lines (11250 loc) · 504 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import type {
DataTableHeader,
DataOptions,
CalendarTimestamp as VTimestamp,
} from "vuetify"
import type VueComponent from "vue"
import type { DefineComponent, VNode } from "vue"
type eventHandler = Function
interface srcObject {
src: string
srcset?: string
lazySrc: string
aspect: number
}
export type InputValidationRule = (value: any) => string | boolean
// We define our own InputValidationRules because vuetify incorrectly does not include
// boolean as a valid array member in its definition of InputValidationRules.
export type InputValidationRules = (InputValidationRule | string | boolean)[]
declare module "vue" {
export interface GlobalComponents {
VApp: DefineComponent<
{
/** Sets the DOM id on the component */ id?: string | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
}
>
VAppBar: DefineComponent<
{
/** Applies position: absolute to the component. */
absolute?: boolean | null
/** Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop */
app?: boolean | null
/** Aligns the component towards the bottom. */
bottom?: boolean | null
/** Designates that the application's `v-navigation-drawer` that is positioned on the left is below the app-bar. */
clippedLeft?: boolean | null
/** Designates that the application's `v-navigation-drawer` that is positioned on the right is below the app-bar. */
clippedRight?: boolean | null
/** Puts the toolbar into a collapsed state reducing its maximum width. */
collapse?: boolean | null
/** Puts the app-bar into a collapsed state when scrolling. */
collapseOnScroll?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Reduces the height of the toolbar content to 48px (96px when using the **prominent** prop). */
dense?: boolean | null
/** Elevates the app-bar when scrolling. */
elevateOnScroll?: boolean | null
/** Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation). */
elevation?: number | string | null
/** Use this prop to increase the height of the toolbar _without_ using the `extension` slot for adding content. May be used in conjunction with the **extension-height** prop, and any of the other props that affect the height of the toolbar, e.g. **prominent**, **dense**, etc., **WITH THE EXCEPTION** of **height**. */
extended?: boolean | null
/** Specify an explicit height for the `extension` slot. */
extensionHeight?: number | string | null
/** When using the **src** prop or `img` slot, will fade the image when scrolling. */
fadeImgOnScroll?: boolean | null
/** Applies **position: fixed** to the component. */
fixed?: boolean | null
/** Removes the toolbar's box-shadow. */
flat?: boolean | null
/** Applies **display: inline-flex** to the component. */
floating?: boolean | null
/** Designates a specific height for the toolbar. Overrides the heights imposed by other props, e.g. **prominent**, **dense**, **extended**, etc. */
height?: number | string | null
/** Hides the app-bar when scrolling. Will still show the `extension` slot. */
hideOnScroll?: boolean | null
/** Hides the app-bar when scrolling down and displays it when scrolling up. */
invertedScroll?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Removes elevation (box-shadow) and adds a *thin* border. */
outlined?: boolean | null
/** Increases the height of the toolbar content to 128px. */
prominent?: boolean | null
/** Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius). */
rounded?: boolean | string | null
/** Hides the app-bar when scrolling. Will **NOT** show the `extension` slot. */
scrollOffScreen?: boolean | null
/** Designates the element to target for scrolling events. Uses `window` by default. */
scrollTarget?: string | null
/** The amount of scroll distance down before **hide-on-scroll** activates. */
scrollThreshold?: string | number | null
/** Applies a large border radius on the top left and bottom right of the card. */
shaped?: boolean | null
/** Reduce the height of the toolbar content to 56px (112px when using the **prominent** prop). */
short?: boolean | null
/** Shrinks a **prominent** toolbar to a **dense** or **short** (default) one when scrolling. */
shrinkOnScroll?: boolean | null
/** Image source. See `v-img` for details */
src?: string | object | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Removes the component's **border-radius**. */
tile?: boolean | null
/** Controls whether the component is visible or hidden. */
value?: boolean | null
/** Sets the width for the component. */
width?: number | string | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
/** Slot positioned directly under the main content of the toolbar. Height of this slot can be set explicitly with the **extension-height** prop. If this slot has no content, the **extended** prop may be used instead. */
extension: undefined
/** Expects the [v-img](/components/images) component. Scoped **props** should be applied with `v-bind="props"`. */
img: (args: {
props: { height: string; src: string | srcObject }
}) => VNode[]
}>
}
>
VAppBarNavIcon: DefineComponent<
{},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
}
>
VAppBarTitle: DefineComponent<
{},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
}
>
VAlert: DefineComponent<
{
/** Puts a border on the alert. Accepts **top** \| **right** \| **bottom** \| **left**. */
border?: string | null
/** Change the default icon used for **dismissible** alerts. */
closeIcon?: string | null
/** Text used for *aria-label* on **dismissible** alerts. Can also be customizing globally in [Internationalization](/customization/internationalization). */
closeLabel?: string | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the defined **color** to the alert's border. */
coloredBorder?: boolean | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Decreases component's height. */
dense?: boolean | null
/** Adds a close icon that can hide the alert. */
dismissible?: boolean | null
/** Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation). */
elevation?: number | string | null
/** Sets the height for the component. */
height?: number | string | null
/** Designates a specific icon. */
icon?: boolean | string | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition). */
mode?: string | null
/** Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin). */
origin?: string | null
/** Makes the background transparent and applies a thin border. */
outlined?: boolean | null
/** Displays a larger vertically centered icon to draw more attention. */
prominent?: boolean | null
/** Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius). */
rounded?: boolean | string | null
/** Applies a large border radius on the top left and bottom right of the card. */
shaped?: boolean | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Applies the defined **color** to text and a low opacity background of the same. */
text?: boolean | null
/** Removes the component's border-radius. */
tile?: boolean | null
/** Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own. */
transition?: string | null
/** Specify a **success**, **info**, **warning** or **error** alert. Uses the contextual color and has a pre-defined icon. */
type?: string | null
/** Controls whether the component is visible or hidden. */
value?: boolean | null
/** Sets the width for the component. */
width?: number | string | null
},
{
$scopedSlots: Readonly<{
/** Slot for icon at end of alert. */
append: undefined
/** Slot for icon used in **dismissible** prop. */
close: (args: { toggle: (...args: any[]) => any }) => VNode[]
/** The default Vue slot. */
default: undefined
/** Slot for icon at beginning of alert. */
prepend: undefined
}>
},
{},
{},
{},
{},
{},
{
/** The updated bound model */
input: (arg0: boolean) => void
}
>
VAutocomplete: DefineComponent<
{
/** Appends an icon to the component, uses the same syntax as `v-icon` */
appendIcon?: string | null
/** Appends an icon to the outside the component's input, uses same syntax as `v-icon` */
appendOuterIcon?: string | null
/** Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default. */
attach?: any | null
/** When searching, will always highlight the first option */
autoSelectFirst?: boolean | null
/** Enables autofocus */
autofocus?: boolean | null
/** Changes the background-color of the input */
backgroundColor?: string | null
/** Keeps a local _unique_ copy of all items that have been passed through the **items** prop. */
cacheItems?: boolean | null
/** Changes display of selections to chips */
chips?: boolean | null
/** Applied when using **clearable** and the input is dirty */
clearIcon?: string | null
/** Add input clear functionality, default icon is Material Design Icons **mdi-clear** */
clearable?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation. */
counter?: boolean | number | string | null
counterValue?: Function | null
/** Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Adds a remove icon to selected chips */
deletableChips?: boolean | null
/** Reduces the input height */
dense?: boolean | null
/** Disables keyboard lookup */
disableLookup?: boolean | null
/** Disables the input */
disabled?: boolean | null
/** Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO. */
eager?: boolean | null
/** Puts the input in a manual error state */
error?: boolean | null
/** The total number of errors that should display at once */
errorCount?: number | string | null
/** Puts the input in an error state and passes through custom error messages. Will be combined with any validations that occur from the **rules** prop. This field will not trigger validation */
errorMessages?: string | any[] | null
/** Applies the alternate filled input style */
filled?: boolean | null
/** The filtering algorithm used when searching. [example](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/components/VAutocomplete/VAutocomplete.ts#L40) */
filter?: Function | null
/** Removes elevation (shadow) added to element when using the **solo** or **solo-inverted** props */
flat?: boolean | null
/** Designates input type as full-width */
fullWidth?: boolean | null
/** Sets the height of the input */
height?: number | string | null
/** Hides hint and validation errors. When set to `auto` messages will be rendered only if there's a message (hint, error message, counter value etc) to display */
hideDetails?: boolean | string | null
/** Hides the menu when there are no options to show. Useful for preventing the menu from opening before results are fetched asynchronously. Also has the effect of opening the menu when the `items` array changes if not already open. */
hideNoData?: boolean | null
/** Do not display in the select menu items that are already selected. Also removes checkboxes from the list when multiple */
hideSelected?: boolean | null
/** Hint text */
hint?: string | null
/** Sets the DOM id on the component */
id?: string | null
/** Sets color of selected items */
itemColor?: string | null
/** Set property of **items**'s disabled value */
itemDisabled?: string | any[] | Function | null
/** Set property of **items**'s text value */
itemText?: string | any[] | Function | null
/** Set property of **items**'s value - **must be primitive**. Dot notation is supported. **Note:** This is currently not supported with `v-combobox` [GitHub Issue](https://github.com/vuetifyjs/vuetify/issues/5479) */
itemValue?: string | any[] | Function | null
/** Can be an array of objects or array of strings. When using objects, will look for a text, value and disabled keys. This can be changed using the **item-text**, **item-value** and **item-disabled** props. Objects that have a **header** or **divider** property are considered special cases and generate a list header or divider; these items are not selectable. */
items?: any[] | null
/** Sets input label */
label?: string | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Specifies the height of the loader */
loaderHeight?: number | string | null
/** Displays linear progress bar. Can either be a String which specifies which color is applied to the progress bar (any material color or theme color - **primary**, **secondary**, **success**, **info**, **warning**, **error**) or a Boolean which uses the component **color** (set by color prop - if it's supported by the component) or the primary color */
loading?: boolean | string | null
/** Pass props through to the `v-menu` component. Accepts either a string for boolean props `menu-props="auto, overflowY"`, or an object `:menu-props="{ auto: true, overflowY: true }"` */
menuProps?: string | any[] | object | null
/** Displays a list of messages or message if using a string */
messages?: string | any[] | null
/** Changes select to multiple. Accepts array for value */
multiple?: boolean | null
/** Display text when there is no data */
noDataText?: string | null
/** Do not apply filtering when searching. Useful when data is being filtered server side */
noFilter?: boolean | null
/** When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state */
openOnClear?: boolean | null
/** Applies the outlined style to the input */
outlined?: boolean | null
/** Forces hint to always be visible */
persistentHint?: boolean | null
/** Forces placeholder to always be visible */
persistentPlaceholder?: boolean | null
/** Sets the input's placeholder text */
placeholder?: string | null
/** Displays prefix text */
prefix?: string | null
/** Prepends an icon to the component, uses the same syntax as `v-icon` */
prependIcon?: string | null
/** Prepends an icon inside the component's input, uses the same syntax as `v-icon` */
prependInnerIcon?: string | null
/** Puts input in readonly state */
readonly?: boolean | null
/** Changes the selection behavior to return the object directly rather than the value specified with **item-value** */
returnObject?: boolean | null
/** Reverses the input orientation */
reverse?: boolean | null
/** Adds a border radius to the input */
rounded?: boolean | null
/** Accepts a mixed array of types `function`, `boolean` and `string`. Functions pass an input value as an argument and must return either `true` / `false` or a `string` containing an error message. The input field will enter an error state if a function returns (or any value in the array contains) `false` or is a `string` */
rules?: InputValidationRules | null
/** Search value. Can be used with `.sync` modifier. */
searchInput?: string | null
/** Round if `outlined` and increase `border-radius` if `filled`. Must be used with either `outlined` or `filled` */
shaped?: boolean | null
/** Label does not move on focus/dirty */
singleLine?: boolean | null
/** Changes display of selections to chips with the **small** property */
smallChips?: boolean | null
/** Changes the style of the input */
solo?: boolean | null
/** Reduces element opacity until focused */
soloInverted?: boolean | null
/** Puts the input in a manual success state */
success?: boolean | null
/** Puts the input in a success state and passes through custom success messages. */
successMessages?: string | any[] | null
/** Displays suffix text */
suffix?: string | null
/** Delays validation until blur event */
validateOnBlur?: boolean | null
/** The input's value */
value?: any | null
/** The comparison algorithm used for values. [More info](https://github.com/vuetifyjs/vuetify/blob/v2-stable/packages/vuetify/src/util/helpers.ts) */
valueComparator?: Function | null
},
{
$scopedSlots: Readonly<{
/** Adds an item inside the input and after input content */
append: undefined
/** Adds an item after menu content */
"append-item": undefined
/** Adds an item outside the input and after input content */
"append-outer": undefined
counter: (args: {
props: {
dark: boolean
light: boolean
max: string | number
value: string
}
}) => VNode[]
/** Define a custom item appearance */
item: (args: {
parent: VueComponent
item: { [key: keyof any]: any }
on: { [key: keyof any]: any }
attrs: { [key: keyof any]: any }
}) => VNode[]
/** Replaces the default label */
label: undefined
message: (args: { key: number; message: string }) => VNode[]
"no-data": undefined
/** Adds an item outside the input and before input content */
prepend: undefined
/** Adds an item inside the input and before input content */
"prepend-inner": undefined
/** Adds an item before menu content */
"prepend-item": undefined
/** Slot for custom progress linear (displayed when **loading** prop is not equal to Boolean False) */
progress: undefined
/** Define a custom selection appearance */
selection: (args: {
parent: VueComponent
item: { [key: keyof any]: any }
index: number
select: (...args: any[]) => any
selected: boolean
disabled: boolean
}) => VNode[]
}>
},
{},
{},
{},
{},
{},
{
/** Emitted when the input is blurred */
blur: (arg0: Event) => void
/** Emitted when the input is changed by user interaction */
change: (arg0: any) => void
/** Emitted when input is clicked */
click: (arg0: MouseEvent) => void
/** Emitted when appended icon is clicked */
"click:append": (arg0: Event) => void
/** Emitted when appended outer icon is clicked */
"click:append-outer": (arg0: Event) => void
/** Emitted when clearable icon clicked */
"click:clear": (arg0: Event) => void
/** Emitted when prepended icon is clicked */
"click:prepend": (arg0: Event) => void
/** Emitted when prepended inner icon is clicked */
"click:prepend-inner": (arg0: Event) => void
/** Emitted when component is focused */
focus: (arg0: Event) => void
/** The updated bound model */
input: (arg0: any) => void
/** Emitted when **any** key is pressed */
keydown: (arg0: KeyboardEvent) => void
/** Emitted when click is pressed */
mousedown: (arg0: MouseEvent) => void
/** Emitted when click is released */
mouseup: (arg0: MouseEvent) => void
/** The `error.sync` event */
"update:error": (arg0: boolean) => void
/** Emitted when menu item is selected using keyboard arrows */
"update:list-index": (arg0: number) => void
/** The `search-input.sync` event */
"update:search-input": (arg0: string) => void
}
>
VAvatar: DefineComponent<
{
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Sets the height for the component. */
height?: number | string | null
/** Designates that the avatar is on the left side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons). */
left?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Designates that the avatar is on the right side of a component. This is hooked into by components such as [v-chip](/components/chips) and [v-btn](/components/buttons). */
right?: boolean | null
/** Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius). */
rounded?: boolean | string | null
/** Sets the height and width of the component. */
size?: number | string | null
/** Removes the component's **border-radius**. */
tile?: boolean | null
/** Sets the width for the component. */
width?: number | string | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
}
>
VBadge: DefineComponent<
{
/** Removes badge padding for the use of the `v-avatar` in the **badge** slot. */
avatar?: boolean | null
/** Applies a **2px** by default and **1.5px** border around the badge when using the **dot** property. */
bordered?: boolean | null
/** Aligns the component towards the bottom. */
bottom?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Any content you want injected as text into the badge. */
content?: any | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Reduce the size of the badge and hide its contents */
dot?: boolean | null
/** Designates a specific icon used in the badge. */
icon?: string | null
/** Moves the badge to be inline with the wrapping element. Supports the usage of the **left** prop. */
inline?: boolean | null
/** The **aria-label** used for the badge */
label?: string | null
/** Aligns the component towards the left. */
left?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Sets the transition mode (does not apply to transition-group). You can find more information on the Vue documentation [for transition modes](https://vuejs.org/v2/api/#transition). */
mode?: string | null
/** Offset the badge on the x-axis. */
offsetX?: number | string | null
/** Offset the badge on the y-axis. */
offsetY?: number | string | null
/** Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin). */
origin?: string | null
/** Overlaps the slotted content on top of the component. */
overlap?: boolean | null
/** Removes the component's border-radius. */
tile?: boolean | null
/** Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own. */
transition?: string | null
/** Controls whether the component is visible or hidden. */
value?: any | null
},
{
$scopedSlots: Readonly<{
/** The slot used for the badge's content. */
badge: undefined
/** The default Vue slot. */
default: undefined
}>
}
>
VBanner: DefineComponent<
{
/** When used inside of `v-main`, will calculate top based upon application `v-toolbar` and `v-system-bar`. */
app?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation). */
elevation?: number | string | null
/** Sets the height for the component. */
height?: number | string | null
/** Designates a specific icon. */
icon?: string | null
/** Designates a specific icon color. */
iconColor?: string | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Sets the designated mobile breakpoint for the component. */
mobileBreakpoint?: number | string | null
/** Removes elevation (box-shadow) and adds a *thin* border. */
outlined?: boolean | null
/** Designates the **border-radius** applied to the component. You can find more information on the [Border Radius page](/styles/border-radius). */
rounded?: boolean | string | null
/** Applies a large border radius on the top left and bottom right of the card. */
shaped?: boolean | null
/** Forces the banner onto a single line. */
singleLine?: boolean | null
/** Applies **position: sticky** to the component (**Evergreen browsers only**). You can find more information on the [MDN documentation for sticky position](https://developer.mozilla.org/en-US/docs/Web/CSS/position). */
sticky?: boolean | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Removes the component's **border-radius**. */
tile?: boolean | null
/** Controls whether the component is visible or hidden. */
value?: boolean | null
/** Sets the width for the component. */
width?: number | string | null
},
{
$scopedSlots: Readonly<{
/** The slot used for the action's content such as a [v-btn](/components/buttons). The **dismiss** function in this slots scope, when invoked, will close the banner. */
actions: (args: { dismiss: () => void }) => VNode[]
/** The default Vue slot. */
default: undefined
/** The slot used for the icon's content. */
icon: undefined
}>
}
>
VBottomNavigation: DefineComponent<
{
/** Applies **position: absolute** to the component. */
absolute?: boolean | null
/** The class applied to a [v-btn](/components/buttons) when activated. */
activeClass?: string | null
/** Designates the component as part of the application layout. Used for dynamically adjusting content sizing. Components using this prop should reside **outside** of `v-main` component to function properly. You can find more information about layouts on the [application page](/components/application). **Note:** this prop automatically applies **position: fixed** to the layout element. You can overwrite this functionality by using the `absolute` prop */
app?: boolean | null
/** Changes the background-color for the component. */
backgroundColor?: string | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Applies **position: fixed** to the component. */
fixed?: boolean | null
/** Force [v-btn](/components/buttons)s to take up all available space. */
grow?: boolean | null
/** Sets the height for the component. */
height?: number | string | null
/** Will transition the navigation off screen when scrolling up. */
hideOnScroll?: boolean | null
/** Uses an alternative horizontal styling for [v-btn](/components/buttons). */
horizontal?: boolean | null
/** Controls whether the component is visible or hidden. Supports the **.sync** modifier. */
inputValue?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Forces a value to always be selected (if available). */
mandatory?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Designates the element to target for scrolling events. Uses `window` by default. */
scrollTarget?: string | null
/** The amount of scroll distance down before **hide-on-scroll** activates. */
scrollThreshold?: string | number | null
/** Hides text of [v-btn](/components/buttons)s when they are not active. */
shift?: boolean | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Holds the value of the currently active [v-btn](/components/buttons). If the button has no value supplied, its index will be used instead.. */
value?: any | null
/** Sets the width for the component. */
width?: number | string | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
},
{},
{},
{},
{},
{},
{
/** The value of currently selected button. If no value is assigned, will be the current index of the button. */
change: (arg0: any) => void
/** The event used for `input-value.sync`. */
"update:input-value": (arg0: string | number) => void
}
>
VBottomSheet: DefineComponent<
{
/** Designate a custom activator when the `activator` slot is not used. String can be any valid querySelector and Object can be any valid Node. */
activator?: any | null
/** Specifies which DOM element that this component should detach to. String can be any valid querySelector and Object can be any valid Node. This will attach to the root `v-app` component by default. */
attach?: any | null
/** Milliseconds to wait before closing component. Only applies to hover and focus events. */
closeDelay?: number | string | null
/** Applies a custom class to the detached element. This is useful because the content is moved to the beginning of the `v-app` component (unless the **attach** prop is provided) and is not targetable by classes passed directly on the component. */
contentClass?: string | null
/** Applies the dark theme variant to the component. This will default the components color to _white_ unless you've configured your [application theme](/customization/theme) to **dark** or if you are using the **color** prop on the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Disables the ability to open the component. */
disabled?: boolean | null
/** Will force the components content to render on mounted. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO. */
eager?: boolean | null
/** Changes layout for fullscreen display. */
fullscreen?: boolean | null
/** Hides the display of the overlay. */
hideOverlay?: boolean | null
/** Reduces the sheet content maximum width to 70%. */
inset?: boolean | null
/** Detaches the menu content inside of the component as opposed to the document. */
internalActivator?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Sets the maximum width for the component. */
maxWidth?: string | number | null
/** Disables the bounce effect when clicking outside of a `v-dialog`'s content when using the **persistent** prop. */
noClickAnimation?: boolean | null
/** Milliseconds to wait before opening component. Only applies to hover and focus events. */
openDelay?: number | string | null
openOnClick?: boolean | null
openOnFocus?: boolean | null
/** Sets the transition origin on the element. You can find more information on the MDN documentation [for transition origin](https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin). */
origin?: string | null
/** Sets the overlay color. */
overlayColor?: string | null
/** Sets the overlay opacity. */
overlayOpacity?: number | string | null
/** Clicking outside of the element or pressing **esc** key will not deactivate it. */
persistent?: boolean | null
/** Tab focus will return to the first child of the dialog by default. Disable this when using external tools that require focus such as TinyMCE or vue-clipboard. */
retainFocus?: boolean | null
returnValue?: any | null
/** When set to true, expects a `v-card` and a `v-card-text` component with a designated height. For more information, check out the [scrollable example](/components/dialogs#scrollable). */
scrollable?: boolean | null
/** Sets the component transition. Can be one of the [built in transitions](/styles/transitions) or one your own. */
transition?: string | null
/** Controls whether the component is visible or hidden. */
value?: any | null
/** Sets the width for the component. */
width?: string | number | null
},
{
$scopedSlots: Readonly<{
/** When used, will activate the component when clicked (or hover for specific components). This manually stops the event propagation. Without this slot, if you open the component through its model, you will need to manually stop the event propagation */
activator: (args: {
attrs: {
role: string
"aria-haspopup": boolean
"aria-expanded": string
}
on: { [eventName: string]: eventHandler }
value: boolean
}) => VNode[]
/** The default Vue slot. */
default: undefined
}>
}
>
VBreadcrumbs: DefineComponent<
{
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Specifies the dividing character between items. */
divider?: string | null
/** An array of objects for each breadcrumb. */
items?: any[] | null
/** Increase the font-size of the breadcrumb item text to 16px (14px default). */
large?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
/** The slot used for dividers. */
divider: undefined
/** The slot used to override default `v-breadcrumbs-item` behavior when using the **items** prop. */
item: (args: { item: any }) => VNode[]
}>
}
>
VBreadcrumbsItem: DefineComponent<
{
/** Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation. */
activeClass?: string | null
/** Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation. */
append?: boolean | null
/** Removes the ability to click or target the component. */
disabled?: boolean | null
/** Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation. */
exact?: boolean | null
/** Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation. */
exactActiveClass?: string | null
/** Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation. */
exactPath?: boolean | null
/** Designates the component as anchor and applies the **href** attribute. */
href?: string | object | null
/** Designates that the component is a link. This is automatic when using the **href** or **to** prop. */
link?: boolean | null
/** Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/). */
nuxt?: boolean | null
/** Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [**replace** prop](https://router.vuejs.org/api/#replace) on the vue-router documentation. */
replace?: boolean | null
/** Applies the [v-ripple](/directives/ripple) directive. */
ripple?: boolean | object | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Designates the target attribute. This should only be applied when using the **href** prop. */
target?: string | null
/** Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation. */
to?: string | object | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
}
>
VBreadcrumbsDivider: DefineComponent<
{
/** Specify a custom tag used on the root element. */
tag?: string | null
},
{}
>
VBtn: DefineComponent<
{
/** Applies **position: absolute** to the component. */
absolute?: boolean | null
/** Configure the active CSS class applied when the link is active. You can find more information about the [**active-class** prop](https://router.vuejs.org/api/#active-class) on the vue-router documentation. */
activeClass?: string | null
/** Setting **append** prop always appends the relative path to the current path. You can find more information about the [**append** prop](https://router.vuejs.org/api/#append) on the vue-router documentation. */
append?: boolean | null
/** Expands the button to 100% of available space. */
block?: boolean | null
/** Aligns the component towards the bottom. */
bottom?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Removes the button box shadow. */
depressed?: boolean | null
/** Removes the ability to click or target the component. */
disabled?: boolean | null
/** Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation). */
elevation?: number | string | null
/** Exactly match the link. Without this, '/' will match every route. You can find more information about the [**exact** prop](https://router.vuejs.org/api/#exact) on the vue-router documentation. */
exact?: boolean | null
/** Configure the active CSS class applied when the link is active with exact match. You can find more information about the [**exact-active-class** prop](https://router.vuejs.org/api/#exact-active-class) on the vue-router documentation. */
exactActiveClass?: string | null
/** Exactly match the link, ignoring the `query` and the `hash` sections. You can find more information about the [**exact-path** prop](https://router.vuejs.org/api/#exact-path) on the vue-router documentation. */
exactPath?: boolean | null
/** Designates the button as a floating-action-button. Button will become _round_. */
fab?: boolean | null
/** Applies **position: fixed** to the component. */
fixed?: boolean | null
/** Sets the height for the component. */
height?: number | string | null
/** Designates the component as anchor and applies the **href** attribute. */
href?: string | object | null
/** Designates the button as icon. Button will become _round_ and applies the **text** prop. */
icon?: boolean | null
/** Controls the button's active state. */
inputValue?: any | null
/** Makes the component large. */
large?: boolean | null
/** Aligns the component towards the left. This should be used with the **absolute** or **fixed** props. */
left?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Designates that the component is a link. This is automatic when using the **href** or **to** prop. */
link?: boolean | null
/** Adds a loading icon animation. */
loading?: boolean | null
/** Sets the maximum height for the component. */
maxHeight?: number | string | null
/** Sets the maximum width for the component. */
maxWidth?: number | string | null
/** Sets the minimum height for the component. */
minHeight?: number | string | null
/** Sets the minimum width for the component. */
minWidth?: number | string | null
/** Specifies the link is a `nuxt-link`. For use with the [nuxt framework](https://nuxtjs.org/api/components-nuxt-link/). */
nuxt?: boolean | null
/** Makes the background transparent and applies a thin border. */
outlined?: boolean | null
/** Removes the default background change applied when hovering over the button. */
plain?: boolean | null
/** Setting **replace** prop will call `router.replace()` instead of `router.push()` when clicked, so the navigation will not leave a history record. You can find more information about the [**replace** prop](https://router.vuejs.org/api/#replace) on the vue-router documentation. */
replace?: boolean | null
/** Don't blur on click. */
retainFocusOnClick?: boolean | null
/** Aligns the component towards the right. This should be used with the **absolute** or **fixed** props. */
right?: boolean | null
/** Applies the [v-ripple](/directives/ripple) directive. */
ripple?: boolean | object | null
/** Applies a large border radius on the button. */
rounded?: boolean | null
/** Applies a large border radius on the top left and bottom right of the card. */
shaped?: boolean | null
/** Makes the component small. */
small?: boolean | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Designates the target attribute. This should only be applied when using the **href** prop. */
target?: string | null
/** Makes the background transparent. When using the **color** prop, the color will be applied to the button text instead of the background. */
text?: boolean | null
/** Removes the component's **border-radius**. */
tile?: boolean | null
/** Denotes the target route of the link. You can find more information about the [**to** prop](https://router.vuejs.org/api/#to) on the vue-router documentation. */
to?: string | object | null
/** Aligns the content towards the top. */
top?: boolean | null
/** Set the button's **type** attribute. */
type?: string | null
/** Controls whether the component is visible or hidden. */
value?: any | null
/** Sets the width for the component. */
width?: number | string | null
/** Makes the component extra large. */
xLarge?: boolean | null
/** Makes the component extra small. */
xSmall?: boolean | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
/** Custom loader. */
loader: undefined
}>
},
{},
{},
{},
{},
{},
{
/** Event that is emitted when the component is clicked */
click: (arg0: Event) => void
}
>
VBtnToggle: DefineComponent<
{
/** The **active-class** applied to children when they are activated. */
activeClass?: string | null
/** Changes the background-color for the component. */
backgroundColor?: string | null
/** Removes the group's border. */
borderless?: boolean | null
/** Applies specified color to the control - it can be the name of material color (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). You can find a list of built-in classes on the [colors page](/styles/colors#material-colors). */
color?: string | null
/** Applies the dark theme variant to the component. You can find more information on the Material Design documentation for [dark themes](https://material.io/design/color/dark-theme.html). */
dark?: boolean | null
/** Reduces the button size and padding. */
dense?: boolean | null
/** Generally used in [v-toolbar](/components/toolbars) and [v-app-bar](/components/app-bars). Removes background color, border and increases space between the buttons */
group?: boolean | null
/** Applies the light theme variant to the component. */
light?: boolean | null
/** Forces a value to always be selected (if available). */
mandatory?: boolean | null
/** Sets a maximum number of selections that can be made. */
max?: number | string | null
/** Allow multiple selections. The **value** prop must be an _array_. */
multiple?: boolean | null
/** Round edge buttons */
rounded?: boolean | null
/** Applies a large border radius on the top left and bottom right of the card. */
shaped?: boolean | null
/** Specify a custom tag used on the root element. */
tag?: string | null
/** Removes the component's border-radius. */
tile?: boolean | null
/** The designated model value for the component. */
value?: any | null
/** Apply a custom value comparator function */
valueComparator?: Function | null
},
{
$scopedSlots: Readonly<{
/** The default Vue slot. */
default: undefined
}>
},
{},
{},
{},
{},
{},
{
/** Emitted when the input is changed by user interaction */
change: (arg0: any[] | any) => void
}