@vuetify/nightly 3.7.7-dev.2025-01-22 → 3.7.7-dev.2025-01-23
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/CHANGELOG.md +4 -3
- package/dist/json/attributes.json +883 -883
- package/dist/json/importMap-labs.json +28 -28
- package/dist/json/importMap.json +134 -134
- package/dist/json/web-types.json +1812 -1812
- package/dist/vuetify-labs.css +3137 -3137
- package/dist/vuetify-labs.d.ts +49 -49
- package/dist/vuetify-labs.esm.js +6 -3
- package/dist/vuetify-labs.esm.js.map +1 -1
- package/dist/vuetify-labs.js +6 -3
- package/dist/vuetify-labs.min.css +2 -2
- package/dist/vuetify.css +4338 -4338
- package/dist/vuetify.d.ts +49 -49
- package/dist/vuetify.esm.js +6 -3
- package/dist/vuetify.esm.js.map +1 -1
- package/dist/vuetify.js +6 -3
- 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/VList/VListGroup.js +1 -0
- package/lib/components/VList/VListGroup.js.map +1 -1
- package/lib/components/VList/VListItem.js +2 -0
- package/lib/components/VList/VListItem.js.map +1 -1
- package/lib/entry-bundler.js +1 -1
- package/lib/framework.d.ts +49 -49
- 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,94 +1275,66 @@
|
|
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/exact": {
|
1287
1283
|
"type": "boolean\n",
|
1288
|
-
"description": "
|
1284
|
+
"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."
|
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
|
},
|
1290
|
+
"VBreadcrumbsItem/active-class": {
|
1291
|
+
"type": "string\n",
|
1292
|
+
"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."
|
1293
|
+
},
|
1294
1294
|
"VBreadcrumbsItem/disabled": {
|
1295
1295
|
"type": "boolean\n",
|
1296
1296
|
"description": "Removes the ability to click or target the component."
|
1297
1297
|
},
|
1298
|
-
"VBreadcrumbsItem/
|
1298
|
+
"VBreadcrumbsItem/color": {
|
1299
1299
|
"type": "string\n",
|
1300
|
-
"description": "
|
1300
|
+
"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)."
|
1301
1301
|
},
|
1302
|
-
"VBreadcrumbsItem/
|
1302
|
+
"VBreadcrumbsItem/active": {
|
1303
1303
|
"type": "boolean\n",
|
1304
|
-
"description": "
|
1304
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
1305
|
+
},
|
1306
|
+
"VBreadcrumbsItem/href": {
|
1307
|
+
"type": "string\n",
|
1308
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
1305
1309
|
},
|
1306
1310
|
"VBreadcrumbsItem/to": {
|
1307
1311
|
"type": "RouteLocationRaw\n",
|
1308
1312
|
"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."
|
1309
1313
|
},
|
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/)."
|
1317
1317
|
},
|
1318
|
-
"VBtn/flat": {
|
1319
|
-
"type": "boolean\n",
|
1320
|
-
"description": "Removes the button box shadow. This is different than using the 'flat' variant."
|
1321
|
-
},
|
1322
|
-
"VBtn/replace": {
|
1323
|
-
"type": "boolean\n",
|
1324
|
-
"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."
|
1325
|
-
},
|
1326
|
-
"VBtn/tag": {
|
1327
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
1328
|
-
"description": "Specify a custom tag used on the root element."
|
1329
|
-
},
|
1330
|
-
"VBtn/theme": {
|
1331
|
-
"type": "string\n",
|
1332
|
-
"description": "Specify a theme for this component and all of its children."
|
1333
|
-
},
|
1334
|
-
"VBtn/size": {
|
1335
|
-
"type": "string | number\n",
|
1336
|
-
"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**."
|
1337
|
-
},
|
1338
|
-
"VBtn/value": {
|
1339
|
-
"type": "any\n",
|
1340
|
-
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|
1341
|
-
},
|
1342
1318
|
"VBtn/text": {
|
1343
1319
|
"type": "string\n",
|
1344
1320
|
"description": "Specify content text for the component."
|
1345
1321
|
},
|
1346
|
-
"VBtn/
|
1347
|
-
"type": "boolean\n",
|
1348
|
-
"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."
|
1349
|
-
},
|
1350
|
-
"VBtn/base-color": {
|
1351
|
-
"type": "string\n",
|
1352
|
-
"description": "Sets the color of component when not focused."
|
1353
|
-
},
|
1354
|
-
"VBtn/active-color": {
|
1355
|
-
"type": "string\n",
|
1356
|
-
"description": "The applied color when the component is in an active state."
|
1357
|
-
},
|
1358
|
-
"VBtn/disabled": {
|
1322
|
+
"VBtn/flat": {
|
1359
1323
|
"type": "boolean\n",
|
1360
|
-
"description": "Removes the
|
1324
|
+
"description": "Removes the button box shadow. This is different than using the 'flat' variant."
|
1361
1325
|
},
|
1362
|
-
"VBtn/
|
1326
|
+
"VBtn/replace": {
|
1363
1327
|
"type": "boolean\n",
|
1364
|
-
"description": "
|
1328
|
+
"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."
|
1365
1329
|
},
|
1366
1330
|
"VBtn/border": {
|
1367
1331
|
"type": "string | number | boolean\n",
|
1368
1332
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
1369
1333
|
},
|
1334
|
+
"VBtn/icon": {
|
1335
|
+
"type": " | boolean\n | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1336
|
+
"description": "Apply a specific icon using the [v-icon](/components/icons/) component. The button will become _round_."
|
1337
|
+
},
|
1370
1338
|
"VBtn/density": {
|
1371
1339
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
1372
1340
|
"description": "Adjusts the vertical height used by the component."
|
@@ -1399,6 +1367,14 @@
|
|
1399
1367
|
"type": "string | number\n",
|
1400
1368
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
1401
1369
|
},
|
1370
|
+
"VBtn/location": {
|
1371
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
1372
|
+
"description": "Specifies the component's location. Can combine by using a space separated string."
|
1373
|
+
},
|
1374
|
+
"VBtn/position": {
|
1375
|
+
"type": "'fixed' | 'static' | 'relative' | 'absolute' | 'sticky'\n",
|
1376
|
+
"description": "Sets the position for the component."
|
1377
|
+
},
|
1402
1378
|
"VBtn/rounded": {
|
1403
1379
|
"type": "string | number | boolean\n",
|
1404
1380
|
"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)."
|
@@ -1407,41 +1383,53 @@
|
|
1407
1383
|
"type": "boolean\n",
|
1408
1384
|
"description": "Removes any applied **border-radius** from the component."
|
1409
1385
|
},
|
1386
|
+
"VBtn/tag": {
|
1387
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
1388
|
+
"description": "Specify a custom tag used on the root element."
|
1389
|
+
},
|
1390
|
+
"VBtn/theme": {
|
1391
|
+
"type": "string\n",
|
1392
|
+
"description": "Specify a theme for this component and all of its children."
|
1393
|
+
},
|
1410
1394
|
"VBtn/color": {
|
1411
1395
|
"type": "string\n",
|
1412
1396
|
"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)."
|
1413
1397
|
},
|
1414
1398
|
"VBtn/variant": {
|
1415
|
-
"type": "'
|
1399
|
+
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
1416
1400
|
"description": "Applies a distinct style to the component."
|
1417
1401
|
},
|
1418
|
-
"VBtn/
|
1419
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
1420
|
-
"description": "Specifies the component's location. Can combine by using a space separated string."
|
1421
|
-
},
|
1422
|
-
"VBtn/block": {
|
1402
|
+
"VBtn/active": {
|
1423
1403
|
"type": "boolean\n",
|
1424
|
-
"description": "
|
1404
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
1425
1405
|
},
|
1426
|
-
"VBtn/
|
1427
|
-
"type": "
|
1428
|
-
"description": "
|
1406
|
+
"VBtn/active-color": {
|
1407
|
+
"type": "string\n",
|
1408
|
+
"description": "The applied color when the component is in an active state."
|
1409
|
+
},
|
1410
|
+
"VBtn/base-color": {
|
1411
|
+
"type": "string\n",
|
1412
|
+
"description": "Sets the color of component when not focused."
|
1429
1413
|
},
|
1430
1414
|
"VBtn/prepend-icon": {
|
1431
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
1415
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1432
1416
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
1433
1417
|
},
|
1418
|
+
"VBtn/append-icon": {
|
1419
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
1420
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
1421
|
+
},
|
1422
|
+
"VBtn/block": {
|
1423
|
+
"type": "boolean\n",
|
1424
|
+
"description": "Expands the button to 100% of available space."
|
1425
|
+
},
|
1434
1426
|
"VBtn/readonly": {
|
1435
1427
|
"type": "boolean\n",
|
1436
1428
|
"description": "Puts the button in a readonly state. Cannot be clicked or navigated to by keyboard."
|
1437
1429
|
},
|
1438
|
-
"VBtn/
|
1430
|
+
"VBtn/slim": {
|
1439
1431
|
"type": "boolean\n",
|
1440
|
-
"description": "
|
1441
|
-
},
|
1442
|
-
"VBtn/loading": {
|
1443
|
-
"type": "string | boolean\n",
|
1444
|
-
"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."
|
1432
|
+
"description": "Reduces padding to 0 8px."
|
1445
1433
|
},
|
1446
1434
|
"VBtn/stacked": {
|
1447
1435
|
"type": "boolean\n",
|
@@ -1451,25 +1439,49 @@
|
|
1451
1439
|
"type": "boolean | { class: string }\n",
|
1452
1440
|
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
1453
1441
|
},
|
1442
|
+
"VBtn/value": {
|
1443
|
+
"type": "any\n",
|
1444
|
+
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|
1445
|
+
},
|
1446
|
+
"VBtn/disabled": {
|
1447
|
+
"type": "boolean\n",
|
1448
|
+
"description": "Removes the ability to click or target the component."
|
1449
|
+
},
|
1454
1450
|
"VBtn/selected-class": {
|
1455
1451
|
"type": "string\n",
|
1456
1452
|
"description": "Configure the active CSS class applied when an item is selected."
|
1457
1453
|
},
|
1458
|
-
"VBtn/
|
1459
|
-
"type": "
|
1460
|
-
"description": "
|
1454
|
+
"VBtn/loading": {
|
1455
|
+
"type": "string | boolean\n",
|
1456
|
+
"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."
|
1461
1457
|
},
|
1462
1458
|
"VBtn/href": {
|
1463
1459
|
"type": "string\n",
|
1464
1460
|
"description": "Designates the component as anchor and applies the **href** attribute."
|
1465
1461
|
},
|
1462
|
+
"VBtn/exact": {
|
1463
|
+
"type": "boolean\n",
|
1464
|
+
"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."
|
1465
|
+
},
|
1466
1466
|
"VBtn/to": {
|
1467
1467
|
"type": "RouteLocationRaw\n",
|
1468
1468
|
"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."
|
1469
1469
|
},
|
1470
|
-
"VBtn/
|
1471
|
-
"type": "
|
1472
|
-
"description": "
|
1470
|
+
"VBtn/size": {
|
1471
|
+
"type": "string | number\n",
|
1472
|
+
"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**."
|
1473
|
+
},
|
1474
|
+
"VBtnGroup/tag": {
|
1475
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
1476
|
+
"description": "Specify a custom tag used on the root element."
|
1477
|
+
},
|
1478
|
+
"VBtnGroup/theme": {
|
1479
|
+
"type": "string\n",
|
1480
|
+
"description": "Specify a theme for this component and all of its children."
|
1481
|
+
},
|
1482
|
+
"VBtnGroup/base-color": {
|
1483
|
+
"type": "string\n",
|
1484
|
+
"description": "Sets the color of component when not focused."
|
1473
1485
|
},
|
1474
1486
|
"VBtnGroup/border": {
|
1475
1487
|
"type": "string | number | boolean\n",
|
@@ -1491,38 +1503,46 @@
|
|
1491
1503
|
"type": "boolean\n",
|
1492
1504
|
"description": "Removes any applied **border-radius** from the component."
|
1493
1505
|
},
|
1494
|
-
"VBtnGroup/tag": {
|
1495
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
1496
|
-
"description": "Specify a custom tag used on the root element."
|
1497
|
-
},
|
1498
|
-
"VBtnGroup/theme": {
|
1499
|
-
"type": "string\n",
|
1500
|
-
"description": "Specify a theme for this component and all of its children."
|
1501
|
-
},
|
1502
1506
|
"VBtnGroup/color": {
|
1503
1507
|
"type": "string\n",
|
1504
1508
|
"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)."
|
1505
1509
|
},
|
1506
1510
|
"VBtnGroup/variant": {
|
1507
|
-
"type": "'
|
1511
|
+
"type": "'flat' | 'text' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
1508
1512
|
"description": "Applies a distinct style to the component."
|
1509
1513
|
},
|
1510
|
-
"VBtnGroup/
|
1514
|
+
"VBtnGroup/divided": {
|
1515
|
+
"type": "boolean\n",
|
1516
|
+
"description": "Add dividers between children [v-btn](/components/buttons) components."
|
1517
|
+
},
|
1518
|
+
"VBtnToggle/tag": {
|
1519
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
1520
|
+
"description": "Specify a custom tag used on the root element."
|
1521
|
+
},
|
1522
|
+
"VBtnToggle/theme": {
|
1523
|
+
"type": "string\n",
|
1524
|
+
"description": "Specify a theme for this component and all of its children."
|
1525
|
+
},
|
1526
|
+
"VBtnToggle/base-color": {
|
1511
1527
|
"type": "string\n",
|
1512
1528
|
"description": "Sets the color of component when not focused."
|
1513
1529
|
},
|
1514
|
-
"
|
1530
|
+
"VBtnToggle/disabled": {
|
1515
1531
|
"type": "boolean\n",
|
1516
|
-
"description": "
|
1532
|
+
"description": "Puts all children components into a disabled state."
|
1533
|
+
},
|
1534
|
+
"VBtnToggle/multiple": {
|
1535
|
+
"type": "boolean\n",
|
1536
|
+
"description": "Allows one to select multiple items."
|
1537
|
+
},
|
1538
|
+
"VBtnToggle/mandatory": {
|
1539
|
+
"type": "boolean | 'force'\n",
|
1540
|
+
"description": "Forces at least one item to always be selected (if available)."
|
1517
1541
|
},
|
1518
1542
|
"VBtnToggle/border": {
|
1519
1543
|
"type": "string | number | boolean\n",
|
1520
1544
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
1521
1545
|
},
|
1522
|
-
"VBtnToggle/model-value": {
|
1523
|
-
"type": "unknown\n",
|
1524
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
1525
|
-
},
|
1526
1546
|
"VBtnToggle/density": {
|
1527
1547
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
1528
1548
|
"description": "Adjusts the vertical height used by the component."
|
@@ -1539,49 +1559,29 @@
|
|
1539
1559
|
"type": "boolean\n",
|
1540
1560
|
"description": "Removes the component's border-radius."
|
1541
1561
|
},
|
1542
|
-
"VBtnToggle/tag": {
|
1543
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
1544
|
-
"description": "Specify a custom tag used on the root element."
|
1545
|
-
},
|
1546
|
-
"VBtnToggle/theme": {
|
1547
|
-
"type": "string\n",
|
1548
|
-
"description": "Specify a theme for this component and all of its children."
|
1549
|
-
},
|
1550
1562
|
"VBtnToggle/color": {
|
1551
1563
|
"type": "string\n",
|
1552
1564
|
"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)."
|
1553
1565
|
},
|
1554
1566
|
"VBtnToggle/variant": {
|
1555
|
-
"type": "'
|
1567
|
+
"type": "'flat' | 'text' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
1556
1568
|
"description": "Applies a distinct style to the component."
|
1557
1569
|
},
|
1558
|
-
"VBtnToggle/
|
1559
|
-
"type": "
|
1560
|
-
"description": "
|
1570
|
+
"VBtnToggle/model-value": {
|
1571
|
+
"type": "unknown\n",
|
1572
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
1561
1573
|
},
|
1562
|
-
"VBtnToggle/
|
1574
|
+
"VBtnToggle/divided": {
|
1563
1575
|
"type": "boolean\n",
|
1564
|
-
"description": "
|
1565
|
-
},
|
1566
|
-
"VBtnToggle/selected-class": {
|
1567
|
-
"type": "string\n",
|
1568
|
-
"description": "Configure the active CSS class applied when an item is selected."
|
1576
|
+
"description": "Add dividers between children [v-btn](/components/buttons) components."
|
1569
1577
|
},
|
1570
1578
|
"VBtnToggle/max": {
|
1571
1579
|
"type": "number\n",
|
1572
1580
|
"description": "Sets a maximum number of selections that can be made."
|
1573
1581
|
},
|
1574
|
-
"VBtnToggle/
|
1575
|
-
"type": "
|
1576
|
-
"description": "
|
1577
|
-
},
|
1578
|
-
"VBtnToggle/mandatory": {
|
1579
|
-
"type": "boolean | 'force'\n",
|
1580
|
-
"description": "Forces at least one item to always be selected (if available)."
|
1581
|
-
},
|
1582
|
-
"VBtnToggle/divided": {
|
1583
|
-
"type": "boolean\n",
|
1584
|
-
"description": "Add dividers between children [v-btn](/components/buttons) components."
|
1582
|
+
"VBtnToggle/selected-class": {
|
1583
|
+
"type": "string\n",
|
1584
|
+
"description": "Configure the active CSS class applied when an item is selected."
|
1585
1585
|
},
|
1586
1586
|
"VCalendar/title": {
|
1587
1587
|
"type": "string\n",
|
@@ -2467,10 +2467,6 @@
|
|
2467
2467
|
"type": "boolean\n",
|
2468
2468
|
"description": "Puts input in readonly state."
|
2469
2469
|
},
|
2470
|
-
"VCheckboxBtn/ripple": {
|
2471
|
-
"type": "boolean | { class: string }\n",
|
2472
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2473
|
-
},
|
2474
2470
|
"VCheckboxBtn/indeterminate": {
|
2475
2471
|
"type": "boolean\n",
|
2476
2472
|
"description": "Puts the control in an indeterminate state. Used with the [indeterminate-icon](#props-indeterminate-icon) property."
|
@@ -2503,6 +2499,10 @@
|
|
2503
2499
|
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
2504
2500
|
"description": "The icon used when active."
|
2505
2501
|
},
|
2502
|
+
"VCheckboxBtn/ripple": {
|
2503
|
+
"type": "boolean | { class: string }\n",
|
2504
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2505
|
+
},
|
2506
2506
|
"VChip/filter": {
|
2507
2507
|
"type": "boolean\n",
|
2508
2508
|
"description": "Displays a selection icon when selected."
|
@@ -2595,14 +2595,6 @@
|
|
2595
2595
|
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
2596
2596
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
2597
2597
|
},
|
2598
|
-
"VChip/ripple": {
|
2599
|
-
"type": "boolean | { class: string }\n",
|
2600
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2601
|
-
},
|
2602
|
-
"VChip/selected-class": {
|
2603
|
-
"type": "string\n",
|
2604
|
-
"description": "Configure the active CSS class applied when an item is selected."
|
2605
|
-
},
|
2606
2598
|
"VChip/href": {
|
2607
2599
|
"type": "string\n",
|
2608
2600
|
"description": "Designates the component as anchor and applies the **href** attribute."
|
@@ -2611,6 +2603,10 @@
|
|
2611
2603
|
"type": "RouteLocationRaw\n",
|
2612
2604
|
"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."
|
2613
2605
|
},
|
2606
|
+
"VChip/selected-class": {
|
2607
|
+
"type": "string\n",
|
2608
|
+
"description": "Configure the active CSS class applied when an item is selected."
|
2609
|
+
},
|
2614
2610
|
"VChip/append-avatar": {
|
2615
2611
|
"type": "string\n",
|
2616
2612
|
"description": "Appends a [v-avatar](/components/avatars/) component after default content in the **append** slot."
|
@@ -2619,6 +2615,10 @@
|
|
2619
2615
|
"type": "string\n",
|
2620
2616
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
2621
2617
|
},
|
2618
|
+
"VChip/ripple": {
|
2619
|
+
"type": "boolean | { class: string }\n",
|
2620
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
2621
|
+
},
|
2622
2622
|
"VChip/closable": {
|
2623
2623
|
"type": "boolean\n",
|
2624
2624
|
"description": "Adds remove button and then a chip can be closed."
|
@@ -3319,70 +3319,50 @@
|
|
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
|
+
},
|
3322
3326
|
"VDataIterator/tag": {
|
3323
3327
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
3324
3328
|
"description": "Specify a custom tag used on the root element."
|
3325
3329
|
},
|
3326
|
-
"VDataIterator/
|
3327
|
-
"type": "unknown[]\n",
|
3328
|
-
"description": "An array of strings or objects used for automatically generating children components."
|
3329
|
-
},
|
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": {
|
3330
|
+
"VDataIterator/loading": {
|
3335
3331
|
"type": "boolean\n",
|
3336
|
-
"description": "
|
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)."
|
3332
|
+
"description": "If `true` and no items are provided, then a loading text will be shown."
|
3353
3333
|
},
|
3354
|
-
"VDataIterator/
|
3355
|
-
"type": "
|
3356
|
-
"description": "
|
3334
|
+
"VDataIterator/transition": {
|
3335
|
+
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component; hideOnLeave: boolean }\n",
|
3336
|
+
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3357
3337
|
},
|
3358
|
-
"VDataIterator/
|
3359
|
-
"type": "
|
3360
|
-
"description": "
|
3338
|
+
"VDataIterator/items": {
|
3339
|
+
"type": "unknown[]\n",
|
3340
|
+
"description": "An array of strings or objects used for automatically generating children components."
|
3361
3341
|
},
|
3362
3342
|
"VDataIterator/value-comparator": {
|
3363
3343
|
"type": "(a: any, b: any) => boolean\n",
|
3364
3344
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3365
3345
|
},
|
3366
|
-
"VDataIterator/
|
3367
|
-
"type": "
|
3368
|
-
"description": "
|
3369
|
-
},
|
3370
|
-
"VDataIterator/transition": {
|
3371
|
-
"type": " | string\n | boolean\n | (TransitionProps & { component: Component })\n | { component: Component; hideOnLeave: boolean }\n",
|
3372
|
-
"description": "Sets the component transition. Can be one of the [built in](/styles/transitions/) or custom transition."
|
3373
|
-
},
|
3374
|
-
"VDataIterator/loading": {
|
3375
|
-
"type": "boolean\n",
|
3376
|
-
"description": "If `true` and no items are provided, then a loading text will be shown."
|
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,13 +3403,69 @@
|
|
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
|
},
|
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
3426
|
"VDataTable/search": {
|
3427
3427
|
"type": "string\n",
|
3428
3428
|
"description": "Text input used to filter items."
|
3429
3429
|
},
|
3430
|
-
"VDataTable/
|
3430
|
+
"VDataTable/tag": {
|
3431
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
3432
|
+
"description": "Specify a custom tag used on the root element."
|
3433
|
+
},
|
3434
|
+
"VDataTable/theme": {
|
3435
|
+
"type": "string\n",
|
3436
|
+
"description": "Specify a theme for this component and all of its children."
|
3437
|
+
},
|
3438
|
+
"VDataTable/items": {
|
3439
|
+
"type": "any[]\n",
|
3440
|
+
"description": "An array of strings or objects used for automatically generating children components."
|
3441
|
+
},
|
3442
|
+
"VDataTable/filter-mode": {
|
3443
|
+
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
3444
|
+
"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."
|
3445
|
+
},
|
3446
|
+
"VDataTable/no-filter": {
|
3447
|
+
"type": "boolean\n",
|
3448
|
+
"description": "Disables all item filtering."
|
3449
|
+
},
|
3450
|
+
"VDataTable/custom-filter": {
|
3451
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
3452
|
+
"description": "Function to filter items."
|
3453
|
+
},
|
3454
|
+
"VDataTable/custom-key-filter": {
|
3431
3455
|
"type": "unknown\n",
|
3432
|
-
"description": "
|
3456
|
+
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
|
3457
|
+
},
|
3458
|
+
"VDataTable/filter-keys": {
|
3459
|
+
"type": "string | string[]\n",
|
3460
|
+
"description": "Array of specific keys to filter on the item."
|
3461
|
+
},
|
3462
|
+
"VDataTable/hide-no-data": {
|
3463
|
+
"type": "boolean\n",
|
3464
|
+
"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."
|
3465
|
+
},
|
3466
|
+
"VDataTable/select-strategy": {
|
3467
|
+
"type": "'single' | 'page' | 'all'\n",
|
3468
|
+
"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)."
|
3433
3469
|
},
|
3434
3470
|
"VDataTable/density": {
|
3435
3471
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
@@ -3443,64 +3479,60 @@
|
|
3443
3479
|
"type": "string | number\n",
|
3444
3480
|
"description": "Sets the width for the component."
|
3445
3481
|
},
|
3446
|
-
"VDataTable/
|
3447
|
-
"type": "
|
3448
|
-
"description": "
|
3482
|
+
"VDataTable/item-value": {
|
3483
|
+
"type": "SelectItemKey<any>\n",
|
3484
|
+
"description": "Property on supplied `items` that contains its value."
|
3449
3485
|
},
|
3450
|
-
"VDataTable/
|
3451
|
-
"type": "
|
3452
|
-
"description": "
|
3486
|
+
"VDataTable/return-object": {
|
3487
|
+
"type": "boolean\n",
|
3488
|
+
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
3453
3489
|
},
|
3454
|
-
"VDataTable/
|
3455
|
-
"type": "
|
3456
|
-
"description": "
|
3490
|
+
"VDataTable/value-comparator": {
|
3491
|
+
"type": "(a: any, b: any) => boolean\n",
|
3492
|
+
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3457
3493
|
},
|
3458
3494
|
"VDataTable/color": {
|
3459
3495
|
"type": "string\n",
|
3460
3496
|
"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)."
|
3461
3497
|
},
|
3462
|
-
"VDataTable/
|
3463
|
-
"type": "
|
3464
|
-
"description": "
|
3465
|
-
},
|
3466
|
-
"VDataTable/mobile": {
|
3467
|
-
"type": "boolean\n",
|
3468
|
-
"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"
|
3498
|
+
"VDataTable/model-value": {
|
3499
|
+
"type": "unknown\n",
|
3500
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
3469
3501
|
},
|
3470
|
-
"VDataTable/
|
3471
|
-
"type": "
|
3472
|
-
"description": "
|
3502
|
+
"VDataTable/no-data-text": {
|
3503
|
+
"type": "string\n",
|
3504
|
+
"description": "Text shown when no items are provided to the component."
|
3473
3505
|
},
|
3474
|
-
"VDataTable/
|
3475
|
-
"type": "
|
3476
|
-
"description": "
|
3506
|
+
"VDataTable/loading": {
|
3507
|
+
"type": "string | boolean\n",
|
3508
|
+
"description": "Displays `loading` slot if set to `true`"
|
3477
3509
|
},
|
3478
3510
|
"VDataTable/next-icon": {
|
3479
|
-
"type": " | string\n | (
|
3511
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3480
3512
|
"description": "Next icon."
|
3481
3513
|
},
|
3482
3514
|
"VDataTable/prev-icon": {
|
3483
|
-
"type": " | string\n | (
|
3515
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3484
3516
|
"description": "Previous icon."
|
3485
3517
|
},
|
3486
3518
|
"VDataTable/hover": {
|
3487
3519
|
"type": "boolean\n",
|
3488
3520
|
"description": "Adds a hover effects to a table rows."
|
3489
3521
|
},
|
3490
|
-
"VDataTable/value-comparator": {
|
3491
|
-
"type": "(a: any, b: any) => boolean\n",
|
3492
|
-
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
3493
|
-
},
|
3494
3522
|
"VDataTable/header-props": {
|
3495
3523
|
"type": "unknown\n",
|
3496
3524
|
"description": "Pass props to the default header. See [`v-data-table-headers` API](/api/v-data-table-headers) for more information."
|
3497
3525
|
},
|
3498
3526
|
"VDataTable/cell-props": {
|
3499
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | '
|
3527
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
3500
3528
|
"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."
|
3501
3529
|
},
|
3530
|
+
"VDataTable/mobile": {
|
3531
|
+
"type": "boolean\n",
|
3532
|
+
"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"
|
3533
|
+
},
|
3502
3534
|
"VDataTable/headers": {
|
3503
|
-
"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?: '
|
3535
|
+
"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?: '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 | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | '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",
|
3504
3536
|
"description": "An array of objects that each describe a header column. See the example below for a definition of all properties."
|
3505
3537
|
},
|
3506
3538
|
"VDataTable/page": {
|
@@ -3515,13 +3547,9 @@
|
|
3515
3547
|
"type": "string\n",
|
3516
3548
|
"description": "Text shown when the data is loading."
|
3517
3549
|
},
|
3518
|
-
"VDataTable/
|
3519
|
-
"type": "
|
3520
|
-
"description": "
|
3521
|
-
},
|
3522
|
-
"VDataTable/no-data-text": {
|
3523
|
-
"type": "string\n",
|
3524
|
-
"description": "Text shown when no items are provided to the component."
|
3550
|
+
"VDataTable/mobile-breakpoint": {
|
3551
|
+
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xs'\n",
|
3552
|
+
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3525
3553
|
},
|
3526
3554
|
"VDataTable/row-props": {
|
3527
3555
|
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
@@ -3555,26 +3583,14 @@
|
|
3555
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",
|
3556
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."
|
3557
3585
|
},
|
3558
|
-
"VDataTable/item-value": {
|
3559
|
-
"type": "SelectItemKey<any>\n",
|
3560
|
-
"description": "Property on supplied `items` that contains its value."
|
3561
|
-
},
|
3562
3586
|
"VDataTable/item-selectable": {
|
3563
3587
|
"type": "SelectItemKey<any>\n",
|
3564
3588
|
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
3565
3589
|
},
|
3566
|
-
"VDataTable/return-object": {
|
3567
|
-
"type": "boolean\n",
|
3568
|
-
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
3569
|
-
},
|
3570
3590
|
"VDataTable/show-select": {
|
3571
3591
|
"type": "boolean\n",
|
3572
3592
|
"description": "Shows the select checkboxes in both the header and rows (if using default rows)."
|
3573
3593
|
},
|
3574
|
-
"VDataTable/select-strategy": {
|
3575
|
-
"type": "'page' | 'single' | 'all'\n",
|
3576
|
-
"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)."
|
3577
|
-
},
|
3578
3594
|
"VDataTable/sort-by": {
|
3579
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",
|
3580
3596
|
"description": "Changes which item property (or properties) should be used for sort order. Can be used with `.sync` modifier."
|
@@ -3591,16 +3607,20 @@
|
|
3591
3607
|
"type": "unknown\n",
|
3592
3608
|
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
|
3593
3609
|
},
|
3610
|
+
"VDataTable/sticky": {
|
3611
|
+
"type": "boolean\n",
|
3612
|
+
"description": "Sticks the header to the top of the table."
|
3613
|
+
},
|
3594
3614
|
"VDataTable/disable-sort": {
|
3595
3615
|
"type": "boolean\n",
|
3596
3616
|
"description": "Disables sorting completely."
|
3597
3617
|
},
|
3598
3618
|
"VDataTable/sort-asc-icon": {
|
3599
|
-
"type": " | string\n | (
|
3619
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3600
3620
|
"description": "Icon used for ascending sort button."
|
3601
3621
|
},
|
3602
3622
|
"VDataTable/sort-desc-icon": {
|
3603
|
-
"type": " | string\n | (
|
3623
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3604
3624
|
"description": "Icon used for descending sort button."
|
3605
3625
|
},
|
3606
3626
|
"VDataTable/fixed-header": {
|
@@ -3611,32 +3631,12 @@
|
|
3611
3631
|
"type": "boolean\n",
|
3612
3632
|
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
3613
3633
|
},
|
3614
|
-
"VDataTable/filter-mode": {
|
3615
|
-
"type": "'every' | 'some' | 'union' | 'intersection'\n",
|
3616
|
-
"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."
|
3617
|
-
},
|
3618
|
-
"VDataTable/no-filter": {
|
3619
|
-
"type": "boolean\n",
|
3620
|
-
"description": "Disables all item filtering."
|
3621
|
-
},
|
3622
|
-
"VDataTable/custom-filter": {
|
3623
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/filter.ts#L19-L19\" target=\"_blank\">FilterFunction</a>\n",
|
3624
|
-
"description": "Function to filter items."
|
3625
|
-
},
|
3626
|
-
"VDataTable/custom-key-filter": {
|
3627
|
-
"type": "unknown\n",
|
3628
|
-
"description": "Function used on specific keys within the item object. `customFilter` is skipped for columns with `customKeyFilter` specified."
|
3629
|
-
},
|
3630
|
-
"VDataTable/filter-keys": {
|
3631
|
-
"type": "string | string[]\n",
|
3632
|
-
"description": "Array of specific keys to filter on the item."
|
3633
|
-
},
|
3634
3634
|
"VDataTable/first-icon": {
|
3635
|
-
"type": " | string\n | (
|
3635
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3636
3636
|
"description": "First icon."
|
3637
3637
|
},
|
3638
3638
|
"VDataTable/last-icon": {
|
3639
|
-
"type": " | string\n | (
|
3639
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3640
3640
|
"description": "Last icon."
|
3641
3641
|
},
|
3642
3642
|
"VDataTable/items-per-page-text": {
|
@@ -3672,19 +3672,19 @@
|
|
3672
3672
|
"description": "Show current page number between prev/next icons."
|
3673
3673
|
},
|
3674
3674
|
"VDataTableFooter/next-icon": {
|
3675
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
3675
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3676
3676
|
"description": "Next icon."
|
3677
3677
|
},
|
3678
3678
|
"VDataTableFooter/prev-icon": {
|
3679
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
3679
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3680
3680
|
"description": "Previous icon."
|
3681
3681
|
},
|
3682
3682
|
"VDataTableFooter/first-icon": {
|
3683
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
3683
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3684
3684
|
"description": "First icon."
|
3685
3685
|
},
|
3686
3686
|
"VDataTableFooter/last-icon": {
|
3687
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
3687
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3688
3688
|
"description": "Last icon."
|
3689
3689
|
},
|
3690
3690
|
"VDataTableFooter/items-per-page-text": {
|
@@ -3719,6 +3719,10 @@
|
|
3719
3719
|
"type": "boolean\n",
|
3720
3720
|
"description": "Show current page number between prev/next icons."
|
3721
3721
|
},
|
3722
|
+
"VDataTableHeaders/sticky": {
|
3723
|
+
"type": "boolean\n",
|
3724
|
+
"description": "Sticks the header to the top of the table."
|
3725
|
+
},
|
3722
3726
|
"VDataTableHeaders/color": {
|
3723
3727
|
"type": "string\n",
|
3724
3728
|
"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)."
|
@@ -3727,9 +3731,13 @@
|
|
3727
3731
|
"type": "string | boolean\n",
|
3728
3732
|
"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."
|
3729
3733
|
},
|
3730
|
-
"VDataTableHeaders/
|
3734
|
+
"VDataTableHeaders/mobile": {
|
3731
3735
|
"type": "boolean\n",
|
3732
|
-
"description": "
|
3736
|
+
"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"
|
3737
|
+
},
|
3738
|
+
"VDataTableHeaders/mobile-breakpoint": {
|
3739
|
+
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3740
|
+
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3733
3741
|
},
|
3734
3742
|
"VDataTableHeaders/multi-sort": {
|
3735
3743
|
"type": "boolean\n",
|
@@ -3739,50 +3747,62 @@
|
|
3739
3747
|
"type": "unknown\n",
|
3740
3748
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDataTableHeaders.json))"
|
3741
3749
|
},
|
3742
|
-
"VDataTableHeaders/mobile": {
|
3743
|
-
"type": "boolean\n",
|
3744
|
-
"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"
|
3745
|
-
},
|
3746
3750
|
"VDataTableHeaders/disable-sort": {
|
3747
3751
|
"type": "boolean\n",
|
3748
3752
|
"description": "Toggles rendering of sort button."
|
3749
3753
|
},
|
3750
3754
|
"VDataTableHeaders/sort-asc-icon": {
|
3751
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
3755
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
3752
3756
|
"description": "Icon used for ascending sort button."
|
3753
3757
|
},
|
3754
3758
|
"VDataTableHeaders/sort-desc-icon": {
|
3755
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
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
|
-
"
|
3759
|
-
"type": "
|
3762
|
+
"VDataTableRow/mobile": {
|
3763
|
+
"type": "boolean\n",
|
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"
|
3765
|
+
},
|
3766
|
+
"VDataTableRow/mobile-breakpoint": {
|
3767
|
+
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3760
3768
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3761
3769
|
},
|
3762
3770
|
"VDataTableRow/item": {
|
3763
3771
|
"type": "unknown\n",
|
3764
3772
|
"description": "Data (key, index and column values) of the displayed item."
|
3765
3773
|
},
|
3774
|
+
"VDataTableRow/cell-props": {
|
3775
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<unknown>,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
3776
|
+
"description": "Props to be applied to the cell."
|
3777
|
+
},
|
3766
3778
|
"VDataTableRow/index": {
|
3767
3779
|
"type": "number\n",
|
3768
3780
|
"description": "Row index."
|
3769
3781
|
},
|
3770
|
-
"
|
3771
|
-
"type": "
|
3772
|
-
"description": "
|
3782
|
+
"VDataTableRows/loading": {
|
3783
|
+
"type": "string | boolean\n",
|
3784
|
+
"description": "Displays `loading` slot if set to `true`"
|
3773
3785
|
},
|
3774
|
-
"
|
3786
|
+
"VDataTableRows/mobile": {
|
3775
3787
|
"type": "boolean\n",
|
3776
3788
|
"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"
|
3777
3789
|
},
|
3778
|
-
"
|
3779
|
-
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'
|
3790
|
+
"VDataTableRows/mobile-breakpoint": {
|
3791
|
+
"type": "number | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl'\n",
|
3780
3792
|
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3781
3793
|
},
|
3782
3794
|
"VDataTableRows/items": {
|
3783
3795
|
"type": "(<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/types.ts#L48-L54\" target=\"_blank\">DataTableItem</a> | <a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/components/VDataTable/composables/group.ts#L18-L25\" target=\"_blank\">Group</a>)[]\n",
|
3784
3796
|
"description": "An array of strings or objects used for automatically generating children components."
|
3785
3797
|
},
|
3798
|
+
"VDataTableRows/cell-props": {
|
3799
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
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."
|
3801
|
+
},
|
3802
|
+
"VDataTableRows/loading-text": {
|
3803
|
+
"type": "string\n",
|
3804
|
+
"description": "Text shown when the data is loading."
|
3805
|
+
},
|
3786
3806
|
"VDataTableRows/hide-no-data": {
|
3787
3807
|
"type": "boolean\n",
|
3788
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."
|
@@ -3791,26 +3811,6 @@
|
|
3791
3811
|
"type": "string\n",
|
3792
3812
|
"description": "Text shown when no items are provided to the component."
|
3793
3813
|
},
|
3794
|
-
"VDataTableRows/loading": {
|
3795
|
-
"type": "string | boolean\n",
|
3796
|
-
"description": "Displays `loading` slot if set to `true`"
|
3797
|
-
},
|
3798
|
-
"VDataTableRows/cell-props": {
|
3799
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
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."
|
3801
|
-
},
|
3802
|
-
"VDataTableRows/mobile": {
|
3803
|
-
"type": "boolean\n",
|
3804
|
-
"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"
|
3805
|
-
},
|
3806
|
-
"VDataTableRows/mobile-breakpoint": {
|
3807
|
-
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xs'\n",
|
3808
|
-
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3809
|
-
},
|
3810
|
-
"VDataTableRows/loading-text": {
|
3811
|
-
"type": "string\n",
|
3812
|
-
"description": "Text shown when the data is loading."
|
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."
|
@@ -3879,10 +3879,6 @@
|
|
3879
3879
|
"type": "string | boolean\n",
|
3880
3880
|
"description": "Displays `loading` slot if set to `true`"
|
3881
3881
|
},
|
3882
|
-
"VDataTableServer/sticky": {
|
3883
|
-
"type": "boolean\n",
|
3884
|
-
"description": "Sticks the header to the top of the table."
|
3885
|
-
},
|
3886
3882
|
"VDataTableServer/next-icon": {
|
3887
3883
|
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3888
3884
|
"description": "Next icon."
|
@@ -3895,37 +3891,53 @@
|
|
3895
3891
|
"type": "boolean\n",
|
3896
3892
|
"description": "Will add a hover effect to a table's row when the mouse is over it."
|
3897
3893
|
},
|
3898
|
-
"VDataTableServer/
|
3899
|
-
"type": "
|
3900
|
-
"description": "
|
3894
|
+
"VDataTableServer/header-props": {
|
3895
|
+
"type": "unknown\n",
|
3896
|
+
"description": "Pass props to the default header. See [`v-data-table-server` API](/api/v-data-table-server) for more information."
|
3901
3897
|
},
|
3902
|
-
"VDataTableServer/
|
3898
|
+
"VDataTableServer/cell-props": {
|
3899
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'index' | 'internalItem' | 'column'\n >,\n ) => Record<string, any>)\n",
|
3900
|
+
"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."
|
3901
|
+
},
|
3902
|
+
"VDataTableServer/mobile": {
|
3903
3903
|
"type": "boolean\n",
|
3904
|
-
"description": "
|
3904
|
+
"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"
|
3905
|
+
},
|
3906
|
+
"VDataTableServer/headers": {
|
3907
|
+
"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?: '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 | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | '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?: '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 | { readonly [x: string]: any }\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | '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",
|
3908
|
+
"description": "An array of objects that each describe a header column."
|
3905
3909
|
},
|
3906
3910
|
"VDataTableServer/page": {
|
3907
3911
|
"type": "string | number\n",
|
3908
3912
|
"description": "The current displayed page number (1-indexed)."
|
3909
3913
|
},
|
3910
|
-
"VDataTableServer/
|
3911
|
-
"type": "
|
3912
|
-
"description": "
|
3914
|
+
"VDataTableServer/items-per-page": {
|
3915
|
+
"type": "string | number\n",
|
3916
|
+
"description": "The number of items to display on each page."
|
3913
3917
|
},
|
3914
|
-
"VDataTableServer/
|
3915
|
-
"type": "
|
3916
|
-
"description": "
|
3918
|
+
"VDataTableServer/loading-text": {
|
3919
|
+
"type": "string\n",
|
3920
|
+
"description": "Text shown when the data is loading."
|
3917
3921
|
},
|
3918
|
-
"VDataTableServer/
|
3922
|
+
"VDataTableServer/mobile-breakpoint": {
|
3923
|
+
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xs'\n",
|
3924
|
+
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
3925
|
+
},
|
3926
|
+
"VDataTableServer/row-props": {
|
3927
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
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."
|
3929
|
+
},
|
3930
|
+
"VDataTableServer/hide-default-body": {
|
3919
3931
|
"type": "boolean\n",
|
3920
|
-
"description": "
|
3932
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
3921
3933
|
},
|
3922
|
-
"VDataTableServer/
|
3923
|
-
"type": "
|
3924
|
-
"description": "
|
3934
|
+
"VDataTableServer/hide-default-footer": {
|
3935
|
+
"type": "boolean\n",
|
3936
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
3925
3937
|
},
|
3926
|
-
"VDataTableServer/
|
3927
|
-
"type": "
|
3928
|
-
"description": "
|
3938
|
+
"VDataTableServer/hide-default-header": {
|
3939
|
+
"type": "boolean\n",
|
3940
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
3929
3941
|
},
|
3930
3942
|
"VDataTableServer/expand-on-click": {
|
3931
3943
|
"type": "boolean\n",
|
@@ -3943,26 +3955,54 @@
|
|
3943
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",
|
3944
3956
|
"description": "Defines the grouping of the table items."
|
3945
3957
|
},
|
3946
|
-
"VDataTableServer/
|
3947
|
-
"type": "
|
3948
|
-
"description": "
|
3958
|
+
"VDataTableServer/item-selectable": {
|
3959
|
+
"type": "SelectItemKey<any>\n",
|
3960
|
+
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
3949
3961
|
},
|
3950
|
-
"VDataTableServer/
|
3951
|
-
"type": "
|
3952
|
-
"description": "
|
3962
|
+
"VDataTableServer/show-select": {
|
3963
|
+
"type": "boolean\n",
|
3964
|
+
"description": "Shows the column with checkboxes for selecting items in the list."
|
3953
3965
|
},
|
3954
|
-
"VDataTableServer/
|
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": {
|
3955
3971
|
"type": "boolean\n",
|
3956
|
-
"description": "
|
3972
|
+
"description": "Allows sorting by multiple columns."
|
3957
3973
|
},
|
3958
|
-
"VDataTableServer/
|
3959
|
-
"type": "
|
3960
|
-
"description": "
|
3974
|
+
"VDataTableServer/must-sort": {
|
3975
|
+
"type": "boolean\n",
|
3976
|
+
"description": "Forces sorting on the column(s)."
|
3977
|
+
},
|
3978
|
+
"VDataTableServer/custom-key-sort": {
|
3979
|
+
"type": "unknown\n",
|
3980
|
+
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
|
3981
|
+
},
|
3982
|
+
"VDataTableServer/sticky": {
|
3983
|
+
"type": "boolean\n",
|
3984
|
+
"description": "Sticks the header to the top of the table."
|
3961
3985
|
},
|
3962
3986
|
"VDataTableServer/disable-sort": {
|
3963
3987
|
"type": "boolean\n",
|
3964
3988
|
"description": "Toggles rendering of sort button."
|
3965
3989
|
},
|
3990
|
+
"VDataTableServer/sort-asc-icon": {
|
3991
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3992
|
+
"description": "Icon used for ascending sort button."
|
3993
|
+
},
|
3994
|
+
"VDataTableServer/sort-desc-icon": {
|
3995
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3996
|
+
"description": "Icon used for descending sort button."
|
3997
|
+
},
|
3998
|
+
"VDataTableServer/fixed-header": {
|
3999
|
+
"type": "boolean\n",
|
4000
|
+
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
|
4001
|
+
},
|
4002
|
+
"VDataTableServer/fixed-footer": {
|
4003
|
+
"type": "boolean\n",
|
4004
|
+
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
4005
|
+
},
|
3966
4006
|
"VDataTableServer/first-icon": {
|
3967
4007
|
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
3968
4008
|
"description": "First icon."
|
@@ -4003,49 +4043,9 @@
|
|
4003
4043
|
"type": "boolean\n",
|
4004
4044
|
"description": "Show current page number between prev/next icons."
|
4005
4045
|
},
|
4006
|
-
"VDataTableServer/
|
4007
|
-
"type": "
|
4008
|
-
"description": "
|
4009
|
-
},
|
4010
|
-
"VDataTableServer/sort-asc-icon": {
|
4011
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
4012
|
-
"description": "Icon used for ascending sort button."
|
4013
|
-
},
|
4014
|
-
"VDataTableServer/sort-desc-icon": {
|
4015
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
4016
|
-
"description": "Icon used for descending sort button."
|
4017
|
-
},
|
4018
|
-
"VDataTableServer/mobile-breakpoint": {
|
4019
|
-
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xs'\n",
|
4020
|
-
"description": "Overrides the display configuration default screen size that the component should be considered in mobile."
|
4021
|
-
},
|
4022
|
-
"VDataTableServer/loading-text": {
|
4023
|
-
"type": "string\n",
|
4024
|
-
"description": "Text shown when the data is loading."
|
4025
|
-
},
|
4026
|
-
"VDataTableServer/row-props": {
|
4027
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
4028
|
-
"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."
|
4029
|
-
},
|
4030
|
-
"VDataTableServer/hide-default-body": {
|
4031
|
-
"type": "boolean\n",
|
4032
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4033
|
-
},
|
4034
|
-
"VDataTableServer/hide-default-footer": {
|
4035
|
-
"type": "boolean\n",
|
4036
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4037
|
-
},
|
4038
|
-
"VDataTableServer/hide-default-header": {
|
4039
|
-
"type": "boolean\n",
|
4040
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4041
|
-
},
|
4042
|
-
"VDataTableServer/fixed-header": {
|
4043
|
-
"type": "boolean\n",
|
4044
|
-
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
|
4045
|
-
},
|
4046
|
-
"VDataTableServer/fixed-footer": {
|
4047
|
-
"type": "boolean\n",
|
4048
|
-
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
4046
|
+
"VDataTableServer/items-length": {
|
4047
|
+
"type": "string | number\n",
|
4048
|
+
"description": "Number of all items."
|
4049
4049
|
},
|
4050
4050
|
"VDataTableVirtual/search": {
|
4051
4051
|
"type": "string\n",
|
@@ -4107,45 +4107,41 @@
|
|
4107
4107
|
"type": "(a: any, b: any) => boolean\n",
|
4108
4108
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
4109
4109
|
},
|
4110
|
-
"VDataTableVirtual/
|
4111
|
-
"type": "
|
4112
|
-
"description": "
|
4113
|
-
},
|
4114
|
-
"VDataTableVirtual/cell-props": {
|
4115
|
-
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
4116
|
-
"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."
|
4110
|
+
"VDataTableVirtual/item-value": {
|
4111
|
+
"type": "SelectItemKey<any>\n",
|
4112
|
+
"description": "Property on supplied `items` that contains its value."
|
4117
4113
|
},
|
4118
|
-
"VDataTableVirtual/
|
4119
|
-
"type": "
|
4120
|
-
"description": "
|
4114
|
+
"VDataTableVirtual/item-selectable": {
|
4115
|
+
"type": "SelectItemKey<any>\n",
|
4116
|
+
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
4121
4117
|
},
|
4122
|
-
"VDataTableVirtual/
|
4123
|
-
"type": "
|
4124
|
-
"description": "
|
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**."
|
4125
4121
|
},
|
4126
|
-
"VDataTableVirtual/
|
4122
|
+
"VDataTableVirtual/show-select": {
|
4127
4123
|
"type": "boolean\n",
|
4128
|
-
"description": "
|
4124
|
+
"description": "Shows the column with checkboxes for selecting items in the list."
|
4129
4125
|
},
|
4130
|
-
"VDataTableVirtual/
|
4131
|
-
"type": "
|
4132
|
-
"description": "
|
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)."
|
4133
4129
|
},
|
4134
|
-
"VDataTableVirtual/
|
4135
|
-
"type": "
|
4136
|
-
"description": "
|
4130
|
+
"VDataTableVirtual/sort-by": {
|
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",
|
4132
|
+
"description": "Array of column keys and sort orders that determines the sort order of the table."
|
4137
4133
|
},
|
4138
|
-
"VDataTableVirtual/
|
4134
|
+
"VDataTableVirtual/multi-sort": {
|
4139
4135
|
"type": "boolean\n",
|
4140
|
-
"description": "
|
4136
|
+
"description": "Allows sorting by multiple columns."
|
4141
4137
|
},
|
4142
|
-
"VDataTableVirtual/
|
4138
|
+
"VDataTableVirtual/must-sort": {
|
4143
4139
|
"type": "boolean\n",
|
4144
|
-
"description": "
|
4140
|
+
"description": "Forces sorting on the column(s)."
|
4145
4141
|
},
|
4146
|
-
"VDataTableVirtual/
|
4147
|
-
"type": "
|
4148
|
-
"description": "
|
4142
|
+
"VDataTableVirtual/custom-key-sort": {
|
4143
|
+
"type": "unknown\n",
|
4144
|
+
"description": "Function used on specific keys within the item object. `customSort` is skipped for columns with `customKeySort` specified."
|
4149
4145
|
},
|
4150
4146
|
"VDataTableVirtual/expand-on-click": {
|
4151
4147
|
"type": "boolean\n",
|
@@ -4163,46 +4159,42 @@
|
|
4163
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",
|
4164
4160
|
"description": "Defines the grouping of the table items."
|
4165
4161
|
},
|
4166
|
-
"VDataTableVirtual/
|
4167
|
-
"type": "
|
4168
|
-
"description": "
|
4169
|
-
},
|
4170
|
-
"VDataTableVirtual/item-selectable": {
|
4171
|
-
"type": "SelectItemKey<any>\n",
|
4172
|
-
"description": "Property on supplied `items` that indicates whether the item is selectable."
|
4173
|
-
},
|
4174
|
-
"VDataTableVirtual/return-object": {
|
4175
|
-
"type": "boolean\n",
|
4176
|
-
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
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."
|
4177
4165
|
},
|
4178
|
-
"VDataTableVirtual/
|
4166
|
+
"VDataTableVirtual/no-filter": {
|
4179
4167
|
"type": "boolean\n",
|
4180
|
-
"description": "
|
4181
|
-
},
|
4182
|
-
"VDataTableVirtual/select-strategy": {
|
4183
|
-
"type": "'page' | 'single' | 'all'\n",
|
4184
|
-
"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)."
|
4168
|
+
"description": "Disables all item filtering."
|
4185
4169
|
},
|
4186
|
-
"VDataTableVirtual/
|
4187
|
-
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/
|
4188
|
-
"description": "
|
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."
|
4189
4173
|
},
|
4190
|
-
"VDataTableVirtual/
|
4191
|
-
"type": "
|
4192
|
-
"description": "
|
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."
|
4193
4177
|
},
|
4194
|
-
"VDataTableVirtual/
|
4195
|
-
"type": "
|
4196
|
-
"description": "
|
4178
|
+
"VDataTableVirtual/filter-keys": {
|
4179
|
+
"type": "string | string[]\n",
|
4180
|
+
"description": "Array of specific keys to filter on the item."
|
4197
4181
|
},
|
4198
|
-
"VDataTableVirtual/
|
4182
|
+
"VDataTableVirtual/header-props": {
|
4199
4183
|
"type": "unknown\n",
|
4200
|
-
"description": "
|
4184
|
+
"description": "Pass props to the default header."
|
4185
|
+
},
|
4186
|
+
"VDataTableVirtual/cell-props": {
|
4187
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<\n ItemKeySlot<any>,\n 'value' | 'item' | 'column' | 'index' | 'internalItem'\n >,\n ) => Record<string, any>)\n",
|
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."
|
4201
4189
|
},
|
4202
4190
|
"VDataTableVirtual/disable-sort": {
|
4203
4191
|
"type": "boolean\n",
|
4204
4192
|
"description": "Toggles rendering of sort button."
|
4205
4193
|
},
|
4194
|
+
"VDataTableVirtual/headers": {
|
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?: '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 | ((\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?: '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 | ((\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",
|
4196
|
+
"description": "An array of objects that each describe a header column."
|
4197
|
+
},
|
4206
4198
|
"VDataTableVirtual/sort-asc-icon": {
|
4207
4199
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4208
4200
|
"description": "Icon used for ascending sort button."
|
@@ -4211,33 +4203,41 @@
|
|
4211
4203
|
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
4212
4204
|
"description": "Icon used for descending sort button."
|
4213
4205
|
},
|
4214
|
-
"VDataTableVirtual/
|
4215
|
-
"type": "
|
4216
|
-
"description": "
|
4206
|
+
"VDataTableVirtual/loading-text": {
|
4207
|
+
"type": "string\n",
|
4208
|
+
"description": "Text shown when the data is loading."
|
4217
4209
|
},
|
4218
|
-
"VDataTableVirtual/
|
4210
|
+
"VDataTableVirtual/hide-no-data": {
|
4219
4211
|
"type": "boolean\n",
|
4220
|
-
"description": "
|
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."
|
4221
4213
|
},
|
4222
|
-
"VDataTableVirtual/
|
4223
|
-
"type": "
|
4224
|
-
"description": "
|
4214
|
+
"VDataTableVirtual/no-data-text": {
|
4215
|
+
"type": "string\n",
|
4216
|
+
"description": "Text shown when no items are provided to the component."
|
4225
4217
|
},
|
4226
|
-
"VDataTableVirtual/
|
4218
|
+
"VDataTableVirtual/row-props": {
|
4219
|
+
"type": " | Record<string, any>\n | ((\n data: Pick<ItemKeySlot<any>, 'item' | 'index' | 'internalItem'>,\n ) => Record<string, any>)\n",
|
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."
|
4221
|
+
},
|
4222
|
+
"VDataTableVirtual/hide-default-body": {
|
4227
4223
|
"type": "boolean\n",
|
4228
|
-
"description": "
|
4224
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4229
4225
|
},
|
4230
|
-
"VDataTableVirtual/
|
4231
|
-
"type": "
|
4232
|
-
"description": "
|
4226
|
+
"VDataTableVirtual/hide-default-footer": {
|
4227
|
+
"type": "boolean\n",
|
4228
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4233
4229
|
},
|
4234
|
-
"VDataTableVirtual/
|
4235
|
-
"type": "
|
4236
|
-
"description": "
|
4230
|
+
"VDataTableVirtual/hide-default-header": {
|
4231
|
+
"type": "boolean\n",
|
4232
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/DataTable.json))"
|
4237
4233
|
},
|
4238
|
-
"VDataTableVirtual/
|
4239
|
-
"type": "
|
4240
|
-
"description": "
|
4234
|
+
"VDataTableVirtual/fixed-header": {
|
4235
|
+
"type": "boolean\n",
|
4236
|
+
"description": "Use the fixed-header prop together with the height prop to fix the header to the top of the table."
|
4237
|
+
},
|
4238
|
+
"VDataTableVirtual/fixed-footer": {
|
4239
|
+
"type": "boolean\n",
|
4240
|
+
"description": "Use the fixed-footer prop together with the height prop to fix the footer to the bottom of the table."
|
4241
4241
|
},
|
4242
4242
|
"VDataTableVirtual/item-height": {
|
4243
4243
|
"type": "string | number\n",
|
@@ -4699,9 +4699,9 @@
|
|
4699
4699
|
"type": "string | string[]\n",
|
4700
4700
|
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
4701
4701
|
},
|
4702
|
-
"VDatePicker/
|
4703
|
-
"type": "
|
4704
|
-
"description": "
|
4702
|
+
"VDatePicker/max": {
|
4703
|
+
"type": "unknown\n",
|
4704
|
+
"description": "Maximum allowed date/month (ISO 8601 format)."
|
4705
4705
|
},
|
4706
4706
|
"VDatePicker/next-icon": {
|
4707
4707
|
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
@@ -4763,10 +4763,6 @@
|
|
4763
4763
|
"type": "unknown\n",
|
4764
4764
|
"description": "The value that determines the month to show. This is different from modelValue, which determines the selected value."
|
4765
4765
|
},
|
4766
|
-
"VDatePicker/max": {
|
4767
|
-
"type": "unknown\n",
|
4768
|
-
"description": "Maximum allowed date/month (ISO 8601 format)."
|
4769
|
-
},
|
4770
4766
|
"VDatePicker/min": {
|
4771
4767
|
"type": "unknown\n",
|
4772
4768
|
"description": "Minimum allowed date/month (ISO 8601 format)."
|
@@ -4779,6 +4775,10 @@
|
|
4779
4775
|
"type": "boolean\n",
|
4780
4776
|
"description": "Hides the header."
|
4781
4777
|
},
|
4778
|
+
"VDatePicker/position": {
|
4779
|
+
"type": "'fixed' | 'relative' | 'absolute' | 'static' | 'sticky'\n",
|
4780
|
+
"description": "Sets the position for the component."
|
4781
|
+
},
|
4782
4782
|
"VDatePickerControls/text": {
|
4783
4783
|
"type": "string\n",
|
4784
4784
|
"description": "Specify content text for the component."
|
@@ -4823,42 +4823,54 @@
|
|
4823
4823
|
"type": "string\n",
|
4824
4824
|
"description": "Sets the transition when the header changes."
|
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
|
+
},
|
4830
|
+
"VDatePickerMonth/multiple": {
|
4831
|
+
"type": "number | boolean | (string & {}) | 'range'\n",
|
4832
|
+
"description": "Sets the multiple of the month."
|
4829
4833
|
},
|
4830
4834
|
"VDatePickerMonth/color": {
|
4831
4835
|
"type": "string\n",
|
4832
4836
|
"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
4837
|
},
|
4834
|
-
"VDatePickerMonth/
|
4835
|
-
"type": "
|
4836
|
-
"description": "
|
4837
|
-
},
|
4838
|
-
"VDatePickerMonth/max": {
|
4839
|
-
"type": "unknown\n",
|
4840
|
-
"description": "Sets the maximum date of the month."
|
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/max": {
|
4847
|
+
"type": "unknown\n",
|
4848
|
+
"description": "Sets the maximum date 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/show-adjacent-months": {
|
4855
|
-
"type": "boolean\n",
|
4856
|
-
"description": "Show adjacent months."
|
4857
|
-
},
|
4858
4854
|
"VDatePickerMonth/year": {
|
4859
4855
|
"type": "string | number\n",
|
4860
4856
|
"description": "Sets the year."
|
4861
4857
|
},
|
4858
|
+
"VDatePickerMonth/hide-weekdays": {
|
4859
|
+
"type": "boolean\n",
|
4860
|
+
"description": "Hide the days of the week letters."
|
4861
|
+
},
|
4862
|
+
"VDatePickerMonth/show-week": {
|
4863
|
+
"type": "boolean\n",
|
4864
|
+
"description": "Show the week number."
|
4865
|
+
},
|
4866
|
+
"VDatePickerMonth/reverse-transition": {
|
4867
|
+
"type": "string\n",
|
4868
|
+
"description": "The transition used when changing months into the past"
|
4869
|
+
},
|
4870
|
+
"VDatePickerMonth/show-adjacent-months": {
|
4871
|
+
"type": "boolean\n",
|
4872
|
+
"description": "Show adjacent months."
|
4873
|
+
},
|
4862
4874
|
"VDatePickerMonth/weekdays": {
|
4863
4875
|
"type": "number[]\n",
|
4864
4876
|
"description": "Sets the weekdays of the month."
|
@@ -4883,17 +4895,9 @@
|
|
4883
4895
|
"type": "unknown\n",
|
4884
4896
|
"description": "Sets the minimum date of the month."
|
4885
4897
|
},
|
4886
|
-
"
|
4887
|
-
"type": "
|
4888
|
-
"description": "The
|
4889
|
-
},
|
4890
|
-
"VDatePickerMonth/hide-weekdays": {
|
4891
|
-
"type": "boolean\n",
|
4892
|
-
"description": "Hide the days of the week letters."
|
4893
|
-
},
|
4894
|
-
"VDatePickerMonth/show-week": {
|
4895
|
-
"type": "boolean\n",
|
4896
|
-
"description": "Show the week number."
|
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."
|
4897
4901
|
},
|
4898
4902
|
"VDatePickerMonths/height": {
|
4899
4903
|
"type": "string | number\n",
|
@@ -4903,18 +4907,14 @@
|
|
4903
4907
|
"type": "string\n",
|
4904
4908
|
"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)."
|
4905
4909
|
},
|
4906
|
-
"VDatePickerMonths/
|
4907
|
-
"type": "
|
4908
|
-
"description": "
|
4910
|
+
"VDatePickerMonths/max": {
|
4911
|
+
"type": "unknown\n",
|
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
4914
|
"VDatePickerMonths/year": {
|
4911
4915
|
"type": "number\n",
|
4912
4916
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDatePickerMonths.json))"
|
4913
4917
|
},
|
4914
|
-
"VDatePickerMonths/max": {
|
4915
|
-
"type": "unknown\n",
|
4916
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VDatePickerMonths.json))"
|
4917
|
-
},
|
4918
4918
|
"VDatePickerMonths/min": {
|
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))"
|
@@ -5287,26 +5287,54 @@
|
|
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)."
|
5301
5301
|
},
|
5302
|
+
"VExpansionPanel/tag": {
|
5303
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
5304
|
+
"description": "Specify a custom tag used on the root element."
|
5305
|
+
},
|
5302
5306
|
"VExpansionPanel/title": {
|
5303
5307
|
"type": "string\n",
|
5304
5308
|
"description": "Specify a title text for the component."
|
5305
5309
|
},
|
5310
|
+
"VExpansionPanel/value": {
|
5311
|
+
"type": "any\n",
|
5312
|
+
"description": "Controls the opened/closed state of content."
|
5313
|
+
},
|
5306
5314
|
"VExpansionPanel/text": {
|
5307
5315
|
"type": "string\n",
|
5308
5316
|
"description": "Specify content text for the component."
|
5309
5317
|
},
|
5318
|
+
"VExpansionPanel/eager": {
|
5319
|
+
"type": "boolean\n",
|
5320
|
+
"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."
|
5321
|
+
},
|
5322
|
+
"VExpansionPanel/bg-color": {
|
5323
|
+
"type": "string\n",
|
5324
|
+
"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)."
|
5325
|
+
},
|
5326
|
+
"VExpansionPanel/disabled": {
|
5327
|
+
"type": "boolean\n",
|
5328
|
+
"description": "Disables the expansion-panel content."
|
5329
|
+
},
|
5330
|
+
"VExpansionPanel/expand-icon": {
|
5331
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
5332
|
+
"description": "Icon used when the expansion panel is in a expandable state."
|
5333
|
+
},
|
5334
|
+
"VExpansionPanel/collapse-icon": {
|
5335
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
5336
|
+
"description": "Icon used when the expansion panel is in a collapsable state."
|
5337
|
+
},
|
5310
5338
|
"VExpansionPanel/height": {
|
5311
5339
|
"type": "string | number\n",
|
5312
5340
|
"description": "Sets the height for the component."
|
@@ -5335,10 +5363,6 @@
|
|
5335
5363
|
"type": "string | number\n",
|
5336
5364
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
5337
5365
|
},
|
5338
|
-
"VExpansionPanel/static": {
|
5339
|
-
"type": "boolean\n",
|
5340
|
-
"description": "Remove title size expansion when selected."
|
5341
|
-
},
|
5342
5366
|
"VExpansionPanel/rounded": {
|
5343
5367
|
"type": "string | number | boolean\n",
|
5344
5368
|
"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)."
|
@@ -5347,54 +5371,30 @@
|
|
5347
5371
|
"type": "boolean\n",
|
5348
5372
|
"description": "Removes any applied **border-radius** from the component."
|
5349
5373
|
},
|
5350
|
-
"VExpansionPanel/tag": {
|
5351
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
5352
|
-
"description": "Specify a custom tag used on the root element."
|
5353
|
-
},
|
5354
5374
|
"VExpansionPanel/color": {
|
5355
5375
|
"type": "string\n",
|
5356
5376
|
"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)."
|
5357
5377
|
},
|
5378
|
+
"VExpansionPanel/static": {
|
5379
|
+
"type": "boolean\n",
|
5380
|
+
"description": "Remove title size expansion when selected."
|
5381
|
+
},
|
5358
5382
|
"VExpansionPanel/readonly": {
|
5359
5383
|
"type": "boolean\n",
|
5360
5384
|
"description": "Makes the expansion panel content read only."
|
5361
5385
|
},
|
5386
|
+
"VExpansionPanel/selected-class": {
|
5387
|
+
"type": "string\n",
|
5388
|
+
"description": "Configure the active CSS class applied when an item is selected."
|
5389
|
+
},
|
5362
5390
|
"VExpansionPanel/ripple": {
|
5363
5391
|
"type": "boolean | { class: string }\n",
|
5364
5392
|
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
5365
5393
|
},
|
5366
|
-
"VExpansionPanel/
|
5367
|
-
"type": "any\n",
|
5368
|
-
"description": "Controls the opened/closed state of content."
|
5369
|
-
},
|
5370
|
-
"VExpansionPanel/disabled": {
|
5371
|
-
"type": "boolean\n",
|
5372
|
-
"description": "Disables the expansion-panel content."
|
5373
|
-
},
|
5374
|
-
"VExpansionPanel/selected-class": {
|
5375
|
-
"type": "string\n",
|
5376
|
-
"description": "Configure the active CSS class applied when an item is selected."
|
5377
|
-
},
|
5378
|
-
"VExpansionPanel/bg-color": {
|
5379
|
-
"type": "string\n",
|
5380
|
-
"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)."
|
5381
|
-
},
|
5382
|
-
"VExpansionPanel/eager": {
|
5383
|
-
"type": "boolean\n",
|
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
|
-
},
|
5386
|
-
"VExpansionPanel/hide-actions": {
|
5394
|
+
"VExpansionPanel/hide-actions": {
|
5387
5395
|
"type": "boolean\n",
|
5388
5396
|
"description": "Hide the expand icon in the content title."
|
5389
5397
|
},
|
5390
|
-
"VExpansionPanel/expand-icon": {
|
5391
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5392
|
-
"description": "Icon used when the expansion panel is in a expandable state."
|
5393
|
-
},
|
5394
|
-
"VExpansionPanel/collapse-icon": {
|
5395
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5396
|
-
"description": "Icon used when the expansion panel is in a collapsable state."
|
5397
|
-
},
|
5398
5398
|
"VExpansionPanel/focusable": {
|
5399
5399
|
"type": "boolean\n",
|
5400
5400
|
"description": "Makes the expansion panel content focusable."
|
@@ -5403,14 +5403,6 @@
|
|
5403
5403
|
"type": "boolean\n",
|
5404
5404
|
"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."
|
5405
5405
|
},
|
5406
|
-
"VExpansionPanelTitle/expand-icon": {
|
5407
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
5408
|
-
"description": "Icon used when the expansion panel is in a expandable state."
|
5409
|
-
},
|
5410
|
-
"VExpansionPanelTitle/collapse-icon": {
|
5411
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
5412
|
-
"description": "Icon used when the expansion panel is in a collapsable state."
|
5413
|
-
},
|
5414
5406
|
"VExpansionPanelTitle/height": {
|
5415
5407
|
"type": "string | number\n",
|
5416
5408
|
"description": "Sets the height for the component."
|
@@ -5435,14 +5427,14 @@
|
|
5435
5427
|
"type": "string | number\n",
|
5436
5428
|
"description": "Sets the width for the component."
|
5437
5429
|
},
|
5438
|
-
"VExpansionPanelTitle/color": {
|
5439
|
-
"type": "string\n",
|
5440
|
-
"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)."
|
5441
|
-
},
|
5442
5430
|
"VExpansionPanelTitle/static": {
|
5443
5431
|
"type": "boolean\n",
|
5444
5432
|
"description": "Remove title size expansion when selected."
|
5445
5433
|
},
|
5434
|
+
"VExpansionPanelTitle/color": {
|
5435
|
+
"type": "string\n",
|
5436
|
+
"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)."
|
5437
|
+
},
|
5446
5438
|
"VExpansionPanelTitle/readonly": {
|
5447
5439
|
"type": "boolean\n",
|
5448
5440
|
"description": "Makes the expansion panel content read only."
|
@@ -5455,6 +5447,14 @@
|
|
5455
5447
|
"type": "boolean\n",
|
5456
5448
|
"description": "Hide the expand icon in the content title."
|
5457
5449
|
},
|
5450
|
+
"VExpansionPanelTitle/expand-icon": {
|
5451
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5452
|
+
"description": "Icon used when the expansion panel is in a expandable state."
|
5453
|
+
},
|
5454
|
+
"VExpansionPanelTitle/collapse-icon": {
|
5455
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5456
|
+
"description": "Icon used when the expansion panel is in a collapsable state."
|
5457
|
+
},
|
5458
5458
|
"VExpansionPanelTitle/focusable": {
|
5459
5459
|
"type": "boolean\n",
|
5460
5460
|
"description": "Makes the expansion panel headers focusable."
|
@@ -5531,17 +5531,17 @@
|
|
5531
5531
|
"type": "boolean\n",
|
5532
5532
|
"description": "Makes the entire expansion panel read only."
|
5533
5533
|
},
|
5534
|
-
"VExpansionPanels/
|
5535
|
-
"type": "
|
5536
|
-
"description": "
|
5534
|
+
"VExpansionPanels/max": {
|
5535
|
+
"type": "number\n",
|
5536
|
+
"description": "Sets a maximum number of selections that can be made."
|
5537
5537
|
},
|
5538
5538
|
"VExpansionPanels/selected-class": {
|
5539
5539
|
"type": "string\n",
|
5540
5540
|
"description": "Configure the active CSS class applied when an item is selected."
|
5541
5541
|
},
|
5542
|
-
"VExpansionPanels/
|
5543
|
-
"type": "
|
5544
|
-
"description": "
|
5542
|
+
"VExpansionPanels/ripple": {
|
5543
|
+
"type": "boolean | { class: string }\n",
|
5544
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
5545
5545
|
},
|
5546
5546
|
"VExpansionPanels/hide-actions": {
|
5547
5547
|
"type": "boolean\n",
|
@@ -5775,22 +5775,22 @@
|
|
5775
5775
|
"type": "boolean\n",
|
5776
5776
|
"description": "Absolutely positions the leaving element (useful for [FLIP](https://aerotwist.com/blog/flip-your-animations/))."
|
5777
5777
|
},
|
5778
|
-
"VFadeTransition/disabled": {
|
5779
|
-
"type": "boolean\n",
|
5780
|
-
"description": "Removes the ability to click or target the component."
|
5781
|
-
},
|
5782
5778
|
"VFadeTransition/mode": {
|
5783
5779
|
"type": "string\n",
|
5784
5780
|
"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)."
|
5785
5781
|
},
|
5786
|
-
"VFadeTransition/
|
5782
|
+
"VFadeTransition/disabled": {
|
5787
5783
|
"type": "boolean\n",
|
5788
|
-
"description": "
|
5784
|
+
"description": "Removes the ability to click or target the component."
|
5789
5785
|
},
|
5790
5786
|
"VFadeTransition/origin": {
|
5791
5787
|
"type": "string\n",
|
5792
5788
|
"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)."
|
5793
5789
|
},
|
5790
|
+
"VFadeTransition/group": {
|
5791
|
+
"type": "boolean\n",
|
5792
|
+
"description": "Creates a `transition-group` component. You can find more information in the [vue docs](https://vuejs.org/api/built-in-components.html#transitiongroup)."
|
5793
|
+
},
|
5794
5794
|
"VFadeTransition/hide-on-leave": {
|
5795
5795
|
"type": "boolean\n",
|
5796
5796
|
"description": "Hides the leaving element (no exit animation)."
|
@@ -5803,57 +5803,65 @@
|
|
5803
5803
|
"type": "boolean\n",
|
5804
5804
|
"description": "Removes box shadow when using a variant with elevation."
|
5805
5805
|
},
|
5806
|
-
"VField/
|
5807
|
-
"type": "
|
5808
|
-
"description": "
|
5806
|
+
"VField/model-value": {
|
5807
|
+
"type": "unknown\n",
|
5808
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
5809
5809
|
},
|
5810
5810
|
"VField/error": {
|
5811
5811
|
"type": "boolean\n",
|
5812
5812
|
"description": "Puts the input in a manual error state."
|
5813
5813
|
},
|
5814
|
-
"VField/
|
5815
|
-
"type": "
|
5816
|
-
"description": "
|
5814
|
+
"VField/reverse": {
|
5815
|
+
"type": "boolean\n",
|
5816
|
+
"description": "Reverses the orientation."
|
5817
|
+
},
|
5818
|
+
"VField/rounded": {
|
5819
|
+
"type": "string | number | boolean\n",
|
5820
|
+
"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)."
|
5821
|
+
},
|
5822
|
+
"VField/tile": {
|
5823
|
+
"type": "boolean\n",
|
5824
|
+
"description": "Removes any applied **border-radius** from the component."
|
5817
5825
|
},
|
5818
5826
|
"VField/theme": {
|
5819
5827
|
"type": "string\n",
|
5820
5828
|
"description": "Specify a theme for this component and all of its children."
|
5821
5829
|
},
|
5822
|
-
"VField/
|
5830
|
+
"VField/color": {
|
5823
5831
|
"type": "string\n",
|
5824
|
-
"description": "
|
5832
|
+
"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)."
|
5833
|
+
},
|
5834
|
+
"VField/variant": {
|
5835
|
+
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
|
5836
|
+
"description": "Applies a distinct style to the component."
|
5837
|
+
},
|
5838
|
+
"VField/active": {
|
5839
|
+
"type": "boolean\n",
|
5840
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
5825
5841
|
},
|
5826
5842
|
"VField/base-color": {
|
5827
5843
|
"type": "string\n",
|
5828
5844
|
"description": "Sets the color of the input when it is not focused."
|
5829
5845
|
},
|
5830
|
-
"VField/bg-color": {
|
5831
|
-
"type": "string\n",
|
5832
|
-
"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)."
|
5833
|
-
},
|
5834
5846
|
"VField/disabled": {
|
5835
5847
|
"type": "boolean\n",
|
5836
5848
|
"description": "Removes the ability to click or target the input."
|
5837
5849
|
},
|
5838
|
-
"VField/
|
5839
|
-
"type": "string |
|
5840
|
-
"description": "
|
5841
|
-
},
|
5842
|
-
"VField/tile": {
|
5843
|
-
"type": "boolean\n",
|
5844
|
-
"description": "Removes any applied **border-radius** from the component."
|
5850
|
+
"VField/loading": {
|
5851
|
+
"type": "string | boolean\n",
|
5852
|
+
"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."
|
5845
5853
|
},
|
5846
|
-
"VField/
|
5854
|
+
"VField/label": {
|
5847
5855
|
"type": "string\n",
|
5848
|
-
"description": "
|
5856
|
+
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
5849
5857
|
},
|
5850
|
-
"VField/
|
5851
|
-
"type": "
|
5852
|
-
"description": "Applies a
|
5858
|
+
"VField/bg-color": {
|
5859
|
+
"type": "string\n",
|
5860
|
+
"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)."
|
5853
5861
|
},
|
5854
|
-
"VField/
|
5855
|
-
"type": "
|
5856
|
-
"description": "
|
5862
|
+
"VField/id": {
|
5863
|
+
"type": "string\n",
|
5864
|
+
"description": "Sets the DOM id on the component."
|
5857
5865
|
},
|
5858
5866
|
"VField/center-affix": {
|
5859
5867
|
"type": "boolean\n",
|
@@ -5864,7 +5872,7 @@
|
|
5864
5872
|
"description": "Forces a focused state styling on the component."
|
5865
5873
|
},
|
5866
5874
|
"VField/append-inner-icon": {
|
5867
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
5875
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5868
5876
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
|
5869
5877
|
},
|
5870
5878
|
"VField/clearable": {
|
@@ -5872,13 +5880,9 @@
|
|
5872
5880
|
"description": "Allows for the component to be cleared."
|
5873
5881
|
},
|
5874
5882
|
"VField/clear-icon": {
|
5875
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
5883
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5876
5884
|
"description": "The icon used when the **clearable** prop is set to true."
|
5877
5885
|
},
|
5878
|
-
"VField/active": {
|
5879
|
-
"type": "boolean\n",
|
5880
|
-
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
5881
|
-
},
|
5882
5886
|
"VField/dirty": {
|
5883
5887
|
"type": "boolean\n",
|
5884
5888
|
"description": "Manually apply the dirty state styling."
|
@@ -5888,17 +5892,13 @@
|
|
5888
5892
|
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
|
5889
5893
|
},
|
5890
5894
|
"VField/prepend-inner-icon": {
|
5891
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
5895
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5892
5896
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
|
5893
5897
|
},
|
5894
5898
|
"VField/single-line": {
|
5895
5899
|
"type": "boolean\n",
|
5896
5900
|
"description": "Label does not move on focus/dirty."
|
5897
5901
|
},
|
5898
|
-
"VField/loading": {
|
5899
|
-
"type": "string | boolean\n",
|
5900
|
-
"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."
|
5901
|
-
},
|
5902
5902
|
"VFieldLabel/floating": {
|
5903
5903
|
"type": "boolean\n",
|
5904
5904
|
"description": "Elevates the label above the slotted content."
|
@@ -5907,17 +5907,49 @@
|
|
5907
5907
|
"type": "boolean\n",
|
5908
5908
|
"description": "Removes box shadow when using a variant with elevation."
|
5909
5909
|
},
|
5910
|
-
"VFileInput/
|
5911
|
-
"type": "
|
5912
|
-
"description": "
|
5910
|
+
"VFileInput/reverse": {
|
5911
|
+
"type": "boolean\n",
|
5912
|
+
"description": "Reverses the orientation."
|
5913
|
+
},
|
5914
|
+
"VFileInput/name": {
|
5915
|
+
"type": "string\n",
|
5916
|
+
"description": "Sets the component's name attribute."
|
5913
5917
|
},
|
5914
5918
|
"VFileInput/error": {
|
5915
5919
|
"type": "boolean\n",
|
5916
5920
|
"description": "Puts the input in a manual error state."
|
5917
5921
|
},
|
5918
|
-
"VFileInput/
|
5922
|
+
"VFileInput/label": {
|
5923
|
+
"type": "string\n",
|
5924
|
+
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
5925
|
+
},
|
5926
|
+
"VFileInput/theme": {
|
5927
|
+
"type": "string\n",
|
5928
|
+
"description": "Specify a theme for this component and all of its children."
|
5929
|
+
},
|
5930
|
+
"VFileInput/id": {
|
5931
|
+
"type": "string\n",
|
5932
|
+
"description": "Sets the DOM id on the component."
|
5933
|
+
},
|
5934
|
+
"VFileInput/chips": {
|
5919
5935
|
"type": "boolean\n",
|
5920
|
-
"description": "
|
5936
|
+
"description": "Changes display of selections to chips."
|
5937
|
+
},
|
5938
|
+
"VFileInput/base-color": {
|
5939
|
+
"type": "string\n",
|
5940
|
+
"description": "Sets the color of the input when it is not focused."
|
5941
|
+
},
|
5942
|
+
"VFileInput/bg-color": {
|
5943
|
+
"type": "string\n",
|
5944
|
+
"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)."
|
5945
|
+
},
|
5946
|
+
"VFileInput/disabled": {
|
5947
|
+
"type": "boolean\n",
|
5948
|
+
"description": "Removes the ability to click or target the input."
|
5949
|
+
},
|
5950
|
+
"VFileInput/multiple": {
|
5951
|
+
"type": "boolean\n",
|
5952
|
+
"description": "Adds the **multiple** attribute to the input, allowing multiple file selections."
|
5921
5953
|
},
|
5922
5954
|
"VFileInput/density": {
|
5923
5955
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
@@ -5943,10 +5975,6 @@
|
|
5943
5975
|
"type": "boolean\n",
|
5944
5976
|
"description": "Removes any applied **border-radius** from the component."
|
5945
5977
|
},
|
5946
|
-
"VFileInput/theme": {
|
5947
|
-
"type": "string\n",
|
5948
|
-
"description": "Specify a theme for this component and all of its children."
|
5949
|
-
},
|
5950
5978
|
"VFileInput/color": {
|
5951
5979
|
"type": "string\n",
|
5952
5980
|
"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)."
|
@@ -5955,58 +5983,26 @@
|
|
5955
5983
|
"type": " | 'outlined'\n | 'plain'\n | 'underlined'\n | 'filled'\n | 'solo'\n | 'solo-inverted'\n | 'solo-filled'\n",
|
5956
5984
|
"description": "Applies a distinct style to the component."
|
5957
5985
|
},
|
5958
|
-
"VFileInput/
|
5959
|
-
"type": "
|
5960
|
-
"description": "
|
5986
|
+
"VFileInput/model-value": {
|
5987
|
+
"type": "File | File[]\n",
|
5988
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
5961
5989
|
},
|
5962
|
-
"VFileInput/
|
5990
|
+
"VFileInput/counter": {
|
5963
5991
|
"type": "boolean\n",
|
5964
|
-
"description": "
|
5965
|
-
},
|
5966
|
-
"VFileInput/base-color": {
|
5967
|
-
"type": "string\n",
|
5968
|
-
"description": "Sets the color of the input when it is not focused."
|
5969
|
-
},
|
5970
|
-
"VFileInput/prepend-icon": {
|
5971
|
-
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
5972
|
-
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
5992
|
+
"description": "Displays the number of selected files."
|
5973
5993
|
},
|
5974
5994
|
"VFileInput/append-icon": {
|
5975
|
-
"type": " | string\n | (
|
5995
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
5976
5996
|
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
5977
5997
|
},
|
5978
|
-
"VFileInput/readonly": {
|
5979
|
-
"type": "boolean\n",
|
5980
|
-
"description": "Puts input in readonly state."
|
5981
|
-
},
|
5982
|
-
"VFileInput/disabled": {
|
5983
|
-
"type": "boolean\n",
|
5984
|
-
"description": "Removes the ability to click or target the input."
|
5985
|
-
},
|
5986
|
-
"VFileInput/loading": {
|
5987
|
-
"type": "string | boolean\n",
|
5988
|
-
"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."
|
5989
|
-
},
|
5990
|
-
"VFileInput/label": {
|
5991
|
-
"type": "string\n",
|
5992
|
-
"description": "Sets the text of the [v-label](/api/v-label/) or [v-field-label](/api/v-field-label/) component."
|
5993
|
-
},
|
5994
|
-
"VFileInput/bg-color": {
|
5995
|
-
"type": "string\n",
|
5996
|
-
"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)."
|
5997
|
-
},
|
5998
|
-
"VFileInput/multiple": {
|
5999
|
-
"type": "boolean\n",
|
6000
|
-
"description": "Adds the **multiple** attribute to the input, allowing multiple file selections."
|
6001
|
-
},
|
6002
|
-
"VFileInput/id": {
|
6003
|
-
"type": "string\n",
|
6004
|
-
"description": "Sets the DOM id on the component."
|
6005
|
-
},
|
6006
5998
|
"VFileInput/center-affix": {
|
6007
5999
|
"type": "boolean\n",
|
6008
6000
|
"description": "Vertically align **appendInner**, **prependInner**, **clearIcon** and **label** in the center."
|
6009
6001
|
},
|
6002
|
+
"VFileInput/prepend-icon": {
|
6003
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
6004
|
+
"description": "Prepends an icon to the component, uses the same syntax as `v-icon`."
|
6005
|
+
},
|
6010
6006
|
"VFileInput/hide-spin-buttons": {
|
6011
6007
|
"type": "boolean\n",
|
6012
6008
|
"description": "Hides spin buttons on the input when type is set to `number`."
|
@@ -6035,6 +6031,10 @@
|
|
6035
6031
|
"type": "string | number\n",
|
6036
6032
|
"description": "Control the maximum number of shown errors from validation."
|
6037
6033
|
},
|
6034
|
+
"VFileInput/readonly": {
|
6035
|
+
"type": "boolean\n",
|
6036
|
+
"description": "Puts input in readonly state."
|
6037
|
+
},
|
6038
6038
|
"VFileInput/rules": {
|
6039
6039
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/composables/validation.ts#L16-L20\" target=\"_blank\">ValidationRule</a>[]\n",
|
6040
6040
|
"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`."
|
@@ -6055,12 +6055,8 @@
|
|
6055
6055
|
"type": "boolean | 'auto'\n",
|
6056
6056
|
"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."
|
6057
6057
|
},
|
6058
|
-
"VFileInput/counter": {
|
6059
|
-
"type": "boolean\n",
|
6060
|
-
"description": "Displays the number of selected files."
|
6061
|
-
},
|
6062
6058
|
"VFileInput/append-inner-icon": {
|
6063
|
-
"type": " | string\n | (
|
6059
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
6064
6060
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **append-inner** slot."
|
6065
6061
|
},
|
6066
6062
|
"VFileInput/clearable": {
|
@@ -6068,9 +6064,13 @@
|
|
6068
6064
|
"description": "Allows for the component to be cleared."
|
6069
6065
|
},
|
6070
6066
|
"VFileInput/clear-icon": {
|
6071
|
-
"type": " | string\n | (
|
6067
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
6072
6068
|
"description": "The icon used when the **clearable** prop is set to true."
|
6073
6069
|
},
|
6070
|
+
"VFileInput/active": {
|
6071
|
+
"type": "boolean\n",
|
6072
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
6073
|
+
},
|
6074
6074
|
"VFileInput/dirty": {
|
6075
6075
|
"type": "boolean\n",
|
6076
6076
|
"description": "Manually apply the dirty state styling."
|
@@ -6080,16 +6080,16 @@
|
|
6080
6080
|
"description": "Always show the clearable icon when the input is dirty (By default it only shows on hover)."
|
6081
6081
|
},
|
6082
6082
|
"VFileInput/prepend-inner-icon": {
|
6083
|
-
"type": " | string\n | (
|
6083
|
+
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
6084
6084
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend-inner** slot."
|
6085
6085
|
},
|
6086
6086
|
"VFileInput/single-line": {
|
6087
6087
|
"type": "boolean\n",
|
6088
6088
|
"description": "Label does not move on focus/dirty."
|
6089
6089
|
},
|
6090
|
-
"VFileInput/
|
6091
|
-
"type": "boolean\n",
|
6092
|
-
"description": "
|
6090
|
+
"VFileInput/loading": {
|
6091
|
+
"type": "string | boolean\n",
|
6092
|
+
"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."
|
6093
6093
|
},
|
6094
6094
|
"VFileInput/counter-size-string": {
|
6095
6095
|
"type": "string\n",
|
@@ -6107,42 +6107,26 @@
|
|
6107
6107
|
"type": "boolean | 1000 | 1024\n",
|
6108
6108
|
"description": "Sets the displayed size of selected file(s). When using **true** will default to _1000_ displaying (**kB, MB, GB**) while _1024_ will display (**KiB, MiB, GiB**)."
|
6109
6109
|
},
|
6110
|
-
"VFileUpload/length": {
|
6111
|
-
"type": "string | number\n",
|
6112
|
-
"description": "Sets the dividers length. Default unit is px."
|
6113
|
-
},
|
6114
|
-
"VFileUpload/tag": {
|
6115
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
6116
|
-
"description": "Specify a custom tag used on the root element."
|
6117
|
-
},
|
6118
|
-
"VFileUpload/name": {
|
6119
|
-
"type": "string\n",
|
6120
|
-
"description": "Sets the component's name attribute."
|
6121
|
-
},
|
6122
6110
|
"VFileUpload/title": {
|
6123
6111
|
"type": "string\n",
|
6124
6112
|
"description": "Specify a title text for the component."
|
6125
6113
|
},
|
6126
|
-
"VFileUpload/
|
6127
|
-
"type": "string\n",
|
6128
|
-
"description": "
|
6129
|
-
},
|
6130
|
-
"VFileUpload/subtitle": {
|
6131
|
-
"type": "string\n",
|
6132
|
-
"description": "Specify a subtitle text for the component."
|
6133
|
-
},
|
6134
|
-
"VFileUpload/disabled": {
|
6135
|
-
"type": "boolean\n",
|
6136
|
-
"description": "Removes the ability to click or target the component."
|
6137
|
-
},
|
6138
|
-
"VFileUpload/multiple": {
|
6139
|
-
"type": "boolean\n",
|
6140
|
-
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
6114
|
+
"VFileUpload/length": {
|
6115
|
+
"type": "string | number\n",
|
6116
|
+
"description": "Sets the dividers length. Default unit is px."
|
6141
6117
|
},
|
6142
6118
|
"VFileUpload/border": {
|
6143
6119
|
"type": "string | number | boolean\n",
|
6144
6120
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
6145
6121
|
},
|
6122
|
+
"VFileUpload/icon": {
|
6123
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6124
|
+
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
6125
|
+
},
|
6126
|
+
"VFileUpload/model-value": {
|
6127
|
+
"type": "File | File[]\n",
|
6128
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6129
|
+
},
|
6146
6130
|
"VFileUpload/density": {
|
6147
6131
|
"type": "'default' | 'comfortable' | 'compact'\n",
|
6148
6132
|
"description": "Adjusts the vertical height used by the component."
|
@@ -6175,6 +6159,14 @@
|
|
6175
6159
|
"type": "string | number\n",
|
6176
6160
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
6177
6161
|
},
|
6162
|
+
"VFileUpload/location": {
|
6163
|
+
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/anchor.ts#L8-L14\" target=\"_blank\">Anchor</a>\n",
|
6164
|
+
"description": "Specifies the component's location. Can combine by using a space separated string."
|
6165
|
+
},
|
6166
|
+
"VFileUpload/position": {
|
6167
|
+
"type": "'fixed' | 'static' | 'relative' | 'absolute' | 'sticky'\n",
|
6168
|
+
"description": "Sets the position for the component."
|
6169
|
+
},
|
6178
6170
|
"VFileUpload/rounded": {
|
6179
6171
|
"type": "string | number | boolean\n",
|
6180
6172
|
"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)."
|
@@ -6183,18 +6175,34 @@
|
|
6183
6175
|
"type": "boolean\n",
|
6184
6176
|
"description": "Removes any applied **border-radius** from the component."
|
6185
6177
|
},
|
6178
|
+
"VFileUpload/tag": {
|
6179
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
6180
|
+
"description": "Specify a custom tag used on the root element."
|
6181
|
+
},
|
6182
|
+
"VFileUpload/theme": {
|
6183
|
+
"type": "string\n",
|
6184
|
+
"description": "Specify a theme for this component and all of its children."
|
6185
|
+
},
|
6186
6186
|
"VFileUpload/color": {
|
6187
6187
|
"type": "string\n",
|
6188
6188
|
"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)."
|
6189
6189
|
},
|
6190
|
+
"VFileUpload/name": {
|
6191
|
+
"type": "string\n",
|
6192
|
+
"description": "Sets the component's name attribute."
|
6193
|
+
},
|
6194
|
+
"VFileUpload/disabled": {
|
6195
|
+
"type": "boolean\n",
|
6196
|
+
"description": "Removes the ability to click or target the component."
|
6197
|
+
},
|
6198
|
+
"VFileUpload/multiple": {
|
6199
|
+
"type": "boolean\n",
|
6200
|
+
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
6201
|
+
},
|
6190
6202
|
"VFileUpload/opacity": {
|
6191
6203
|
"type": "string | number\n",
|
6192
6204
|
"description": "Sets the component's opacity value"
|
6193
6205
|
},
|
6194
|
-
"VFileUpload/model-value": {
|
6195
|
-
"type": "File | File[]\n",
|
6196
|
-
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6197
|
-
},
|
6198
6206
|
"VFileUpload/scrim": {
|
6199
6207
|
"type": "string | boolean\n",
|
6200
6208
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
@@ -6207,21 +6215,17 @@
|
|
6207
6215
|
"type": "string | number\n",
|
6208
6216
|
"description": "Milliseconds to wait before opening component. Only applies to hover and focus events."
|
6209
6217
|
},
|
6210
|
-
"VFileUpload/
|
6211
|
-
"type": "
|
6212
|
-
"description": "
|
6218
|
+
"VFileUpload/subtitle": {
|
6219
|
+
"type": "string\n",
|
6220
|
+
"description": "Specify a subtitle text for the component."
|
6213
6221
|
},
|
6214
6222
|
"VFileUpload/clearable": {
|
6215
6223
|
"type": "boolean\n",
|
6216
6224
|
"description": "Allows for the component to be cleared."
|
6217
6225
|
},
|
6218
|
-
"VFileUpload/
|
6219
|
-
"type": "
|
6220
|
-
"description": "Sets the
|
6221
|
-
},
|
6222
|
-
"VFileUpload/icon": {
|
6223
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n | (string | [string, number])[]\n",
|
6224
|
-
"description": "Apply a specific icon using the [v-icon](/components/icons/) component."
|
6226
|
+
"VFileUpload/thickness": {
|
6227
|
+
"type": "string | number\n",
|
6228
|
+
"description": "Sets the dividers thickness. Default unit is px."
|
6225
6229
|
},
|
6226
6230
|
"VFileUpload/browse-text": {
|
6227
6231
|
"type": "string\n",
|
@@ -6239,9 +6243,9 @@
|
|
6239
6243
|
"type": "boolean\n",
|
6240
6244
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUpload.json))"
|
6241
6245
|
},
|
6242
|
-
"
|
6246
|
+
"VFileUploadItem/title": {
|
6243
6247
|
"type": "string | number\n",
|
6244
|
-
"description": "
|
6248
|
+
"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."
|
6245
6249
|
},
|
6246
6250
|
"VFileUploadItem/replace": {
|
6247
6251
|
"type": "boolean\n",
|
@@ -6251,58 +6255,6 @@
|
|
6251
6255
|
"type": "boolean\n",
|
6252
6256
|
"description": "Designates that the component is a link. This is automatic when using the href or to prop."
|
6253
6257
|
},
|
6254
|
-
"VFileUploadItem/tag": {
|
6255
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
6256
|
-
"description": "Specify a custom tag used on the root element."
|
6257
|
-
},
|
6258
|
-
"VFileUploadItem/nav": {
|
6259
|
-
"type": "boolean\n",
|
6260
|
-
"description": "Reduces the width v-list-item takes up as well as adding a border radius."
|
6261
|
-
},
|
6262
|
-
"VFileUploadItem/title": {
|
6263
|
-
"type": "string | number\n",
|
6264
|
-
"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."
|
6265
|
-
},
|
6266
|
-
"VFileUploadItem/theme": {
|
6267
|
-
"type": "string\n",
|
6268
|
-
"description": "Specify a theme for this component and all of its children."
|
6269
|
-
},
|
6270
|
-
"VFileUploadItem/value": {
|
6271
|
-
"type": "any\n",
|
6272
|
-
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
6273
|
-
},
|
6274
|
-
"VFileUploadItem/exact": {
|
6275
|
-
"type": "boolean\n",
|
6276
|
-
"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."
|
6277
|
-
},
|
6278
|
-
"VFileUploadItem/subtitle": {
|
6279
|
-
"type": "string | number\n",
|
6280
|
-
"description": "Specify a subtitle text for the component."
|
6281
|
-
},
|
6282
|
-
"VFileUploadItem/base-color": {
|
6283
|
-
"type": "string\n",
|
6284
|
-
"description": "Sets the color of component when not focused."
|
6285
|
-
},
|
6286
|
-
"VFileUploadItem/active-color": {
|
6287
|
-
"type": "string\n",
|
6288
|
-
"description": "The applied color when the component is in an active state."
|
6289
|
-
},
|
6290
|
-
"VFileUploadItem/active-class": {
|
6291
|
-
"type": "string\n",
|
6292
|
-
"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."
|
6293
|
-
},
|
6294
|
-
"VFileUploadItem/disabled": {
|
6295
|
-
"type": "boolean\n",
|
6296
|
-
"description": "Removes the ability to click or target the component."
|
6297
|
-
},
|
6298
|
-
"VFileUploadItem/lines": {
|
6299
|
-
"type": "false | 'one' | 'two' | 'three'\n",
|
6300
|
-
"description": "The line declaration specifies the minimum height of the item and can also be controlled from v-list with the same prop."
|
6301
|
-
},
|
6302
|
-
"VFileUploadItem/slim": {
|
6303
|
-
"type": "boolean\n",
|
6304
|
-
"description": "Reduces horizontal spacing for badges, icons, tooltips, and avatars to create a more compact visual representation."
|
6305
|
-
},
|
6306
6258
|
"VFileUploadItem/border": {
|
6307
6259
|
"type": "string | number | boolean\n",
|
6308
6260
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
@@ -6347,41 +6299,85 @@
|
|
6347
6299
|
"type": "boolean\n",
|
6348
6300
|
"description": "Removes any applied **border-radius** from the component."
|
6349
6301
|
},
|
6302
|
+
"VFileUploadItem/tag": {
|
6303
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
6304
|
+
"description": "Specify a custom tag used on the root element."
|
6305
|
+
},
|
6306
|
+
"VFileUploadItem/theme": {
|
6307
|
+
"type": "string\n",
|
6308
|
+
"description": "Specify a theme for this component and all of its children."
|
6309
|
+
},
|
6350
6310
|
"VFileUploadItem/color": {
|
6351
6311
|
"type": "string\n",
|
6352
6312
|
"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),"
|
6353
6313
|
},
|
6354
6314
|
"VFileUploadItem/variant": {
|
6355
|
-
"type": "'
|
6315
|
+
"type": "'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain'\n",
|
6356
6316
|
"description": "Applies a distinct style to the component."
|
6357
6317
|
},
|
6358
|
-
"VFileUploadItem/
|
6359
|
-
"type": "
|
6360
|
-
"description": "
|
6318
|
+
"VFileUploadItem/active": {
|
6319
|
+
"type": "boolean\n",
|
6320
|
+
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
6321
|
+
},
|
6322
|
+
"VFileUploadItem/active-color": {
|
6323
|
+
"type": "string\n",
|
6324
|
+
"description": "The applied color when the component is in an active state."
|
6325
|
+
},
|
6326
|
+
"VFileUploadItem/base-color": {
|
6327
|
+
"type": "string\n",
|
6328
|
+
"description": "Sets the color of component when not focused."
|
6361
6329
|
},
|
6362
6330
|
"VFileUploadItem/prepend-icon": {
|
6363
|
-
"type": " | string\n | (new () => any)\n | FunctionalComponent\n
|
6331
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6364
6332
|
"description": "Creates a [v-icon](/api/v-icon/) component in the **prepend** slot before default content."
|
6365
6333
|
},
|
6366
|
-
"VFileUploadItem/
|
6367
|
-
"type": "
|
6368
|
-
"description": "
|
6334
|
+
"VFileUploadItem/append-icon": {
|
6335
|
+
"type": " | string\n | (string | [string, number])[]\n | (new () => any)\n | FunctionalComponent\n",
|
6336
|
+
"description": "Creates a [v-icon](/api/v-icon/) component after default content in the **append** slot."
|
6369
6337
|
},
|
6370
|
-
"VFileUploadItem/
|
6338
|
+
"VFileUploadItem/slim": {
|
6371
6339
|
"type": "boolean\n",
|
6372
|
-
"description": "
|
6340
|
+
"description": "Reduces horizontal spacing for badges, icons, tooltips, and avatars to create a more compact visual representation."
|
6373
6341
|
},
|
6374
6342
|
"VFileUploadItem/ripple": {
|
6375
6343
|
"type": "boolean | { class: string }\n",
|
6376
6344
|
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
6377
6345
|
},
|
6378
|
-
"VFileUploadItem/
|
6346
|
+
"VFileUploadItem/value": {
|
6347
|
+
"type": "any\n",
|
6348
|
+
"description": "The value used for selection. Obtained from [`v-list`](/api/v-list)'s `v-model:selected` when the item is selected."
|
6349
|
+
},
|
6350
|
+
"VFileUploadItem/disabled": {
|
6351
|
+
"type": "boolean\n",
|
6352
|
+
"description": "Removes the ability to click or target the component."
|
6353
|
+
},
|
6354
|
+
"VFileUploadItem/href": {
|
6355
|
+
"type": "string\n",
|
6356
|
+
"description": "Designates the component as anchor and applies the **href** attribute."
|
6357
|
+
},
|
6358
|
+
"VFileUploadItem/exact": {
|
6359
|
+
"type": "boolean\n",
|
6360
|
+
"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."
|
6361
|
+
},
|
6362
|
+
"VFileUploadItem/to": {
|
6363
|
+
"type": "RouteLocationRaw\n",
|
6364
|
+
"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."
|
6365
|
+
},
|
6366
|
+
"VFileUploadItem/lines": {
|
6367
|
+
"type": "false | 'one' | 'two' | 'three'\n",
|
6368
|
+
"description": "The line declaration specifies the minimum height of the item and can also be controlled from v-list with the same prop."
|
6369
|
+
},
|
6370
|
+
"VFileUploadItem/nav": {
|
6371
|
+
"type": "boolean\n",
|
6372
|
+
"description": "Reduces the width v-list-item takes up as well as adding a border radius."
|
6373
|
+
},
|
6374
|
+
"VFileUploadItem/active-class": {
|
6379
6375
|
"type": "string\n",
|
6380
|
-
"description": "
|
6376
|
+
"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."
|
6381
6377
|
},
|
6382
|
-
"VFileUploadItem/
|
6383
|
-
"type": "
|
6384
|
-
"description": "
|
6378
|
+
"VFileUploadItem/subtitle": {
|
6379
|
+
"type": "string | number\n",
|
6380
|
+
"description": "Specify a subtitle text for the component."
|
6385
6381
|
},
|
6386
6382
|
"VFileUploadItem/append-avatar": {
|
6387
6383
|
"type": "string\n",
|
@@ -6391,6 +6387,10 @@
|
|
6391
6387
|
"type": "string\n",
|
6392
6388
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
6393
6389
|
},
|
6390
|
+
"VFileUploadItem/clearable": {
|
6391
|
+
"type": "boolean\n",
|
6392
|
+
"description": "Allows for the component to be cleared."
|
6393
|
+
},
|
6394
6394
|
"VFileUploadItem/show-size": {
|
6395
6395
|
"type": "boolean\n",
|
6396
6396
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUploadItem.json))"
|
@@ -6403,18 +6403,6 @@
|
|
6403
6403
|
"type": "string\n",
|
6404
6404
|
"description": "MISSING DESCRIPTION ([edit in github](https://github.com/vuetifyjs/vuetify/tree/dev/packages/api-generator/src/locale/en/VFileUploadItem.json))"
|
6405
6405
|
},
|
6406
|
-
"VFooter/tag": {
|
6407
|
-
"type": "string | (new () => any) | FunctionalComponent\n",
|
6408
|
-
"description": "Specify a custom tag used on the root element."
|
6409
|
-
},
|
6410
|
-
"VFooter/name": {
|
6411
|
-
"type": "string\n",
|
6412
|
-
"description": "Assign a specific name for layout registration."
|
6413
|
-
},
|
6414
|
-
"VFooter/theme": {
|
6415
|
-
"type": "string\n",
|
6416
|
-
"description": "Specify a theme for this component and all of its children."
|
6417
|
-
},
|
6418
6406
|
"VFooter/border": {
|
6419
6407
|
"type": "string | number | boolean\n",
|
6420
6408
|
"description": "Designates the **border-radius** applied to the component. This can be **xs**, **sm**, **md**, **lg**, **xl**."
|
@@ -6427,6 +6415,10 @@
|
|
6427
6415
|
"type": "string | number\n",
|
6428
6416
|
"description": "Designates an elevation applied to the component between 0 and 24. You can find more information on the [elevation page](/styles/elevation)."
|
6429
6417
|
},
|
6418
|
+
"VFooter/absolute": {
|
6419
|
+
"type": "boolean\n",
|
6420
|
+
"description": "Applies **position: absolute** to the component."
|
6421
|
+
},
|
6430
6422
|
"VFooter/rounded": {
|
6431
6423
|
"type": "string | number | boolean\n",
|
6432
6424
|
"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)."
|
@@ -6435,13 +6427,21 @@
|
|
6435
6427
|
"type": "boolean\n",
|
6436
6428
|
"description": "Removes any applied **border-radius** from the component."
|
6437
6429
|
},
|
6430
|
+
"VFooter/tag": {
|
6431
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
6432
|
+
"description": "Specify a custom tag used on the root element."
|
6433
|
+
},
|
6434
|
+
"VFooter/theme": {
|
6435
|
+
"type": "string\n",
|
6436
|
+
"description": "Specify a theme for this component and all of its children."
|
6437
|
+
},
|
6438
6438
|
"VFooter/color": {
|
6439
6439
|
"type": "string\n",
|
6440
6440
|
"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)."
|
6441
6441
|
},
|
6442
|
-
"VFooter/
|
6443
|
-
"type": "
|
6444
|
-
"description": "
|
6442
|
+
"VFooter/name": {
|
6443
|
+
"type": "string\n",
|
6444
|
+
"description": "Assign a specific name for layout registration."
|
6445
6445
|
},
|
6446
6446
|
"VFooter/order": {
|
6447
6447
|
"type": "string | number\n",
|
@@ -6451,10 +6451,6 @@
|
|
6451
6451
|
"type": "boolean\n",
|
6452
6452
|
"description": "Determines the position of the footer. If true, the footer would be given a fixed position at the bottom of the viewport. If false, the footer is set to the bottom of the page."
|
6453
6453
|
},
|
6454
|
-
"VForm/disabled": {
|
6455
|
-
"type": "boolean\n",
|
6456
|
-
"description": "Puts all children inputs into a disabled state."
|
6457
|
-
},
|
6458
6454
|
"VForm/model-value": {
|
6459
6455
|
"type": "boolean\n",
|
6460
6456
|
"description": "The value representing the validity of the form. If the value is `null` then no validation has taken place yet, or the form has been reset. Otherwise the value will be a `boolean` that indicates if validation has passed or not."
|
@@ -6463,6 +6459,10 @@
|
|
6463
6459
|
"type": "boolean\n",
|
6464
6460
|
"description": "Puts all children inputs into a readonly state."
|
6465
6461
|
},
|
6462
|
+
"VForm/disabled": {
|
6463
|
+
"type": "boolean\n",
|
6464
|
+
"description": "Puts all children inputs into a disabled state."
|
6465
|
+
},
|
6466
6466
|
"VForm/validate-on": {
|
6467
6467
|
"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",
|
6468
6468
|
"description": "Changes the events in which validation occurs."
|
@@ -6575,10 +6575,6 @@
|
|
6575
6575
|
"type": "IntersectionObserverInit\n",
|
6576
6576
|
"description": "Options that are passed to the [Intersection observer](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) constructor."
|
6577
6577
|
},
|
6578
|
-
"VImg/position": {
|
6579
|
-
"type": "string\n",
|
6580
|
-
"description": "Applies [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) styles to the image and placeholder elements."
|
6581
|
-
},
|
6582
6578
|
"VImg/inline": {
|
6583
6579
|
"type": "boolean\n",
|
6584
6580
|
"description": "Display as an inline element instead of a block, also disables flex-grow."
|
@@ -6587,10 +6583,18 @@
|
|
6587
6583
|
"type": "boolean | 'true' | 'false'\n",
|
6588
6584
|
"description": "Controls the `draggable` behavior of the image. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/draggable)."
|
6589
6585
|
},
|
6586
|
+
"VImg/position": {
|
6587
|
+
"type": "string\n",
|
6588
|
+
"description": "Applies [object-position](https://developer.mozilla.org/en-US/docs/Web/CSS/object-position) styles to the image and placeholder elements."
|
6589
|
+
},
|
6590
6590
|
"VImg/alt": {
|
6591
6591
|
"type": "string\n",
|
6592
6592
|
"description": "Alternate text for screen readers. Leave empty for decorative images."
|
6593
6593
|
},
|
6594
|
+
"VImg/src": {
|
6595
|
+
"type": " | string\n | { src: string; srcset: string; lazySrc: string; aspect: number }\n",
|
6596
|
+
"description": "The image URL. This prop is mandatory."
|
6597
|
+
},
|
6594
6598
|
"VImg/cover": {
|
6595
6599
|
"type": "boolean\n",
|
6596
6600
|
"description": "Resizes the background image to cover the entire container."
|
@@ -6607,10 +6611,6 @@
|
|
6607
6611
|
"type": "string\n",
|
6608
6612
|
"description": "For use with `srcset`, see [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-sizes)."
|
6609
6613
|
},
|
6610
|
-
"VImg/src": {
|
6611
|
-
"type": " | string\n | { src: string; srcset: string; lazySrc: string; aspect: number }\n",
|
6612
|
-
"description": "The image URL. This prop is mandatory."
|
6613
|
-
},
|
6614
6614
|
"VImg/srcset": {
|
6615
6615
|
"type": "string\n",
|
6616
6616
|
"description": "A set of alternate images to use based on device size. [Read more...](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attr-srcset)."
|
@@ -6827,33 +6827,25 @@
|
|
6827
6827
|
"type": "unknown\n",
|
6828
6828
|
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6829
6829
|
},
|
6830
|
-
"VItemGroup/selected-class": {
|
6831
|
-
"type": "string\n",
|
6832
|
-
"description": "Configure the selected CSS class. This class will be available in `v-item` default scoped slot."
|
6833
|
-
},
|
6834
6830
|
"VItemGroup/max": {
|
6835
6831
|
"type": "number\n",
|
6836
6832
|
"description": "Sets a maximum number of selections that can be made."
|
6837
6833
|
},
|
6838
|
-
"
|
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,29 +6871,37 @@
|
|
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%."
|
6885
6877
|
},
|
6886
|
-
"
|
6887
|
-
"type": "
|
6888
|
-
"description": "
|
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."
|
6889
6889
|
},
|
6890
6890
|
"VLayoutItem/absolute": {
|
6891
6891
|
"type": "boolean\n",
|
6892
6892
|
"description": "Applies **position: absolute** to the component."
|
6893
6893
|
},
|
6894
|
-
"VLayoutItem/
|
6895
|
-
"type": "
|
6896
|
-
"description": "
|
6894
|
+
"VLayoutItem/model-value": {
|
6895
|
+
"type": "boolean\n",
|
6896
|
+
"description": "The v-model value of the component. If component supports the **multiple** prop, this defaults to an empty array."
|
6897
6897
|
},
|
6898
6898
|
"VLayoutItem/order": {
|
6899
6899
|
"type": "string | number\n",
|
6900
6900
|
"description": "Adjust the order of the component in relation to its registration order."
|
6901
6901
|
},
|
6902
|
-
"VLayoutItem/
|
6903
|
-
"type": "
|
6904
|
-
"description": "
|
6902
|
+
"VLayoutItem/position": {
|
6903
|
+
"type": "'top' | 'left' | 'right' | 'bottom'\n",
|
6904
|
+
"description": "The position of the item."
|
6905
6905
|
},
|
6906
6906
|
"VLazy/tag": {
|
6907
6907
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
@@ -7295,10 +7295,6 @@
|
|
7295
7295
|
"type": "boolean\n",
|
7296
7296
|
"description": "Controls the **active** state of the item. This is typically used to highlight the component."
|
7297
7297
|
},
|
7298
|
-
"VListItem/ripple": {
|
7299
|
-
"type": "boolean | { class: string }\n",
|
7300
|
-
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
7301
|
-
},
|
7302
7298
|
"VListItem/href": {
|
7303
7299
|
"type": "string\n",
|
7304
7300
|
"description": "Designates the component as anchor and applies the **href** attribute."
|
@@ -7315,30 +7311,34 @@
|
|
7315
7311
|
"type": "string\n",
|
7316
7312
|
"description": "Prepends a [v-avatar](/components/avatars/) component in the **prepend** slot before default content."
|
7317
7313
|
},
|
7318
|
-
"
|
7319
|
-
"type": "
|
7320
|
-
"description": "
|
7321
|
-
},
|
7322
|
-
"VListItemAction/start": {
|
7323
|
-
"type": "boolean\n",
|
7324
|
-
"description": "Applies margin at the end of the component."
|
7314
|
+
"VListItem/ripple": {
|
7315
|
+
"type": "boolean | { class: string }\n",
|
7316
|
+
"description": "Applies the [v-ripple](/directives/ripple) directive."
|
7325
7317
|
},
|
7326
7318
|
"VListItemAction/end": {
|
7327
7319
|
"type": "boolean\n",
|
7328
7320
|
"description": "Applies margin at the start of the component."
|
7329
7321
|
},
|
7330
|
-
"
|
7331
|
-
"type": "boolean\n",
|
7332
|
-
"description": "Applies margin at the start of the component."
|
7333
|
-
},
|
7334
|
-
"VListItemMedia/start": {
|
7322
|
+
"VListItemAction/start": {
|
7335
7323
|
"type": "boolean\n",
|
7336
7324
|
"description": "Applies margin at the end of the component."
|
7337
7325
|
},
|
7326
|
+
"VListItemAction/tag": {
|
7327
|
+
"type": "string | (new () => any) | FunctionalComponent\n",
|
7328
|
+
"description": "Specify a custom tag used on the root element."
|
7329
|
+
},
|
7338
7330
|
"VListItemMedia/tag": {
|
7339
7331
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
7340
7332
|
"description": "Specify a custom tag used on the root element."
|
7341
7333
|
},
|
7334
|
+
"VListItemMedia/start": {
|
7335
|
+
"type": "boolean\n",
|
7336
|
+
"description": "Applies margin at the end of the component."
|
7337
|
+
},
|
7338
|
+
"VListItemMedia/end": {
|
7339
|
+
"type": "boolean\n",
|
7340
|
+
"description": "Applies margin at the start of the component."
|
7341
|
+
},
|
7342
7342
|
"VListItemSubtitle/tag": {
|
7343
7343
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
7344
7344
|
"description": "Specify a custom tag used on the root element."
|
@@ -7647,10 +7647,6 @@
|
|
7647
7647
|
"type": "'top' | 'left' | 'right' | 'bottom' | 'start' | 'end'\n",
|
7648
7648
|
"description": "Controls the edge of the screen the drawer is attached to."
|
7649
7649
|
},
|
7650
|
-
"VNavigationDrawer/sticky": {
|
7651
|
-
"type": "boolean\n",
|
7652
|
-
"description": "When true, the drawer will remain visible when scrolling past the top of the page."
|
7653
|
-
},
|
7654
7650
|
"VNavigationDrawer/order": {
|
7655
7651
|
"type": "string | number\n",
|
7656
7652
|
"description": "Adjust the order of the component in relation to its registration order."
|
@@ -7663,6 +7659,14 @@
|
|
7663
7659
|
"type": "number | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xs'\n",
|
7664
7660
|
"description": "Sets the designated mobile breakpoint for the component. This will apply alternate styles for mobile devices such as the `temporary` prop, or activate the `bottom` prop when the breakpoint value is met. Setting the value to `0` will disable this functionality."
|
7665
7661
|
},
|
7662
|
+
"VNavigationDrawer/sticky": {
|
7663
|
+
"type": "boolean\n",
|
7664
|
+
"description": "When true, the drawer will remain visible when scrolling past the top of the page."
|
7665
|
+
},
|
7666
|
+
"VNavigationDrawer/floating": {
|
7667
|
+
"type": "boolean\n",
|
7668
|
+
"description": "A floating drawer has no visible container (no border-right)."
|
7669
|
+
},
|
7666
7670
|
"VNavigationDrawer/image": {
|
7667
7671
|
"type": "string\n",
|
7668
7672
|
"description": "Apply a specific background image to the component."
|
@@ -7679,10 +7683,6 @@
|
|
7679
7683
|
"type": "boolean\n",
|
7680
7684
|
"description": "Collapses the drawer to a **mini-variant** until hovering with the mouse."
|
7681
7685
|
},
|
7682
|
-
"VNavigationDrawer/floating": {
|
7683
|
-
"type": "boolean\n",
|
7684
|
-
"description": "A floating drawer has no visible container (no border-right)."
|
7685
|
-
},
|
7686
7686
|
"VNavigationDrawer/permanent": {
|
7687
7687
|
"type": "boolean\n",
|
7688
7688
|
"description": "The drawer remains visible regardless of screen size."
|
@@ -7927,10 +7927,6 @@
|
|
7927
7927
|
"type": "boolean\n",
|
7928
7928
|
"description": "Applies an indentation to the dividers used in the stepper buttons."
|
7929
7929
|
},
|
7930
|
-
"VNumberInput/control-variant": {
|
7931
|
-
"type": "'split' | 'default' | 'stacked'\n",
|
7932
|
-
"description": "The color of the control. It defaults to the value of `variant` prop."
|
7933
|
-
},
|
7934
7930
|
"VNumberInput/hide-input": {
|
7935
7931
|
"type": "boolean\n",
|
7936
7932
|
"description": "Hide the input field."
|
@@ -7939,6 +7935,10 @@
|
|
7939
7935
|
"type": "number\n",
|
7940
7936
|
"description": "Defines the interval between allowed values when the user increments or decrements the input"
|
7941
7937
|
},
|
7938
|
+
"VNumberInput/control-variant": {
|
7939
|
+
"type": "'split' | 'default' | 'stacked'\n",
|
7940
|
+
"description": "The color of the control. It defaults to the value of `variant` prop."
|
7941
|
+
},
|
7942
7942
|
"VOtpInput/length": {
|
7943
7943
|
"type": "string | number\n",
|
7944
7944
|
"description": "The OTP field's length."
|
@@ -8475,6 +8475,10 @@
|
|
8475
8475
|
"type": "boolean\n",
|
8476
8476
|
"description": "Constantly animates, use when loading progress is unknown."
|
8477
8477
|
},
|
8478
|
+
"VProgressLinear/stream": {
|
8479
|
+
"type": "boolean\n",
|
8480
|
+
"description": "An alternative style for portraying loading that works in tandem with **buffer-value**."
|
8481
|
+
},
|
8478
8482
|
"VProgressLinear/bg-opacity": {
|
8479
8483
|
"type": "string | number\n",
|
8480
8484
|
"description": "Background opacity, if null it defaults to 0.3 if background color is not specified or 1 otherwise."
|
@@ -8495,10 +8499,6 @@
|
|
8495
8499
|
"type": "boolean\n",
|
8496
8500
|
"description": "Clicking on the progress track will automatically set the value."
|
8497
8501
|
},
|
8498
|
-
"VProgressLinear/stream": {
|
8499
|
-
"type": "boolean\n",
|
8500
|
-
"description": "An alternative style for portraying loading that works in tandem with **buffer-value**."
|
8501
|
-
},
|
8502
8502
|
"VProgressLinear/striped": {
|
8503
8503
|
"type": "boolean\n",
|
8504
8504
|
"description": "Adds a stripe background to the filled portion of the progress component."
|
@@ -9435,14 +9435,6 @@
|
|
9435
9435
|
"type": "(a: any, b: any) => boolean\n",
|
9436
9436
|
"description": "Apply a custom comparison algorithm to compare **model-value** and values contains in the **items** prop."
|
9437
9437
|
},
|
9438
|
-
"VSelect/hide-no-data": {
|
9439
|
-
"type": "boolean\n",
|
9440
|
-
"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."
|
9441
|
-
},
|
9442
|
-
"VSelect/no-data-text": {
|
9443
|
-
"type": "string\n",
|
9444
|
-
"description": "Text shown when no items are provided to the component."
|
9445
|
-
},
|
9446
9438
|
"VSelect/item-value": {
|
9447
9439
|
"type": "SelectItemKey<any>\n",
|
9448
9440
|
"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)."
|
@@ -9451,6 +9443,14 @@
|
|
9451
9443
|
"type": "boolean\n",
|
9452
9444
|
"description": "Changes the selection behavior to return the object directly rather than the value specified with **item-value**."
|
9453
9445
|
},
|
9446
|
+
"VSelect/hide-no-data": {
|
9447
|
+
"type": "boolean\n",
|
9448
|
+
"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."
|
9449
|
+
},
|
9450
|
+
"VSelect/no-data-text": {
|
9451
|
+
"type": "string\n",
|
9452
|
+
"description": "Text shown when no items are provided to the component."
|
9453
|
+
},
|
9454
9454
|
"VSelect/autofocus": {
|
9455
9455
|
"type": "boolean\n",
|
9456
9456
|
"description": "Enables autofocus."
|
@@ -9499,10 +9499,6 @@
|
|
9499
9499
|
"type": "unknown\n",
|
9500
9500
|
"description": "**FOR INTERNAL USE ONLY**"
|
9501
9501
|
},
|
9502
|
-
"VSelect/chips": {
|
9503
|
-
"type": "boolean\n",
|
9504
|
-
"description": "Changes display of selections to chips."
|
9505
|
-
},
|
9506
9502
|
"VSelect/item-title": {
|
9507
9503
|
"type": "SelectItemKey<any>\n",
|
9508
9504
|
"description": "Property on supplied `items` that contains its title."
|
@@ -9515,6 +9511,10 @@
|
|
9515
9511
|
"type": "SelectItemKey<any>\n",
|
9516
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."
|
9517
9513
|
},
|
9514
|
+
"VSelect/chips": {
|
9515
|
+
"type": "boolean\n",
|
9516
|
+
"description": "Changes display of selections to chips."
|
9517
|
+
},
|
9518
9518
|
"VSelect/closable-chips": {
|
9519
9519
|
"type": "boolean\n",
|
9520
9520
|
"description": "Enables the [closable](/api/v-chip/#props-closable) prop on all [v-chip](/components/chips/) components."
|
@@ -10559,10 +10559,6 @@
|
|
10559
10559
|
"type": "string\n",
|
10560
10560
|
"description": "The value of the item."
|
10561
10561
|
},
|
10562
|
-
"VSparkline/labels": {
|
10563
|
-
"type": "(string | number | { value: number })[]\n",
|
10564
|
-
"description": "An array of string labels that correspond to the same index as its data counterpart."
|
10565
|
-
},
|
10566
10562
|
"VSparkline/auto-line-width": {
|
10567
10563
|
"type": "boolean\n",
|
10568
10564
|
"description": "Automatically expand bars to use space efficiently."
|
@@ -10583,6 +10579,10 @@
|
|
10583
10579
|
"type": "'top' | 'bottom' | 'left' | 'right'\n",
|
10584
10580
|
"description": "The direction the gradient should run."
|
10585
10581
|
},
|
10582
|
+
"VSparkline/labels": {
|
10583
|
+
"type": "(string | number | { value: number })[]\n",
|
10584
|
+
"description": "An array of string labels that correspond to the same index as its data counterpart."
|
10585
|
+
},
|
10586
10586
|
"VSparkline/label-size": {
|
10587
10587
|
"type": "string | number\n",
|
10588
10588
|
"description": "The label font size."
|
@@ -10904,7 +10904,7 @@
|
|
10904
10904
|
"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)."
|
10905
10905
|
},
|
10906
10906
|
"VStepperActions/disabled": {
|
10907
|
-
"type": "boolean | '
|
10907
|
+
"type": "boolean | 'prev' | 'next'\n",
|
10908
10908
|
"description": "Removes the ability to click or target the component."
|
10909
10909
|
},
|
10910
10910
|
"VStepperActions/prev-text": {
|
@@ -11124,7 +11124,7 @@
|
|
11124
11124
|
"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)."
|
11125
11125
|
},
|
11126
11126
|
"VStepperVerticalActions/disabled": {
|
11127
|
-
"type": "boolean | '
|
11127
|
+
"type": "boolean | 'prev' | 'next'\n",
|
11128
11128
|
"description": "Removes the ability to click or target the component."
|
11129
11129
|
},
|
11130
11130
|
"VStepperVerticalActions/prev-text": {
|
@@ -12495,14 +12495,14 @@
|
|
12495
12495
|
"type": "number\n",
|
12496
12496
|
"description": "Defines the minimum time value that can be selected."
|
12497
12497
|
},
|
12498
|
-
"VTimePickerClock/step": {
|
12499
|
-
"type": "number\n",
|
12500
|
-
"description": "Defines the increments between selectable times, such as a step of 1 for every minute or a larger step for every 5 or 15 minutes."
|
12501
|
-
},
|
12502
12498
|
"VTimePickerClock/rotate": {
|
12503
12499
|
"type": "number\n",
|
12504
12500
|
"description": "Controls rotation, specifying the degree of rotation for the clock hands."
|
12505
12501
|
},
|
12502
|
+
"VTimePickerClock/step": {
|
12503
|
+
"type": "number\n",
|
12504
|
+
"description": "Defines the increments between selectable times, such as a step of 1 for every minute or a larger step for every 5 or 15 minutes."
|
12505
|
+
},
|
12506
12506
|
"VTimePickerClock/format": {
|
12507
12507
|
"type": "Function\n",
|
12508
12508
|
"description": "Specifies the format of the displayed time, either 12-hour or 24-hour, depending on the component's setup."
|
@@ -13407,10 +13407,6 @@
|
|
13407
13407
|
"type": "boolean\n",
|
13408
13408
|
"description": "Forces a focused state styling on the component."
|
13409
13409
|
},
|
13410
|
-
"VVirtualScroll/items": {
|
13411
|
-
"type": "unknown[]\n",
|
13412
|
-
"description": "The array of items to display."
|
13413
|
-
},
|
13414
13410
|
"VVirtualScroll/height": {
|
13415
13411
|
"type": "string | number\n",
|
13416
13412
|
"description": "Height of the component as a css value/"
|
@@ -13435,9 +13431,9 @@
|
|
13435
13431
|
"type": "string | number\n",
|
13436
13432
|
"description": "Sets the width for the component."
|
13437
13433
|
},
|
13438
|
-
"VVirtualScroll/
|
13439
|
-
"type": "
|
13440
|
-
"description": "
|
13434
|
+
"VVirtualScroll/items": {
|
13435
|
+
"type": "unknown[]\n",
|
13436
|
+
"description": "The array of items to display."
|
13441
13437
|
},
|
13442
13438
|
"VVirtualScroll/item-height": {
|
13443
13439
|
"type": "string | number\n",
|
@@ -13447,6 +13443,10 @@
|
|
13447
13443
|
"type": "<a href=\"https://github.com/vuetifyjs/vuetify/blob/master/packages/vuetify/src/util/helpers.ts#L73-L77\" target=\"_blank\">SelectItemKey</a>\n",
|
13448
13444
|
"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."
|
13449
13445
|
},
|
13446
|
+
"VVirtualScroll/renderless": {
|
13447
|
+
"type": "boolean\n",
|
13448
|
+
"description": "Disables default component rendering functionality."
|
13449
|
+
},
|
13450
13450
|
"VWindow/tag": {
|
13451
13451
|
"type": "string | (new () => any) | FunctionalComponent\n",
|
13452
13452
|
"description": "Specify a custom tag used on the root element."
|
@@ -13503,21 +13503,21 @@
|
|
13503
13503
|
"type": "any\n",
|
13504
13504
|
"description": "The value used when the component is selected in a group. If not provided, a unique ID will be used."
|
13505
13505
|
},
|
13506
|
+
"VWindowItem/eager": {
|
13507
|
+
"type": "boolean\n",
|
13508
|
+
"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."
|
13509
|
+
},
|
13506
13510
|
"VWindowItem/disabled": {
|
13507
13511
|
"type": "boolean\n",
|
13508
13512
|
"description": "Prevents the item from becoming active when using the \"next\" and \"prev\" buttons or the `toggle` method."
|
13509
13513
|
},
|
13510
|
-
"VWindowItem/selected-class": {
|
13511
|
-
"type": "string\n",
|
13512
|
-
"description": "Configure the active CSS class applied when an item is selected."
|
13513
|
-
},
|
13514
13514
|
"VWindowItem/transition": {
|
13515
13515
|
"type": "string | boolean\n",
|
13516
13516
|
"description": "The transition used when the component progressing through items. Can be one of the [built in](/styles/transitions/) or custom transition."
|
13517
13517
|
},
|
13518
|
-
"VWindowItem/
|
13519
|
-
"type": "
|
13520
|
-
"description": "
|
13518
|
+
"VWindowItem/selected-class": {
|
13519
|
+
"type": "string\n",
|
13520
|
+
"description": "Configure the active CSS class applied when an item is selected."
|
13521
13521
|
},
|
13522
13522
|
"VWindowItem/reverse-transition": {
|
13523
13523
|
"type": "string | boolean\n",
|