quasar 2.3.2 → 2.4.1

package/dist/api/QTable.json

@@ -54,7 +54,8 @@
         "row-key=\"name\"",
         ":row-key=\"row => row.name\""
       ],
-      "category": "general"
+      "category": "general",
+      "required": false
     },
     "virtual-scroll": {
       "type": "Boolean",
@@ -71,7 +72,8 @@
       "examples": [
         "virtual-scroll-slice-size=\"60\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-slice-ratio-before": {
       "type": [
@@ -83,7 +85,8 @@
       "examples": [
         "virtual-scroll-slice-ratio-before=\"0.3\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-slice-ratio-after": {
       "type": [
@@ -95,7 +98,8 @@
       "examples": [
         "virtual-scroll-slice-ratio-after=\"2\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-item-size": {
       "type": [
@@ -107,7 +111,8 @@
       "examples": [
         "virtual-scroll-item-size=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-sticky-size-start": {
       "type": [
@@ -119,7 +124,8 @@
       "examples": [
         "virtual-scroll-sticky-size-start=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-sticky-size-end": {
       "type": [
@@ -131,7 +137,8 @@
       "examples": [
         "virtual-scroll-sticky-size-end=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "table-colspan": {
       "type": [
@@ -152,7 +159,8 @@
         "teal-10"
       ],
       "category": "style",
-      "default": "grey-8"
+      "default": "grey-8",
+      "required": false
     },
     "icon-first-page": {
       "type": "String",
@@ -223,16 +231,16 @@
       "definition": {
         "name": {
           "type": "String",
-          "desc": "Unique id, identifies column, (used by pagination.sortBy, 'body-cell-[name]' slot, ...)",
           "required": true,
+          "desc": "Unique id, identifies column, (used by pagination.sortBy, 'body-cell-[name]' slot, ...)",
           "examples": [
             "desc"
           ]
         },
         "label": {
           "type": "String",
-          "desc": "Label for header",
           "required": true,
+          "desc": "Label for header",
           "examples": [
             "Dessert (100g serving)"
           ]
@@ -242,11 +250,12 @@
             "String",
             "Function"
           ],
-          "desc": "Row Object property to determine value for this column or function which maps to the required property",
           "required": true,
+          "desc": "Row Object property to determine value for this column or function which maps to the required property",
           "params": {
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "The current row being processed",
               "examples": [
                 "{ name: 'Lorem Ipsum', prices: { active: 19, old: 25, list: 29 } }"
@@ -267,8 +276,7 @@
         },
         "required": {
           "type": "Boolean",
-          "desc": "If we use visible-columns, this col will always be visible",
-          "default": false
+          "desc": "If we use visible-columns, this col will always be visible"
         },
         "align": {
           "type": "String",
@@ -279,16 +287,13 @@
             "center"
           ],
           "default": "right",
-          "examples": [
-            "left",
-            "right",
-            "center"
-          ]
+          "required": false
         },
         "sortable": {
           "type": "Boolean",
           "desc": "Tell QTable you want this column sortable",
-          "default": false
+          "default": false,
+          "required": false
         },
         "sort": {
           "type": "Function",
@@ -299,6 +304,7 @@
           "params": {
             "a": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the first comparison term",
               "examples": [
                 123,
@@ -307,6 +313,7 @@
             },
             "b": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the second comparison term",
               "examples": [
                 123,
@@ -315,6 +322,7 @@
             },
             "rowA": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which is contained the first term",
               "examples": [
                 "{ name: 'Potassium', value: 'K' }"
@@ -322,6 +330,7 @@
             },
             "rowB": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which is contained the second term",
               "examples": [
                 "{ name: 'Fluorine', value: 'F' }"
@@ -345,7 +354,8 @@
             "ad",
             "da"
           ],
-          "default": "ad"
+          "default": "ad",
+          "required": false
         },
         "format": {
           "type": "Function",
@@ -357,6 +367,7 @@
           "params": {
             "val": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the cell",
               "examples": [
                 123,
@@ -365,6 +376,7 @@
             },
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which the cell is contained",
               "examples": [
                 "{ name: 'Potassium', value: 'K' }"
@@ -388,6 +400,7 @@
           "params": {
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "The current row being processed",
               "examples": [
                 "{ name: 'Frozen Yogurt', calories: 159 }"
@@ -411,6 +424,7 @@
           "params": {
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "The current row being processed",
               "examples": [
                 "{ name: 'Frozen Yogurt', calories: 159 }"
@@ -518,10 +532,8 @@
         "cell",
         "none"
       ],
-      "examples": [
-        "cell"
-      ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "wrap-cells": {
       "type": "Boolean",
@@ -541,7 +553,8 @@
         "da"
       ],
       "default": "ad",
-      "category": "sorting"
+      "category": "sorting",
+      "required": false
     },
     "no-data-label": {
       "type": "String",
@@ -773,20 +786,18 @@
       "params": {
         "rows": {
           "type": "Array",
-          "desc": "Array of rows",
-          "required": true
+          "desc": "Array of rows"
         },
         "terms": {
           "type": [
             "String",
             "Object"
           ],
-          "desc": "Terms to filter with (is essentially the 'filter' prop value)",
-          "required": true
+          "desc": "Terms to filter with (is essentially the 'filter' prop value)"
         },
         "cols": {
           "type": "Array",
-          "desc": "Optional column definitions"
+          "desc": "Column definitions"
         },
         "getCellValue": {
           "type": "Function",
@@ -794,10 +805,12 @@
           "params": {
             "col": {
               "type": "Object",
+              "required": true,
               "desc": "Column name from column definitions"
             },
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "The row object"
             }
           },
@@ -818,7 +831,8 @@
       "examples": [
         "(see source code)"
       ],
-      "category": "filter"
+      "category": "filter",
+      "required": false
     },
     "pagination": {
       "type": "Object",
@@ -871,7 +885,8 @@
       "examples": [
         ":rows-per-page-options=\"[10, 20]\""
       ],
-      "category": "pagination"
+      "category": "pagination",
+      "required": false
     },
     "selection": {
       "type": "String",
@@ -885,7 +900,8 @@
       "examples": [
         "multiple"
       ],
-      "category": "selection"
+      "category": "selection",
+      "required": false
     },
     "selected": {
       "type": "Array",
@@ -894,7 +910,8 @@
       "examples": [
         "v-model:selected=\"selection\""
       ],
-      "category": "selection"
+      "category": "selection",
+      "required": false
     },
     "expanded": {
       "type": "Array",
@@ -903,7 +920,8 @@
       "examples": [
         "v-model:expanded=\"expanded\""
       ],
-      "category": "expansion"
+      "category": "expansion",
+      "required": false
     },
     "sort-method": {
       "type": "Function",
@@ -933,7 +951,8 @@
       "examples": [
         "(see source code)"
       ],
-      "category": "sorting"
+      "category": "sorting",
+      "required": false
     }
   },
   "slots": {
@@ -976,8 +995,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1002,8 +1021,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1053,8 +1071,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1079,8 +1097,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1142,8 +1159,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1168,8 +1185,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1227,8 +1243,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1253,8 +1269,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1288,8 +1303,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1314,8 +1329,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1361,8 +1375,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1387,8 +1401,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1426,8 +1439,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1452,8 +1465,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1503,8 +1515,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1529,8 +1541,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1564,8 +1575,8 @@
                 "String",
                 "Object"
               ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [
                 "calories"
               ]
@@ -1590,8 +1601,7 @@
             "primary",
             "teal-10"
           ],
-          "category": "style",
-          "default": "grey-8"
+          "category": "style"
         },
         "dark": {
           "type": "Boolean",
@@ -1632,6 +1642,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -1639,10 +1650,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -1650,6 +1663,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -1717,6 +1731,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -1724,10 +1739,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -1735,6 +1752,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -1802,6 +1820,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -1809,10 +1828,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -1820,6 +1841,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -1887,6 +1909,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -1894,10 +1917,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -1905,6 +1930,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -1972,6 +1998,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -1979,10 +2006,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -1990,6 +2019,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -2057,6 +2087,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -2064,10 +2095,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -2075,6 +2108,7 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
@@ -2159,8 +2193,7 @@
       "params": {
         "evt": {
           "type": "Object",
-          "desc": "JS event object",
-          "required": true
+          "desc": "JS event object"
         },
         "row": {
           "type": "Object",
@@ -2177,8 +2210,7 @@
       "params": {
         "evt": {
           "type": "Object",
-          "desc": "JS event object",
-          "required": true
+          "desc": "JS event object"
         },
         "row": {
           "type": "Object",
@@ -2195,8 +2227,7 @@
       "params": {
         "evt": {
           "type": "Object",
-          "desc": "JS event object",
-          "required": true
+          "desc": "JS event object"
         },
         "row": {
           "type": "Object",
@@ -2217,10 +2248,12 @@
           "definition": {
             "pagination": {
               "type": "Object",
+              "required": true,
               "desc": "Pagination object",
               "definition": {
                 "sortBy": {
                   "type": "String",
+                  "required": true,
                   "desc": "Column name (from column definition)",
                   "examples": [
                     "calories"
@@ -2228,10 +2261,12 @@
                 },
                 "descending": {
                   "type": "Boolean",
+                  "required": true,
                   "desc": "Is sorting in descending order?"
                 },
                 "page": {
                   "type": "Number",
+                  "required": true,
                   "desc": "Page number (1-based)",
                   "examples": [
                     3
@@ -2239,6 +2274,7 @@
                 },
                 "rowsPerPage": {
                   "type": "Number",
+                  "required": true,
                   "desc": "How many rows per page? 0 means Infinite",
                   "examples": [
                     10
@@ -2248,20 +2284,21 @@
             },
             "filter": {
               "type": "Function",
+              "required": true,
               "desc": "Filter method (the 'filter-method' prop)",
               "params": {
                 "rows": {
                   "type": "Array",
-                  "desc": "Array of rows",
-                  "required": true
+                  "required": true,
+                  "desc": "Array of rows"
                 },
                 "terms": {
                   "type": [
                     "String",
                     "Object"
                   ],
-                  "desc": "Terms to filter with (is essentially the 'filter' prop value)",
-                  "required": true
+                  "required": true,
+                  "desc": "Terms to filter with (is essentially the 'filter' prop value)"
                 },
                 "cols": {
                   "type": "Array",
@@ -2273,10 +2310,12 @@
                   "params": {
                     "col": {
                       "type": "Object",
+                      "required": true,
                       "desc": "Column name from column definitions"
                     },
                     "row": {
                       "type": "Object",
+                      "required": true,
                       "desc": "The row object"
                     }
                   },
@@ -2296,14 +2335,17 @@
             },
             "getCellValue": {
               "type": "Function",
-              "desc": "Optional function to get a cell value",
+              "required": true,
+              "desc": "Function to get a cell value",
               "params": {
                 "col": {
                   "type": "Object",
+                  "required": true,
                   "desc": "Column name from column definitions"
                 },
                 "row": {
                   "type": "Object",
+                  "required": true,
                   "desc": "The row object"
                 }
               },
@@ -2328,20 +2370,23 @@
           "definition": {
             "rows": {
               "type": "Array",
+              "required": true,
               "desc": "Array of row objects that were selected/unselected"
             },
             "keys": {
               "type": "Array",
+              "required": true,
               "desc": "Array of the keys of rows that were selected/unselected"
             },
             "added": {
               "type": "Boolean",
+              "required": true,
               "desc": "Were the rows added to selection (true) or removed from selection (false)"
             },
             "evt": {
               "type": "Object",
-              "desc": "JS event object",
-              "required": true
+              "required": true,
+              "desc": "JS event object"
             }
           }
         }
@@ -2356,6 +2401,7 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [
                 "calories"
@@ -2363,10 +2409,12 @@
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [
                 3
@@ -2374,10 +2422,20 @@
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [
                 10
               ]
+            },
+            "rowsNumber": {
+              "type": "Number",
+              "required": false,
+              "desc": "For server-side fetching only. How many total database rows are there to be added to the table.",
+              "examples": [
+                100,
+                200
+              ]
             }
           }
         }
@@ -2416,6 +2474,7 @@
           "definition": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Index of the list item that was scrolled into view (0 based)",
               "examples": [
                 30
@@ -2423,6 +2482,7 @@
             },
             "from": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the first list item that is rendered (0 based)",
               "examples": [
                 10
@@ -2430,6 +2490,7 @@
             },
             "to": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the last list item that is rendered (0 based)",
               "examples": [
                 50
@@ -2437,6 +2498,7 @@
             },
             "direction": {
               "type": "String",
+              "required": true,
               "desc": "Direction of change",
               "values": [
                 "increase",
@@ -2463,10 +2525,12 @@
       "params": {
         "props": {
           "type": "Object",
+          "required": false,
           "desc": "Request details",
           "definition": {
             "pagination": {
               "type": "Object",
+              "required": false,
               "desc": "Optional pagination object",
               "definition": {
                 "sortBy": {
@@ -2502,16 +2566,16 @@
               "params": {
                 "rows": {
                   "type": "Array",
-                  "desc": "Array of rows",
-                  "required": true
+                  "required": true,
+                  "desc": "Array of rows"
                 },
                 "terms": {
                   "type": [
                     "String",
                     "Object"
                   ],
-                  "desc": "Terms to filter with (is essentially the 'filter' prop value)",
-                  "required": true
+                  "required": true,
+                  "desc": "Terms to filter with (is essentially the 'filter' prop value)"
                 },
                 "cols": {
                   "type": "Array",
@@ -2553,8 +2617,8 @@
       "params": {
         "pagination": {
           "type": "Object",
-          "desc": "Pagination object",
           "required": true,
+          "desc": "Pagination object",
           "definition": {
             "sortBy": {
               "type": "String",
@@ -2606,8 +2670,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "Row key value",
           "required": true,
+          "desc": "Row key value",
           "examples": [
             "calories"
           ]
@@ -2626,8 +2690,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "Row key value",
           "required": true,
+          "desc": "Row key value",
           "examples": [
             "calories"
           ]
@@ -2643,8 +2707,8 @@
       "params": {
         "expanded": {
           "type": "Array",
-          "desc": "Array containing keys of the expanded rows",
           "required": true,
+          "desc": "Array containing keys of the expanded rows",
           "examples": [
             "[ 'row-a', 'row-b' ]"
           ]
@@ -2659,8 +2723,8 @@
             "String",
             "Object"
           ],
-          "desc": "Column name or column definition object",
           "required": true,
+          "desc": "Column name or column definition object",
           "examples": [
             "calories"
           ]
@@ -2678,8 +2742,8 @@
             "String",
             "Number"
           ],
-          "desc": "The index of the row in page (0 based)",
           "required": true,
+          "desc": "The index of the row in page (0 based)",
           "examples": [
             "1",
             23
@@ -2687,7 +2751,7 @@
         },
         "edge": {
           "type": "String",
-          "desc": "Only for virtual scroll - the edge to align to if the row is not visible already (by default it aligns to end if scrolling towards the end and to start otherwise); If the '-force' version is used then it always aligns",
+          "desc": "Only for virtual scroll - the edge to align to if the row is not visible already; If the '-force' version is used then it always aligns",
           "values": [
             "start",
             "center",
@@ -2695,7 +2759,9 @@
             "start-force",
             "center-force",
             "end-force"
-          ]
+          ],
+          "default": "end (if scrolling towards the end) / start (if scrolling towards the start)",
+          "required": false
         }
       }
     }