@vuetify/nightly 3.7.6-dev.2025-01-15 → 3.7.6-dev.2025-01-17
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/dist/json/attributes.json +1383 -1379
- package/dist/json/importMap-labs.json +18 -18
- package/dist/json/importMap.json +154 -154
- package/dist/json/tags.json +1 -0
- package/dist/json/web-types.json +2910 -2901
- package/dist/vuetify-labs.css +3443 -3443
- package/dist/vuetify-labs.d.ts +57 -51
- package/dist/vuetify-labs.esm.js +10 -4
- package/dist/vuetify-labs.esm.js.map +1 -1
- package/dist/vuetify-labs.js +10 -4
- package/dist/vuetify-labs.min.css +2 -2
- package/dist/vuetify.css +5558 -5558
- package/dist/vuetify.d.ts +57 -51
- package/dist/vuetify.esm.js +10 -4
- package/dist/vuetify.esm.js.map +1 -1
- package/dist/vuetify.js +10 -4
- package/dist/vuetify.js.map +1 -1
- package/dist/vuetify.min.css +2 -2
- package/dist/vuetify.min.js +5 -5
- package/dist/vuetify.min.js.map +1 -1
- package/lib/components/VTimeline/VTimeline.css +8 -8
- package/lib/components/VTimeline/VTimeline.sass +12 -4
- package/lib/components/VTimeline/VTimelineItem.d.ts +12 -1
- package/lib/components/VTimeline/VTimelineItem.js +7 -1
- package/lib/components/VTimeline/VTimelineItem.js.map +1 -1
- package/lib/entry-bundler.js +1 -1
- package/lib/framework.d.ts +51 -51
- package/lib/framework.js +1 -1
- package/package.json +1 -1
@@ -1267,10 +1267,6 @@
|
|
1267
1267
|
"type": "string | number\n",
|
1268
1268
|
"description": "Specifies the dividing character between items."
|
1269
1269
|
},
|
1270
|
-
"VBreadcrumbsItem/title": {
|
1271
|
-
"type": "string\n",
|
1272
|
-
"description": "Specify a title text for the component."
|
1273
|
-
},
|
1274
1270
|
"VBreadcrumbsItem/replace": {
|
1275
1271
|
"type": "boolean\n",
|
1276
1272
|
"description": "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](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
|
@@ -1279,38 +1275,42 @@
|
|
1279
1275
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
1280
1276
|
"description": "Specify a custom tag used on the root element."
|
1281
1277
|
},
|
1282
|
-
"VBreadcrumbsItem/
|
1278
|
+
"VBreadcrumbsItem/title": {
|
1283
1279
|
"type": "string\n",
|
1284
|
-
"description": "
|
1280
|
+
"description": "Specify a title text for the component."
|
1285
1281
|
},
|
1286
|
-
"VBreadcrumbsItem/
|
1282
|
+
"VBreadcrumbsItem/active": {
|
1287
1283
|
"type": "boolean\n",
|
1288
|
-
"description": "
|
1284
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
1289
1285
|
},
|
1290
1286
|
"VBreadcrumbsItem/active-color": {
|
1291
1287
|
"type": "string\n",
|
1292
1288
|
"description": "The applied color when the component is in an active state."
|
1293
1289
|
},
|
1294
|
-
"VBreadcrumbsItem/active-class": {
|
1295
|
-
"type": "string\n",
|
1296
|
-
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
|
1297
|
-
},
|
1298
1290
|
"VBreadcrumbsItem/disabled": {
|
1299
1291
|
"type": "boolean\n",
|
1300
1292
|
"description": "Removes the ability to click or target the component."
|
1301
1293
|
},
|
1302
|
-
"VBreadcrumbsItem/active": {
|
1303
|
-
"type": "boolean\n",
|
1304
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
1305
|
-
},
|
1306
1294
|
"VBreadcrumbsItem/href": {
|
1307
1295
|
"type": "string\n",
|
1308
1296
|
"description": "Designates the component as anchor and applies the **href** attribute."
|
1309
1297
|
},
|
1298
|
+
"VBreadcrumbsItem/exact": {
|
1299
|
+
"type": "boolean\n",
|
1300
|
+
"description": "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."
|
1301
|
+
},
|
1310
1302
|
"VBreadcrumbsItem/to": {
|
1311
1303
|
"type": "RouteLocationRaw\n",
|
1312
1304
|
"description": "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."
|
1313
1305
|
},
|
1306
|
+
"VBreadcrumbsItem/color": {
|
1307
|
+
"type": "string\n",
|
1308
|
+
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
1309
|
+
},
|
1310
|
+
"VBreadcrumbsItem/active-class": {
|
1311
|
+
"type": "string\n",
|
1312
|
+
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
|
1313
|
+
},
|
1314
1314
|
"VBtn/symbol": {
|
1315
1315
|
"type": "any\n",
|
1316
1316
|
"description": "The [Symbol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol) used to hook into group functionality for components like [v-btn-toggle](/components/btn-toggle) and [v-bottom-navigation](/components/bottom-navigations/)."
|
@@ -1843,14 +1843,6 @@
|
|
1843
1843
|
"type": "any[]\n",
|
1844
1844
|
"description": "Array of events associated with this specific day."
|
1845
1845
|
},
|
1846
|
-
"VCard/title": {
|
1847
|
-
"type": "string | number\n",
|
1848
|
-
"description": "Specify a title text for the component."
|
1849
|
-
},
|
1850
|
-
"VCard/text": {
|
1851
|
-
"type": "string | number\n",
|
1852
|
-
"description": "Specify content text for the component."
|
1853
|
-
},
|
1854
1846
|
"VCard/flat": {
|
1855
1847
|
"type": "boolean\n",
|
1856
1848
|
"description": "Removes the card's elevation."
|
@@ -1863,6 +1855,34 @@
|
|
1863
1855
|
"type": "boolean\n",
|
1864
1856
|
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
|
1865
1857
|
},
|
1858
|
+
"VCard/tag": {
|
1859
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
1860
|
+
"description": "Specify a custom tag used on the root element."
|
1861
|
+
},
|
1862
|
+
"VCard/title": {
|
1863
|
+
"type": "string | number\n",
|
1864
|
+
"description": "Specify a title text for the component."
|
1865
|
+
},
|
1866
|
+
"VCard/theme": {
|
1867
|
+
"type": "string\n",
|
1868
|
+
"description": "Specify a theme for this component and all of its children."
|
1869
|
+
},
|
1870
|
+
"VCard/prepend-icon": {
|
1871
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1872
|
+
"description": "Prepends a [v-icon](/components/icons/) component to the header."
|
1873
|
+
},
|
1874
|
+
"VCard/append-icon": {
|
1875
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1876
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
1877
|
+
},
|
1878
|
+
"VCard/ripple": {
|
1879
|
+
"type": "boolean | { class: string }\n",
|
1880
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
1881
|
+
},
|
1882
|
+
"VCard/text": {
|
1883
|
+
"type": "string | number\n",
|
1884
|
+
"description": "Specify content text for the component."
|
1885
|
+
},
|
1866
1886
|
"VCard/border": {
|
1867
1887
|
"type": "string | number | boolean\n",
|
1868
1888
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
@@ -1899,12 +1919,20 @@
|
|
1899
1919
|
"type": "string | number\n",
|
1900
1920
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
1901
1921
|
},
|
1922
|
+
"VCard/disabled": {
|
1923
|
+
"type": "boolean\n",
|
1924
|
+
"description": "Removes the ability to click or target the component."
|
1925
|
+
},
|
1926
|
+
"VCard/loading": {
|
1927
|
+
"type": "string | boolean\n",
|
1928
|
+
"description": "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."
|
1929
|
+
},
|
1902
1930
|
"VCard/location": {
|
1903
1931
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
1904
1932
|
"description": "Specifies the component's location. Can combine by using a space separated string."
|
1905
1933
|
},
|
1906
1934
|
"VCard/position": {
|
1907
|
-
"type": "'fixed' | '
|
1935
|
+
"type": "'fixed' | 'relative' | 'static' | 'absolute' | 'sticky'\n",
|
1908
1936
|
"description": "Sets the position for the component."
|
1909
1937
|
},
|
1910
1938
|
"VCard/rounded": {
|
@@ -1915,58 +1943,34 @@
|
|
1915
1943
|
"type": "boolean\n",
|
1916
1944
|
"description": "Removes any applied **border-radius** from the component."
|
1917
1945
|
},
|
1918
|
-
"VCard/
|
1919
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
1920
|
-
"description": "Specify a custom tag used on the root element."
|
1921
|
-
},
|
1922
|
-
"VCard/theme": {
|
1946
|
+
"VCard/href": {
|
1923
1947
|
"type": "string\n",
|
1924
|
-
"description": "
|
1948
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
1949
|
+
},
|
1950
|
+
"VCard/exact": {
|
1951
|
+
"type": "boolean\n",
|
1952
|
+
"description": "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."
|
1953
|
+
},
|
1954
|
+
"VCard/to": {
|
1955
|
+
"type": "RouteLocationRaw\n",
|
1956
|
+
"description": "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."
|
1925
1957
|
},
|
1926
1958
|
"VCard/color": {
|
1927
1959
|
"type": "string\n",
|
1928
1960
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
1929
1961
|
},
|
1930
1962
|
"VCard/variant": {
|
1931
|
-
"type": "'
|
1963
|
+
"type": "'flat' | 'text' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
1932
1964
|
"description": "Applies a distinct style to the component."
|
1933
1965
|
},
|
1934
1966
|
"VCard/image": {
|
1935
1967
|
"type": "string\n",
|
1936
1968
|
"description": "Apply a specific background image to the component."
|
1937
1969
|
},
|
1938
|
-
"VCard/exact": {
|
1939
|
-
"type": "boolean\n",
|
1940
|
-
"description": "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."
|
1941
|
-
},
|
1942
1970
|
"VCard/subtitle": {
|
1943
1971
|
"type": "string | number\n",
|
1944
1972
|
"description": "Specify a subtitle text for the component."
|
1945
1973
|
},
|
1946
|
-
"VCard/disabled": {
|
1947
|
-
"type": "boolean\n",
|
1948
|
-
"description": "Removes the ability to click or target the component."
|
1949
|
-
},
|
1950
|
-
"VCard/append-icon": {
|
1951
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1952
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
1953
|
-
},
|
1954
|
-
"VCard/prepend-icon": {
|
1955
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1956
|
-
"description": "Prepends a [v-icon](/components/icons/) component to the header."
|
1957
|
-
},
|
1958
|
-
"VCard/loading": {
|
1959
|
-
"type": "string | boolean\n",
|
1960
|
-
"description": "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."
|
1961
|
-
},
|
1962
|
-
"VCard/href": {
|
1963
|
-
"type": "string\n",
|
1964
|
-
"description": "Designates the component as anchor and applies the **href** attribute."
|
1965
|
-
},
|
1966
|
-
"VCard/to": {
|
1967
|
-
"type": "RouteLocationRaw\n",
|
1968
|
-
"description": "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."
|
1969
|
-
},
|
1970
1974
|
"VCard/append-avatar": {
|
1971
1975
|
"type": "string\n",
|
1972
1976
|
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
|
@@ -1979,22 +1983,10 @@
|
|
1979
1983
|
"type": "string\n",
|
1980
1984
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
1981
1985
|
},
|
1982
|
-
"VCard/ripple": {
|
1983
|
-
"type": "boolean | { class: string }\n",
|
1984
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
1985
|
-
},
|
1986
1986
|
"VCardItem/title": {
|
1987
1987
|
"type": "string | number\n",
|
1988
1988
|
"description": "Specify a title text for the component."
|
1989
1989
|
},
|
1990
|
-
"VCardItem/prepend-icon": {
|
1991
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1992
|
-
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
1993
|
-
},
|
1994
|
-
"VCardItem/append-icon": {
|
1995
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1996
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
1997
|
-
},
|
1998
1990
|
"VCardItem/density": {
|
1999
1991
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
2000
1992
|
"description": "Adjusts the vertical height used by the component."
|
@@ -2003,6 +1995,14 @@
|
|
2003
1995
|
"type": "string | number\n",
|
2004
1996
|
"description": "Specify a subtitle text for the component."
|
2005
1997
|
},
|
1998
|
+
"VCardItem/append-icon": {
|
1999
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2000
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
2001
|
+
},
|
2002
|
+
"VCardItem/prepend-icon": {
|
2003
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2004
|
+
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
2005
|
+
},
|
2006
2006
|
"VCardItem/append-avatar": {
|
2007
2007
|
"type": "string\n",
|
2008
2008
|
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
|
@@ -2375,10 +2375,6 @@
|
|
2375
2375
|
"type": "boolean | 'auto'\n",
|
2376
2376
|
"description": "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."
|
2377
2377
|
},
|
2378
|
-
"VCheckbox/ripple": {
|
2379
|
-
"type": "boolean | { class: string }\n",
|
2380
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2381
|
-
},
|
2382
2378
|
"VCheckbox/indeterminate": {
|
2383
2379
|
"type": "boolean\n",
|
2384
2380
|
"description": "Sets an indeterminate state for the checkbox."
|
@@ -2407,6 +2403,10 @@
|
|
2407
2403
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2408
2404
|
"description": "The icon used when active."
|
2409
2405
|
},
|
2406
|
+
"VCheckbox/ripple": {
|
2407
|
+
"type": "boolean | { class: string }\n",
|
2408
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2409
|
+
},
|
2410
2410
|
"VCheckboxBtn/type": {
|
2411
2411
|
"type": "string\n",
|
2412
2412
|
"description": "Provides the default type for children selection controls."
|
@@ -2731,14 +2731,14 @@
|
|
2731
2731
|
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
2732
2732
|
"description": "Sets the designated mobile breakpoint for the component."
|
2733
2733
|
},
|
2734
|
-
"VClassIcon/icon": {
|
2735
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2736
|
-
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
2737
|
-
},
|
2738
2734
|
"VClassIcon/tag": {
|
2739
2735
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
2740
2736
|
"description": "Specify a custom tag used on the root element."
|
2741
2737
|
},
|
2738
|
+
"VClassIcon/icon": {
|
2739
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2740
|
+
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
2741
|
+
},
|
2742
2742
|
"VCode/tag": {
|
2743
2743
|
"type": "string\n",
|
2744
2744
|
"description": "Specify a custom tag used on the root element."
|
@@ -2747,6 +2747,14 @@
|
|
2747
2747
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
2748
2748
|
"description": "Specify a custom tag used on the root element."
|
2749
2749
|
},
|
2750
|
+
"VCol/order": {
|
2751
|
+
"type": "string | number\n",
|
2752
|
+
"description": "Sets the default [order](https://developer.mozilla.org/en-US/docs/Web/CSS/order) for the column."
|
2753
|
+
},
|
2754
|
+
"VCol/offset": {
|
2755
|
+
"type": "string | number\n",
|
2756
|
+
"description": "Sets the default offset for the column."
|
2757
|
+
},
|
2750
2758
|
"VCol/sm": {
|
2751
2759
|
"type": "string | number | boolean\n",
|
2752
2760
|
"description": "Changes the number of columns on small and greater breakpoints."
|
@@ -2767,14 +2775,6 @@
|
|
2767
2775
|
"type": "string | number | boolean\n",
|
2768
2776
|
"description": "Changes the number of columns on extra extra large and greater breakpoints."
|
2769
2777
|
},
|
2770
|
-
"VCol/order": {
|
2771
|
-
"type": "string | number\n",
|
2772
|
-
"description": "Sets the default [order](https://developer.mozilla.org/en-US/docs/Web/CSS/order) for the column."
|
2773
|
-
},
|
2774
|
-
"VCol/offset": {
|
2775
|
-
"type": "string | number\n",
|
2776
|
-
"description": "Sets the default offset for the column."
|
2777
|
-
},
|
2778
2778
|
"VCol/cols": {
|
2779
2779
|
"type": "string | number | boolean\n",
|
2780
2780
|
"description": "Sets the default number of columns the component extends. Available options are: **1 -> 12** and **auto**."
|
@@ -2820,17 +2820,25 @@
|
|
2820
2820
|
"description": "Changes the order of the component on extra extra large and greater breakpoints."
|
2821
2821
|
},
|
2822
2822
|
"VCol/align-self": {
|
2823
|
-
"type": "'
|
2823
|
+
"type": "'end' | 'start' | 'center' | 'auto' | 'baseline' | 'stretch'\n",
|
2824
2824
|
"description": "Applies the [align-items](https://developer.mozilla.org/en-US/docs/Web/CSS/align-items) css property. Available options are: **start**, **center**, **end**, **auto**, **baseline** and **stretch**."
|
2825
2825
|
},
|
2826
|
+
"VColorPicker/tag": {
|
2827
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
2828
|
+
"description": "Specify a custom tag used on the root element."
|
2829
|
+
},
|
2830
|
+
"VColorPicker/mode": {
|
2831
|
+
"type": "'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hex' | 'hexa'\n",
|
2832
|
+
"description": "The current selected input type. Syncable with `v-model:mode`."
|
2833
|
+
},
|
2834
|
+
"VColorPicker/theme": {
|
2835
|
+
"type": "string\n",
|
2836
|
+
"description": "Specify a theme for this component and all of its children."
|
2837
|
+
},
|
2826
2838
|
"VColorPicker/border": {
|
2827
2839
|
"type": "string | number | boolean\n",
|
2828
2840
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
2829
2841
|
},
|
2830
|
-
"VColorPicker/model-value": {
|
2831
|
-
"type": "string | Record<string, unknown>\n",
|
2832
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
2833
|
-
},
|
2834
2842
|
"VColorPicker/width": {
|
2835
2843
|
"type": "string | number\n",
|
2836
2844
|
"description": "Sets the width of the color picker."
|
@@ -2839,8 +2847,12 @@
|
|
2839
2847
|
"type": "string | number\n",
|
2840
2848
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
2841
2849
|
},
|
2850
|
+
"VColorPicker/disabled": {
|
2851
|
+
"type": "boolean\n",
|
2852
|
+
"description": "Removes the ability to click or target the component."
|
2853
|
+
},
|
2842
2854
|
"VColorPicker/position": {
|
2843
|
-
"type": "'fixed' | '
|
2855
|
+
"type": "'fixed' | 'relative' | 'static' | 'absolute' | 'sticky'\n",
|
2844
2856
|
"description": "Sets the position for the component."
|
2845
2857
|
},
|
2846
2858
|
"VColorPicker/rounded": {
|
@@ -2851,25 +2863,13 @@
|
|
2851
2863
|
"type": "boolean\n",
|
2852
2864
|
"description": "Removes any applied **border-radius** from the component."
|
2853
2865
|
},
|
2854
|
-
"VColorPicker/tag": {
|
2855
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
2856
|
-
"description": "Specify a custom tag used on the root element."
|
2857
|
-
},
|
2858
|
-
"VColorPicker/theme": {
|
2859
|
-
"type": "string\n",
|
2860
|
-
"description": "Specify a theme for this component and all of its children."
|
2861
|
-
},
|
2862
2866
|
"VColorPicker/color": {
|
2863
2867
|
"type": "string\n",
|
2864
2868
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
2865
2869
|
},
|
2866
|
-
"VColorPicker/
|
2867
|
-
"type": "
|
2868
|
-
"description": "
|
2869
|
-
},
|
2870
|
-
"VColorPicker/mode": {
|
2871
|
-
"type": "'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hex' | 'hexa'\n",
|
2872
|
-
"description": "The current selected input type. Syncable with `v-model:mode`."
|
2870
|
+
"VColorPicker/model-value": {
|
2871
|
+
"type": "string | Record<string, unknown>\n",
|
2872
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
2873
2873
|
},
|
2874
2874
|
"VColorPicker/canvas-height": {
|
2875
2875
|
"type": "string | number\n",
|
@@ -2915,86 +2915,34 @@
|
|
2915
2915
|
"type": "string\n",
|
2916
2916
|
"description": "Sets input type."
|
2917
2917
|
},
|
2918
|
-
"VCombobox/
|
2919
|
-
"type": "
|
2920
|
-
"description": "
|
2921
|
-
},
|
2922
|
-
"VCombobox/name": {
|
2923
|
-
"type": "string\n",
|
2924
|
-
"description": "Sets the component's name attribute."
|
2918
|
+
"VCombobox/model-value": {
|
2919
|
+
"type": "any\n",
|
2920
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
2925
2921
|
},
|
2926
2922
|
"VCombobox/error": {
|
2927
2923
|
"type": "boolean\n",
|
2928
2924
|
"description": "Puts the input in a manual error state."
|
2929
2925
|
},
|
2930
|
-
"VCombobox/
|
2931
|
-
"type": "string\n",
|
2932
|
-
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
2933
|
-
},
|
2934
|
-
"VCombobox/menu": {
|
2926
|
+
"VCombobox/reverse": {
|
2935
2927
|
"type": "boolean\n",
|
2936
|
-
"description": "
|
2937
|
-
},
|
2938
|
-
"VCombobox/delimiters": {
|
2939
|
-
"type": "string[]\n",
|
2940
|
-
"description": "Accepts an array of strings that will trigger a new tag when typing. Does not replace the normal Tab and Enter keys."
|
2928
|
+
"description": "Reverses the orientation."
|
2941
2929
|
},
|
2942
|
-
"VCombobox/
|
2943
|
-
"type": "
|
2944
|
-
"description": "
|
2930
|
+
"VCombobox/density": {
|
2931
|
+
"type": "'default' | 'comfortable' | 'compact'\n",
|
2932
|
+
"description": "Adjusts the vertical height used by the component."
|
2945
2933
|
},
|
2946
|
-
"VCombobox/
|
2947
|
-
"type": "
|
2948
|
-
"description": "
|
2934
|
+
"VCombobox/max-width": {
|
2935
|
+
"type": "string | number\n",
|
2936
|
+
"description": "Sets the maximum width for the component."
|
2949
2937
|
},
|
2950
|
-
"VCombobox/
|
2951
|
-
"type": "string\n",
|
2952
|
-
"description": "Sets the
|
2953
|
-
},
|
2954
|
-
"VCombobox/active": {
|
2955
|
-
"type": "boolean\n",
|
2956
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
2957
|
-
},
|
2958
|
-
"VCombobox/base-color": {
|
2959
|
-
"type": "string\n",
|
2960
|
-
"description": "Sets the color of the input when it is not focused."
|
2961
|
-
},
|
2962
|
-
"VCombobox/prepend-icon": {
|
2963
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2964
|
-
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
|
2965
|
-
},
|
2966
|
-
"VCombobox/append-icon": {
|
2967
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
2968
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
2969
|
-
},
|
2970
|
-
"VCombobox/readonly": {
|
2971
|
-
"type": "boolean\n",
|
2972
|
-
"description": "Puts input in readonly state."
|
2973
|
-
},
|
2974
|
-
"VCombobox/density": {
|
2975
|
-
"type": "'default' | 'comfortable' | 'compact'\n",
|
2976
|
-
"description": "Adjusts the vertical height used by the component."
|
2977
|
-
},
|
2978
|
-
"VCombobox/max-width": {
|
2979
|
-
"type": "string | number\n",
|
2980
|
-
"description": "Sets the maximum width for the component."
|
2981
|
-
},
|
2982
|
-
"VCombobox/min-width": {
|
2983
|
-
"type": "string | number\n",
|
2984
|
-
"description": "Sets the minimum width for the component."
|
2938
|
+
"VCombobox/min-width": {
|
2939
|
+
"type": "string | number\n",
|
2940
|
+
"description": "Sets the minimum width for the component."
|
2985
2941
|
},
|
2986
2942
|
"VCombobox/width": {
|
2987
2943
|
"type": "string | number\n",
|
2988
2944
|
"description": "Sets the width for the component."
|
2989
2945
|
},
|
2990
|
-
"VCombobox/disabled": {
|
2991
|
-
"type": "boolean\n",
|
2992
|
-
"description": "Removes the ability to click or target the input."
|
2993
|
-
},
|
2994
|
-
"VCombobox/loading": {
|
2995
|
-
"type": "string | boolean\n",
|
2996
|
-
"description": "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."
|
2997
|
-
},
|
2998
2946
|
"VCombobox/rounded": {
|
2999
2947
|
"type": "string | number | boolean\n",
|
3000
2948
|
"description": "Adds a border radius to the input."
|
@@ -3003,6 +2951,10 @@
|
|
3003
2951
|
"type": "boolean\n",
|
3004
2952
|
"description": "Removes any applied **border-radius** from the component."
|
3005
2953
|
},
|
2954
|
+
"VCombobox/theme": {
|
2955
|
+
"type": "string\n",
|
2956
|
+
"description": "Specify a theme for this component and all of its children."
|
2957
|
+
},
|
3006
2958
|
"VCombobox/color": {
|
3007
2959
|
"type": "string\n",
|
3008
2960
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
@@ -3011,41 +2963,17 @@
|
|
3011
2963
|
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
|
3012
2964
|
"description": "Applies a distinct style to the component."
|
3013
2965
|
},
|
3014
|
-
"VCombobox/
|
3015
|
-
"type": "any\n",
|
3016
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3017
|
-
},
|
3018
|
-
"VCombobox/transition": {
|
3019
|
-
"type": "string | boolean | (TransitionProps & { component: Component })\n",
|
3020
|
-
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3021
|
-
},
|
3022
|
-
"VCombobox/bg-color": {
|
2966
|
+
"VCombobox/name": {
|
3023
2967
|
"type": "string\n",
|
3024
|
-
"description": "
|
3025
|
-
},
|
3026
|
-
"VCombobox/multiple": {
|
3027
|
-
"type": "boolean\n",
|
3028
|
-
"description": "Changes select to multiple. Accepts array for value."
|
3029
|
-
},
|
3030
|
-
"VCombobox/eager": {
|
3031
|
-
"type": "boolean\n",
|
3032
|
-
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
2968
|
+
"description": "Sets the component's name attribute."
|
3033
2969
|
},
|
3034
|
-
"VCombobox/
|
3035
|
-
"type": "string\n",
|
3036
|
-
"description": "
|
2970
|
+
"VCombobox/delimiters": {
|
2971
|
+
"type": "string[]\n",
|
2972
|
+
"description": "Accepts an array of strings that will trigger a new tag when typing. Does not replace the normal Tab and Enter keys."
|
3037
2973
|
},
|
3038
|
-
"VCombobox/
|
2974
|
+
"VCombobox/label": {
|
3039
2975
|
"type": "string\n",
|
3040
|
-
"description": "
|
3041
|
-
},
|
3042
|
-
"VCombobox/direction": {
|
3043
|
-
"type": "'horizontal' | 'vertical'\n",
|
3044
|
-
"description": "Changes the direction of the input."
|
3045
|
-
},
|
3046
|
-
"VCombobox/value-comparator": {
|
3047
|
-
"type": "(a: any, b: any) => boolean\n",
|
3048
|
-
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
2976
|
+
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
3049
2977
|
},
|
3050
2978
|
"VCombobox/auto-select-first": {
|
3051
2979
|
"type": "boolean | 'exact'\n",
|
@@ -3091,6 +3019,10 @@
|
|
3091
3019
|
"type": "string\n",
|
3092
3020
|
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
|
3093
3021
|
},
|
3022
|
+
"VCombobox/eager": {
|
3023
|
+
"type": "boolean\n",
|
3024
|
+
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
3025
|
+
},
|
3094
3026
|
"VCombobox/hide-no-data": {
|
3095
3027
|
"type": "boolean\n",
|
3096
3028
|
"description": "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."
|
@@ -3103,6 +3035,26 @@
|
|
3103
3035
|
"type": "unknown\n",
|
3104
3036
|
"description": "Pass props through to the `v-list` component. Accepts an object with anything from [v-list](/api/v-list/#props) props, camelCase keys are recommended."
|
3105
3037
|
},
|
3038
|
+
"VCombobox/base-color": {
|
3039
|
+
"type": "string\n",
|
3040
|
+
"description": "Sets the color of the input when it is not focused."
|
3041
|
+
},
|
3042
|
+
"VCombobox/bg-color": {
|
3043
|
+
"type": "string\n",
|
3044
|
+
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
3045
|
+
},
|
3046
|
+
"VCombobox/disabled": {
|
3047
|
+
"type": "boolean\n",
|
3048
|
+
"description": "Removes the ability to click or target the input."
|
3049
|
+
},
|
3050
|
+
"VCombobox/multiple": {
|
3051
|
+
"type": "boolean\n",
|
3052
|
+
"description": "Changes select to multiple. Accepts array for value."
|
3053
|
+
},
|
3054
|
+
"VCombobox/items": {
|
3055
|
+
"type": "any[]\n",
|
3056
|
+
"description": "Can be an array of objects or strings. By default objects should have **title** and **value** properties, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props). Keys to use for these can be changed with the **item-title**, **item-value**, and **item-props** props."
|
3057
|
+
},
|
3106
3058
|
"VCombobox/item-title": {
|
3107
3059
|
"type": "SelectItemKey<any>\n",
|
3108
3060
|
"description": "Property on supplied `items` that contains its title."
|
@@ -3123,6 +3075,14 @@
|
|
3123
3075
|
"type": "boolean\n",
|
3124
3076
|
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
3125
3077
|
},
|
3078
|
+
"VCombobox/value-comparator": {
|
3079
|
+
"type": "(a: any, b: any) => boolean\n",
|
3080
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3081
|
+
},
|
3082
|
+
"VCombobox/menu": {
|
3083
|
+
"type": "boolean\n",
|
3084
|
+
"description": "Renders with the menu open by default."
|
3085
|
+
},
|
3126
3086
|
"VCombobox/menu-icon": {
|
3127
3087
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3128
3088
|
"description": "Sets the the spin icon."
|
@@ -3131,6 +3091,14 @@
|
|
3131
3091
|
"type": "unknown\n",
|
3132
3092
|
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
|
3133
3093
|
},
|
3094
|
+
"VCombobox/id": {
|
3095
|
+
"type": "string\n",
|
3096
|
+
"description": "Sets the DOM id on the component."
|
3097
|
+
},
|
3098
|
+
"VCombobox/transition": {
|
3099
|
+
"type": "string | boolean | (TransitionProps & { component: Component })\n",
|
3100
|
+
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3101
|
+
},
|
3134
3102
|
"VCombobox/no-data-text": {
|
3135
3103
|
"type": "string\n",
|
3136
3104
|
"description": "Text shown when no items are provided to the component."
|
@@ -3151,6 +3119,10 @@
|
|
3151
3119
|
"type": "string | number | boolean\n",
|
3152
3120
|
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
|
3153
3121
|
},
|
3122
|
+
"VCombobox/prefix": {
|
3123
|
+
"type": "string\n",
|
3124
|
+
"description": "Displays prefix text."
|
3125
|
+
},
|
3154
3126
|
"VCombobox/placeholder": {
|
3155
3127
|
"type": "string\n",
|
3156
3128
|
"description": "Sets the input’s placeholder text."
|
@@ -3167,10 +3139,22 @@
|
|
3167
3139
|
"type": "string\n",
|
3168
3140
|
"description": "Displays suffix text."
|
3169
3141
|
},
|
3142
|
+
"VCombobox/role": {
|
3143
|
+
"type": "string\n",
|
3144
|
+
"description": "The role attribute applied to the input."
|
3145
|
+
},
|
3146
|
+
"VCombobox/append-icon": {
|
3147
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3148
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
3149
|
+
},
|
3170
3150
|
"VCombobox/center-affix": {
|
3171
3151
|
"type": "boolean\n",
|
3172
3152
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
3173
3153
|
},
|
3154
|
+
"VCombobox/prepend-icon": {
|
3155
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3156
|
+
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
|
3157
|
+
},
|
3174
3158
|
"VCombobox/hide-spin-buttons": {
|
3175
3159
|
"type": "boolean\n",
|
3176
3160
|
"description": "Hides spin buttons on the input when type is set to `number`."
|
@@ -3187,6 +3171,10 @@
|
|
3187
3171
|
"type": "string | string[]\n",
|
3188
3172
|
"description": "Displays a list of messages or a single message if using a string."
|
3189
3173
|
},
|
3174
|
+
"VCombobox/direction": {
|
3175
|
+
"type": "'horizontal' | 'vertical'\n",
|
3176
|
+
"description": "Changes the direction of the input."
|
3177
|
+
},
|
3190
3178
|
"VCombobox/error-messages": {
|
3191
3179
|
"type": "string | string[]\n",
|
3192
3180
|
"description": "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."
|
@@ -3195,6 +3183,10 @@
|
|
3195
3183
|
"type": "string | number\n",
|
3196
3184
|
"description": "Control the maximum number of shown errors from validation."
|
3197
3185
|
},
|
3186
|
+
"VCombobox/readonly": {
|
3187
|
+
"type": "boolean\n",
|
3188
|
+
"description": "Puts input in readonly state."
|
3189
|
+
},
|
3198
3190
|
"VCombobox/rules": {
|
3199
3191
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/validation.ts#L16-L20\" target=\"_blank\">ValidationRule</a>[]\n",
|
3200
3192
|
"description": "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`."
|
@@ -3219,6 +3211,10 @@
|
|
3219
3211
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3220
3212
|
"description": "The icon used when the **clearable** prop is set to true."
|
3221
3213
|
},
|
3214
|
+
"VCombobox/active": {
|
3215
|
+
"type": "boolean\n",
|
3216
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
3217
|
+
},
|
3222
3218
|
"VCombobox/persistent-clear": {
|
3223
3219
|
"type": "boolean\n",
|
3224
3220
|
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
|
@@ -3231,6 +3227,10 @@
|
|
3231
3227
|
"type": "boolean\n",
|
3232
3228
|
"description": "Label does not move on focus/dirty."
|
3233
3229
|
},
|
3230
|
+
"VCombobox/loading": {
|
3231
|
+
"type": "string | boolean\n",
|
3232
|
+
"description": "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."
|
3233
|
+
},
|
3234
3234
|
"VCombobox/counter-value": {
|
3235
3235
|
"type": "number | ((value: any) => number)\n",
|
3236
3236
|
"description": "Function returns the counter display text."
|
@@ -3239,22 +3239,22 @@
|
|
3239
3239
|
"type": "unknown\n",
|
3240
3240
|
"description": "**FOR INTERNAL USE ONLY**"
|
3241
3241
|
},
|
3242
|
-
"VComponentIcon/icon": {
|
3243
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3244
|
-
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
3245
|
-
},
|
3246
3242
|
"VComponentIcon/tag": {
|
3247
3243
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
3248
3244
|
"description": "Specify a custom tag used on the root element."
|
3249
3245
|
},
|
3250
|
-
"
|
3251
|
-
"type": "
|
3252
|
-
"description": "
|
3246
|
+
"VComponentIcon/icon": {
|
3247
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3248
|
+
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
3253
3249
|
},
|
3254
3250
|
"VConfirmEdit/color": {
|
3255
3251
|
"type": "string\n",
|
3256
3252
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
3257
3253
|
},
|
3254
|
+
"VConfirmEdit/model-value": {
|
3255
|
+
"type": "unknown\n",
|
3256
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3257
|
+
},
|
3258
3258
|
"VConfirmEdit/cancel-text": {
|
3259
3259
|
"type": "string\n",
|
3260
3260
|
"description": "Text for the cancel button"
|
@@ -3263,6 +3263,10 @@
|
|
3263
3263
|
"type": "string\n",
|
3264
3264
|
"description": "Text for the ok button"
|
3265
3265
|
},
|
3266
|
+
"VContainer/tag": {
|
3267
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
3268
|
+
"description": "Specify a custom tag used on the root element."
|
3269
|
+
},
|
3266
3270
|
"VContainer/height": {
|
3267
3271
|
"type": "string | number\n",
|
3268
3272
|
"description": "Sets the height for the component."
|
@@ -3287,102 +3291,78 @@
|
|
3287
3291
|
"type": "string | number\n",
|
3288
3292
|
"description": "Sets the width for the component."
|
3289
3293
|
},
|
3290
|
-
"VContainer/tag": {
|
3291
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
3292
|
-
"description": "Specify a custom tag used on the root element."
|
3293
|
-
},
|
3294
3294
|
"VContainer/fluid": {
|
3295
3295
|
"type": "boolean\n",
|
3296
3296
|
"description": "Removes viewport maximum-width size breakpoints."
|
3297
3297
|
},
|
3298
|
-
"VCounter/disabled": {
|
3299
|
-
"type": "boolean\n",
|
3300
|
-
"description": "Removes the ability to click or target the component."
|
3301
|
-
},
|
3302
3298
|
"VCounter/value": {
|
3303
3299
|
"type": "string | number\n",
|
3304
3300
|
"description": "Sets the current counter value."
|
3305
3301
|
},
|
3306
|
-
"VCounter/transition": {
|
3307
|
-
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
|
3308
|
-
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3309
|
-
},
|
3310
3302
|
"VCounter/active": {
|
3311
3303
|
"type": "boolean\n",
|
3312
3304
|
"description": "Determines whether the counter is visible or not."
|
3313
3305
|
},
|
3306
|
+
"VCounter/disabled": {
|
3307
|
+
"type": "boolean\n",
|
3308
|
+
"description": "Removes the ability to click or target the component."
|
3309
|
+
},
|
3314
3310
|
"VCounter/max": {
|
3315
3311
|
"type": "string | number\n",
|
3316
3312
|
"description": "Sets the maximum allowed value."
|
3317
3313
|
},
|
3314
|
+
"VCounter/transition": {
|
3315
|
+
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
|
3316
|
+
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3317
|
+
},
|
3318
3318
|
"VDataIterator/search": {
|
3319
3319
|
"type": "string\n",
|
3320
3320
|
"description": "Text input used to filter items."
|
3321
3321
|
},
|
3322
|
-
"VDataIterator/model-value": {
|
3323
|
-
"type": "any[]\n",
|
3324
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3325
|
-
},
|
3326
3322
|
"VDataIterator/tag": {
|
3327
3323
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
3328
3324
|
"description": "Specify a custom tag used on the root element."
|
3329
3325
|
},
|
3330
|
-
"VDataIterator/filter-mode": {
|
3331
|
-
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
3332
|
-
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
|
3333
|
-
},
|
3334
|
-
"VDataIterator/no-filter": {
|
3335
|
-
"type": "boolean\n",
|
3336
|
-
"description": "Disables all item filtering."
|
3337
|
-
},
|
3338
|
-
"VDataIterator/custom-filter": {
|
3339
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
3340
|
-
"description": "Function to filter items."
|
3341
|
-
},
|
3342
|
-
"VDataIterator/custom-key-filter": {
|
3343
|
-
"type": "unknown\n",
|
3344
|
-
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
|
3345
|
-
},
|
3346
|
-
"VDataIterator/filter-keys": {
|
3347
|
-
"type": "string | string[]\n",
|
3348
|
-
"description": "Array of specific keys to filter on the item."
|
3349
|
-
},
|
3350
|
-
"VDataIterator/select-strategy": {
|
3351
|
-
"type": "'single' | 'page' | 'all'\n",
|
3352
|
-
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
|
3353
|
-
},
|
3354
3326
|
"VDataIterator/items": {
|
3355
3327
|
"type": "unknown[]\n",
|
3356
3328
|
"description": "An array of strings or objects used for automatically generating children components."
|
3357
3329
|
},
|
3358
|
-
"VDataIterator/
|
3359
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
3360
|
-
"description": "Property on supplied `items` that contains its value."
|
3361
|
-
},
|
3362
|
-
"VDataIterator/return-object": {
|
3330
|
+
"VDataIterator/loading": {
|
3363
3331
|
"type": "boolean\n",
|
3364
|
-
"description": "
|
3332
|
+
"description": "If `true` and no items are provided, then a loading text will be shown."
|
3365
3333
|
},
|
3366
|
-
"VDataIterator/value
|
3367
|
-
"type": "
|
3368
|
-
"description": "
|
3334
|
+
"VDataIterator/model-value": {
|
3335
|
+
"type": "any[]\n",
|
3336
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3369
3337
|
},
|
3370
3338
|
"VDataIterator/transition": {
|
3371
3339
|
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component; hideOnLeave: boolean }\n",
|
3372
3340
|
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3373
3341
|
},
|
3374
|
-
"VDataIterator/
|
3375
|
-
"type": "boolean\n",
|
3376
|
-
"description": "
|
3342
|
+
"VDataIterator/value-comparator": {
|
3343
|
+
"type": "(a: any, b: any) => boolean\n",
|
3344
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3345
|
+
},
|
3346
|
+
"VDataIterator/item-value": {
|
3347
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
3348
|
+
"description": "Property on supplied `items` that contains its value."
|
3377
3349
|
},
|
3378
3350
|
"VDataIterator/item-selectable": {
|
3379
3351
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
3380
3352
|
"description": "Property on supplied `items` that contains the boolean value indicating if the item is selectable."
|
3381
3353
|
},
|
3354
|
+
"VDataIterator/return-object": {
|
3355
|
+
"type": "boolean\n",
|
3356
|
+
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
3357
|
+
},
|
3382
3358
|
"VDataIterator/show-select": {
|
3383
3359
|
"type": "boolean\n",
|
3384
3360
|
"description": "Shows the column with checkboxes for selecting items in the list."
|
3385
3361
|
},
|
3362
|
+
"VDataIterator/select-strategy": {
|
3363
|
+
"type": "'single' | 'page' | 'all'\n",
|
3364
|
+
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
|
3365
|
+
},
|
3386
3366
|
"VDataIterator/page": {
|
3387
3367
|
"type": "string | number\n",
|
3388
3368
|
"description": "The current displayed page number (1-indexed)."
|
@@ -3423,10 +3403,30 @@
|
|
3423
3403
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3424
3404
|
"description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier."
|
3425
3405
|
},
|
3426
|
-
"
|
3427
|
-
"type": "
|
3428
|
-
"description": "
|
3429
|
-
},
|
3406
|
+
"VDataIterator/filter-mode": {
|
3407
|
+
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
3408
|
+
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
|
3409
|
+
},
|
3410
|
+
"VDataIterator/no-filter": {
|
3411
|
+
"type": "boolean\n",
|
3412
|
+
"description": "Disables all item filtering."
|
3413
|
+
},
|
3414
|
+
"VDataIterator/custom-filter": {
|
3415
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
3416
|
+
"description": "Function to filter items."
|
3417
|
+
},
|
3418
|
+
"VDataIterator/custom-key-filter": {
|
3419
|
+
"type": "unknown\n",
|
3420
|
+
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
|
3421
|
+
},
|
3422
|
+
"VDataIterator/filter-keys": {
|
3423
|
+
"type": "string | string[]\n",
|
3424
|
+
"description": "Array of specific keys to filter on the item."
|
3425
|
+
},
|
3426
|
+
"VDataTable/search": {
|
3427
|
+
"type": "string\n",
|
3428
|
+
"description": "Text input used to filter items."
|
3429
|
+
},
|
3430
3430
|
"VDataTable/model-value": {
|
3431
3431
|
"type": "unknown\n",
|
3432
3432
|
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
@@ -3519,10 +3519,6 @@
|
|
3519
3519
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3520
3520
|
"description": "Previous icon."
|
3521
3521
|
},
|
3522
|
-
"VDataTable/hover": {
|
3523
|
-
"type": "boolean\n",
|
3524
|
-
"description": "Adds a hover effects to a table rows."
|
3525
|
-
},
|
3526
3522
|
"VDataTable/mobile": {
|
3527
3523
|
"type": "boolean\n",
|
3528
3524
|
"description": "Determines the display mode of the component. If true, the component will be displayed in mobile mode. If false, the component will be displayed in desktop mode. If null, will be based on the current mobile-breakpoint"
|
@@ -3531,37 +3527,45 @@
|
|
3531
3527
|
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3532
3528
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3533
3529
|
},
|
3534
|
-
"VDataTable/
|
3535
|
-
"type": "
|
3536
|
-
"description": "
|
3530
|
+
"VDataTable/header-props": {
|
3531
|
+
"type": "unknown\n",
|
3532
|
+
"description": "Pass props to the default header. See [`v-data-table-headers` API](/api/v-data-table-headers) for more information."
|
3537
3533
|
},
|
3538
|
-
"VDataTable/
|
3539
|
-
"type": "
|
3540
|
-
"description": "
|
3534
|
+
"VDataTable/cell-props": {
|
3535
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
3536
|
+
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
3537
|
+
},
|
3538
|
+
"VDataTable/headers": {
|
3539
|
+
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey<any>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'end' | 'start' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?: readonly any[] | undefined\n}[]\n",
|
3540
|
+
"description": "An array of objects that each describe a header column. See the example below for a definition of all properties."
|
3541
3541
|
},
|
3542
3542
|
"VDataTable/page": {
|
3543
3543
|
"type": "string | number\n",
|
3544
3544
|
"description": "The current displayed page number (1-indexed)."
|
3545
3545
|
},
|
3546
|
-
"VDataTable/
|
3547
|
-
"type": "
|
3548
|
-
"description": "Changes
|
3546
|
+
"VDataTable/items-per-page": {
|
3547
|
+
"type": "string | number\n",
|
3548
|
+
"description": "Changes how many items per page should be visible. Can be used with `.sync` modifier. Setting this prop to `-1` will display all items on the page."
|
3549
3549
|
},
|
3550
|
-
"VDataTable/
|
3551
|
-
"type": "
|
3552
|
-
"description": "
|
3550
|
+
"VDataTable/loading-text": {
|
3551
|
+
"type": "string\n",
|
3552
|
+
"description": "Text shown when the data is loading."
|
3553
3553
|
},
|
3554
|
-
"VDataTable/
|
3554
|
+
"VDataTable/row-props": {
|
3555
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
3556
|
+
"description": "An object of additional props to be passed to each `<tr>` in the table body. Also accepts a function that will be called for each row."
|
3557
|
+
},
|
3558
|
+
"VDataTable/hide-default-body": {
|
3555
3559
|
"type": "boolean\n",
|
3556
|
-
"description": "
|
3560
|
+
"description": "Hides the default body."
|
3557
3561
|
},
|
3558
|
-
"VDataTable/
|
3559
|
-
"type": "
|
3560
|
-
"description": "
|
3562
|
+
"VDataTable/hide-default-footer": {
|
3563
|
+
"type": "boolean\n",
|
3564
|
+
"description": "Hides the default footer. This has no effect on `v-data-table-virtual`."
|
3561
3565
|
},
|
3562
|
-
"VDataTable/
|
3563
|
-
"type": "
|
3564
|
-
"description": "
|
3566
|
+
"VDataTable/hide-default-header": {
|
3567
|
+
"type": "boolean\n",
|
3568
|
+
"description": "Hides the default header."
|
3565
3569
|
},
|
3566
3570
|
"VDataTable/expand-on-click": {
|
3567
3571
|
"type": "boolean\n",
|
@@ -3579,41 +3583,33 @@
|
|
3579
3583
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3580
3584
|
"description": "Changes which item property should be used for grouping items. Currently only supports a single grouping in the format: `group` or `['group']`. When using an array, only the first element is considered. Can be used with `.sync` modifier."
|
3581
3585
|
},
|
3582
|
-
"VDataTable/
|
3583
|
-
"type": "
|
3584
|
-
"description": "
|
3585
|
-
},
|
3586
|
-
"VDataTable/cell-props": {
|
3587
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
3588
|
-
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
3586
|
+
"VDataTable/item-selectable": {
|
3587
|
+
"type": "SelectItemKey<any>\n",
|
3588
|
+
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
3589
3589
|
},
|
3590
|
-
"VDataTable/
|
3590
|
+
"VDataTable/show-select": {
|
3591
3591
|
"type": "boolean\n",
|
3592
|
-
"description": "
|
3593
|
-
},
|
3594
|
-
"VDataTable/headers": {
|
3595
|
-
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey<any>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'end' | 'start' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?: readonly any[] | undefined\n}[]\n",
|
3596
|
-
"description": "An array of objects that each describe a header column. See the example below for a definition of all properties."
|
3597
|
-
},
|
3598
|
-
"VDataTable/loading-text": {
|
3599
|
-
"type": "string\n",
|
3600
|
-
"description": "Text shown when the data is loading."
|
3592
|
+
"description": "Shows the select checkboxes in both the header and rows (if using default rows)."
|
3601
3593
|
},
|
3602
|
-
"VDataTable/
|
3603
|
-
"type": "
|
3604
|
-
"description": "
|
3594
|
+
"VDataTable/sort-by": {
|
3595
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3596
|
+
"description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier."
|
3605
3597
|
},
|
3606
|
-
"VDataTable/
|
3598
|
+
"VDataTable/multi-sort": {
|
3607
3599
|
"type": "boolean\n",
|
3608
|
-
"description": "
|
3600
|
+
"description": "If `true` then one can sort on multiple properties."
|
3609
3601
|
},
|
3610
|
-
"VDataTable/
|
3602
|
+
"VDataTable/must-sort": {
|
3611
3603
|
"type": "boolean\n",
|
3612
|
-
"description": "
|
3604
|
+
"description": "If `true` then one can not disable sorting, it will always switch between ascending and descending."
|
3613
3605
|
},
|
3614
|
-
"VDataTable/
|
3606
|
+
"VDataTable/custom-key-sort": {
|
3607
|
+
"type": "unknown\n",
|
3608
|
+
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
|
3609
|
+
},
|
3610
|
+
"VDataTable/disable-sort": {
|
3615
3611
|
"type": "boolean\n",
|
3616
|
-
"description": "
|
3612
|
+
"description": "Disables sorting completely."
|
3617
3613
|
},
|
3618
3614
|
"VDataTable/sort-asc-icon": {
|
3619
3615
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
@@ -3631,6 +3627,10 @@
|
|
3631
3627
|
"type": "boolean\n",
|
3632
3628
|
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
3633
3629
|
},
|
3630
|
+
"VDataTable/hover": {
|
3631
|
+
"type": "boolean\n",
|
3632
|
+
"description": "Adds a hover effects to a table rows."
|
3633
|
+
},
|
3634
3634
|
"VDataTable/first-icon": {
|
3635
3635
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3636
3636
|
"description": "First icon."
|
@@ -3739,14 +3739,18 @@
|
|
3739
3739
|
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3740
3740
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3741
3741
|
},
|
3742
|
-
"VDataTableHeaders/disable-sort": {
|
3743
|
-
"type": "boolean\n",
|
3744
|
-
"description": "Toggles rendering of sort button."
|
3745
|
-
},
|
3746
3742
|
"VDataTableHeaders/multi-sort": {
|
3747
3743
|
"type": "boolean\n",
|
3748
3744
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDataTableHeaders.json))"
|
3749
3745
|
},
|
3746
|
+
"VDataTableHeaders/header-props": {
|
3747
|
+
"type": "unknown\n",
|
3748
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDataTableHeaders.json))"
|
3749
|
+
},
|
3750
|
+
"VDataTableHeaders/disable-sort": {
|
3751
|
+
"type": "boolean\n",
|
3752
|
+
"description": "Toggles rendering of sort button."
|
3753
|
+
},
|
3750
3754
|
"VDataTableHeaders/sort-asc-icon": {
|
3751
3755
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3752
3756
|
"description": "Icon used for ascending sort button."
|
@@ -3755,10 +3759,6 @@
|
|
3755
3759
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3756
3760
|
"description": "Icon used for descending sort button."
|
3757
3761
|
},
|
3758
|
-
"VDataTableHeaders/header-props": {
|
3759
|
-
"type": "unknown\n",
|
3760
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDataTableHeaders.json))"
|
3761
|
-
},
|
3762
3762
|
"VDataTableRow/mobile": {
|
3763
3763
|
"type": "boolean\n",
|
3764
3764
|
"description": "Determines the display mode of the component. If true, the component will be displayed in mobile mode. If false, the component will be displayed in desktop mode. If null, will be based on the current mobile-breakpoint"
|
@@ -3795,14 +3795,6 @@
|
|
3795
3795
|
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3796
3796
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3797
3797
|
},
|
3798
|
-
"VDataTableRows/hide-no-data": {
|
3799
|
-
"type": "boolean\n",
|
3800
|
-
"description": "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."
|
3801
|
-
},
|
3802
|
-
"VDataTableRows/no-data-text": {
|
3803
|
-
"type": "string\n",
|
3804
|
-
"description": "Text shown when no items are provided to the component."
|
3805
|
-
},
|
3806
3798
|
"VDataTableRows/cell-props": {
|
3807
3799
|
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
3808
3800
|
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
@@ -3811,6 +3803,14 @@
|
|
3811
3803
|
"type": "string\n",
|
3812
3804
|
"description": "Text shown when the data is loading."
|
3813
3805
|
},
|
3806
|
+
"VDataTableRows/hide-no-data": {
|
3807
|
+
"type": "boolean\n",
|
3808
|
+
"description": "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."
|
3809
|
+
},
|
3810
|
+
"VDataTableRows/no-data-text": {
|
3811
|
+
"type": "string\n",
|
3812
|
+
"description": "Text shown when no items are provided to the component."
|
3813
|
+
},
|
3814
3814
|
"VDataTableRows/row-props": {
|
3815
3815
|
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
3816
3816
|
"description": "An object of additional props to be passed to each `<tr>` in the table body. Also accepts a function that will be called for each row."
|
@@ -3819,17 +3819,9 @@
|
|
3819
3819
|
"type": "string\n",
|
3820
3820
|
"description": "Text input used to filter items."
|
3821
3821
|
},
|
3822
|
-
"VDataTableServer/
|
3823
|
-
"type": "
|
3824
|
-
"description": "
|
3825
|
-
},
|
3826
|
-
"VDataTableServer/theme": {
|
3827
|
-
"type": "string\n",
|
3828
|
-
"description": "Specify a theme for this component and all of its children."
|
3829
|
-
},
|
3830
|
-
"VDataTableServer/items": {
|
3831
|
-
"type": "any[]\n",
|
3832
|
-
"description": "An array of strings or objects used for automatically generating children components."
|
3822
|
+
"VDataTableServer/model-value": {
|
3823
|
+
"type": "unknown\n",
|
3824
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3833
3825
|
},
|
3834
3826
|
"VDataTableServer/density": {
|
3835
3827
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
@@ -3843,46 +3835,22 @@
|
|
3843
3835
|
"type": "string | number\n",
|
3844
3836
|
"description": "Sets the width for the component."
|
3845
3837
|
},
|
3846
|
-
"VDataTableServer/loading": {
|
3847
|
-
"type": "string | boolean\n",
|
3848
|
-
"description": "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."
|
3849
|
-
},
|
3850
3838
|
"VDataTableServer/sticky": {
|
3851
3839
|
"type": "boolean\n",
|
3852
3840
|
"description": "Sticks the header to the top of the table."
|
3853
3841
|
},
|
3842
|
+
"VDataTableServer/tag": {
|
3843
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
3844
|
+
"description": "Specify a custom tag used on the root element."
|
3845
|
+
},
|
3846
|
+
"VDataTableServer/theme": {
|
3847
|
+
"type": "string\n",
|
3848
|
+
"description": "Specify a theme for this component and all of its children."
|
3849
|
+
},
|
3854
3850
|
"VDataTableServer/color": {
|
3855
3851
|
"type": "string\n",
|
3856
3852
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
3857
3853
|
},
|
3858
|
-
"VDataTableServer/model-value": {
|
3859
|
-
"type": "unknown\n",
|
3860
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3861
|
-
},
|
3862
|
-
"VDataTableServer/mobile": {
|
3863
|
-
"type": "boolean\n",
|
3864
|
-
"description": "Determines the display mode of the component. If true, the component will be displayed in mobile mode. If false, the component will be displayed in desktop mode. If null, will be based on the current mobile-breakpoint"
|
3865
|
-
},
|
3866
|
-
"VDataTableServer/mobile-breakpoint": {
|
3867
|
-
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3868
|
-
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3869
|
-
},
|
3870
|
-
"VDataTableServer/next-icon": {
|
3871
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3872
|
-
"description": "Next icon."
|
3873
|
-
},
|
3874
|
-
"VDataTableServer/prev-icon": {
|
3875
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3876
|
-
"description": "Previous icon."
|
3877
|
-
},
|
3878
|
-
"VDataTableServer/hover": {
|
3879
|
-
"type": "boolean\n",
|
3880
|
-
"description": "Will add a hover effect to a table's row when the mouse is over it."
|
3881
|
-
},
|
3882
|
-
"VDataTableServer/value-comparator": {
|
3883
|
-
"type": "(a: any, b: any) => boolean\n",
|
3884
|
-
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3885
|
-
},
|
3886
3854
|
"VDataTableServer/hide-no-data": {
|
3887
3855
|
"type": "boolean\n",
|
3888
3856
|
"description": "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."
|
@@ -3891,6 +3859,10 @@
|
|
3891
3859
|
"type": "'single' | 'page' | 'all'\n",
|
3892
3860
|
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
|
3893
3861
|
},
|
3862
|
+
"VDataTableServer/items": {
|
3863
|
+
"type": "any[]\n",
|
3864
|
+
"description": "An array of strings or objects used for automatically generating children components."
|
3865
|
+
},
|
3894
3866
|
"VDataTableServer/item-value": {
|
3895
3867
|
"type": "SelectItemKey<any>\n",
|
3896
3868
|
"description": "Property on supplied `items` that contains its value."
|
@@ -3899,93 +3871,53 @@
|
|
3899
3871
|
"type": "boolean\n",
|
3900
3872
|
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
3901
3873
|
},
|
3874
|
+
"VDataTableServer/value-comparator": {
|
3875
|
+
"type": "(a: any, b: any) => boolean\n",
|
3876
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3877
|
+
},
|
3902
3878
|
"VDataTableServer/no-data-text": {
|
3903
3879
|
"type": "string\n",
|
3904
3880
|
"description": "Text shown when no items are provided to the component."
|
3905
3881
|
},
|
3906
|
-
"VDataTableServer/
|
3882
|
+
"VDataTableServer/loading": {
|
3883
|
+
"type": "string | boolean\n",
|
3884
|
+
"description": "Displays `loading` slot if set to `true`"
|
3885
|
+
},
|
3886
|
+
"VDataTableServer/next-icon": {
|
3907
3887
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3908
|
-
"description": "
|
3888
|
+
"description": "Next icon."
|
3909
3889
|
},
|
3910
|
-
"VDataTableServer/
|
3890
|
+
"VDataTableServer/prev-icon": {
|
3911
3891
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3912
|
-
"description": "
|
3892
|
+
"description": "Previous icon."
|
3913
3893
|
},
|
3914
|
-
"VDataTableServer/
|
3915
|
-
"type": "
|
3916
|
-
"description": "
|
3894
|
+
"VDataTableServer/mobile": {
|
3895
|
+
"type": "boolean\n",
|
3896
|
+
"description": "Determines the display mode of the component. If true, the component will be displayed in mobile mode. If false, the component will be displayed in desktop mode. If null, will be based on the current mobile-breakpoint"
|
3917
3897
|
},
|
3918
|
-
"VDataTableServer/
|
3919
|
-
"type": "
|
3920
|
-
"description": "
|
3898
|
+
"VDataTableServer/mobile-breakpoint": {
|
3899
|
+
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3900
|
+
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3921
3901
|
},
|
3922
|
-
"VDataTableServer/
|
3923
|
-
"type": "
|
3924
|
-
"description": "
|
3902
|
+
"VDataTableServer/header-props": {
|
3903
|
+
"type": "unknown\n",
|
3904
|
+
"description": "Pass props to the default header. See [`v-data-table-server` API](/api/v-data-table-server) for more information."
|
3925
3905
|
},
|
3926
|
-
"VDataTableServer/
|
3927
|
-
"type": "string\n",
|
3928
|
-
"description": "
|
3929
|
-
},
|
3930
|
-
"VDataTableServer/next-page-label": {
|
3931
|
-
"type": "string\n",
|
3932
|
-
"description": "Label for next page."
|
3933
|
-
},
|
3934
|
-
"VDataTableServer/last-page-label": {
|
3935
|
-
"type": "string\n",
|
3936
|
-
"description": "Label for last page."
|
3937
|
-
},
|
3938
|
-
"VDataTableServer/items-per-page-options": {
|
3939
|
-
"type": "(number | { title: string; value: number })[]\n",
|
3940
|
-
"description": "Array of options to show in the items-per-page dropdown."
|
3941
|
-
},
|
3942
|
-
"VDataTableServer/show-current-page": {
|
3943
|
-
"type": "boolean\n",
|
3944
|
-
"description": "Show current page number between prev/next icons."
|
3906
|
+
"VDataTableServer/cell-props": {
|
3907
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
3908
|
+
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
3945
3909
|
},
|
3946
3910
|
"VDataTableServer/headers": {
|
3947
|
-
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-
|
3911
|
+
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey<Record<string, any>>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'end' | 'start' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?:\n | readonly {\n readonly key?:\n | (string & {})\n | 'data-table-group'\n | 'data-table-select'\n | 'data-table-expand'\n | undefined\n readonly value?: SelectItemKey<Record<string, any>>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'end' | 'start' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'item' | 'value' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?: readonly any[] | undefined\n }[]\n | undefined\n}[]\n",
|
3948
3912
|
"description": "An array of objects that each describe a header column."
|
3949
3913
|
},
|
3950
|
-
"VDataTableServer/disable-sort": {
|
3951
|
-
"type": "boolean\n",
|
3952
|
-
"description": "Toggles rendering of sort button."
|
3953
|
-
},
|
3954
|
-
"VDataTableServer/multi-sort": {
|
3955
|
-
"type": "boolean\n",
|
3956
|
-
"description": "Allows sorting by multiple columns."
|
3957
|
-
},
|
3958
|
-
"VDataTableServer/sort-asc-icon": {
|
3959
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3960
|
-
"description": "Icon used for ascending sort button."
|
3961
|
-
},
|
3962
|
-
"VDataTableServer/sort-desc-icon": {
|
3963
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3964
|
-
"description": "Icon used for descending sort button."
|
3965
|
-
},
|
3966
|
-
"VDataTableServer/header-props": {
|
3967
|
-
"type": "unknown\n",
|
3968
|
-
"description": "Pass props to the default header. See [`v-data-table-server` API](/api/v-data-table-server) for more information."
|
3969
|
-
},
|
3970
|
-
"VDataTableServer/cell-props": {
|
3971
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
3972
|
-
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
3973
|
-
},
|
3974
|
-
"VDataTableServer/sort-by": {
|
3975
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3976
|
-
"description": "Array of column keys and sort orders that determines the sort order of the table."
|
3977
|
-
},
|
3978
3914
|
"VDataTableServer/page": {
|
3979
3915
|
"type": "string | number\n",
|
3980
3916
|
"description": "The current displayed page number (1-indexed)."
|
3981
3917
|
},
|
3982
|
-
"VDataTableServer/
|
3983
|
-
"type": "string
|
3984
|
-
"description": "
|
3985
|
-
},
|
3986
|
-
"VDataTableServer/expand-on-click": {
|
3987
|
-
"type": "boolean\n",
|
3988
|
-
"description": "Expands item when the row is clicked."
|
3918
|
+
"VDataTableServer/items-per-page": {
|
3919
|
+
"type": "string | number\n",
|
3920
|
+
"description": "The number of items to display on each page."
|
3989
3921
|
},
|
3990
3922
|
"VDataTableServer/loading-text": {
|
3991
3923
|
"type": "string\n",
|
@@ -3995,18 +3927,6 @@
|
|
3995
3927
|
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
3996
3928
|
"description": "An object of additional props to be passed to each `<tr>` in the table body. Also accepts a function that will be called for each row."
|
3997
3929
|
},
|
3998
|
-
"VDataTableServer/group-by": {
|
3999
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
4000
|
-
"description": "Defines the grouping of the table items."
|
4001
|
-
},
|
4002
|
-
"VDataTableServer/items-length": {
|
4003
|
-
"type": "string | number\n",
|
4004
|
-
"description": "Number of all items."
|
4005
|
-
},
|
4006
|
-
"VDataTableServer/items-per-page": {
|
4007
|
-
"type": "string | number\n",
|
4008
|
-
"description": "The number of items to display on each page."
|
4009
|
-
},
|
4010
3930
|
"VDataTableServer/hide-default-body": {
|
4011
3931
|
"type": "boolean\n",
|
4012
3932
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
@@ -4019,10 +3939,22 @@
|
|
4019
3939
|
"type": "boolean\n",
|
4020
3940
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4021
3941
|
},
|
3942
|
+
"VDataTableServer/expand-on-click": {
|
3943
|
+
"type": "boolean\n",
|
3944
|
+
"description": "Expands item when the row is clicked."
|
3945
|
+
},
|
4022
3946
|
"VDataTableServer/show-expand": {
|
4023
3947
|
"type": "boolean\n",
|
4024
3948
|
"description": "Shows the expand icon."
|
4025
3949
|
},
|
3950
|
+
"VDataTableServer/expanded": {
|
3951
|
+
"type": "string[]\n",
|
3952
|
+
"description": "Whether the item is expanded or not."
|
3953
|
+
},
|
3954
|
+
"VDataTableServer/group-by": {
|
3955
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3956
|
+
"description": "Defines the grouping of the table items."
|
3957
|
+
},
|
4026
3958
|
"VDataTableServer/item-selectable": {
|
4027
3959
|
"type": "SelectItemKey<any>\n",
|
4028
3960
|
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
@@ -4031,6 +3963,14 @@
|
|
4031
3963
|
"type": "boolean\n",
|
4032
3964
|
"description": "Shows the column with checkboxes for selecting items in the list."
|
4033
3965
|
},
|
3966
|
+
"VDataTableServer/sort-by": {
|
3967
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
3968
|
+
"description": "Array of column keys and sort orders that determines the sort order of the table."
|
3969
|
+
},
|
3970
|
+
"VDataTableServer/multi-sort": {
|
3971
|
+
"type": "boolean\n",
|
3972
|
+
"description": "Allows sorting by multiple columns."
|
3973
|
+
},
|
4034
3974
|
"VDataTableServer/must-sort": {
|
4035
3975
|
"type": "boolean\n",
|
4036
3976
|
"description": "Forces sorting on the column(s)."
|
@@ -4039,6 +3979,18 @@
|
|
4039
3979
|
"type": "unknown\n",
|
4040
3980
|
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
|
4041
3981
|
},
|
3982
|
+
"VDataTableServer/disable-sort": {
|
3983
|
+
"type": "boolean\n",
|
3984
|
+
"description": "Toggles rendering of sort button."
|
3985
|
+
},
|
3986
|
+
"VDataTableServer/sort-asc-icon": {
|
3987
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3988
|
+
"description": "Icon used for ascending sort button."
|
3989
|
+
},
|
3990
|
+
"VDataTableServer/sort-desc-icon": {
|
3991
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3992
|
+
"description": "Icon used for descending sort button."
|
3993
|
+
},
|
4042
3994
|
"VDataTableServer/fixed-header": {
|
4043
3995
|
"type": "boolean\n",
|
4044
3996
|
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
|
@@ -4047,97 +3999,97 @@
|
|
4047
3999
|
"type": "boolean\n",
|
4048
4000
|
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
4049
4001
|
},
|
4050
|
-
"
|
4051
|
-
"type": "
|
4052
|
-
"description": "
|
4002
|
+
"VDataTableServer/hover": {
|
4003
|
+
"type": "boolean\n",
|
4004
|
+
"description": "Will add a hover effect to a table's row when the mouse is over it."
|
4053
4005
|
},
|
4054
|
-
"
|
4055
|
-
"type": "
|
4056
|
-
"description": "
|
4006
|
+
"VDataTableServer/first-icon": {
|
4007
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4008
|
+
"description": "First icon."
|
4057
4009
|
},
|
4058
|
-
"
|
4059
|
-
"type": "
|
4060
|
-
"description": "
|
4010
|
+
"VDataTableServer/last-icon": {
|
4011
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4012
|
+
"description": "Last icon."
|
4061
4013
|
},
|
4062
|
-
"
|
4063
|
-
"type": "string
|
4064
|
-
"description": "
|
4014
|
+
"VDataTableServer/items-per-page-text": {
|
4015
|
+
"type": "string\n",
|
4016
|
+
"description": "Text for items-per-page dropdown."
|
4065
4017
|
},
|
4066
|
-
"
|
4067
|
-
"type": "string
|
4068
|
-
"description": "
|
4018
|
+
"VDataTableServer/page-text": {
|
4019
|
+
"type": "string\n",
|
4020
|
+
"description": "Label for page number."
|
4069
4021
|
},
|
4070
|
-
"
|
4071
|
-
"type": "
|
4072
|
-
"description": "
|
4022
|
+
"VDataTableServer/first-page-label": {
|
4023
|
+
"type": "string\n",
|
4024
|
+
"description": "Label for first page."
|
4073
4025
|
},
|
4074
|
-
"
|
4075
|
-
"type": "string
|
4076
|
-
"description": "
|
4026
|
+
"VDataTableServer/prev-page-label": {
|
4027
|
+
"type": "string\n",
|
4028
|
+
"description": "Label for previous page."
|
4077
4029
|
},
|
4078
|
-
"
|
4030
|
+
"VDataTableServer/next-page-label": {
|
4079
4031
|
"type": "string\n",
|
4080
|
-
"description": "
|
4032
|
+
"description": "Label for next page."
|
4081
4033
|
},
|
4082
|
-
"
|
4034
|
+
"VDataTableServer/last-page-label": {
|
4083
4035
|
"type": "string\n",
|
4084
|
-
"description": "
|
4036
|
+
"description": "Label for last page."
|
4085
4037
|
},
|
4086
|
-
"
|
4087
|
-
"type": "
|
4088
|
-
"description": "
|
4038
|
+
"VDataTableServer/items-per-page-options": {
|
4039
|
+
"type": "(number | { title: string; value: number })[]\n",
|
4040
|
+
"description": "Array of options to show in the items-per-page dropdown."
|
4089
4041
|
},
|
4090
|
-
"
|
4042
|
+
"VDataTableServer/show-current-page": {
|
4091
4043
|
"type": "boolean\n",
|
4092
|
-
"description": "
|
4093
|
-
},
|
4094
|
-
"VDataTableVirtual/custom-filter": {
|
4095
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
4096
|
-
"description": "Function used to filter items, called for each filterable key on each item in the list. The first argument is the filterable value from the item, the second is the search term, and the third is the internal item object. The function should return true if the item should be included in the filtered list, or the index of the match in the value if it should be included with the result highlighted."
|
4044
|
+
"description": "Show current page number between prev/next icons."
|
4097
4045
|
},
|
4098
|
-
"
|
4099
|
-
"type": "
|
4100
|
-
"description": "
|
4046
|
+
"VDataTableServer/items-length": {
|
4047
|
+
"type": "string | number\n",
|
4048
|
+
"description": "Number of all items."
|
4101
4049
|
},
|
4102
|
-
"VDataTableVirtual/
|
4103
|
-
"type": "string
|
4104
|
-
"description": "
|
4050
|
+
"VDataTableVirtual/search": {
|
4051
|
+
"type": "string\n",
|
4052
|
+
"description": "Text input used to filter items."
|
4105
4053
|
},
|
4106
|
-
"VDataTableVirtual/
|
4107
|
-
"type": "
|
4108
|
-
"description": "
|
4054
|
+
"VDataTableVirtual/tag": {
|
4055
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
4056
|
+
"description": "Specify a custom tag used on the root element."
|
4109
4057
|
},
|
4110
|
-
"VDataTableVirtual/
|
4111
|
-
"type": "
|
4112
|
-
"description": "
|
4058
|
+
"VDataTableVirtual/theme": {
|
4059
|
+
"type": "string\n",
|
4060
|
+
"description": "Specify a theme for this component and all of its children."
|
4113
4061
|
},
|
4114
4062
|
"VDataTableVirtual/items": {
|
4115
4063
|
"type": "any[]\n",
|
4116
4064
|
"description": "An array of strings or objects used for automatically generating children components."
|
4117
4065
|
},
|
4118
|
-
"VDataTableVirtual/
|
4119
|
-
"type": "
|
4120
|
-
"description": "
|
4121
|
-
},
|
4122
|
-
"VDataTableVirtual/return-object": {
|
4123
|
-
"type": "boolean\n",
|
4124
|
-
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
4066
|
+
"VDataTableVirtual/density": {
|
4067
|
+
"type": "'default' | 'comfortable' | 'compact'\n",
|
4068
|
+
"description": "Adjusts the vertical height used by the component."
|
4125
4069
|
},
|
4126
|
-
"VDataTableVirtual/
|
4127
|
-
"type": "
|
4128
|
-
"description": "
|
4070
|
+
"VDataTableVirtual/height": {
|
4071
|
+
"type": "string | number\n",
|
4072
|
+
"description": "Use the height prop to set the height of the table."
|
4129
4073
|
},
|
4130
|
-
"VDataTableVirtual/
|
4131
|
-
"type": "string\n",
|
4132
|
-
"description": "
|
4074
|
+
"VDataTableVirtual/width": {
|
4075
|
+
"type": "string | number\n",
|
4076
|
+
"description": "Sets the width for the component."
|
4133
4077
|
},
|
4134
4078
|
"VDataTableVirtual/loading": {
|
4135
4079
|
"type": "string | boolean\n",
|
4136
|
-
"description": "Displays
|
4080
|
+
"description": "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."
|
4137
4081
|
},
|
4138
|
-
"VDataTableVirtual/
|
4082
|
+
"VDataTableVirtual/sticky": {
|
4139
4083
|
"type": "boolean\n",
|
4140
|
-
"description": "
|
4084
|
+
"description": "Sticks the header to the top of the table."
|
4085
|
+
},
|
4086
|
+
"VDataTableVirtual/color": {
|
4087
|
+
"type": "string\n",
|
4088
|
+
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4089
|
+
},
|
4090
|
+
"VDataTableVirtual/model-value": {
|
4091
|
+
"type": "unknown\n",
|
4092
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4141
4093
|
},
|
4142
4094
|
"VDataTableVirtual/mobile": {
|
4143
4095
|
"type": "boolean\n",
|
@@ -4147,14 +4099,34 @@
|
|
4147
4099
|
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
4148
4100
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
4149
4101
|
},
|
4102
|
+
"VDataTableVirtual/hover": {
|
4103
|
+
"type": "boolean\n",
|
4104
|
+
"description": "Will add a hover effect to a table's row when the mouse is over it."
|
4105
|
+
},
|
4106
|
+
"VDataTableVirtual/value-comparator": {
|
4107
|
+
"type": "(a: any, b: any) => boolean\n",
|
4108
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
4109
|
+
},
|
4110
|
+
"VDataTableVirtual/item-value": {
|
4111
|
+
"type": "SelectItemKey<any>\n",
|
4112
|
+
"description": "Property on supplied `items` that contains its value."
|
4113
|
+
},
|
4150
4114
|
"VDataTableVirtual/item-selectable": {
|
4151
4115
|
"type": "SelectItemKey<any>\n",
|
4152
4116
|
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
4153
4117
|
},
|
4118
|
+
"VDataTableVirtual/return-object": {
|
4119
|
+
"type": "boolean\n",
|
4120
|
+
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
4121
|
+
},
|
4154
4122
|
"VDataTableVirtual/show-select": {
|
4155
4123
|
"type": "boolean\n",
|
4156
4124
|
"description": "Shows the column with checkboxes for selecting items in the list."
|
4157
4125
|
},
|
4126
|
+
"VDataTableVirtual/select-strategy": {
|
4127
|
+
"type": "'single' | 'page' | 'all'\n",
|
4128
|
+
"description": "Defines the strategy of selecting items in the list. Possible values are: 'single' (only one item can be selected at a time), 'page' ('Select all' button will select only items on the current page), 'all' ('Select all' button will select all items in the list)."
|
4129
|
+
},
|
4158
4130
|
"VDataTableVirtual/sort-by": {
|
4159
4131
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
4160
4132
|
"description": "Array of column keys and sort orders that determines the sort order of the table."
|
@@ -4187,12 +4159,32 @@
|
|
4187
4159
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/sort.ts#L30-L30\" target=\"_blank\">SortItem</a>[]\n",
|
4188
4160
|
"description": "Defines the grouping of the table items."
|
4189
4161
|
},
|
4162
|
+
"VDataTableVirtual/filter-mode": {
|
4163
|
+
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
4164
|
+
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
|
4165
|
+
},
|
4166
|
+
"VDataTableVirtual/no-filter": {
|
4167
|
+
"type": "boolean\n",
|
4168
|
+
"description": "Disables all item filtering."
|
4169
|
+
},
|
4170
|
+
"VDataTableVirtual/custom-filter": {
|
4171
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
4172
|
+
"description": "Function used to filter items, called for each filterable key on each item in the list. The first argument is the filterable value from the item, the second is the search term, and the third is the internal item object. The function should return true if the item should be included in the filtered list, or the index of the match in the value if it should be included with the result highlighted."
|
4173
|
+
},
|
4174
|
+
"VDataTableVirtual/custom-key-filter": {
|
4175
|
+
"type": "unknown\n",
|
4176
|
+
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
|
4177
|
+
},
|
4178
|
+
"VDataTableVirtual/filter-keys": {
|
4179
|
+
"type": "string | string[]\n",
|
4180
|
+
"description": "Array of specific keys to filter on the item."
|
4181
|
+
},
|
4190
4182
|
"VDataTableVirtual/header-props": {
|
4191
4183
|
"type": "unknown\n",
|
4192
4184
|
"description": "Pass props to the default header."
|
4193
4185
|
},
|
4194
4186
|
"VDataTableVirtual/cell-props": {
|
4195
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n '
|
4187
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
4196
4188
|
"description": "An object of additional props to be passed to each `<td>` in the table body. Also accepts a function that will be called for each cell. If the same prop is defined both here and in `cellProps` in a headers object, the value from the headers object will be used."
|
4197
4189
|
},
|
4198
4190
|
"VDataTableVirtual/disable-sort": {
|
@@ -4200,13 +4192,29 @@
|
|
4200
4192
|
"description": "Toggles rendering of sort button."
|
4201
4193
|
},
|
4202
4194
|
"VDataTableVirtual/headers": {
|
4203
|
-
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-
|
4195
|
+
"type": "{\n readonly key?:\n | (string & {})\n | 'data-table-expand'\n | 'data-table-select'\n | 'data-table-group'\n | undefined\n readonly value?: SelectItemKey<Record<string, any>>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'start' | 'end' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | { readonly [x: string]: any }\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?:\n | readonly {\n readonly key?:\n | (string & {})\n | 'data-table-expand'\n | 'data-table-select'\n | 'data-table-group'\n | undefined\n readonly value?: SelectItemKey<Record<string, any>>\n readonly title?: string | undefined\n readonly fixed?: boolean | undefined\n readonly align?: 'start' | 'end' | 'center' | undefined\n readonly width?: string | number | undefined\n readonly minWidth?: string | undefined\n readonly maxWidth?: string | undefined\n readonly nowrap?: boolean | undefined\n readonly headerProps?: { readonly [x: string]: any } | undefined\n readonly cellProps?:\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n | { readonly [x: string]: any }\n | undefined\n readonly sortable?: boolean | undefined\n readonly sort?: DataTableCompareFunction<any> | undefined\n readonly sortRaw?: DataTableCompareFunction<any> | undefined\n readonly filter?: FilterFunction | undefined\n readonly mobile?: boolean | undefined\n readonly children?: readonly any[] | undefined\n }[]\n | undefined\n}[]\n",
|
4204
4196
|
"description": "An array of objects that each describe a header column."
|
4205
4197
|
},
|
4198
|
+
"VDataTableVirtual/sort-asc-icon": {
|
4199
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4200
|
+
"description": "Icon used for ascending sort button."
|
4201
|
+
},
|
4202
|
+
"VDataTableVirtual/sort-desc-icon": {
|
4203
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4204
|
+
"description": "Icon used for descending sort button."
|
4205
|
+
},
|
4206
4206
|
"VDataTableVirtual/loading-text": {
|
4207
4207
|
"type": "string\n",
|
4208
4208
|
"description": "Text shown when the data is loading."
|
4209
4209
|
},
|
4210
|
+
"VDataTableVirtual/hide-no-data": {
|
4211
|
+
"type": "boolean\n",
|
4212
|
+
"description": "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."
|
4213
|
+
},
|
4214
|
+
"VDataTableVirtual/no-data-text": {
|
4215
|
+
"type": "string\n",
|
4216
|
+
"description": "Text shown when no items are provided to the component."
|
4217
|
+
},
|
4210
4218
|
"VDataTableVirtual/row-props": {
|
4211
4219
|
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
4212
4220
|
"description": "An object of additional props to be passed to each `<tr>` in the table body. Also accepts a function that will be called for each row."
|
@@ -4223,14 +4231,6 @@
|
|
4223
4231
|
"type": "boolean\n",
|
4224
4232
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4225
4233
|
},
|
4226
|
-
"VDataTableVirtual/sort-asc-icon": {
|
4227
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4228
|
-
"description": "Icon used for ascending sort button."
|
4229
|
-
},
|
4230
|
-
"VDataTableVirtual/sort-desc-icon": {
|
4231
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4232
|
-
"description": "Icon used for descending sort button."
|
4233
|
-
},
|
4234
4234
|
"VDataTableVirtual/fixed-header": {
|
4235
4235
|
"type": "boolean\n",
|
4236
4236
|
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
|
@@ -4247,37 +4247,77 @@
|
|
4247
4247
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
4248
4248
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/virtual.json))"
|
4249
4249
|
},
|
4250
|
-
"VDateInput/title": {
|
4251
|
-
"type": "string\n",
|
4252
|
-
"description": "Specify a title text for the component."
|
4253
|
-
},
|
4254
|
-
"VDateInput/text": {
|
4255
|
-
"type": "string\n",
|
4256
|
-
"description": "Specify content text for the component."
|
4257
|
-
},
|
4258
4250
|
"VDateInput/flat": {
|
4259
4251
|
"type": "boolean\n",
|
4260
4252
|
"description": "Removes box shadow when using a variant with elevation."
|
4261
4253
|
},
|
4262
|
-
"VDateInput/
|
4263
|
-
"type": "string |
|
4264
|
-
"description": "
|
4254
|
+
"VDateInput/tag": {
|
4255
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
4256
|
+
"description": "Specify a custom tag used on the root element."
|
4265
4257
|
},
|
4266
4258
|
"VDateInput/type": {
|
4267
4259
|
"type": "string\n",
|
4268
4260
|
"description": "Sets input type."
|
4269
4261
|
},
|
4270
|
-
"VDateInput/
|
4271
|
-
"type": "
|
4272
|
-
"description": "
|
4262
|
+
"VDateInput/reverse": {
|
4263
|
+
"type": "boolean\n",
|
4264
|
+
"description": "Reverses the orientation."
|
4265
|
+
},
|
4266
|
+
"VDateInput/name": {
|
4267
|
+
"type": "string\n",
|
4268
|
+
"description": "Sets the component's name attribute."
|
4273
4269
|
},
|
4274
4270
|
"VDateInput/error": {
|
4275
4271
|
"type": "boolean\n",
|
4276
4272
|
"description": "Puts the input in a manual error state."
|
4277
4273
|
},
|
4278
|
-
"VDateInput/
|
4274
|
+
"VDateInput/header": {
|
4275
|
+
"type": "string\n",
|
4276
|
+
"description": "Text shown when no **display-date** is set."
|
4277
|
+
},
|
4278
|
+
"VDateInput/label": {
|
4279
|
+
"type": "string\n",
|
4280
|
+
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
4281
|
+
},
|
4282
|
+
"VDateInput/title": {
|
4283
|
+
"type": "string\n",
|
4284
|
+
"description": "Specify a title text for the component."
|
4285
|
+
},
|
4286
|
+
"VDateInput/theme": {
|
4287
|
+
"type": "string\n",
|
4288
|
+
"description": "Specify a theme for this component and all of its children."
|
4289
|
+
},
|
4290
|
+
"VDateInput/id": {
|
4291
|
+
"type": "string\n",
|
4292
|
+
"description": "Sets the DOM id on the component."
|
4293
|
+
},
|
4294
|
+
"VDateInput/active": {
|
4279
4295
|
"type": "boolean\n",
|
4280
|
-
"description": "
|
4296
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
4297
|
+
},
|
4298
|
+
"VDateInput/base-color": {
|
4299
|
+
"type": "string\n",
|
4300
|
+
"description": "Sets the color of the input when it is not focused."
|
4301
|
+
},
|
4302
|
+
"VDateInput/prepend-icon": {
|
4303
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4304
|
+
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
|
4305
|
+
},
|
4306
|
+
"VDateInput/append-icon": {
|
4307
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4308
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
4309
|
+
},
|
4310
|
+
"VDateInput/readonly": {
|
4311
|
+
"type": "boolean\n",
|
4312
|
+
"description": "Puts input in readonly state."
|
4313
|
+
},
|
4314
|
+
"VDateInput/text": {
|
4315
|
+
"type": "string\n",
|
4316
|
+
"description": "Specify content text for the component."
|
4317
|
+
},
|
4318
|
+
"VDateInput/border": {
|
4319
|
+
"type": "string | number | boolean\n",
|
4320
|
+
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
4281
4321
|
},
|
4282
4322
|
"VDateInput/density": {
|
4283
4323
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
@@ -4285,7 +4325,7 @@
|
|
4285
4325
|
},
|
4286
4326
|
"VDateInput/height": {
|
4287
4327
|
"type": "string | number\n",
|
4288
|
-
"description": "Sets the height
|
4328
|
+
"description": "Sets the height of the input."
|
4289
4329
|
},
|
4290
4330
|
"VDateInput/max-height": {
|
4291
4331
|
"type": "string | number\n",
|
@@ -4311,12 +4351,20 @@
|
|
4311
4351
|
"type": "string | number\n",
|
4312
4352
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
4313
4353
|
},
|
4354
|
+
"VDateInput/disabled": {
|
4355
|
+
"type": "boolean\n",
|
4356
|
+
"description": "Removes the ability to click or target the input."
|
4357
|
+
},
|
4358
|
+
"VDateInput/loading": {
|
4359
|
+
"type": "string | boolean\n",
|
4360
|
+
"description": "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."
|
4361
|
+
},
|
4314
4362
|
"VDateInput/location": {
|
4315
4363
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
4316
4364
|
"description": "Specifies the component's location. Can combine by using a space separated string."
|
4317
4365
|
},
|
4318
4366
|
"VDateInput/position": {
|
4319
|
-
"type": "'fixed' | '
|
4367
|
+
"type": "'fixed' | 'relative' | 'static' | 'absolute' | 'sticky'\n",
|
4320
4368
|
"description": "Sets the position for the component."
|
4321
4369
|
},
|
4322
4370
|
"VDateInput/rounded": {
|
@@ -4327,57 +4375,113 @@
|
|
4327
4375
|
"type": "boolean\n",
|
4328
4376
|
"description": "Removes any applied **border-radius** from the component."
|
4329
4377
|
},
|
4330
|
-
"VDateInput/
|
4331
|
-
"type": "string
|
4332
|
-
"description": "
|
4378
|
+
"VDateInput/color": {
|
4379
|
+
"type": "string\n",
|
4380
|
+
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4333
4381
|
},
|
4334
|
-
"VDateInput/
|
4382
|
+
"VDateInput/variant": {
|
4383
|
+
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
|
4384
|
+
"description": "Applies a distinct style to the component."
|
4385
|
+
},
|
4386
|
+
"VDateInput/max": {
|
4387
|
+
"type": "unknown\n",
|
4388
|
+
"description": "Maximum allowed date/month (ISO 8601 format)."
|
4389
|
+
},
|
4390
|
+
"VDateInput/model-value": {
|
4391
|
+
"type": "any\n",
|
4392
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4393
|
+
},
|
4394
|
+
"VDateInput/transition": {
|
4335
4395
|
"type": "string\n",
|
4336
|
-
"description": "
|
4396
|
+
"description": "The transition used when changing months into the future"
|
4397
|
+
},
|
4398
|
+
"VDateInput/bg-color": {
|
4399
|
+
"type": "string\n",
|
4400
|
+
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4401
|
+
},
|
4402
|
+
"VDateInput/multiple": {
|
4403
|
+
"type": "number | boolean | (string & {}) | 'range'\n",
|
4404
|
+
"description": "Allow the selection of multiple dates. The **range** value selects all dates between two selections."
|
4405
|
+
},
|
4406
|
+
"VDateInput/prefix": {
|
4407
|
+
"type": "string\n",
|
4408
|
+
"description": "Displays prefix text."
|
4409
|
+
},
|
4410
|
+
"VDateInput/role": {
|
4411
|
+
"type": "string\n",
|
4412
|
+
"description": "The role attribute applied to the input."
|
4413
|
+
},
|
4414
|
+
"VDateInput/hide-header": {
|
4415
|
+
"type": "boolean\n",
|
4416
|
+
"description": "Hides the header."
|
4417
|
+
},
|
4418
|
+
"VDateInput/month": {
|
4419
|
+
"type": "string | number\n",
|
4420
|
+
"description": "Sets the month."
|
4421
|
+
},
|
4422
|
+
"VDateInput/show-adjacent-months": {
|
4423
|
+
"type": "boolean\n",
|
4424
|
+
"description": "Toggles visibility of days from previous and next months."
|
4425
|
+
},
|
4426
|
+
"VDateInput/year": {
|
4427
|
+
"type": "number\n",
|
4428
|
+
"description": "Sets the year."
|
4429
|
+
},
|
4430
|
+
"VDateInput/weekdays": {
|
4431
|
+
"type": "number[]\n",
|
4432
|
+
"description": "Array of weekdays."
|
4433
|
+
},
|
4434
|
+
"VDateInput/weeks-in-month": {
|
4435
|
+
"type": "'static' | 'dynamic'\n",
|
4436
|
+
"description": "A dynamic number of weeks in a month will grow and shrink depending on how many days are in the month. A static number always shows 7 weeks."
|
4437
|
+
},
|
4438
|
+
"VDateInput/first-day-of-week": {
|
4439
|
+
"type": "string | number\n",
|
4440
|
+
"description": "Sets the first day of the week, starting with 0 for Sunday."
|
4441
|
+
},
|
4442
|
+
"VDateInput/allowed-dates": {
|
4443
|
+
"type": "unknown[] | ((date: unknown) => boolean)\n",
|
4444
|
+
"description": "Restricts which dates can be selected."
|
4445
|
+
},
|
4446
|
+
"VDateInput/display-value": {
|
4447
|
+
"type": "unknown\n",
|
4448
|
+
"description": "The value that determines the month to show. This is different from modelValue, which determines the selected value."
|
4337
4449
|
},
|
4338
|
-
"VDateInput/
|
4339
|
-
"type": "
|
4340
|
-
"description": "
|
4450
|
+
"VDateInput/min": {
|
4451
|
+
"type": "unknown\n",
|
4452
|
+
"description": "Minimum allowed date/month (ISO 8601 format)."
|
4341
4453
|
},
|
4342
|
-
"VDateInput/
|
4343
|
-
"type": " |
|
4344
|
-
"description": "
|
4454
|
+
"VDateInput/next-icon": {
|
4455
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4456
|
+
"description": "Sets the icon for next month/year button."
|
4345
4457
|
},
|
4346
|
-
"VDateInput/
|
4347
|
-
"type": "string\n",
|
4348
|
-
"description": "Sets the
|
4458
|
+
"VDateInput/prev-icon": {
|
4459
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4460
|
+
"description": "Sets the icon for previous month/year button."
|
4349
4461
|
},
|
4350
|
-
"VDateInput/
|
4351
|
-
"type": "
|
4352
|
-
"description": "
|
4462
|
+
"VDateInput/view-mode": {
|
4463
|
+
"type": "'month' | 'year' | 'months'\n",
|
4464
|
+
"description": "Determines which picker in the date or month picker is being displayed. Allowed values: `'month'`, `'months'`, `'year'`."
|
4353
4465
|
},
|
4354
|
-
"VDateInput/
|
4355
|
-
"type": "
|
4356
|
-
"description": "
|
4466
|
+
"VDateInput/direction": {
|
4467
|
+
"type": "'horizontal' | 'vertical'\n",
|
4468
|
+
"description": "Changes the direction of the input."
|
4357
4469
|
},
|
4358
|
-
"VDateInput/
|
4470
|
+
"VDateInput/cancel-text": {
|
4359
4471
|
"type": "string\n",
|
4360
|
-
"description": "
|
4472
|
+
"description": "Text for the cancel button"
|
4361
4473
|
},
|
4362
|
-
"VDateInput/
|
4474
|
+
"VDateInput/ok-text": {
|
4363
4475
|
"type": "string\n",
|
4364
|
-
"description": "
|
4476
|
+
"description": "Text for the ok button"
|
4365
4477
|
},
|
4366
|
-
"VDateInput/
|
4478
|
+
"VDateInput/hide-actions": {
|
4367
4479
|
"type": "boolean\n",
|
4368
|
-
"description": "
|
4369
|
-
},
|
4370
|
-
"VDateInput/multiple": {
|
4371
|
-
"type": "number | boolean | (string & {}) | 'range'\n",
|
4372
|
-
"description": "Allow the selection of multiple dates. The **range** value selects all dates between two selections."
|
4373
|
-
},
|
4374
|
-
"VDateInput/id": {
|
4375
|
-
"type": "string\n",
|
4376
|
-
"description": "Sets the DOM id on the component."
|
4480
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDateInput.json))"
|
4377
4481
|
},
|
4378
|
-
"VDateInput/
|
4379
|
-
"type": "
|
4380
|
-
"description": "
|
4482
|
+
"VDateInput/focused": {
|
4483
|
+
"type": "boolean\n",
|
4484
|
+
"description": "Forces a focused state styling on the component."
|
4381
4485
|
},
|
4382
4486
|
"VDateInput/autofocus": {
|
4383
4487
|
"type": "boolean\n",
|
@@ -4387,10 +4491,6 @@
|
|
4387
4491
|
"type": "string | number | boolean\n",
|
4388
4492
|
"description": "Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation."
|
4389
4493
|
},
|
4390
|
-
"VDateInput/prefix": {
|
4391
|
-
"type": "string\n",
|
4392
|
-
"description": "Displays prefix text."
|
4393
|
-
},
|
4394
4494
|
"VDateInput/placeholder": {
|
4395
4495
|
"type": "string\n",
|
4396
4496
|
"description": "Sets the input’s placeholder text."
|
@@ -4407,22 +4507,10 @@
|
|
4407
4507
|
"type": "string\n",
|
4408
4508
|
"description": "Displays suffix text."
|
4409
4509
|
},
|
4410
|
-
"VDateInput/role": {
|
4411
|
-
"type": "string\n",
|
4412
|
-
"description": "The role attribute applied to the input."
|
4413
|
-
},
|
4414
|
-
"VDateInput/append-icon": {
|
4415
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4416
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
4417
|
-
},
|
4418
4510
|
"VDateInput/center-affix": {
|
4419
4511
|
"type": "boolean\n",
|
4420
4512
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
4421
4513
|
},
|
4422
|
-
"VDateInput/prepend-icon": {
|
4423
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4424
|
-
"description": "Prepends an icon to the outnside the component's input, uses the same syntax as `v-icon`."
|
4425
|
-
},
|
4426
4514
|
"VDateInput/hide-spin-buttons": {
|
4427
4515
|
"type": "boolean\n",
|
4428
4516
|
"description": "Hides spin buttons on the input when type is set to `number`."
|
@@ -4439,10 +4527,6 @@
|
|
4439
4527
|
"type": "string | string[]\n",
|
4440
4528
|
"description": "Displays a list of messages or a single message if using a string."
|
4441
4529
|
},
|
4442
|
-
"VDateInput/direction": {
|
4443
|
-
"type": "'horizontal' | 'vertical'\n",
|
4444
|
-
"description": "Changes the direction of the input."
|
4445
|
-
},
|
4446
4530
|
"VDateInput/error-messages": {
|
4447
4531
|
"type": "string | string[]\n",
|
4448
4532
|
"description": "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."
|
@@ -4451,10 +4535,6 @@
|
|
4451
4535
|
"type": "string | number\n",
|
4452
4536
|
"description": "Control the maximum number of shown errors from validation."
|
4453
4537
|
},
|
4454
|
-
"VDateInput/readonly": {
|
4455
|
-
"type": "boolean\n",
|
4456
|
-
"description": "Makes the picker readonly (doesn't allow to select new date)."
|
4457
|
-
},
|
4458
4538
|
"VDateInput/rules": {
|
4459
4539
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/validation.ts#L16-L20\" target=\"_blank\">ValidationRule</a>[]\n",
|
4460
4540
|
"description": "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`."
|
@@ -4467,10 +4547,6 @@
|
|
4467
4547
|
"type": "any\n",
|
4468
4548
|
"description": "The value used when applying validation rules."
|
4469
4549
|
},
|
4470
|
-
"VDateInput/focused": {
|
4471
|
-
"type": "boolean\n",
|
4472
|
-
"description": "Forces a focused state styling on the component."
|
4473
|
-
},
|
4474
4550
|
"VDateInput/hide-details": {
|
4475
4551
|
"type": "boolean | 'auto'\n",
|
4476
4552
|
"description": "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."
|
@@ -4487,10 +4563,6 @@
|
|
4487
4563
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4488
4564
|
"description": "The icon used when the **clearable** prop is set to true."
|
4489
4565
|
},
|
4490
|
-
"VDateInput/active": {
|
4491
|
-
"type": "boolean\n",
|
4492
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
4493
|
-
},
|
4494
4566
|
"VDateInput/dirty": {
|
4495
4567
|
"type": "boolean\n",
|
4496
4568
|
"description": "Manually apply the dirty state styling."
|
@@ -4507,10 +4579,6 @@
|
|
4507
4579
|
"type": "boolean\n",
|
4508
4580
|
"description": "Label does not move on focus/dirty."
|
4509
4581
|
},
|
4510
|
-
"VDateInput/loading": {
|
4511
|
-
"type": "string | boolean\n",
|
4512
|
-
"description": "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."
|
4513
|
-
},
|
4514
4582
|
"VDateInput/counter-value": {
|
4515
4583
|
"type": "number | ((value: any) => number)\n",
|
4516
4584
|
"description": "Function returns the counter display text."
|
@@ -4519,49 +4587,9 @@
|
|
4519
4587
|
"type": "unknown\n",
|
4520
4588
|
"description": "**FOR INTERNAL USE ONLY**"
|
4521
4589
|
},
|
4522
|
-
"VDateInput/max": {
|
4523
|
-
"type": "unknown\n",
|
4524
|
-
"description": "Maximum allowed date/month (ISO 8601 format)."
|
4525
|
-
},
|
4526
|
-
"VDateInput/next-icon": {
|
4527
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4528
|
-
"description": "Icon used for the next button."
|
4529
|
-
},
|
4530
|
-
"VDateInput/prev-icon": {
|
4531
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4532
|
-
"description": "Icon used for the previous button."
|
4533
|
-
},
|
4534
|
-
"VDateInput/view-mode": {
|
4535
|
-
"type": "'month' | 'months' | 'year'\n",
|
4536
|
-
"description": "Sets the view mode of the date picker."
|
4537
|
-
},
|
4538
|
-
"VDateInput/month": {
|
4539
|
-
"type": "string | number\n",
|
4540
|
-
"description": "Sets the month."
|
4541
|
-
},
|
4542
|
-
"VDateInput/reverse-transition": {
|
4543
|
-
"type": "string\n",
|
4544
|
-
"description": "The transition used when changing months into the past"
|
4545
|
-
},
|
4546
|
-
"VDateInput/cancel-text": {
|
4547
|
-
"type": "string\n",
|
4548
|
-
"description": "Text for the cancel button"
|
4549
|
-
},
|
4550
|
-
"VDateInput/ok-text": {
|
4551
|
-
"type": "string\n",
|
4552
|
-
"description": "Text for the ok button"
|
4553
|
-
},
|
4554
|
-
"VDateInput/hide-actions": {
|
4555
|
-
"type": "boolean\n",
|
4556
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDateInput.json))"
|
4557
|
-
},
|
4558
4590
|
"VDateInput/mode-icon": {
|
4559
4591
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4560
|
-
"description": "Icon
|
4561
|
-
},
|
4562
|
-
"VDateInput/year": {
|
4563
|
-
"type": "number\n",
|
4564
|
-
"description": "Sets the year."
|
4592
|
+
"description": "Icon displayed next to the current month and year, toggles year selection when clicked."
|
4565
4593
|
},
|
4566
4594
|
"VDateInput/hide-weekdays": {
|
4567
4595
|
"type": "boolean\n",
|
@@ -4571,62 +4599,18 @@
|
|
4571
4599
|
"type": "boolean\n",
|
4572
4600
|
"description": "Toggles visibility of the week numbers in the body of the calendar."
|
4573
4601
|
},
|
4574
|
-
"VDateInput/
|
4575
|
-
"type": "
|
4576
|
-
"description": "
|
4577
|
-
},
|
4578
|
-
"VDateInput/weekdays": {
|
4579
|
-
"type": "number[]\n",
|
4580
|
-
"description": "Array of weekdays."
|
4581
|
-
},
|
4582
|
-
"VDateInput/weeks-in-month": {
|
4583
|
-
"type": "'static' | 'dynamic'\n",
|
4584
|
-
"description": "A dynamic number of weeks in a month will grow and shrink depending on how many days are in the month. A static number always shows 7 weeks."
|
4585
|
-
},
|
4586
|
-
"VDateInput/first-day-of-week": {
|
4587
|
-
"type": "string | number\n",
|
4588
|
-
"description": "Sets the first day of the week, starting with 0 for Sunday."
|
4589
|
-
},
|
4590
|
-
"VDateInput/allowed-dates": {
|
4591
|
-
"type": "unknown[] | ((date: unknown) => boolean)\n",
|
4592
|
-
"description": "Restricts which dates can be selected."
|
4593
|
-
},
|
4594
|
-
"VDateInput/display-value": {
|
4595
|
-
"type": "unknown\n",
|
4596
|
-
"description": "The value that determines the month to show. This is different from modelValue, which determines the selected value."
|
4597
|
-
},
|
4598
|
-
"VDateInput/min": {
|
4599
|
-
"type": "unknown\n",
|
4600
|
-
"description": "Minimum allowed date/month (ISO 8601 format)."
|
4602
|
+
"VDateInput/reverse-transition": {
|
4603
|
+
"type": "string\n",
|
4604
|
+
"description": "The transition used when changing months into the past"
|
4601
4605
|
},
|
4602
4606
|
"VDateInput/landscape": {
|
4603
4607
|
"type": "boolean\n",
|
4604
|
-
"description": "
|
4605
|
-
},
|
4606
|
-
"VDateInput/hide-header": {
|
4607
|
-
"type": "boolean\n",
|
4608
|
-
"description": "Hide the picker header."
|
4609
|
-
},
|
4610
|
-
"VDatePicker/tag": {
|
4611
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
4612
|
-
"description": "Specify a custom tag used on the root element."
|
4613
|
-
},
|
4614
|
-
"VDatePicker/header": {
|
4615
|
-
"type": "string\n",
|
4616
|
-
"description": "Text shown when no **display-date** is set."
|
4608
|
+
"description": "Changes the picker to landscape mode."
|
4617
4609
|
},
|
4618
4610
|
"VDatePicker/title": {
|
4619
4611
|
"type": "string\n",
|
4620
4612
|
"description": "Specify a title text for the component."
|
4621
4613
|
},
|
4622
|
-
"VDatePicker/theme": {
|
4623
|
-
"type": "string\n",
|
4624
|
-
"description": "Specify a theme for this component and all of its children."
|
4625
|
-
},
|
4626
|
-
"VDatePicker/active": {
|
4627
|
-
"type": "string | string[]\n",
|
4628
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
4629
|
-
},
|
4630
4614
|
"VDatePicker/text": {
|
4631
4615
|
"type": "string\n",
|
4632
4616
|
"description": "Specify content text for the component."
|
@@ -4635,6 +4619,10 @@
|
|
4635
4619
|
"type": "string | number | boolean\n",
|
4636
4620
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
4637
4621
|
},
|
4622
|
+
"VDatePicker/model-value": {
|
4623
|
+
"type": "unknown\n",
|
4624
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4625
|
+
},
|
4638
4626
|
"VDatePicker/height": {
|
4639
4627
|
"type": "string | number\n",
|
4640
4628
|
"description": "Sets the height for the component."
|
@@ -4663,16 +4651,12 @@
|
|
4663
4651
|
"type": "string | number\n",
|
4664
4652
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
4665
4653
|
},
|
4666
|
-
"VDatePicker/disabled": {
|
4667
|
-
"type": "boolean\n",
|
4668
|
-
"description": "Removes the ability to click or target the component."
|
4669
|
-
},
|
4670
4654
|
"VDatePicker/location": {
|
4671
4655
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
4672
4656
|
"description": "Specifies the component's location. Can combine by using a space separated string."
|
4673
4657
|
},
|
4674
4658
|
"VDatePicker/position": {
|
4675
|
-
"type": "'fixed' | '
|
4659
|
+
"type": "'fixed' | 'static' | 'relative' | 'absolute' | 'sticky'\n",
|
4676
4660
|
"description": "Sets the position for the component."
|
4677
4661
|
},
|
4678
4662
|
"VDatePicker/rounded": {
|
@@ -4683,46 +4667,86 @@
|
|
4683
4667
|
"type": "boolean\n",
|
4684
4668
|
"description": "Removes any applied **border-radius** from the component."
|
4685
4669
|
},
|
4670
|
+
"VDatePicker/tag": {
|
4671
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
4672
|
+
"description": "Specify a custom tag used on the root element."
|
4673
|
+
},
|
4674
|
+
"VDatePicker/theme": {
|
4675
|
+
"type": "string\n",
|
4676
|
+
"description": "Specify a theme for this component and all of its children."
|
4677
|
+
},
|
4686
4678
|
"VDatePicker/color": {
|
4687
4679
|
"type": "string\n",
|
4688
4680
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4689
4681
|
},
|
4690
|
-
"VDatePicker/
|
4691
|
-
"type": "
|
4692
|
-
"description": "
|
4682
|
+
"VDatePicker/header": {
|
4683
|
+
"type": "string\n",
|
4684
|
+
"description": "Text shown when no **display-date** is set."
|
4693
4685
|
},
|
4694
|
-
"VDatePicker/
|
4695
|
-
"type": "
|
4696
|
-
"description": "
|
4686
|
+
"VDatePicker/bg-color": {
|
4687
|
+
"type": "string\n",
|
4688
|
+
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4689
|
+
},
|
4690
|
+
"VDatePicker/disabled": {
|
4691
|
+
"type": "boolean\n",
|
4692
|
+
"description": "Removes the ability to click or target the component."
|
4693
|
+
},
|
4694
|
+
"VDatePicker/multiple": {
|
4695
|
+
"type": "number | boolean | (string & {}) | 'range'\n",
|
4696
|
+
"description": "Allow the selection of multiple dates. The **range** value selects all dates between two selections."
|
4697
4697
|
},
|
4698
4698
|
"VDatePicker/transition": {
|
4699
4699
|
"type": "string\n",
|
4700
4700
|
"description": "The transition used when changing months into the future"
|
4701
4701
|
},
|
4702
|
-
"VDatePicker/
|
4702
|
+
"VDatePicker/active": {
|
4703
|
+
"type": "string | string[]\n",
|
4704
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
4705
|
+
},
|
4706
|
+
"VDatePicker/max": {
|
4707
|
+
"type": "unknown\n",
|
4708
|
+
"description": "Maximum allowed date/month (ISO 8601 format)."
|
4709
|
+
},
|
4710
|
+
"VDatePicker/next-icon": {
|
4711
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4712
|
+
"description": "Sets the icon for next month/year button."
|
4713
|
+
},
|
4714
|
+
"VDatePicker/prev-icon": {
|
4715
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4716
|
+
"description": "Sets the icon for previous month/year button."
|
4717
|
+
},
|
4718
|
+
"VDatePicker/view-mode": {
|
4719
|
+
"type": "'month' | 'months' | 'year'\n",
|
4720
|
+
"description": "Determines which picker in the date or month picker is being displayed. Allowed values: `'month'`, `'months'`, `'year'`."
|
4721
|
+
},
|
4722
|
+
"VDatePicker/month": {
|
4723
|
+
"type": "string | number\n",
|
4724
|
+
"description": "Sets the month."
|
4725
|
+
},
|
4726
|
+
"VDatePicker/reverse-transition": {
|
4703
4727
|
"type": "string\n",
|
4704
|
-
"description": "
|
4728
|
+
"description": "The transition used when changing months into the past"
|
4729
|
+
},
|
4730
|
+
"VDatePicker/mode-icon": {
|
4731
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4732
|
+
"description": "Icon displayed next to the current month and year, toggles year selection when clicked."
|
4705
4733
|
},
|
4706
|
-
"VDatePicker/
|
4707
|
-
"type": "number
|
4708
|
-
"description": "
|
4734
|
+
"VDatePicker/year": {
|
4735
|
+
"type": "number\n",
|
4736
|
+
"description": "Sets the year."
|
4709
4737
|
},
|
4710
|
-
"VDatePicker/hide-
|
4738
|
+
"VDatePicker/hide-weekdays": {
|
4711
4739
|
"type": "boolean\n",
|
4712
|
-
"description": "Hides the
|
4740
|
+
"description": "Hides the weekdays."
|
4713
4741
|
},
|
4714
|
-
"VDatePicker/
|
4715
|
-
"type": "
|
4716
|
-
"description": "
|
4742
|
+
"VDatePicker/show-week": {
|
4743
|
+
"type": "boolean\n",
|
4744
|
+
"description": "Toggles visibility of the week numbers in the body of the calendar."
|
4717
4745
|
},
|
4718
4746
|
"VDatePicker/show-adjacent-months": {
|
4719
4747
|
"type": "boolean\n",
|
4720
4748
|
"description": "Toggles visibility of days from previous and next months."
|
4721
4749
|
},
|
4722
|
-
"VDatePicker/year": {
|
4723
|
-
"type": "number\n",
|
4724
|
-
"description": "Sets the year."
|
4725
|
-
},
|
4726
4750
|
"VDatePicker/weekdays": {
|
4727
4751
|
"type": "number[]\n",
|
4728
4752
|
"description": "Array of weekdays."
|
@@ -4747,38 +4771,14 @@
|
|
4747
4771
|
"type": "unknown\n",
|
4748
4772
|
"description": "Minimum allowed date/month (ISO 8601 format)."
|
4749
4773
|
},
|
4750
|
-
"VDatePicker/next-icon": {
|
4751
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4752
|
-
"description": "Sets the icon for next month/year button."
|
4753
|
-
},
|
4754
|
-
"VDatePicker/prev-icon": {
|
4755
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4756
|
-
"description": "Sets the icon for previous month/year button."
|
4757
|
-
},
|
4758
|
-
"VDatePicker/view-mode": {
|
4759
|
-
"type": "'month' | 'year' | 'months'\n",
|
4760
|
-
"description": "Determines which picker in the date or month picker is being displayed. Allowed values: `'month'`, `'months'`, `'year'`."
|
4761
|
-
},
|
4762
|
-
"VDatePicker/mode-icon": {
|
4763
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4764
|
-
"description": "Icon displayed next to the current month and year, toggles year selection when clicked."
|
4765
|
-
},
|
4766
|
-
"VDatePicker/hide-weekdays": {
|
4767
|
-
"type": "boolean\n",
|
4768
|
-
"description": "Hides the weekdays."
|
4769
|
-
},
|
4770
|
-
"VDatePicker/show-week": {
|
4771
|
-
"type": "boolean\n",
|
4772
|
-
"description": "Toggles visibility of the week numbers in the body of the calendar."
|
4773
|
-
},
|
4774
|
-
"VDatePicker/reverse-transition": {
|
4775
|
-
"type": "string\n",
|
4776
|
-
"description": "The transition used when changing months into the past"
|
4777
|
-
},
|
4778
4774
|
"VDatePicker/landscape": {
|
4779
4775
|
"type": "boolean\n",
|
4780
4776
|
"description": "Changes the picker to landscape mode."
|
4781
4777
|
},
|
4778
|
+
"VDatePicker/hide-header": {
|
4779
|
+
"type": "boolean\n",
|
4780
|
+
"description": "Hides the header."
|
4781
|
+
},
|
4782
4782
|
"VDatePickerControls/text": {
|
4783
4783
|
"type": "string\n",
|
4784
4784
|
"description": "Specify content text for the component."
|
@@ -4823,54 +4823,42 @@
|
|
4823
4823
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4824
4824
|
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
4825
4825
|
},
|
4826
|
-
"VDatePickerMonth/
|
4827
|
-
"type": "
|
4828
|
-
"description": "
|
4826
|
+
"VDatePickerMonth/disabled": {
|
4827
|
+
"type": "boolean\n",
|
4828
|
+
"description": "Removes the ability to click or target the component."
|
4829
4829
|
},
|
4830
4830
|
"VDatePickerMonth/color": {
|
4831
4831
|
"type": "string\n",
|
4832
4832
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
4833
4833
|
},
|
4834
|
-
"VDatePickerMonth/
|
4835
|
-
"type": "
|
4836
|
-
"description": "
|
4834
|
+
"VDatePickerMonth/max": {
|
4835
|
+
"type": "unknown\n",
|
4836
|
+
"description": "Sets the maximum date of the month."
|
4837
4837
|
},
|
4838
|
-
"VDatePickerMonth/
|
4839
|
-
"type": "
|
4840
|
-
"description": "
|
4838
|
+
"VDatePickerMonth/model-value": {
|
4839
|
+
"type": "unknown[]\n",
|
4840
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4841
4841
|
},
|
4842
4842
|
"VDatePickerMonth/transition": {
|
4843
4843
|
"type": "string\n",
|
4844
4844
|
"description": "The transition used when changing months into the future"
|
4845
4845
|
},
|
4846
|
-
"VDatePickerMonth/
|
4847
|
-
"type": "
|
4848
|
-
"description": "Sets the
|
4846
|
+
"VDatePickerMonth/multiple": {
|
4847
|
+
"type": "number | boolean | (string & {}) | 'range'\n",
|
4848
|
+
"description": "Sets the multiple of the month."
|
4849
4849
|
},
|
4850
4850
|
"VDatePickerMonth/month": {
|
4851
4851
|
"type": "string | number\n",
|
4852
4852
|
"description": "Sets the month."
|
4853
4853
|
},
|
4854
|
-
"VDatePickerMonth/
|
4855
|
-
"type": "
|
4856
|
-
"description": "
|
4854
|
+
"VDatePickerMonth/show-adjacent-months": {
|
4855
|
+
"type": "boolean\n",
|
4856
|
+
"description": "Show adjacent months."
|
4857
4857
|
},
|
4858
4858
|
"VDatePickerMonth/year": {
|
4859
4859
|
"type": "string | number\n",
|
4860
4860
|
"description": "Sets the year."
|
4861
4861
|
},
|
4862
|
-
"VDatePickerMonth/hide-weekdays": {
|
4863
|
-
"type": "boolean\n",
|
4864
|
-
"description": "Hide the days of the week letters."
|
4865
|
-
},
|
4866
|
-
"VDatePickerMonth/show-week": {
|
4867
|
-
"type": "boolean\n",
|
4868
|
-
"description": "Show the week number."
|
4869
|
-
},
|
4870
|
-
"VDatePickerMonth/show-adjacent-months": {
|
4871
|
-
"type": "boolean\n",
|
4872
|
-
"description": "Show adjacent months."
|
4873
|
-
},
|
4874
4862
|
"VDatePickerMonth/weekdays": {
|
4875
4863
|
"type": "number[]\n",
|
4876
4864
|
"description": "Sets the weekdays of the month."
|
@@ -4895,6 +4883,22 @@
|
|
4895
4883
|
"type": "unknown\n",
|
4896
4884
|
"description": "Sets the minimum date of the month."
|
4897
4885
|
},
|
4886
|
+
"VDatePickerMonth/hide-weekdays": {
|
4887
|
+
"type": "boolean\n",
|
4888
|
+
"description": "Hide the days of the week letters."
|
4889
|
+
},
|
4890
|
+
"VDatePickerMonth/show-week": {
|
4891
|
+
"type": "boolean\n",
|
4892
|
+
"description": "Show the week number."
|
4893
|
+
},
|
4894
|
+
"VDatePickerMonth/reverse-transition": {
|
4895
|
+
"type": "string\n",
|
4896
|
+
"description": "The transition used when changing months into the past"
|
4897
|
+
},
|
4898
|
+
"VDatePickerMonths/model-value": {
|
4899
|
+
"type": "number\n",
|
4900
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4901
|
+
},
|
4898
4902
|
"VDatePickerMonths/height": {
|
4899
4903
|
"type": "string | number\n",
|
4900
4904
|
"description": "Sets the height for the component."
|
@@ -4907,10 +4911,6 @@
|
|
4907
4911
|
"type": "unknown\n",
|
4908
4912
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDatePickerMonths.json))"
|
4909
4913
|
},
|
4910
|
-
"VDatePickerMonths/model-value": {
|
4911
|
-
"type": "number\n",
|
4912
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4913
|
-
},
|
4914
4914
|
"VDatePickerMonths/year": {
|
4915
4915
|
"type": "number\n",
|
4916
4916
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDatePickerMonths.json))"
|
@@ -4919,10 +4919,6 @@
|
|
4919
4919
|
"type": "unknown\n",
|
4920
4920
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDatePickerMonths.json))"
|
4921
4921
|
},
|
4922
|
-
"VDatePickerYears/model-value": {
|
4923
|
-
"type": "number\n",
|
4924
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4925
|
-
},
|
4926
4922
|
"VDatePickerYears/height": {
|
4927
4923
|
"type": "string | number\n",
|
4928
4924
|
"description": "Sets the height for the component."
|
@@ -4935,14 +4931,14 @@
|
|
4935
4931
|
"type": "unknown\n",
|
4936
4932
|
"description": "Sets the maximum date of the month."
|
4937
4933
|
},
|
4934
|
+
"VDatePickerYears/model-value": {
|
4935
|
+
"type": "number\n",
|
4936
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
4937
|
+
},
|
4938
4938
|
"VDatePickerYears/min": {
|
4939
4939
|
"type": "unknown\n",
|
4940
4940
|
"description": "Sets the minimum date of the month."
|
4941
4941
|
},
|
4942
|
-
"VDefaultsProvider/reset": {
|
4943
|
-
"type": "string | number\n",
|
4944
|
-
"description": "Reset the default values up the nested chain by {n} amount."
|
4945
|
-
},
|
4946
4942
|
"VDefaultsProvider/disabled": {
|
4947
4943
|
"type": "boolean\n",
|
4948
4944
|
"description": "Turns off all calculations of new default values for improved performance in situations where defaults propagation isn't necessary."
|
@@ -4951,6 +4947,10 @@
|
|
4951
4947
|
"type": "string | boolean\n",
|
4952
4948
|
"description": "Force current defaults to match the application root defaults."
|
4953
4949
|
},
|
4950
|
+
"VDefaultsProvider/reset": {
|
4951
|
+
"type": "string | number\n",
|
4952
|
+
"description": "Reset the default values up the nested chain by {n} amount."
|
4953
|
+
},
|
4954
4954
|
"VDefaultsProvider/scoped": {
|
4955
4955
|
"type": "boolean\n",
|
4956
4956
|
"description": "Prevents the ability for default values to be inherited from parent components."
|
@@ -4959,9 +4959,9 @@
|
|
4959
4959
|
"type": "{\n global: Record<string, unknown>\n [string]: Record<string, unknown>\n}\n",
|
4960
4960
|
"description": "Specify new default prop values for components. Keep in mind that this will be merged with previously defined values."
|
4961
4961
|
},
|
4962
|
-
"VDialog/
|
4963
|
-
"type": "
|
4964
|
-
"description": "
|
4962
|
+
"VDialog/theme": {
|
4963
|
+
"type": "string\n",
|
4964
|
+
"description": "Specify a theme for this component and all of its children."
|
4965
4965
|
},
|
4966
4966
|
"VDialog/height": {
|
4967
4967
|
"type": "string | number\n",
|
@@ -4987,6 +4987,10 @@
|
|
4987
4987
|
"type": "string | number\n",
|
4988
4988
|
"description": "Sets the width for the component."
|
4989
4989
|
},
|
4990
|
+
"VDialog/disabled": {
|
4991
|
+
"type": "boolean\n",
|
4992
|
+
"description": "Removes the ability to click or target the component."
|
4993
|
+
},
|
4990
4994
|
"VDialog/location": {
|
4991
4995
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
4992
4996
|
"description": "Specifies the anchor point for positioning the component, using directional cues to align it either horizontally, vertically, or both.."
|
@@ -4995,22 +4999,30 @@
|
|
4995
4999
|
"type": "boolean\n",
|
4996
5000
|
"description": "Applies **position: absolute** to the content element."
|
4997
5001
|
},
|
4998
|
-
"VDialog/
|
4999
|
-
"type": "string\n",
|
5000
|
-
"description": "Specify a theme for this component and all of its children."
|
5001
|
-
},
|
5002
|
-
"VDialog/eager": {
|
5002
|
+
"VDialog/model-value": {
|
5003
5003
|
"type": "boolean\n",
|
5004
|
-
"description": "
|
5004
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
5005
5005
|
},
|
5006
|
-
"VDialog/
|
5007
|
-
"type": "boolean\n",
|
5008
|
-
"description": "
|
5006
|
+
"VDialog/transition": {
|
5007
|
+
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
|
5008
|
+
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
5009
5009
|
},
|
5010
5010
|
"VDialog/activator": {
|
5011
5011
|
"type": "Element | (string & {}) | 'parent' | ComponentPublicInstance\n",
|
5012
5012
|
"description": "Explicitly sets the overlay's activator."
|
5013
5013
|
},
|
5014
|
+
"VDialog/fullscreen": {
|
5015
|
+
"type": "boolean\n",
|
5016
|
+
"description": "Changes layout for fullscreen display."
|
5017
|
+
},
|
5018
|
+
"VDialog/retain-focus": {
|
5019
|
+
"type": "boolean\n",
|
5020
|
+
"description": "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."
|
5021
|
+
},
|
5022
|
+
"VDialog/scrollable": {
|
5023
|
+
"type": "boolean\n",
|
5024
|
+
"description": "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)."
|
5025
|
+
},
|
5014
5026
|
"VDialog/close-on-back": {
|
5015
5027
|
"type": "boolean\n",
|
5016
5028
|
"description": "Closes the overlay content when the browser's back button is pressed or `$router.back()` is called, cancelling the original navigation. `persistent` overlays will cancel navigation and animate as if they were clicked outside instead of closing."
|
@@ -5079,6 +5091,10 @@
|
|
5079
5091
|
"type": "string | number\n",
|
5080
5092
|
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
|
5081
5093
|
},
|
5094
|
+
"VDialog/eager": {
|
5095
|
+
"type": "boolean\n",
|
5096
|
+
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
5097
|
+
},
|
5082
5098
|
"VDialog/location-strategy": {
|
5083
5099
|
"type": "'static' | 'connected' | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VOverlay/locationStrategies.ts#L36-L40\" target=\"_blank\">LocationStrategyFn</a>\n",
|
5084
5100
|
"description": "A function used to specifies how the component should position relative to its activator."
|
@@ -5092,45 +5108,29 @@
|
|
5092
5108
|
"description": "A single value that offsets content away from the target based upon what side it is on."
|
5093
5109
|
},
|
5094
5110
|
"VDialog/scroll-strategy": {
|
5095
|
-
"type": "'close' | '
|
5111
|
+
"type": "'close' | 'block' | 'none' | 'reposition' | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VOverlay/scrollStrategies.ts#L17-L17\" target=\"_blank\">ScrollStrategyFn</a>\n",
|
5096
5112
|
"description": "Strategy used when the component is activate and user scrolls."
|
5097
5113
|
},
|
5098
|
-
"VDialog/transition": {
|
5099
|
-
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component }\n",
|
5100
|
-
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
5101
|
-
},
|
5102
5114
|
"VDialog/attach": {
|
5103
5115
|
"type": "string | boolean | Element\n",
|
5104
5116
|
"description": "Specifies which DOM element the overlay content should teleport to. Can be a direct element reference, querySelector string, or `true` to disable teleporting. Uses `body` by default."
|
5105
5117
|
},
|
5106
|
-
"
|
5107
|
-
"type": "boolean\n",
|
5108
|
-
"description": "Changes layout for fullscreen display."
|
5109
|
-
},
|
5110
|
-
"VDialog/retain-focus": {
|
5111
|
-
"type": "boolean\n",
|
5112
|
-
"description": "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."
|
5113
|
-
},
|
5114
|
-
"VDialog/scrollable": {
|
5118
|
+
"VDialogBottomTransition/disabled": {
|
5115
5119
|
"type": "boolean\n",
|
5116
|
-
"description": "
|
5120
|
+
"description": "Removes the ability to click or target the component."
|
5117
5121
|
},
|
5118
5122
|
"VDialogBottomTransition/mode": {
|
5119
5123
|
"type": "string\n",
|
5120
5124
|
"description": "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/api/built-in-components.html#transition)."
|
5121
5125
|
},
|
5122
|
-
"VDialogBottomTransition/
|
5123
|
-
"type": "
|
5124
|
-
"description": "
|
5126
|
+
"VDialogBottomTransition/origin": {
|
5127
|
+
"type": "string\n",
|
5128
|
+
"description": "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)."
|
5125
5129
|
},
|
5126
5130
|
"VDialogBottomTransition/group": {
|
5127
5131
|
"type": "boolean\n",
|
5128
5132
|
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
|
5129
5133
|
},
|
5130
|
-
"VDialogBottomTransition/origin": {
|
5131
|
-
"type": "string\n",
|
5132
|
-
"description": "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)."
|
5133
|
-
},
|
5134
5134
|
"VDialogBottomTransition/hide-on-leave": {
|
5135
5135
|
"type": "boolean\n",
|
5136
5136
|
"description": "Hides the leaving element (no exit animation)."
|
@@ -5139,22 +5139,22 @@
|
|
5139
5139
|
"type": "boolean\n",
|
5140
5140
|
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
|
5141
5141
|
},
|
5142
|
-
"VDialogTopTransition/mode": {
|
5143
|
-
"type": "string\n",
|
5144
|
-
"description": "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/api/built-in-components.html#transition)."
|
5145
|
-
},
|
5146
5142
|
"VDialogTopTransition/disabled": {
|
5147
5143
|
"type": "boolean\n",
|
5148
5144
|
"description": "Removes the ability to click or target the component."
|
5149
5145
|
},
|
5150
|
-
"VDialogTopTransition/
|
5151
|
-
"type": "
|
5152
|
-
"description": "
|
5146
|
+
"VDialogTopTransition/mode": {
|
5147
|
+
"type": "string\n",
|
5148
|
+
"description": "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/api/built-in-components.html#transition)."
|
5153
5149
|
},
|
5154
5150
|
"VDialogTopTransition/origin": {
|
5155
5151
|
"type": "string\n",
|
5156
5152
|
"description": "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)."
|
5157
5153
|
},
|
5154
|
+
"VDialogTopTransition/group": {
|
5155
|
+
"type": "boolean\n",
|
5156
|
+
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
|
5157
|
+
},
|
5158
5158
|
"VDialogTopTransition/hide-on-leave": {
|
5159
5159
|
"type": "boolean\n",
|
5160
5160
|
"description": "Hides the leaving element (no exit animation)."
|
@@ -5179,10 +5179,6 @@
|
|
5179
5179
|
"type": "string\n",
|
5180
5180
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
5181
5181
|
},
|
5182
|
-
"VDivider/inset": {
|
5183
|
-
"type": "boolean\n",
|
5184
|
-
"description": "Adds indentation (72px) for **normal** dividers, reduces max height for **vertical**."
|
5185
|
-
},
|
5186
5182
|
"VDivider/opacity": {
|
5187
5183
|
"type": "string | number\n",
|
5188
5184
|
"description": "Sets the component's opacity value"
|
@@ -5191,6 +5187,10 @@
|
|
5191
5187
|
"type": "boolean\n",
|
5192
5188
|
"description": "Displays dividers vertically."
|
5193
5189
|
},
|
5190
|
+
"VDivider/inset": {
|
5191
|
+
"type": "boolean\n",
|
5192
|
+
"description": "Adds indentation (72px) for **normal** dividers, reduces max height for **vertical**."
|
5193
|
+
},
|
5194
5194
|
"VDivider/thickness": {
|
5195
5195
|
"type": "string | number\n",
|
5196
5196
|
"description": "Sets the dividers thickness. Default unit is px."
|
@@ -5251,14 +5251,6 @@
|
|
5251
5251
|
"type": "string | number\n",
|
5252
5252
|
"description": "Sets the height and width of the component. Default unit is px. Can also use the following predefined sizes: **x-small**, **small**, **default**, **large**, and **x-large**."
|
5253
5253
|
},
|
5254
|
-
"VEmptyState/href": {
|
5255
|
-
"type": "string\n",
|
5256
|
-
"description": "The URL the action button links to."
|
5257
|
-
},
|
5258
|
-
"VEmptyState/to": {
|
5259
|
-
"type": "string\n",
|
5260
|
-
"description": "The URL the action button links to."
|
5261
|
-
},
|
5262
5254
|
"VEmptyState/headline": {
|
5263
5255
|
"type": "string\n",
|
5264
5256
|
"description": "A large headline often used for 404 pages."
|
@@ -5275,6 +5267,14 @@
|
|
5275
5267
|
"type": "string | number\n",
|
5276
5268
|
"description": "Sets the width of the text container."
|
5277
5269
|
},
|
5270
|
+
"VEmptyState/href": {
|
5271
|
+
"type": "string\n",
|
5272
|
+
"description": "The URL the action button links to."
|
5273
|
+
},
|
5274
|
+
"VEmptyState/to": {
|
5275
|
+
"type": "string\n",
|
5276
|
+
"description": "The URL the action button links to."
|
5277
|
+
},
|
5278
5278
|
"VExpandTransition/mode": {
|
5279
5279
|
"type": "'default' | 'in-out' | 'out-in'\n",
|
5280
5280
|
"description": "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/api/built-in-components.html#transition)."
|
@@ -5287,14 +5287,14 @@
|
|
5287
5287
|
"type": "boolean\n",
|
5288
5288
|
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
|
5289
5289
|
},
|
5290
|
-
"VExpandXTransition/mode": {
|
5291
|
-
"type": "'default' | 'in-out' | 'out-in'\n",
|
5292
|
-
"description": "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/api/built-in-components.html#transition)."
|
5293
|
-
},
|
5294
5290
|
"VExpandXTransition/disabled": {
|
5295
5291
|
"type": "boolean\n",
|
5296
5292
|
"description": "Removes the ability to click or target the component."
|
5297
5293
|
},
|
5294
|
+
"VExpandXTransition/mode": {
|
5295
|
+
"type": "'default' | 'in-out' | 'out-in'\n",
|
5296
|
+
"description": "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/api/built-in-components.html#transition)."
|
5297
|
+
},
|
5298
5298
|
"VExpandXTransition/group": {
|
5299
5299
|
"type": "boolean\n",
|
5300
5300
|
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
|
@@ -5383,6 +5383,10 @@
|
|
5383
5383
|
"type": "boolean\n",
|
5384
5384
|
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
5385
5385
|
},
|
5386
|
+
"VExpansionPanel/hide-actions": {
|
5387
|
+
"type": "boolean\n",
|
5388
|
+
"description": "Hide the expand icon in the content title."
|
5389
|
+
},
|
5386
5390
|
"VExpansionPanel/expand-icon": {
|
5387
5391
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5388
5392
|
"description": "Icon used when the expansion panel is in a expandable state."
|
@@ -5391,10 +5395,6 @@
|
|
5391
5395
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5392
5396
|
"description": "Icon used when the expansion panel is in a collapsable state."
|
5393
5397
|
},
|
5394
|
-
"VExpansionPanel/hide-actions": {
|
5395
|
-
"type": "boolean\n",
|
5396
|
-
"description": "Hide the expand icon in the content title."
|
5397
|
-
},
|
5398
5398
|
"VExpansionPanel/focusable": {
|
5399
5399
|
"type": "boolean\n",
|
5400
5400
|
"description": "Makes the expansion panel content focusable."
|
@@ -5535,6 +5535,10 @@
|
|
5535
5535
|
"type": "boolean\n",
|
5536
5536
|
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
5537
5537
|
},
|
5538
|
+
"VExpansionPanels/hide-actions": {
|
5539
|
+
"type": "boolean\n",
|
5540
|
+
"description": "Hide the expand icon in the content title."
|
5541
|
+
},
|
5538
5542
|
"VExpansionPanels/expand-icon": {
|
5539
5543
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5540
5544
|
"description": "Icon used when the expansion panel is in a expandable state."
|
@@ -5543,10 +5547,6 @@
|
|
5543
5547
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5544
5548
|
"description": "Icon used when the expansion panel is in a collapsable state."
|
5545
5549
|
},
|
5546
|
-
"VExpansionPanels/hide-actions": {
|
5547
|
-
"type": "boolean\n",
|
5548
|
-
"description": "Hide the expand icon in the content title."
|
5549
|
-
},
|
5550
5550
|
"VExpansionPanels/focusable": {
|
5551
5551
|
"type": "boolean\n",
|
5552
5552
|
"description": "Makes the expansion-panel headers focusable."
|
@@ -5719,14 +5719,6 @@
|
|
5719
5719
|
"type": "string | boolean\n",
|
5720
5720
|
"description": "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."
|
5721
5721
|
},
|
5722
|
-
"VFab/href": {
|
5723
|
-
"type": "string\n",
|
5724
|
-
"description": "Designates the component as anchor and applies the **href** attribute."
|
5725
|
-
},
|
5726
|
-
"VFab/to": {
|
5727
|
-
"type": "RouteLocationRaw\n",
|
5728
|
-
"description": "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."
|
5729
|
-
},
|
5730
5722
|
"VFab/selected-class": {
|
5731
5723
|
"type": "string\n",
|
5732
5724
|
"description": "Configure the active CSS class applied when an item is selected."
|
@@ -5735,6 +5727,14 @@
|
|
5735
5727
|
"type": "boolean | { class: string }\n",
|
5736
5728
|
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
5737
5729
|
},
|
5730
|
+
"VFab/href": {
|
5731
|
+
"type": "string\n",
|
5732
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
5733
|
+
},
|
5734
|
+
"VFab/to": {
|
5735
|
+
"type": "RouteLocationRaw\n",
|
5736
|
+
"description": "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."
|
5737
|
+
},
|
5738
5738
|
"VFab/app": {
|
5739
5739
|
"type": "boolean\n",
|
5740
5740
|
"description": "If true, attaches to the closest layout and positions according to the value of **location**."
|
@@ -5863,14 +5863,14 @@
|
|
5863
5863
|
"type": "string\n",
|
5864
5864
|
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
5865
5865
|
},
|
5866
|
-
"VField/center-affix": {
|
5867
|
-
"type": "boolean\n",
|
5868
|
-
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
5869
|
-
},
|
5870
5866
|
"VField/focused": {
|
5871
5867
|
"type": "boolean\n",
|
5872
5868
|
"description": "Forces a focused state styling on the component."
|
5873
5869
|
},
|
5870
|
+
"VField/center-affix": {
|
5871
|
+
"type": "boolean\n",
|
5872
|
+
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
5873
|
+
},
|
5874
5874
|
"VField/append-inner-icon": {
|
5875
5875
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5876
5876
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
|
@@ -6223,10 +6223,6 @@
|
|
6223
6223
|
"type": "boolean\n",
|
6224
6224
|
"description": "Allows for the component to be cleared."
|
6225
6225
|
},
|
6226
|
-
"VFileUpload/thickness": {
|
6227
|
-
"type": "string | number\n",
|
6228
|
-
"description": "Sets the dividers thickness. Default unit is px."
|
6229
|
-
},
|
6230
6226
|
"VFileUpload/browse-text": {
|
6231
6227
|
"type": "string\n",
|
6232
6228
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
@@ -6243,6 +6239,10 @@
|
|
6243
6239
|
"type": "boolean\n",
|
6244
6240
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
6245
6241
|
},
|
6242
|
+
"VFileUpload/thickness": {
|
6243
|
+
"type": "string | number\n",
|
6244
|
+
"description": "Sets the dividers thickness. Default unit is px."
|
6245
|
+
},
|
6246
6246
|
"VFileUploadItem/replace": {
|
6247
6247
|
"type": "boolean\n",
|
6248
6248
|
"description": "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](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
|
@@ -6627,6 +6627,14 @@
|
|
6627
6627
|
"type": " | 'origin'\n | 'no-referrer'\n | 'no-referrer-when-downgrade'\n | 'origin-when-cross-origin'\n | 'same-origin'\n | 'strict-origin'\n | 'strict-origin-when-cross-origin'\n | 'unsafe-url'\n",
|
6628
6628
|
"description": "Define which referrer is sent when fetching the resource [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#referrerpolicy)"
|
6629
6629
|
},
|
6630
|
+
"VInfiniteScroll/tag": {
|
6631
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
6632
|
+
"description": "Specify a custom tag used on the root element."
|
6633
|
+
},
|
6634
|
+
"VInfiniteScroll/mode": {
|
6635
|
+
"type": "'intersect' | 'manual'\n",
|
6636
|
+
"description": "Specifies if content should load automatically when scrolling (**intersect**) or manually (**manual**)."
|
6637
|
+
},
|
6630
6638
|
"VInfiniteScroll/height": {
|
6631
6639
|
"type": "string | number\n",
|
6632
6640
|
"description": "Sets the height for the component."
|
@@ -6651,24 +6659,16 @@
|
|
6651
6659
|
"type": "string | number\n",
|
6652
6660
|
"description": "Sets the width for the component."
|
6653
6661
|
},
|
6654
|
-
"VInfiniteScroll/tag": {
|
6655
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
6656
|
-
"description": "Specify a custom tag used on the root element."
|
6657
|
-
},
|
6658
6662
|
"VInfiniteScroll/color": {
|
6659
6663
|
"type": "string\n",
|
6660
6664
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
6661
6665
|
},
|
6662
|
-
"VInfiniteScroll/mode": {
|
6663
|
-
"type": "'intersect' | 'manual'\n",
|
6664
|
-
"description": "Specifies if content should load automatically when scrolling (**intersect**) or manually (**manual**)."
|
6665
|
-
},
|
6666
6666
|
"VInfiniteScroll/direction": {
|
6667
6667
|
"type": "'horizontal' | 'vertical'\n",
|
6668
6668
|
"description": "Specifies if scroller is **vertical** or **horizontal**."
|
6669
6669
|
},
|
6670
6670
|
"VInfiniteScroll/side": {
|
6671
|
-
"type": "'
|
6671
|
+
"type": "'start' | 'end' | 'both'\n",
|
6672
6672
|
"description": "Specifies the side where new content should appear. Either the **start**, **end**, or **both** sides."
|
6673
6673
|
},
|
6674
6674
|
"VInfiniteScroll/margin": {
|
@@ -6683,14 +6683,38 @@
|
|
6683
6683
|
"type": "string\n",
|
6684
6684
|
"description": "Text shown when there is no more content to load."
|
6685
6685
|
},
|
6686
|
-
"VInput/
|
6687
|
-
"type": "
|
6688
|
-
"description": "
|
6686
|
+
"VInput/name": {
|
6687
|
+
"type": "string\n",
|
6688
|
+
"description": "Sets the component's name attribute."
|
6689
6689
|
},
|
6690
6690
|
"VInput/error": {
|
6691
6691
|
"type": "boolean\n",
|
6692
6692
|
"description": "Puts the input in a manual error state."
|
6693
6693
|
},
|
6694
|
+
"VInput/label": {
|
6695
|
+
"type": "string\n",
|
6696
|
+
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
6697
|
+
},
|
6698
|
+
"VInput/theme": {
|
6699
|
+
"type": "string\n",
|
6700
|
+
"description": "Specify a theme for this component and all of its children."
|
6701
|
+
},
|
6702
|
+
"VInput/id": {
|
6703
|
+
"type": "string\n",
|
6704
|
+
"description": "Sets the DOM id on the component."
|
6705
|
+
},
|
6706
|
+
"VInput/prepend-icon": {
|
6707
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6708
|
+
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
6709
|
+
},
|
6710
|
+
"VInput/append-icon": {
|
6711
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6712
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
6713
|
+
},
|
6714
|
+
"VInput/readonly": {
|
6715
|
+
"type": "boolean\n",
|
6716
|
+
"description": "Puts input in readonly state."
|
6717
|
+
},
|
6694
6718
|
"VInput/density": {
|
6695
6719
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
6696
6720
|
"description": "Adjusts the vertical height used by the component."
|
@@ -6707,38 +6731,26 @@
|
|
6707
6731
|
"type": "string | number\n",
|
6708
6732
|
"description": "Sets the width for the component."
|
6709
6733
|
},
|
6710
|
-
"VInput/theme": {
|
6711
|
-
"type": "string\n",
|
6712
|
-
"description": "Specify a theme for this component and all of its children."
|
6713
|
-
},
|
6714
|
-
"VInput/name": {
|
6715
|
-
"type": "string\n",
|
6716
|
-
"description": "Sets the component's name attribute."
|
6717
|
-
},
|
6718
|
-
"VInput/label": {
|
6719
|
-
"type": "string\n",
|
6720
|
-
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
6721
|
-
},
|
6722
6734
|
"VInput/disabled": {
|
6723
6735
|
"type": "boolean\n",
|
6724
6736
|
"description": "Removes the ability to click or target the component."
|
6725
6737
|
},
|
6726
|
-
"VInput/
|
6727
|
-
"type": "
|
6728
|
-
"description": "
|
6738
|
+
"VInput/model-value": {
|
6739
|
+
"type": "unknown\n",
|
6740
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6729
6741
|
},
|
6730
|
-
"VInput/
|
6731
|
-
"type": "
|
6732
|
-
"description": "
|
6742
|
+
"VInput/direction": {
|
6743
|
+
"type": "'horizontal' | 'vertical'\n",
|
6744
|
+
"description": "Changes the direction of the input."
|
6745
|
+
},
|
6746
|
+
"VInput/focused": {
|
6747
|
+
"type": "boolean\n",
|
6748
|
+
"description": "Forces a focused state styling on the component."
|
6733
6749
|
},
|
6734
6750
|
"VInput/center-affix": {
|
6735
6751
|
"type": "boolean\n",
|
6736
6752
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
6737
6753
|
},
|
6738
|
-
"VInput/prepend-icon": {
|
6739
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6740
|
-
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
6741
|
-
},
|
6742
6754
|
"VInput/hide-spin-buttons": {
|
6743
6755
|
"type": "boolean\n",
|
6744
6756
|
"description": "Hides spin buttons on the input when type is set to `number`."
|
@@ -6755,10 +6767,6 @@
|
|
6755
6767
|
"type": "string | string[]\n",
|
6756
6768
|
"description": "Displays a list of messages or a single message if using a string."
|
6757
6769
|
},
|
6758
|
-
"VInput/direction": {
|
6759
|
-
"type": "'horizontal' | 'vertical'\n",
|
6760
|
-
"description": "Changes the direction of the input."
|
6761
|
-
},
|
6762
6770
|
"VInput/error-messages": {
|
6763
6771
|
"type": "string | string[]\n",
|
6764
6772
|
"description": "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."
|
@@ -6767,10 +6775,6 @@
|
|
6767
6775
|
"type": "string | number\n",
|
6768
6776
|
"description": "Control the maximum number of shown errors from validation."
|
6769
6777
|
},
|
6770
|
-
"VInput/readonly": {
|
6771
|
-
"type": "boolean\n",
|
6772
|
-
"description": "Puts input in readonly state."
|
6773
|
-
},
|
6774
6778
|
"VInput/rules": {
|
6775
6779
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/validation.ts#L16-L20\" target=\"_blank\">ValidationRule</a>[]\n",
|
6776
6780
|
"description": "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`."
|
@@ -6783,26 +6787,26 @@
|
|
6783
6787
|
"type": "any\n",
|
6784
6788
|
"description": "The value used when applying validation rules."
|
6785
6789
|
},
|
6786
|
-
"VInput/focused": {
|
6787
|
-
"type": "boolean\n",
|
6788
|
-
"description": "Forces a focused state styling on the component."
|
6789
|
-
},
|
6790
6790
|
"VInput/hide-details": {
|
6791
6791
|
"type": "boolean | 'auto'\n",
|
6792
6792
|
"description": "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."
|
6793
6793
|
},
|
6794
|
-
"VItem/value": {
|
6795
|
-
"type": "any\n",
|
6796
|
-
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|
6797
|
-
},
|
6798
6794
|
"VItem/disabled": {
|
6799
6795
|
"type": "boolean\n",
|
6800
6796
|
"description": "Removes the ability to click or target the component."
|
6801
6797
|
},
|
6798
|
+
"VItem/value": {
|
6799
|
+
"type": "any\n",
|
6800
|
+
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|
6801
|
+
},
|
6802
6802
|
"VItem/selected-class": {
|
6803
6803
|
"type": "string\n",
|
6804
6804
|
"description": "Configure the active CSS class applied when an item is selected."
|
6805
6805
|
},
|
6806
|
+
"VItemGroup/model-value": {
|
6807
|
+
"type": "unknown\n",
|
6808
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6809
|
+
},
|
6806
6810
|
"VItemGroup/tag": {
|
6807
6811
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
6808
6812
|
"description": "Specify a custom tag used on the root element."
|
@@ -6815,18 +6819,6 @@
|
|
6815
6819
|
"type": "boolean\n",
|
6816
6820
|
"description": "Puts all children components into a disabled state."
|
6817
6821
|
},
|
6818
|
-
"VItemGroup/selected-class": {
|
6819
|
-
"type": "string\n",
|
6820
|
-
"description": "Configure the selected CSS class. This class will be available in `v-item` default scoped slot."
|
6821
|
-
},
|
6822
|
-
"VItemGroup/max": {
|
6823
|
-
"type": "number\n",
|
6824
|
-
"description": "Sets a maximum number of selections that can be made."
|
6825
|
-
},
|
6826
|
-
"VItemGroup/model-value": {
|
6827
|
-
"type": "unknown\n",
|
6828
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6829
|
-
},
|
6830
6822
|
"VItemGroup/multiple": {
|
6831
6823
|
"type": "boolean\n",
|
6832
6824
|
"description": "Allows one to select multiple items."
|
@@ -6835,25 +6827,25 @@
|
|
6835
6827
|
"type": "boolean | 'force'\n",
|
6836
6828
|
"description": "Forces at least one item to always be selected (if available)."
|
6837
6829
|
},
|
6838
|
-
"
|
6830
|
+
"VItemGroup/max": {
|
6831
|
+
"type": "number\n",
|
6832
|
+
"description": "Sets a maximum number of selections that can be made."
|
6833
|
+
},
|
6834
|
+
"VItemGroup/selected-class": {
|
6839
6835
|
"type": "string\n",
|
6840
|
-
"description": "
|
6836
|
+
"description": "Configure the selected CSS class. This class will be available in `v-item` default scoped slot."
|
6841
6837
|
},
|
6842
|
-
"
|
6838
|
+
"VKbd/tag": {
|
6843
6839
|
"type": "string\n",
|
6844
|
-
"description": "Specify
|
6840
|
+
"description": "Specify a custom tag used on the root element."
|
6845
6841
|
},
|
6846
6842
|
"VLabel/theme": {
|
6847
6843
|
"type": "string\n",
|
6848
6844
|
"description": "Specify a theme for this component and all of its children."
|
6849
6845
|
},
|
6850
|
-
"
|
6851
|
-
"type": "
|
6852
|
-
"description": "
|
6853
|
-
},
|
6854
|
-
"VLayout/overlaps": {
|
6855
|
-
"type": "string[]\n",
|
6856
|
-
"description": "**FOR INTERNAL USE ONLY**"
|
6846
|
+
"VLabel/text": {
|
6847
|
+
"type": "string\n",
|
6848
|
+
"description": "Specify content text for the component."
|
6857
6849
|
},
|
6858
6850
|
"VLayout/height": {
|
6859
6851
|
"type": "string | number\n",
|
@@ -6879,30 +6871,38 @@
|
|
6879
6871
|
"type": "string | number\n",
|
6880
6872
|
"description": "Sets the width for the component."
|
6881
6873
|
},
|
6882
|
-
"
|
6874
|
+
"VLayout/full-height": {
|
6883
6875
|
"type": "boolean\n",
|
6884
|
-
"description": "
|
6876
|
+
"description": "Sets the component height to 100%."
|
6877
|
+
},
|
6878
|
+
"VLayout/overlaps": {
|
6879
|
+
"type": "string[]\n",
|
6880
|
+
"description": "**FOR INTERNAL USE ONLY**"
|
6881
|
+
},
|
6882
|
+
"VLayoutItem/name": {
|
6883
|
+
"type": "string\n",
|
6884
|
+
"description": "Assign a specific name for layout registration."
|
6885
|
+
},
|
6886
|
+
"VLayoutItem/size": {
|
6887
|
+
"type": "string | number\n",
|
6888
|
+
"description": "Sets the height and width of the component."
|
6885
6889
|
},
|
6886
6890
|
"VLayoutItem/position": {
|
6887
|
-
"type": "'top' | '
|
6891
|
+
"type": "'top' | 'left' | 'right' | 'bottom'\n",
|
6888
6892
|
"description": "The position of the item."
|
6889
6893
|
},
|
6890
6894
|
"VLayoutItem/absolute": {
|
6891
6895
|
"type": "boolean\n",
|
6892
6896
|
"description": "Applies **position: absolute** to the component."
|
6893
6897
|
},
|
6894
|
-
"VLayoutItem/
|
6895
|
-
"type": "
|
6896
|
-
"description": "
|
6898
|
+
"VLayoutItem/model-value": {
|
6899
|
+
"type": "boolean\n",
|
6900
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6897
6901
|
},
|
6898
6902
|
"VLayoutItem/order": {
|
6899
6903
|
"type": "string | number\n",
|
6900
6904
|
"description": "Adjust the order of the component in relation to its registration order."
|
6901
6905
|
},
|
6902
|
-
"VLayoutItem/size": {
|
6903
|
-
"type": "string | number\n",
|
6904
|
-
"description": "Sets the height and width of the component."
|
6905
|
-
},
|
6906
6906
|
"VLazy/tag": {
|
6907
6907
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
6908
6908
|
"description": "Specify a custom tag used on the root element."
|
@@ -6951,6 +6951,38 @@
|
|
6951
6951
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
6952
6952
|
"description": "Specify a custom tag used on the root element."
|
6953
6953
|
},
|
6954
|
+
"VList/tag": {
|
6955
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
6956
|
+
"description": "Specify a custom tag used on the root element."
|
6957
|
+
},
|
6958
|
+
"VList/nav": {
|
6959
|
+
"type": "boolean\n",
|
6960
|
+
"description": "An alternative styling that reduces `v-list-item` width and rounds the corners. Typically used with **[v-navigation-drawer](/components/navigation-drawers)**."
|
6961
|
+
},
|
6962
|
+
"VList/activated": {
|
6963
|
+
"type": "any\n",
|
6964
|
+
"description": "Array of ids of activated nodes."
|
6965
|
+
},
|
6966
|
+
"VList/theme": {
|
6967
|
+
"type": "string\n",
|
6968
|
+
"description": "Specify a theme for this component and all of its children."
|
6969
|
+
},
|
6970
|
+
"VList/items": {
|
6971
|
+
"type": "any[]\n",
|
6972
|
+
"description": "Can be an array of objects or strings. By default objects should have a **title** property, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props), a **value** property to allow selection, and a **children** property containing more item objects. Keys to use for these can be changed with the **item-title**, **item-value**, **item-props**, and **item-children** props."
|
6973
|
+
},
|
6974
|
+
"VList/active-color": {
|
6975
|
+
"type": "string\n",
|
6976
|
+
"description": "The applied color when the component is in an active state."
|
6977
|
+
},
|
6978
|
+
"VList/base-color": {
|
6979
|
+
"type": "string\n",
|
6980
|
+
"description": "Sets the color of component when not focused."
|
6981
|
+
},
|
6982
|
+
"VList/slim": {
|
6983
|
+
"type": "boolean\n",
|
6984
|
+
"description": "Reduces horizontal spacing for badges, icons, tooltips, and avatars within slim list items to create a more compact visual representation."
|
6985
|
+
},
|
6954
6986
|
"VList/border": {
|
6955
6987
|
"type": "string | number | boolean\n",
|
6956
6988
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
@@ -6987,6 +7019,10 @@
|
|
6987
7019
|
"type": "string | number\n",
|
6988
7020
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
6989
7021
|
},
|
7022
|
+
"VList/disabled": {
|
7023
|
+
"type": "boolean\n",
|
7024
|
+
"description": "Puts all children inputs into a disabled state."
|
7025
|
+
},
|
6990
7026
|
"VList/rounded": {
|
6991
7027
|
"type": "string | number | boolean\n",
|
6992
7028
|
"description": "Designates the **border-radius** applied to the component. This can be **0**, **xs**, **sm**, true, **lg**, **xl**, **pill**, **circle**, and **shaped**. Find more information on available border radius classes on the [Border Radius page](/styles/border-radius)."
|
@@ -6995,45 +7031,49 @@
|
|
6995
7031
|
"type": "boolean\n",
|
6996
7032
|
"description": "Removes any applied **border-radius** from the component."
|
6997
7033
|
},
|
6998
|
-
"VList/tag": {
|
6999
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
7000
|
-
"description": "Specify a custom tag used on the root element."
|
7001
|
-
},
|
7002
|
-
"VList/theme": {
|
7003
|
-
"type": "string\n",
|
7004
|
-
"description": "Specify a theme for this component and all of its children."
|
7005
|
-
},
|
7006
7034
|
"VList/color": {
|
7007
7035
|
"type": "string\n",
|
7008
7036
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
7009
7037
|
},
|
7010
7038
|
"VList/variant": {
|
7011
|
-
"type": "'
|
7039
|
+
"type": "'flat' | 'text' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
7012
7040
|
"description": "Applies a distinct style to the component."
|
7013
7041
|
},
|
7014
|
-
"VList/
|
7015
|
-
"type": "any\n",
|
7016
|
-
"description": "Array of ids of activated nodes."
|
7017
|
-
},
|
7018
|
-
"VList/base-color": {
|
7019
|
-
"type": "string\n",
|
7020
|
-
"description": "Sets the color of component when not focused."
|
7021
|
-
},
|
7022
|
-
"VList/active-color": {
|
7042
|
+
"VList/bg-color": {
|
7023
7043
|
"type": "string\n",
|
7024
|
-
"description": "
|
7044
|
+
"description": "Applies specified color to the control's background. Used on components that also support the **color** prop. - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
7045
|
+
},
|
7046
|
+
"VList/lines": {
|
7047
|
+
"type": "false | 'one' | 'two' | 'three'\n",
|
7048
|
+
"description": "Designates a **minimum-height** for all children `v-list-item` components. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers."
|
7049
|
+
},
|
7050
|
+
"VList/mandatory": {
|
7051
|
+
"type": "boolean\n",
|
7052
|
+
"description": "Forces at least one item to always be selected (if available)."
|
7025
7053
|
},
|
7026
7054
|
"VList/active-class": {
|
7027
7055
|
"type": "string\n",
|
7028
7056
|
"description": "The class applied to the component when it is in an active state."
|
7029
7057
|
},
|
7030
|
-
"VList/
|
7031
|
-
"type": "
|
7032
|
-
"description": "
|
7058
|
+
"VList/selected": {
|
7059
|
+
"type": "unknown\n",
|
7060
|
+
"description": "An array containing the values of currently selected items. Can be two-way bound with `v-model:selected`."
|
7033
7061
|
},
|
7034
|
-
"VList/
|
7062
|
+
"VList/value-comparator": {
|
7063
|
+
"type": "(a: any, b: any) => boolean\n",
|
7064
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
7065
|
+
},
|
7066
|
+
"VList/item-value": {
|
7067
|
+
"type": "SelectItemKey<any>\n",
|
7068
|
+
"description": "Property on supplied `items` that contains its value."
|
7069
|
+
},
|
7070
|
+
"VList/return-object": {
|
7035
7071
|
"type": "boolean\n",
|
7036
|
-
"description": "
|
7072
|
+
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
7073
|
+
},
|
7074
|
+
"VList/select-strategy": {
|
7075
|
+
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | 'classic'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>)\n",
|
7076
|
+
"description": "Affects how items with children behave when selected.\n- **leaf:** Only leaf nodes (items without children) can be selected.\n- **independent:** All nodes can be selected whether they have children or not.\n- **classic:** Selecting a parent node will cause all children to be selected, parent nodes will be displayed as selected if all their descendants are selected. Only leaf nodes will be added to the model."
|
7037
7077
|
},
|
7038
7078
|
"VList/expand-icon": {
|
7039
7079
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
@@ -7043,18 +7083,6 @@
|
|
7043
7083
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7044
7084
|
"description": "Icon to display when the list item is expanded."
|
7045
7085
|
},
|
7046
|
-
"VList/lines": {
|
7047
|
-
"type": "false | 'one' | 'two' | 'three'\n",
|
7048
|
-
"description": "Designates a **minimum-height** for all children `v-list-item` components. This prop uses [line-clamp](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-line-clamp) and is not supported in all browsers."
|
7049
|
-
},
|
7050
|
-
"VList/slim": {
|
7051
|
-
"type": "boolean\n",
|
7052
|
-
"description": "Reduces horizontal spacing for badges, icons, tooltips, and avatars within slim list items to create a more compact visual representation."
|
7053
|
-
},
|
7054
|
-
"VList/nav": {
|
7055
|
-
"type": "boolean\n",
|
7056
|
-
"description": "An alternative styling that reduces `v-list-item` width and rounds the corners. Typically used with **[v-navigation-drawer](/components/navigation-drawers)**."
|
7057
|
-
},
|
7058
7086
|
"VList/activatable": {
|
7059
7087
|
"type": "boolean\n",
|
7060
7088
|
"description": "Designates whether the list items are activatable."
|
@@ -7067,42 +7095,22 @@
|
|
7067
7095
|
"type": "unknown\n",
|
7068
7096
|
"description": "An array containing the values of currently opened groups. Can be two-way bound with `v-model:opened`."
|
7069
7097
|
},
|
7070
|
-
"VList/selected": {
|
7071
|
-
"type": "unknown\n",
|
7072
|
-
"description": "An array containing the values of currently selected items. Can be two-way bound with `v-model:selected`."
|
7073
|
-
},
|
7074
|
-
"VList/mandatory": {
|
7075
|
-
"type": "boolean\n",
|
7076
|
-
"description": "Forces at least one item to always be selected (if available)."
|
7077
|
-
},
|
7078
7098
|
"VList/active-strategy": {
|
7079
7099
|
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/activeStrategies.ts#L27-L31\" target=\"_blank\">ActiveStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/activeStrategies.ts#L27-L31\" target=\"_blank\">ActiveStrategy</a>)\n",
|
7080
7100
|
"description": "Affects how items with children behave when activated.\n- **leaf:** Only leaf nodes (items without children) can be activated.\n- **independent:** All nodes can be activated whether they have children or not.\n- **classic:** Activating a parent node will cause all children to be activated."
|
7081
7101
|
},
|
7082
|
-
"VList/select-strategy": {
|
7083
|
-
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | 'classic'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>)\n",
|
7084
|
-
"description": "Affects how items with children behave when selected.\n- **leaf:** Only leaf nodes (items without children) can be selected.\n- **independent:** All nodes can be selected whether they have children or not.\n- **classic:** Selecting a parent node will cause all children to be selected, parent nodes will be displayed as selected if all their descendants are selected. Only leaf nodes will be added to the model."
|
7085
|
-
},
|
7086
7102
|
"VList/open-strategy": {
|
7087
|
-
"type": "'
|
7103
|
+
"type": "'multiple' | 'single' | 'list' | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/openStrategies.ts#L20-L23\" target=\"_blank\">OpenStrategy</a>\n",
|
7088
7104
|
"description": "Affects how items with children behave when expanded.\n- **multiple:** Any number of groups can be open at once.\n- **single:** Only one group at each level can be open, opening a group will cause others to close.\n- **list:** Multiple, but all other groups will close when an item is selected."
|
7089
7105
|
},
|
7090
7106
|
"VList/item-type": {
|
7091
7107
|
"type": "string\n",
|
7092
7108
|
"description": "Designates the key on the supplied items that is used for determining the nodes type."
|
7093
7109
|
},
|
7094
|
-
"VList/items": {
|
7095
|
-
"type": "any[]\n",
|
7096
|
-
"description": "Can be an array of objects or strings. By default objects should have a **title** property, and can optionally have a **props** property containing any [VListItem props](/api/v-list-item/#props), a **value** property to allow selection, and a **children** property containing more item objects. Keys to use for these can be changed with the **item-title**, **item-value**, **item-props**, and **item-children** props."
|
7097
|
-
},
|
7098
7110
|
"VList/item-title": {
|
7099
7111
|
"type": "SelectItemKey<any>\n",
|
7100
7112
|
"description": "Property on supplied `items` that contains its title."
|
7101
7113
|
},
|
7102
|
-
"VList/item-value": {
|
7103
|
-
"type": "SelectItemKey<any>\n",
|
7104
|
-
"description": "Property on supplied `items` that contains its value."
|
7105
|
-
},
|
7106
7114
|
"VList/item-children": {
|
7107
7115
|
"type": "SelectItemKey<any>\n",
|
7108
7116
|
"description": "Property on supplied `items` that contains its children."
|
@@ -7111,45 +7119,25 @@
|
|
7111
7119
|
"type": "SelectItemKey<any>\n",
|
7112
7120
|
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
|
7113
7121
|
},
|
7114
|
-
"VList/return-object": {
|
7115
|
-
"type": "boolean\n",
|
7116
|
-
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
7117
|
-
},
|
7118
|
-
"VList/value-comparator": {
|
7119
|
-
"type": "(a: any, b: any) => boolean\n",
|
7120
|
-
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
7121
|
-
},
|
7122
|
-
"VListGroup/tag": {
|
7123
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
7124
|
-
"description": "Specify a custom tag used on the root element."
|
7125
|
-
},
|
7126
7122
|
"VListGroup/title": {
|
7127
7123
|
"type": "string\n",
|
7128
7124
|
"description": "Specify a title text for the component."
|
7129
7125
|
},
|
7130
|
-
"VListGroup/
|
7131
|
-
"type": "any\n",
|
7132
|
-
"description": "
|
7126
|
+
"VListGroup/tag": {
|
7127
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
7128
|
+
"description": "Specify a custom tag used on the root element."
|
7133
7129
|
},
|
7134
|
-
"VListGroup/
|
7130
|
+
"VListGroup/color": {
|
7135
7131
|
"type": "string\n",
|
7136
|
-
"description": "
|
7132
|
+
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
7137
7133
|
},
|
7138
7134
|
"VListGroup/base-color": {
|
7139
7135
|
"type": "string\n",
|
7140
7136
|
"description": "Sets the color of component when not focused."
|
7141
7137
|
},
|
7142
|
-
"VListGroup/
|
7143
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7144
|
-
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
7145
|
-
},
|
7146
|
-
"VListGroup/append-icon": {
|
7147
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7148
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
7149
|
-
},
|
7150
|
-
"VListGroup/color": {
|
7138
|
+
"VListGroup/active-color": {
|
7151
7139
|
"type": "string\n",
|
7152
|
-
"description": "
|
7140
|
+
"description": "The applied color when the component is in an active state."
|
7153
7141
|
},
|
7154
7142
|
"VListGroup/expand-icon": {
|
7155
7143
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
@@ -7159,6 +7147,18 @@
|
|
7159
7147
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7160
7148
|
"description": "Icon to display when the list item is expanded."
|
7161
7149
|
},
|
7150
|
+
"VListGroup/value": {
|
7151
|
+
"type": "any\n",
|
7152
|
+
"description": "Expands / Collapse the list-group."
|
7153
|
+
},
|
7154
|
+
"VListGroup/append-icon": {
|
7155
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7156
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
7157
|
+
},
|
7158
|
+
"VListGroup/prepend-icon": {
|
7159
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7160
|
+
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
7161
|
+
},
|
7162
7162
|
"VListGroup/fluid": {
|
7163
7163
|
"type": "boolean\n",
|
7164
7164
|
"description": "Removes the left padding assigned for action icons from group items."
|
@@ -7171,61 +7171,17 @@
|
|
7171
7171
|
"type": "string\n",
|
7172
7172
|
"description": "Specify a custom tag used on the root element."
|
7173
7173
|
},
|
7174
|
-
"VListItem/replace": {
|
7175
|
-
"type": "boolean\n",
|
7176
|
-
"description": "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](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
|
7177
|
-
},
|
7178
|
-
"VListItem/link": {
|
7179
|
-
"type": "boolean\n",
|
7180
|
-
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
|
7181
|
-
},
|
7182
|
-
"VListItem/tag": {
|
7183
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
7184
|
-
"description": "Specify a custom tag used on the root element."
|
7185
|
-
},
|
7186
|
-
"VListItem/nav": {
|
7187
|
-
"type": "boolean\n",
|
7188
|
-
"description": "Reduces the width v-list-item takes up as well as adding a border radius."
|
7189
|
-
},
|
7190
7174
|
"VListItem/title": {
|
7191
7175
|
"type": "string | number\n",
|
7192
7176
|
"description": "Generates a `v-list-item-title` component with the supplied value. Note that this overrides the native [`title`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) attribute, that must be set with `v-bind:title.attr` instead."
|
7193
7177
|
},
|
7194
|
-
"VListItem/
|
7195
|
-
"type": "string\n",
|
7196
|
-
"description": "Specify a theme for this component and all of its children."
|
7197
|
-
},
|
7198
|
-
"VListItem/value": {
|
7199
|
-
"type": "any\n",
|
7200
|
-
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
7201
|
-
},
|
7202
|
-
"VListItem/active": {
|
7178
|
+
"VListItem/replace": {
|
7203
7179
|
"type": "boolean\n",
|
7204
|
-
"description": "
|
7205
|
-
},
|
7206
|
-
"VListItem/active-color": {
|
7207
|
-
"type": "string\n",
|
7208
|
-
"description": "The applied color when the component is in an active state."
|
7209
|
-
},
|
7210
|
-
"VListItem/base-color": {
|
7211
|
-
"type": "string\n",
|
7212
|
-
"description": "Sets the color of component when not focused."
|
7213
|
-
},
|
7214
|
-
"VListItem/prepend-icon": {
|
7215
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7216
|
-
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
7217
|
-
},
|
7218
|
-
"VListItem/append-icon": {
|
7219
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7220
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
7180
|
+
"description": "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](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
|
7221
7181
|
},
|
7222
|
-
"VListItem/
|
7182
|
+
"VListItem/link": {
|
7223
7183
|
"type": "boolean\n",
|
7224
|
-
"description": "
|
7225
|
-
},
|
7226
|
-
"VListItem/ripple": {
|
7227
|
-
"type": "boolean | { class: string }\n",
|
7228
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
7184
|
+
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
|
7229
7185
|
},
|
7230
7186
|
"VListItem/border": {
|
7231
7187
|
"type": "string | number | boolean\n",
|
@@ -7263,10 +7219,6 @@
|
|
7263
7219
|
"type": "string | number\n",
|
7264
7220
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
7265
7221
|
},
|
7266
|
-
"VListItem/disabled": {
|
7267
|
-
"type": "boolean\n",
|
7268
|
-
"description": "Removes the ability to click or target the component."
|
7269
|
-
},
|
7270
7222
|
"VListItem/rounded": {
|
7271
7223
|
"type": "string | number | boolean\n",
|
7272
7224
|
"description": "Designates the **border-radius** applied to the component. This can be **0**, **xs**, **sm**, true, **lg**, **xl**, **pill**, **circle**, and **shaped**. Find more information on available border radius classes on the [Border Radius page](/styles/border-radius)."
|
@@ -7275,37 +7227,73 @@
|
|
7275
7227
|
"type": "boolean\n",
|
7276
7228
|
"description": "Removes any applied **border-radius** from the component."
|
7277
7229
|
},
|
7278
|
-
"VListItem/
|
7230
|
+
"VListItem/tag": {
|
7231
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
7232
|
+
"description": "Specify a custom tag used on the root element."
|
7233
|
+
},
|
7234
|
+
"VListItem/theme": {
|
7279
7235
|
"type": "string\n",
|
7280
|
-
"description": "
|
7236
|
+
"description": "Specify a theme for this component and all of its children."
|
7237
|
+
},
|
7238
|
+
"VListItem/color": {
|
7239
|
+
"type": "string\n",
|
7240
|
+
"description": "Applies specified color to the control when in an **active** state or **input-value** is **true** - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors),"
|
7241
|
+
},
|
7242
|
+
"VListItem/variant": {
|
7243
|
+
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
7244
|
+
"description": "Applies a distinct style to the component."
|
7281
7245
|
},
|
7282
7246
|
"VListItem/exact": {
|
7283
7247
|
"type": "boolean\n",
|
7284
7248
|
"description": "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."
|
7285
7249
|
},
|
7286
|
-
"VListItem/
|
7287
|
-
"type": "
|
7288
|
-
"description": "
|
7250
|
+
"VListItem/subtitle": {
|
7251
|
+
"type": "string | number\n",
|
7252
|
+
"description": "Specify a subtitle text for the component."
|
7289
7253
|
},
|
7290
|
-
"VListItem/color": {
|
7254
|
+
"VListItem/base-color": {
|
7291
7255
|
"type": "string\n",
|
7292
|
-
"description": "
|
7256
|
+
"description": "Sets the color of component when not focused."
|
7293
7257
|
},
|
7294
|
-
"VListItem/
|
7295
|
-
"type": "
|
7296
|
-
"description": "
|
7258
|
+
"VListItem/active-color": {
|
7259
|
+
"type": "string\n",
|
7260
|
+
"description": "The applied color when the component is in an active state."
|
7261
|
+
},
|
7262
|
+
"VListItem/active-class": {
|
7263
|
+
"type": "string\n",
|
7264
|
+
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
|
7265
|
+
},
|
7266
|
+
"VListItem/disabled": {
|
7267
|
+
"type": "boolean\n",
|
7268
|
+
"description": "Removes the ability to click or target the component."
|
7297
7269
|
},
|
7298
7270
|
"VListItem/lines": {
|
7299
7271
|
"type": "false | 'one' | 'two' | 'three'\n",
|
7300
7272
|
"description": "The line declaration specifies the minimum height of the item and can also be controlled from v-list with the same prop."
|
7301
7273
|
},
|
7302
|
-
"VListItem/
|
7303
|
-
"type": "
|
7304
|
-
"description": "
|
7274
|
+
"VListItem/slim": {
|
7275
|
+
"type": "boolean\n",
|
7276
|
+
"description": "Reduces horizontal spacing for badges, icons, tooltips, and avatars to create a more compact visual representation."
|
7305
7277
|
},
|
7306
|
-
"VListItem/
|
7307
|
-
"type": "
|
7308
|
-
"description": "
|
7278
|
+
"VListItem/nav": {
|
7279
|
+
"type": "boolean\n",
|
7280
|
+
"description": "Reduces the width v-list-item takes up as well as adding a border radius."
|
7281
|
+
},
|
7282
|
+
"VListItem/value": {
|
7283
|
+
"type": "any\n",
|
7284
|
+
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
7285
|
+
},
|
7286
|
+
"VListItem/append-icon": {
|
7287
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7288
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
7289
|
+
},
|
7290
|
+
"VListItem/prepend-icon": {
|
7291
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
7292
|
+
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
7293
|
+
},
|
7294
|
+
"VListItem/active": {
|
7295
|
+
"type": "boolean\n",
|
7296
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
7309
7297
|
},
|
7310
7298
|
"VListItem/append-avatar": {
|
7311
7299
|
"type": "string\n",
|
@@ -7315,29 +7303,41 @@
|
|
7315
7303
|
"type": "string\n",
|
7316
7304
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
7317
7305
|
},
|
7318
|
-
"
|
7319
|
-
"type": "boolean\n",
|
7320
|
-
"description": "Applies
|
7306
|
+
"VListItem/ripple": {
|
7307
|
+
"type": "boolean | { class: string }\n",
|
7308
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
7309
|
+
},
|
7310
|
+
"VListItem/href": {
|
7311
|
+
"type": "string\n",
|
7312
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
7313
|
+
},
|
7314
|
+
"VListItem/to": {
|
7315
|
+
"type": "RouteLocationRaw\n",
|
7316
|
+
"description": "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."
|
7317
|
+
},
|
7318
|
+
"VListItemAction/tag": {
|
7319
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
7320
|
+
"description": "Specify a custom tag used on the root element."
|
7321
7321
|
},
|
7322
7322
|
"VListItemAction/start": {
|
7323
7323
|
"type": "boolean\n",
|
7324
|
-
"description": "Applies margin at the end of the component."
|
7324
|
+
"description": "Applies margin at the end of the component."
|
7325
|
+
},
|
7326
|
+
"VListItemAction/end": {
|
7327
|
+
"type": "boolean\n",
|
7328
|
+
"description": "Applies margin at the start of the component."
|
7325
7329
|
},
|
7326
|
-
"
|
7330
|
+
"VListItemMedia/tag": {
|
7327
7331
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
7328
7332
|
"description": "Specify a custom tag used on the root element."
|
7329
7333
|
},
|
7330
|
-
"VListItemMedia/end": {
|
7331
|
-
"type": "boolean\n",
|
7332
|
-
"description": "Applies margin at the start of the component."
|
7333
|
-
},
|
7334
7334
|
"VListItemMedia/start": {
|
7335
7335
|
"type": "boolean\n",
|
7336
7336
|
"description": "Applies margin at the end of the component."
|
7337
7337
|
},
|
7338
|
-
"VListItemMedia/
|
7339
|
-
"type": "
|
7340
|
-
"description": "
|
7338
|
+
"VListItemMedia/end": {
|
7339
|
+
"type": "boolean\n",
|
7340
|
+
"description": "Applies margin at the start of the component."
|
7341
7341
|
},
|
7342
7342
|
"VListItemSubtitle/tag": {
|
7343
7343
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
@@ -7351,6 +7351,10 @@
|
|
7351
7351
|
"type": "string\n",
|
7352
7352
|
"description": "Specify a custom tag used on the root element."
|
7353
7353
|
},
|
7354
|
+
"VListSubheader/tag": {
|
7355
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
7356
|
+
"description": "Specify a custom tag used on the root element."
|
7357
|
+
},
|
7354
7358
|
"VListSubheader/title": {
|
7355
7359
|
"type": "string\n",
|
7356
7360
|
"description": "Specify a title text for the component."
|
@@ -7359,10 +7363,6 @@
|
|
7359
7363
|
"type": "boolean\n",
|
7360
7364
|
"description": "Sticks the header to the top of the table."
|
7361
7365
|
},
|
7362
|
-
"VListSubheader/tag": {
|
7363
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
7364
|
-
"description": "Specify a custom tag used on the root element."
|
7365
|
-
},
|
7366
7366
|
"VListSubheader/color": {
|
7367
7367
|
"type": "string\n",
|
7368
7368
|
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
@@ -7923,6 +7923,10 @@
|
|
7923
7923
|
"type": "number\n",
|
7924
7924
|
"description": "Specifies the minimum allowable value for the input."
|
7925
7925
|
},
|
7926
|
+
"VNumberInput/inset": {
|
7927
|
+
"type": "boolean\n",
|
7928
|
+
"description": "Applies an indentation to the dividers used in the stepper buttons."
|
7929
|
+
},
|
7926
7930
|
"VNumberInput/hide-input": {
|
7927
7931
|
"type": "boolean\n",
|
7928
7932
|
"description": "Hide the input field."
|
@@ -7931,10 +7935,6 @@
|
|
7931
7935
|
"type": "number\n",
|
7932
7936
|
"description": "Defines the interval between allowed values when the user increments or decrements the input"
|
7933
7937
|
},
|
7934
|
-
"VNumberInput/inset": {
|
7935
|
-
"type": "boolean\n",
|
7936
|
-
"description": "Applies an indentation to the dividers used in the stepper buttons."
|
7937
|
-
},
|
7938
7938
|
"VNumberInput/control-variant": {
|
7939
7939
|
"type": "'default' | 'split' | 'stacked'\n",
|
7940
7940
|
"description": "The color of the control. It defaults to the value of `variant` prop."
|
@@ -8019,6 +8019,10 @@
|
|
8019
8019
|
"type": "string\n",
|
8020
8020
|
"description": "Specifies the dividing character between items."
|
8021
8021
|
},
|
8022
|
+
"VOtpInput/focused": {
|
8023
|
+
"type": "boolean\n",
|
8024
|
+
"description": "Forces a focused state styling on the component."
|
8025
|
+
},
|
8022
8026
|
"VOtpInput/autofocus": {
|
8023
8027
|
"type": "boolean\n",
|
8024
8028
|
"description": "Automatically focuses the first input on page load"
|
@@ -8027,10 +8031,6 @@
|
|
8027
8031
|
"type": "string\n",
|
8028
8032
|
"description": "Sets the input’s placeholder text."
|
8029
8033
|
},
|
8030
|
-
"VOtpInput/focused": {
|
8031
|
-
"type": "boolean\n",
|
8032
|
-
"description": "Forces a focused state styling on the component."
|
8033
|
-
},
|
8034
8034
|
"VOtpInput/focus-all": {
|
8035
8035
|
"type": "boolean\n",
|
8036
8036
|
"description": "Puts all inputs into a focus state when any are focused"
|
@@ -8699,6 +8699,10 @@
|
|
8699
8699
|
"type": "(a: any, b: any) => boolean\n",
|
8700
8700
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
8701
8701
|
},
|
8702
|
+
"VRadioGroup/focused": {
|
8703
|
+
"type": "boolean\n",
|
8704
|
+
"description": "Forces a focused state styling on the component."
|
8705
|
+
},
|
8702
8706
|
"VRadioGroup/center-affix": {
|
8703
8707
|
"type": "boolean\n",
|
8704
8708
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
@@ -8739,10 +8743,6 @@
|
|
8739
8743
|
"type": "any\n",
|
8740
8744
|
"description": "The value used when applying validation rules."
|
8741
8745
|
},
|
8742
|
-
"VRadioGroup/focused": {
|
8743
|
-
"type": "boolean\n",
|
8744
|
-
"description": "Forces a focused state styling on the component."
|
8745
|
-
},
|
8746
8746
|
"VRadioGroup/hide-details": {
|
8747
8747
|
"type": "boolean | 'auto'\n",
|
8748
8748
|
"description": "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."
|
@@ -8843,6 +8843,10 @@
|
|
8843
8843
|
"type": "'horizontal' | 'vertical'\n",
|
8844
8844
|
"description": "Changes the direction of the input."
|
8845
8845
|
},
|
8846
|
+
"VRangeSlider/focused": {
|
8847
|
+
"type": "boolean\n",
|
8848
|
+
"description": "Forces a focused state styling on the component."
|
8849
|
+
},
|
8846
8850
|
"VRangeSlider/center-affix": {
|
8847
8851
|
"type": "boolean\n",
|
8848
8852
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
@@ -8883,10 +8887,6 @@
|
|
8883
8887
|
"type": "any\n",
|
8884
8888
|
"description": "The value used when applying validation rules."
|
8885
8889
|
},
|
8886
|
-
"VRangeSlider/focused": {
|
8887
|
-
"type": "boolean\n",
|
8888
|
-
"description": "Forces a focused state styling on the component."
|
8889
|
-
},
|
8890
8890
|
"VRangeSlider/hide-details": {
|
8891
8891
|
"type": "boolean | 'auto'\n",
|
8892
8892
|
"description": "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."
|
@@ -9387,73 +9387,25 @@
|
|
9387
9387
|
"type": "(a: any, b: any) => boolean\n",
|
9388
9388
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
9389
9389
|
},
|
9390
|
-
"VSelect/chips": {
|
9391
|
-
"type": "boolean\n",
|
9392
|
-
"description": "Changes display of selections to chips."
|
9393
|
-
},
|
9394
|
-
"VSelect/closable-chips": {
|
9395
|
-
"type": "boolean\n",
|
9396
|
-
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
|
9397
|
-
},
|
9398
|
-
"VSelect/close-text": {
|
9399
|
-
"type": "string\n",
|
9400
|
-
"description": "Text set to to the inputs `aria-label` and `title` when input menu is closed."
|
9401
|
-
},
|
9402
|
-
"VSelect/open-text": {
|
9403
|
-
"type": "string\n",
|
9404
|
-
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
|
9405
|
-
},
|
9406
|
-
"VSelect/hide-no-data": {
|
9407
|
-
"type": "boolean\n",
|
9408
|
-
"description": "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."
|
9409
|
-
},
|
9410
|
-
"VSelect/hide-selected": {
|
9411
|
-
"type": "boolean\n",
|
9412
|
-
"description": "Do not display in the select menu items that are already selected."
|
9413
|
-
},
|
9414
|
-
"VSelect/list-props": {
|
9415
|
-
"type": "unknown\n",
|
9416
|
-
"description": "Pass props through to the `v-list` component. Accepts an object with anything from [v-list](/api/v-list/#props) props, camelCase keys are recommended."
|
9417
|
-
},
|
9418
|
-
"VSelect/item-title": {
|
9419
|
-
"type": "SelectItemKey<any>\n",
|
9420
|
-
"description": "Property on supplied `items` that contains its title."
|
9421
|
-
},
|
9422
9390
|
"VSelect/item-value": {
|
9423
9391
|
"type": "SelectItemKey<any>\n",
|
9424
9392
|
"description": "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)."
|
9425
9393
|
},
|
9426
|
-
"VSelect/item-children": {
|
9427
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
9428
|
-
"description": "This property currently has **no effect**."
|
9429
|
-
},
|
9430
|
-
"VSelect/item-props": {
|
9431
|
-
"type": "SelectItemKey<any>\n",
|
9432
|
-
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
|
9433
|
-
},
|
9434
9394
|
"VSelect/return-object": {
|
9435
9395
|
"type": "boolean\n",
|
9436
9396
|
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
9437
9397
|
},
|
9438
|
-
"VSelect/
|
9439
|
-
"type": "
|
9440
|
-
"description": "
|
9441
|
-
},
|
9442
|
-
"VSelect/menu-props": {
|
9443
|
-
"type": "unknown\n",
|
9444
|
-
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
|
9398
|
+
"VSelect/hide-no-data": {
|
9399
|
+
"type": "boolean\n",
|
9400
|
+
"description": "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."
|
9445
9401
|
},
|
9446
9402
|
"VSelect/no-data-text": {
|
9447
9403
|
"type": "string\n",
|
9448
9404
|
"description": "Text shown when no items are provided to the component."
|
9449
9405
|
},
|
9450
|
-
"VSelect/
|
9406
|
+
"VSelect/focused": {
|
9451
9407
|
"type": "boolean\n",
|
9452
|
-
"description": "
|
9453
|
-
},
|
9454
|
-
"VSelect/item-color": {
|
9455
|
-
"type": "string\n",
|
9456
|
-
"description": "Sets color of selected items."
|
9408
|
+
"description": "Forces a focused state styling on the component."
|
9457
9409
|
},
|
9458
9410
|
"VSelect/autofocus": {
|
9459
9411
|
"type": "boolean\n",
|
@@ -9515,10 +9467,6 @@
|
|
9515
9467
|
"type": " | 'eager'\n | 'lazy'\n | 'blur'\n | 'input'\n | 'submit'\n | 'invalid-input'\n | 'blur lazy'\n | 'input lazy'\n | 'submit lazy'\n | 'invalid-input lazy'\n | 'blur eager'\n | 'input eager'\n | 'submit eager'\n | 'invalid-input eager'\n | 'lazy blur'\n | 'lazy input'\n | 'lazy submit'\n | 'lazy invalid-input'\n | 'eager blur'\n | 'eager input'\n | 'eager submit'\n | 'eager invalid-input'\n",
|
9516
9468
|
"description": "Change what type of event triggers validation to run."
|
9517
9469
|
},
|
9518
|
-
"VSelect/focused": {
|
9519
|
-
"type": "boolean\n",
|
9520
|
-
"description": "Forces a focused state styling on the component."
|
9521
|
-
},
|
9522
9470
|
"VSelect/hide-details": {
|
9523
9471
|
"type": "boolean | 'auto'\n",
|
9524
9472
|
"description": "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."
|
@@ -9551,6 +9499,58 @@
|
|
9551
9499
|
"type": "unknown\n",
|
9552
9500
|
"description": "**FOR INTERNAL USE ONLY**"
|
9553
9501
|
},
|
9502
|
+
"VSelect/item-title": {
|
9503
|
+
"type": "SelectItemKey<any>\n",
|
9504
|
+
"description": "Property on supplied `items` that contains its title."
|
9505
|
+
},
|
9506
|
+
"VSelect/item-children": {
|
9507
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
9508
|
+
"description": "This property currently has **no effect**."
|
9509
|
+
},
|
9510
|
+
"VSelect/item-props": {
|
9511
|
+
"type": "SelectItemKey<any>\n",
|
9512
|
+
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
|
9513
|
+
},
|
9514
|
+
"VSelect/chips": {
|
9515
|
+
"type": "boolean\n",
|
9516
|
+
"description": "Changes display of selections to chips."
|
9517
|
+
},
|
9518
|
+
"VSelect/closable-chips": {
|
9519
|
+
"type": "boolean\n",
|
9520
|
+
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
|
9521
|
+
},
|
9522
|
+
"VSelect/close-text": {
|
9523
|
+
"type": "string\n",
|
9524
|
+
"description": "Text set to to the inputs `aria-label` and `title` when input menu is closed."
|
9525
|
+
},
|
9526
|
+
"VSelect/open-text": {
|
9527
|
+
"type": "string\n",
|
9528
|
+
"description": "Text set to to the inputs **aria-label** and **title** when input menu is open."
|
9529
|
+
},
|
9530
|
+
"VSelect/hide-selected": {
|
9531
|
+
"type": "boolean\n",
|
9532
|
+
"description": "Do not display in the select menu items that are already selected."
|
9533
|
+
},
|
9534
|
+
"VSelect/list-props": {
|
9535
|
+
"type": "unknown\n",
|
9536
|
+
"description": "Pass props through to the `v-list` component. Accepts an object with anything from [v-list](/api/v-list/#props) props, camelCase keys are recommended."
|
9537
|
+
},
|
9538
|
+
"VSelect/menu-icon": {
|
9539
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
9540
|
+
"description": "Sets the the spin icon."
|
9541
|
+
},
|
9542
|
+
"VSelect/menu-props": {
|
9543
|
+
"type": "unknown\n",
|
9544
|
+
"description": "Pass props through to the `v-menu` component. Accepts an object with anything from [v-menu](/api/v-menu/#props) props, camelCase keys are recommended."
|
9545
|
+
},
|
9546
|
+
"VSelect/open-on-clear": {
|
9547
|
+
"type": "boolean\n",
|
9548
|
+
"description": "When using the **clearable** prop, once cleared, the select menu will either open or stay open, depending on the current state."
|
9549
|
+
},
|
9550
|
+
"VSelect/item-color": {
|
9551
|
+
"type": "string\n",
|
9552
|
+
"description": "Sets color of selected items."
|
9553
|
+
},
|
9554
9554
|
"VSelectionControl/type": {
|
9555
9555
|
"type": "string\n",
|
9556
9556
|
"description": "Provides the default type for children selection controls."
|
@@ -10079,6 +10079,10 @@
|
|
10079
10079
|
"type": "'horizontal' | 'vertical'\n",
|
10080
10080
|
"description": "Changes the direction of the input."
|
10081
10081
|
},
|
10082
|
+
"VSlider/focused": {
|
10083
|
+
"type": "boolean\n",
|
10084
|
+
"description": "Forces a focused state styling on the component."
|
10085
|
+
},
|
10082
10086
|
"VSlider/center-affix": {
|
10083
10087
|
"type": "boolean\n",
|
10084
10088
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
@@ -10119,10 +10123,6 @@
|
|
10119
10123
|
"type": "any\n",
|
10120
10124
|
"description": "The value used when applying validation rules."
|
10121
10125
|
},
|
10122
|
-
"VSlider/focused": {
|
10123
|
-
"type": "boolean\n",
|
10124
|
-
"description": "Forces a focused state styling on the component."
|
10125
|
-
},
|
10126
10126
|
"VSlider/hide-details": {
|
10127
10127
|
"type": "boolean | 'auto'\n",
|
10128
10128
|
"description": "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."
|
@@ -10855,10 +10855,6 @@
|
|
10855
10855
|
"type": "boolean | 'force'\n",
|
10856
10856
|
"description": "Forces at least one item to always be selected (if available)."
|
10857
10857
|
},
|
10858
|
-
"VStepper/item-title": {
|
10859
|
-
"type": "string\n",
|
10860
|
-
"description": "Property on supplied `items` that contains its title."
|
10861
|
-
},
|
10862
10858
|
"VStepper/item-value": {
|
10863
10859
|
"type": "string\n",
|
10864
10860
|
"description": "Property on supplied `items` that contains its value."
|
@@ -10867,6 +10863,10 @@
|
|
10867
10863
|
"type": "boolean\n",
|
10868
10864
|
"description": "Hide actions bar (prev and next buttons)."
|
10869
10865
|
},
|
10866
|
+
"VStepper/item-title": {
|
10867
|
+
"type": "string\n",
|
10868
|
+
"description": "Property on supplied `items` that contains its title."
|
10869
|
+
},
|
10870
10870
|
"VStepper/alt-labels": {
|
10871
10871
|
"type": "boolean\n",
|
10872
10872
|
"description": "Places the labels beneath the step."
|
@@ -11063,18 +11063,6 @@
|
|
11063
11063
|
"type": "boolean\n",
|
11064
11064
|
"description": "Forces the component's content to render when it mounts. This is useful if you have content that will not be rendered in the DOM that you want crawled for SEO."
|
11065
11065
|
},
|
11066
|
-
"VStepperVertical/expand-icon": {
|
11067
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11068
|
-
"description": "Icon used when the expansion panel is in a expandable state."
|
11069
|
-
},
|
11070
|
-
"VStepperVertical/collapse-icon": {
|
11071
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11072
|
-
"description": "Icon used when the expansion panel is in a collapsable state."
|
11073
|
-
},
|
11074
|
-
"VStepperVertical/item-title": {
|
11075
|
-
"type": "string\n",
|
11076
|
-
"description": "Property on supplied `items` that contains its title."
|
11077
|
-
},
|
11078
11066
|
"VStepperVertical/item-value": {
|
11079
11067
|
"type": "string\n",
|
11080
11068
|
"description": "Property on supplied `items` that contains its value."
|
@@ -11083,10 +11071,22 @@
|
|
11083
11071
|
"type": "boolean\n",
|
11084
11072
|
"description": "Hide actions bar (prev and next buttons)."
|
11085
11073
|
},
|
11074
|
+
"VStepperVertical/expand-icon": {
|
11075
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11076
|
+
"description": "Icon used when the expansion panel is in a expandable state."
|
11077
|
+
},
|
11078
|
+
"VStepperVertical/collapse-icon": {
|
11079
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11080
|
+
"description": "Icon used when the expansion panel is in a collapsable state."
|
11081
|
+
},
|
11086
11082
|
"VStepperVertical/focusable": {
|
11087
11083
|
"type": "boolean\n",
|
11088
11084
|
"description": "Makes the expansion-panel headers focusable."
|
11089
11085
|
},
|
11086
|
+
"VStepperVertical/item-title": {
|
11087
|
+
"type": "string\n",
|
11088
|
+
"description": "Property on supplied `items` that contains its title."
|
11089
|
+
},
|
11090
11090
|
"VStepperVertical/alt-labels": {
|
11091
11091
|
"type": "boolean\n",
|
11092
11092
|
"description": "Places the labels beneath the step."
|
@@ -11231,6 +11231,14 @@
|
|
11231
11231
|
"type": "string\n",
|
11232
11232
|
"description": "Specify a subtitle text for the component."
|
11233
11233
|
},
|
11234
|
+
"VStepperVerticalItem/hide-actions": {
|
11235
|
+
"type": "boolean\n",
|
11236
|
+
"description": "Hide the expand icon in the content title."
|
11237
|
+
},
|
11238
|
+
"VStepperVerticalItem/rules": {
|
11239
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VStepper/VStepperItem.tsx#L43-L43\" target=\"_blank\">ValidationRule</a>[]\n",
|
11240
|
+
"description": "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`."
|
11241
|
+
},
|
11234
11242
|
"VStepperVerticalItem/expand-icon": {
|
11235
11243
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11236
11244
|
"description": "Icon used when the expansion panel is in a expandable state."
|
@@ -11239,14 +11247,6 @@
|
|
11239
11247
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
11240
11248
|
"description": "Icon used when the expansion panel is in a collapsable state."
|
11241
11249
|
},
|
11242
|
-
"VStepperVerticalItem/rules": {
|
11243
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VStepper/VStepperItem.tsx#L43-L43\" target=\"_blank\">ValidationRule</a>[]\n",
|
11244
|
-
"description": "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`."
|
11245
|
-
},
|
11246
|
-
"VStepperVerticalItem/hide-actions": {
|
11247
|
-
"type": "boolean\n",
|
11248
|
-
"description": "Hide the expand icon in the content title."
|
11249
|
-
},
|
11250
11250
|
"VStepperVerticalItem/focusable": {
|
11251
11251
|
"type": "boolean\n",
|
11252
11252
|
"description": "Makes the expansion panel content focusable."
|
@@ -11459,6 +11459,10 @@
|
|
11459
11459
|
"type": "(a: any, b: any) => boolean\n",
|
11460
11460
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
11461
11461
|
},
|
11462
|
+
"VSwitch/focused": {
|
11463
|
+
"type": "boolean\n",
|
11464
|
+
"description": "Forces a focused state styling on the component."
|
11465
|
+
},
|
11462
11466
|
"VSwitch/center-affix": {
|
11463
11467
|
"type": "boolean\n",
|
11464
11468
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
@@ -11499,10 +11503,6 @@
|
|
11499
11503
|
"type": "any\n",
|
11500
11504
|
"description": "The value used when applying validation rules."
|
11501
11505
|
},
|
11502
|
-
"VSwitch/focused": {
|
11503
|
-
"type": "boolean\n",
|
11504
|
-
"description": "Forces a focused state styling on the component."
|
11505
|
-
},
|
11506
11506
|
"VSwitch/hide-details": {
|
11507
11507
|
"type": "boolean | 'auto'\n",
|
11508
11508
|
"description": "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."
|
@@ -11999,6 +11999,10 @@
|
|
11999
11999
|
"type": "'horizontal' | 'vertical'\n",
|
12000
12000
|
"description": "Changes the direction of the input."
|
12001
12001
|
},
|
12002
|
+
"VTextField/focused": {
|
12003
|
+
"type": "boolean\n",
|
12004
|
+
"description": "Forces a focused state styling on the component."
|
12005
|
+
},
|
12002
12006
|
"VTextField/autofocus": {
|
12003
12007
|
"type": "boolean\n",
|
12004
12008
|
"description": "Enables autofocus."
|
@@ -12063,10 +12067,6 @@
|
|
12063
12067
|
"type": "any\n",
|
12064
12068
|
"description": "The value used when applying validation rules."
|
12065
12069
|
},
|
12066
|
-
"VTextField/focused": {
|
12067
|
-
"type": "boolean\n",
|
12068
|
-
"description": "Forces a focused state styling on the component."
|
12069
|
-
},
|
12070
12070
|
"VTextField/hide-details": {
|
12071
12071
|
"type": "boolean | 'auto'\n",
|
12072
12072
|
"description": "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."
|
@@ -12211,6 +12211,10 @@
|
|
12211
12211
|
"type": "'horizontal' | 'vertical'\n",
|
12212
12212
|
"description": "Changes the direction of the input."
|
12213
12213
|
},
|
12214
|
+
"VTextarea/focused": {
|
12215
|
+
"type": "boolean\n",
|
12216
|
+
"description": "Forces a focused state styling on the component."
|
12217
|
+
},
|
12214
12218
|
"VTextarea/autofocus": {
|
12215
12219
|
"type": "boolean\n",
|
12216
12220
|
"description": "The element should be focused as soon as the page loads."
|
@@ -12275,10 +12279,6 @@
|
|
12275
12279
|
"type": "any\n",
|
12276
12280
|
"description": "The value used when applying validation rules."
|
12277
12281
|
},
|
12278
|
-
"VTextarea/focused": {
|
12279
|
-
"type": "boolean\n",
|
12280
|
-
"description": "Forces a focused state styling on the component."
|
12281
|
-
},
|
12282
12282
|
"VTextarea/hide-details": {
|
12283
12283
|
"type": "boolean | 'auto'\n",
|
12284
12284
|
"description": "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."
|
@@ -12599,6 +12599,10 @@
|
|
12599
12599
|
"type": "'start' | 'center'\n",
|
12600
12600
|
"description": "Places the timeline dot at the top or center of the timeline item."
|
12601
12601
|
},
|
12602
|
+
"VTimeline/side": {
|
12603
|
+
"type": "'start' | 'end'\n",
|
12604
|
+
"description": "Display all timeline items on one side of the timeline, either **start** or **end**."
|
12605
|
+
},
|
12602
12606
|
"VTimeline/justify": {
|
12603
12607
|
"type": "string\n",
|
12604
12608
|
"description": "Places timeline line at the center or automatically on the left or right side."
|
@@ -12631,10 +12635,6 @@
|
|
12631
12635
|
"type": "string | number\n",
|
12632
12636
|
"description": "Specifies the distance between the line and the dot of timeline items."
|
12633
12637
|
},
|
12634
|
-
"VTimeline/side": {
|
12635
|
-
"type": "'start' | 'end'\n",
|
12636
|
-
"description": "Display all timeline items on one side of the timeline, either **before** or **after**."
|
12637
|
-
},
|
12638
12638
|
"VTimeline/truncate-line": {
|
12639
12639
|
"type": "'start' | 'end' | 'both'\n",
|
12640
12640
|
"description": "Truncate timeline directly at the **start** or **end** of the line, or on **both** ends."
|
@@ -12691,6 +12691,10 @@
|
|
12691
12691
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
12692
12692
|
"description": "Apply a specific icon to the inside dot using the [v-icon](/components/icons/) component."
|
12693
12693
|
},
|
12694
|
+
"VTimelineItem/side": {
|
12695
|
+
"type": "'start' | 'end'\n",
|
12696
|
+
"description": "Display the item on one side of the timeline, either **start** or **end**. This will override the implicit ordering of items, unless `v-timeline` has it's own **side** prop defined."
|
12697
|
+
},
|
12694
12698
|
"VTimelineItem/dot-color": {
|
12695
12699
|
"type": "string\n",
|
12696
12700
|
"description": "Color of the item dot."
|
@@ -13075,6 +13079,18 @@
|
|
13075
13079
|
"type": "(a: any, b: any) => boolean\n",
|
13076
13080
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
13077
13081
|
},
|
13082
|
+
"VTreeview/item-value": {
|
13083
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13084
|
+
"description": "Property on supplied `items` that contains its value."
|
13085
|
+
},
|
13086
|
+
"VTreeview/return-object": {
|
13087
|
+
"type": "boolean\n",
|
13088
|
+
"description": "When `true` will make `v-model`, `active.sync` and `open.sync` return the complete object instead of just the key."
|
13089
|
+
},
|
13090
|
+
"VTreeview/select-strategy": {
|
13091
|
+
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | 'classic'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>)\n",
|
13092
|
+
"description": "Affects how items with children behave when selected.\n- **leaf:** Only leaf nodes (items without children) can be selected.\n- **independent:** All nodes can be selected whether they have children or not.\n- **classic:** Selecting a parent node will cause all children to be selected, parent nodes will be displayed as selected if all their descendants are selected. Only leaf nodes will be added to the model."
|
13093
|
+
},
|
13078
13094
|
"VTreeview/filter-mode": {
|
13079
13095
|
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
13080
13096
|
"description": "Controls how the results of `customFilter` and `customKeyFilter` are combined. All modes only apply `customFilter` to columns not specified in `customKeyFilter`.\n\n- **some**: There is at least one match from either the custom filter or the custom key filter.\n- **every**: All columns match either the custom filter or the custom key filter.\n- **union**: There is at least one match from the custom filter, or all columns match the custom key filters.\n- **intersection**: There is at least one match from the custom filter, and all columns match the custom key filters."
|
@@ -13119,18 +13135,10 @@
|
|
13119
13135
|
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/activeStrategies.ts#L27-L31\" target=\"_blank\">ActiveStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/activeStrategies.ts#L27-L31\" target=\"_blank\">ActiveStrategy</a>)\n",
|
13120
13136
|
"description": "Affects how items with children behave when activated.\n- **leaf:** Only leaf nodes (items without children) can be activated.\n- **independent:** All nodes can be activated whether they have children or not.\n- **classic:** Activating a parent node will cause all children to be activated."
|
13121
13137
|
},
|
13122
|
-
"VTreeview/select-strategy": {
|
13123
|
-
"type": " | 'single-leaf'\n | 'leaf'\n | 'independent'\n | 'single-independent'\n | 'classic'\n | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>\n | ((mandatory: boolean) => <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/nested/selectStrategies.ts#L26-L30\" target=\"_blank\">SelectStrategy</a>)\n",
|
13124
|
-
"description": "Affects how items with children behave when selected.\n- **leaf:** Only leaf nodes (items without children) can be selected.\n- **independent:** All nodes can be selected whether they have children or not.\n- **classic:** Selecting a parent node will cause all children to be selected, parent nodes will be displayed as selected if all their descendants are selected. Only leaf nodes will be added to the model."
|
13125
|
-
},
|
13126
13138
|
"VTreeview/item-title": {
|
13127
13139
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13128
13140
|
"description": "Property on supplied `items` that contains its title."
|
13129
13141
|
},
|
13130
|
-
"VTreeview/item-value": {
|
13131
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13132
|
-
"description": "Property on supplied `items` that contains its value."
|
13133
|
-
},
|
13134
13142
|
"VTreeview/item-children": {
|
13135
13143
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13136
13144
|
"description": "Property on supplied `items` that contains its children."
|
@@ -13139,10 +13147,6 @@
|
|
13139
13147
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13140
13148
|
"description": "Props object that will be applied to each item component. `true` will treat the original object as raw props and pass it directly to the component."
|
13141
13149
|
},
|
13142
|
-
"VTreeview/return-object": {
|
13143
|
-
"type": "boolean\n",
|
13144
|
-
"description": "When `true` will make `v-model`, `active.sync` and `open.sync` return the complete object instead of just the key."
|
13145
|
-
},
|
13146
13150
|
"VTreeview/open-all": {
|
13147
13151
|
"type": "boolean\n",
|
13148
13152
|
"description": "When `true` will cause all branch nodes to be opened when component is mounted."
|
@@ -13159,25 +13163,41 @@
|
|
13159
13163
|
"type": "(item: unknown) => Promise<void>\n",
|
13160
13164
|
"description": "A function used when dynamically loading children. If this prop is set, then the supplied function will be run if expanding an item that has a `item-children` property that is an empty array. Supports returning a Promise."
|
13161
13165
|
},
|
13166
|
+
"VTreeviewGroup/tag": {
|
13167
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
13168
|
+
"description": "Specify a custom tag used on the root element."
|
13169
|
+
},
|
13162
13170
|
"VTreeviewGroup/title": {
|
13163
13171
|
"type": "string\n",
|
13164
13172
|
"description": "Specify a title text for the component."
|
13165
13173
|
},
|
13166
|
-
"VTreeviewGroup/
|
13167
|
-
"type": "
|
13168
|
-
"description": "
|
13174
|
+
"VTreeviewGroup/value": {
|
13175
|
+
"type": "any\n",
|
13176
|
+
"description": "Expands / Collapse the list-group."
|
13169
13177
|
},
|
13170
|
-
"VTreeviewGroup/color": {
|
13178
|
+
"VTreeviewGroup/active-color": {
|
13171
13179
|
"type": "string\n",
|
13172
|
-
"description": "
|
13180
|
+
"description": "The applied color when the component is in an active state."
|
13173
13181
|
},
|
13174
13182
|
"VTreeviewGroup/base-color": {
|
13175
13183
|
"type": "string\n",
|
13176
13184
|
"description": "Sets the color of component when not focused."
|
13177
13185
|
},
|
13178
|
-
"VTreeviewGroup/
|
13186
|
+
"VTreeviewGroup/prepend-icon": {
|
13187
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13188
|
+
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
13189
|
+
},
|
13190
|
+
"VTreeviewGroup/append-icon": {
|
13191
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13192
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
13193
|
+
},
|
13194
|
+
"VTreeviewGroup/color": {
|
13179
13195
|
"type": "string\n",
|
13180
|
-
"description": "
|
13196
|
+
"description": "Applies specified color to the control - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors)."
|
13197
|
+
},
|
13198
|
+
"VTreeviewGroup/fluid": {
|
13199
|
+
"type": "boolean\n",
|
13200
|
+
"description": "Removes viewport maximum-width size breakpoints."
|
13181
13201
|
},
|
13182
13202
|
"VTreeviewGroup/expand-icon": {
|
13183
13203
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
@@ -13187,33 +13207,61 @@
|
|
13187
13207
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13188
13208
|
"description": "Icon to display when the list item is expanded."
|
13189
13209
|
},
|
13190
|
-
"
|
13191
|
-
"type": "
|
13192
|
-
"description": "
|
13210
|
+
"VTreeviewItem/replace": {
|
13211
|
+
"type": "boolean\n",
|
13212
|
+
"description": "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](https://router.vuejs.org/api/#replace) prop on the vue-router documentation."
|
13193
13213
|
},
|
13194
|
-
"
|
13195
|
-
"type": "
|
13196
|
-
"description": "
|
13214
|
+
"VTreeviewItem/link": {
|
13215
|
+
"type": "boolean\n",
|
13216
|
+
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
|
13197
13217
|
},
|
13198
|
-
"
|
13199
|
-
"type": "
|
13200
|
-
"description": "
|
13218
|
+
"VTreeviewItem/tag": {
|
13219
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
13220
|
+
"description": "Specify a custom tag used on the root element."
|
13201
13221
|
},
|
13202
|
-
"
|
13222
|
+
"VTreeviewItem/nav": {
|
13203
13223
|
"type": "boolean\n",
|
13204
|
-
"description": "
|
13224
|
+
"description": "Reduces the width of v-list-item takes and adds a border radius."
|
13205
13225
|
},
|
13206
13226
|
"VTreeviewItem/title": {
|
13207
13227
|
"type": "string | number\n",
|
13208
13228
|
"description": "Generates a `v-list-item-title` component with the supplied value. Note that this overrides the native [`title`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title) attribute, that must be set with `v-bind:title.attr` instead."
|
13209
13229
|
},
|
13210
|
-
"VTreeviewItem/
|
13230
|
+
"VTreeviewItem/theme": {
|
13231
|
+
"type": "string\n",
|
13232
|
+
"description": "Specify a theme for this component and all of its children."
|
13233
|
+
},
|
13234
|
+
"VTreeviewItem/value": {
|
13235
|
+
"type": "any\n",
|
13236
|
+
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
13237
|
+
},
|
13238
|
+
"VTreeviewItem/active": {
|
13211
13239
|
"type": "boolean\n",
|
13212
|
-
"description": "
|
13240
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
13213
13241
|
},
|
13214
|
-
"VTreeviewItem/
|
13242
|
+
"VTreeviewItem/active-color": {
|
13243
|
+
"type": "string\n",
|
13244
|
+
"description": "The applied color when the component is in an active state."
|
13245
|
+
},
|
13246
|
+
"VTreeviewItem/base-color": {
|
13247
|
+
"type": "string\n",
|
13248
|
+
"description": "Sets the color of component when not focused."
|
13249
|
+
},
|
13250
|
+
"VTreeviewItem/prepend-icon": {
|
13251
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13252
|
+
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
13253
|
+
},
|
13254
|
+
"VTreeviewItem/append-icon": {
|
13255
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13256
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
13257
|
+
},
|
13258
|
+
"VTreeviewItem/slim": {
|
13215
13259
|
"type": "boolean\n",
|
13216
|
-
"description": "
|
13260
|
+
"description": "Reduces the vertical padding or height of the v-treeview-item, making it more compact."
|
13261
|
+
},
|
13262
|
+
"VTreeviewItem/ripple": {
|
13263
|
+
"type": "boolean | { class: string }\n",
|
13264
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
13217
13265
|
},
|
13218
13266
|
"VTreeviewItem/border": {
|
13219
13267
|
"type": "string | number | boolean\n",
|
@@ -13251,6 +13299,14 @@
|
|
13251
13299
|
"type": "string | number\n",
|
13252
13300
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
13253
13301
|
},
|
13302
|
+
"VTreeviewItem/disabled": {
|
13303
|
+
"type": "boolean\n",
|
13304
|
+
"description": "Removes the ability to click or target the component."
|
13305
|
+
},
|
13306
|
+
"VTreeviewItem/loading": {
|
13307
|
+
"type": "boolean\n",
|
13308
|
+
"description": "Places the v-treeview-item into a loading state."
|
13309
|
+
},
|
13254
13310
|
"VTreeviewItem/rounded": {
|
13255
13311
|
"type": "string | number | boolean\n",
|
13256
13312
|
"description": "Designates the **border-radius** applied to the component. This can be **0**, **xs**, **sm**, true, **lg**, **xl**, **pill**, **circle**, and **shaped**. Find more information on available border radius classes on the [Border Radius page](/styles/border-radius)."
|
@@ -13259,85 +13315,37 @@
|
|
13259
13315
|
"type": "boolean\n",
|
13260
13316
|
"description": "Removes any applied **border-radius** from the component."
|
13261
13317
|
},
|
13262
|
-
"VTreeviewItem/
|
13263
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
13264
|
-
"description": "Specify a custom tag used on the root element."
|
13265
|
-
},
|
13266
|
-
"VTreeviewItem/theme": {
|
13267
|
-
"type": "string\n",
|
13268
|
-
"description": "Specify a theme for this component and all of its children."
|
13269
|
-
},
|
13270
|
-
"VTreeviewItem/color": {
|
13318
|
+
"VTreeviewItem/href": {
|
13271
13319
|
"type": "string\n",
|
13272
|
-
"description": "
|
13273
|
-
},
|
13274
|
-
"VTreeviewItem/variant": {
|
13275
|
-
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
13276
|
-
"description": "Applies a distinct style to the component."
|
13320
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
13277
13321
|
},
|
13278
13322
|
"VTreeviewItem/exact": {
|
13279
13323
|
"type": "boolean\n",
|
13280
13324
|
"description": "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."
|
13281
13325
|
},
|
13282
|
-
"VTreeviewItem/
|
13283
|
-
"type": "
|
13284
|
-
"description": "
|
13285
|
-
},
|
13286
|
-
"VTreeviewItem/base-color": {
|
13287
|
-
"type": "string\n",
|
13288
|
-
"description": "Sets the color of component when not focused."
|
13289
|
-
},
|
13290
|
-
"VTreeviewItem/active-color": {
|
13291
|
-
"type": "string\n",
|
13292
|
-
"description": "The applied color when the component is in an active state."
|
13326
|
+
"VTreeviewItem/to": {
|
13327
|
+
"type": "RouteLocationRaw\n",
|
13328
|
+
"description": "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."
|
13293
13329
|
},
|
13294
|
-
"VTreeviewItem/
|
13330
|
+
"VTreeviewItem/color": {
|
13295
13331
|
"type": "string\n",
|
13296
|
-
"description": "
|
13332
|
+
"description": "Applies specified color to the control when in an **active** state or **input-value** is **true** - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors),"
|
13297
13333
|
},
|
13298
|
-
"VTreeviewItem/
|
13299
|
-
"type": "
|
13300
|
-
"description": "
|
13334
|
+
"VTreeviewItem/variant": {
|
13335
|
+
"type": "'flat' | 'text' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
13336
|
+
"description": "Applies a distinct style to the component."
|
13301
13337
|
},
|
13302
13338
|
"VTreeviewItem/lines": {
|
13303
13339
|
"type": "false | 'one' | 'two' | 'three'\n",
|
13304
13340
|
"description": "The line declaration specifies the minimum height of the item and can also be controlled from v-list with the same prop."
|
13305
13341
|
},
|
13306
|
-
"VTreeviewItem/
|
13307
|
-
"type": "boolean\n",
|
13308
|
-
"description": "Reduces the vertical padding or height of the v-treeview-item, making it more compact."
|
13309
|
-
},
|
13310
|
-
"VTreeviewItem/nav": {
|
13311
|
-
"type": "boolean\n",
|
13312
|
-
"description": "Reduces the width of v-list-item takes and adds a border radius."
|
13313
|
-
},
|
13314
|
-
"VTreeviewItem/value": {
|
13315
|
-
"type": "any\n",
|
13316
|
-
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
13317
|
-
},
|
13318
|
-
"VTreeviewItem/append-icon": {
|
13319
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13320
|
-
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
13321
|
-
},
|
13322
|
-
"VTreeviewItem/prepend-icon": {
|
13323
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13324
|
-
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
13325
|
-
},
|
13326
|
-
"VTreeviewItem/active": {
|
13327
|
-
"type": "boolean\n",
|
13328
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
13329
|
-
},
|
13330
|
-
"VTreeviewItem/loading": {
|
13331
|
-
"type": "boolean\n",
|
13332
|
-
"description": "Places the v-treeview-item into a loading state."
|
13333
|
-
},
|
13334
|
-
"VTreeviewItem/href": {
|
13342
|
+
"VTreeviewItem/active-class": {
|
13335
13343
|
"type": "string\n",
|
13336
|
-
"description": "
|
13344
|
+
"description": "The class applied to the component when it matches the current route. Find more information about the [active-class prop](https://router.vuejs.org/api/#active-class) on the [vue-router](https://router.vuejs.org/) documentation."
|
13337
13345
|
},
|
13338
|
-
"VTreeviewItem/
|
13339
|
-
"type": "
|
13340
|
-
"description": "
|
13346
|
+
"VTreeviewItem/subtitle": {
|
13347
|
+
"type": "string | number\n",
|
13348
|
+
"description": "Specify a subtitle text for the component."
|
13341
13349
|
},
|
13342
13350
|
"VTreeviewItem/append-avatar": {
|
13343
13351
|
"type": "string\n",
|
@@ -13347,10 +13355,6 @@
|
|
13347
13355
|
"type": "string\n",
|
13348
13356
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
13349
13357
|
},
|
13350
|
-
"VTreeviewItem/ripple": {
|
13351
|
-
"type": "boolean | { class: string }\n",
|
13352
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
13353
|
-
},
|
13354
13358
|
"VTreeviewItem/toggle-icon": {
|
13355
13359
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13356
13360
|
"description": "Allows customization of the icon used to toggle the expansion and collapse of treeview branches."
|
@@ -13379,6 +13383,10 @@
|
|
13379
13383
|
"type": "unknown\n",
|
13380
13384
|
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
13381
13385
|
},
|
13386
|
+
"VValidation/focused": {
|
13387
|
+
"type": "boolean\n",
|
13388
|
+
"description": "Forces a focused state styling on the component."
|
13389
|
+
},
|
13382
13390
|
"VValidation/error-messages": {
|
13383
13391
|
"type": "string | string[]\n",
|
13384
13392
|
"description": "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."
|
@@ -13399,14 +13407,6 @@
|
|
13399
13407
|
"type": "any\n",
|
13400
13408
|
"description": "The value used when applying validation rules."
|
13401
13409
|
},
|
13402
|
-
"VValidation/focused": {
|
13403
|
-
"type": "boolean\n",
|
13404
|
-
"description": "Forces a focused state styling on the component."
|
13405
|
-
},
|
13406
|
-
"VVirtualScroll/items": {
|
13407
|
-
"type": "unknown[]\n",
|
13408
|
-
"description": "The array of items to display."
|
13409
|
-
},
|
13410
13410
|
"VVirtualScroll/height": {
|
13411
13411
|
"type": "string | number\n",
|
13412
13412
|
"description": "Height of the component as a css value/"
|
@@ -13431,6 +13431,10 @@
|
|
13431
13431
|
"type": "string | number\n",
|
13432
13432
|
"description": "Sets the width for the component."
|
13433
13433
|
},
|
13434
|
+
"VVirtualScroll/items": {
|
13435
|
+
"type": "unknown[]\n",
|
13436
|
+
"description": "The array of items to display."
|
13437
|
+
},
|
13434
13438
|
"VVirtualScroll/renderless": {
|
13435
13439
|
"type": "boolean\n",
|
13436
13440
|
"description": "Disables default component rendering functionality."
|
@@ -13443,18 +13447,14 @@
|
|
13443
13447
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13444
13448
|
"description": "Should point to a property with a unique value for each item, if not set then item index will be used as a key which may result in unnecessary re-renders."
|
13445
13449
|
},
|
13446
|
-
"VWindow/
|
13447
|
-
"type": "
|
13448
|
-
"description": "
|
13450
|
+
"VWindow/tag": {
|
13451
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
13452
|
+
"description": "Specify a custom tag used on the root element."
|
13449
13453
|
},
|
13450
13454
|
"VWindow/reverse": {
|
13451
13455
|
"type": "boolean\n",
|
13452
13456
|
"description": "Reverse the normal transition direction."
|
13453
13457
|
},
|
13454
|
-
"VWindow/tag": {
|
13455
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
13456
|
-
"description": "Specify a custom tag used on the root element."
|
13457
|
-
},
|
13458
13458
|
"VWindow/theme": {
|
13459
13459
|
"type": "string\n",
|
13460
13460
|
"description": "Specify a theme for this component and all of its children."
|
@@ -13463,18 +13463,18 @@
|
|
13463
13463
|
"type": "boolean\n",
|
13464
13464
|
"description": "Removes the ability to click or target the component."
|
13465
13465
|
},
|
13466
|
-
"VWindow/mandatory": {
|
13467
|
-
"type": "boolean | 'force'\n",
|
13468
|
-
"description": "Forces at least one item to always be selected (if available)."
|
13469
|
-
},
|
13470
|
-
"VWindow/direction": {
|
13471
|
-
"type": "'horizontal' | 'vertical'\n",
|
13472
|
-
"description": "The transition direction when changing windows."
|
13473
|
-
},
|
13474
13466
|
"VWindow/selected-class": {
|
13475
13467
|
"type": "string\n",
|
13476
13468
|
"description": "Configure the active CSS class applied when an item is selected."
|
13477
13469
|
},
|
13470
|
+
"VWindow/model-value": {
|
13471
|
+
"type": "unknown\n",
|
13472
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
13473
|
+
},
|
13474
|
+
"VWindow/mandatory": {
|
13475
|
+
"type": "boolean | 'force'\n",
|
13476
|
+
"description": "Forces at least one item to always be selected (if available)."
|
13477
|
+
},
|
13478
13478
|
"VWindow/next-icon": {
|
13479
13479
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13480
13480
|
"description": "Icon used for the \"next\" button if `show-arrows` is `true`."
|
@@ -13483,18 +13483,22 @@
|
|
13483
13483
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
13484
13484
|
"description": "Icon used for the \"prev\" button if `show-arrows` is `true`."
|
13485
13485
|
},
|
13486
|
-
"VWindow/show-arrows": {
|
13487
|
-
"type": "string | boolean\n",
|
13488
|
-
"description": "Display the \"next\" and \"prev\" buttons."
|
13489
|
-
},
|
13490
13486
|
"VWindow/continuous": {
|
13491
13487
|
"type": "boolean\n",
|
13492
13488
|
"description": "If `true`, window will \"wrap around\" from the last item to the first, and from the first item to the last."
|
13493
13489
|
},
|
13490
|
+
"VWindow/show-arrows": {
|
13491
|
+
"type": "string | boolean\n",
|
13492
|
+
"description": "Display the \"next\" and \"prev\" buttons."
|
13493
|
+
},
|
13494
13494
|
"VWindow/touch": {
|
13495
13495
|
"type": "boolean | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/directives/touch/index.ts#L9-L17\" target=\"_blank\">TouchHandlers</a>\n",
|
13496
13496
|
"description": "Provide a custom **left** and **right** function when swiped left or right."
|
13497
13497
|
},
|
13498
|
+
"VWindow/direction": {
|
13499
|
+
"type": "'horizontal' | 'vertical'\n",
|
13500
|
+
"description": "The transition direction when changing windows."
|
13501
|
+
},
|
13498
13502
|
"VWindowItem/value": {
|
13499
13503
|
"type": "any\n",
|
13500
13504
|
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|