quasar 2.2.4 → 2.3.3

package/src/components/table/QTable.json

@@ -17,6 +17,18 @@
       "type": [ "String", "Function" ],
       "desc": "Property of each row that defines the unique key of each row (the result must be a primitive, not Object, Array, etc); The value of property must be string or a function taking a row and returning the desired (nested) key in the row; If supplying a function then for best performance, reference it from your scope and do not define it inline",
       "default": "id",
+      "params": {
+        "row": {
+          "type": "Object",
+          "desc": "The current row being processed",
+          "examples": [ "{ name: 'Lorem Ipsum', price: 19 }" ]
+        }
+      },
+      "returns": {
+        "type": "Any",
+        "desc": "Current row's key",
+        "examples": [ "'34f39dda-6206-4071-a9df-4393aabe49ac'", "34" ]
+      },
       "examples": [ "row-key=\"name\"", ":row-key=\"row => row.name\"" ],
       "category": "general"
     },
@@ -132,33 +144,44 @@
       "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)" ]
         },
         "field": {
           "type": [ "String", "Function" ],
-          "desc": "Row Object property to determine value for this column or function which maps to the required property",
           "required": true,
-          "examples": [ "name", "row => row.some.nested.prop" ]
+          "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 } }" ]
+            }
+          },
+          "returns": {
+            "type": "Any",
+            "desc": "Value for this column",
+            "examples": [ "19" ]
+          },
+          "examples": [ "name", "row => row.prices.active" ]
         },
         "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",
           "desc": "Horizontal alignment of cells in this column",
           "values": [ "left", "right", "center" ],
-          "default": "right",
-          "examples": [ "left", "right", "center" ]
+          "default": "right"
         },
         "sortable": {
           "type": "Boolean",
@@ -172,21 +195,25 @@
           "params": {
             "a": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the first comparison term",
               "examples": [ 123, "abc" ]
             },
             "b": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the second comparison term",
               "examples": [ 123, "abc" ]
             },
             "rowA": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which is contained the first term",
               "examples": [ "{ name: 'Potassium', value: 'K' }" ]
             },
             "rowB": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which is contained the second term",
               "examples": [ "{ name: 'Fluorine', value: 'F' }" ]
             }
@@ -210,11 +237,13 @@
           "params": {
             "val": {
               "type": "Any",
+              "required": true,
               "desc": "Value of the cell",
               "examples": [ 123, "abc" ]
             },
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "Full Row object in which the cell is contained",
               "examples": [ "{ name: 'Potassium', value: 'K' }" ]
             }
@@ -228,17 +257,41 @@
         "style": {
           "type": [ "String", "Function" ],
           "desc": "Style to apply on normal cells of the column",
+          "params": {
+            "row": {
+              "type": "Object",
+              "required": true,
+              "desc": "The current row being processed",
+              "examples": [ "{ name: 'Frozen Yogurt', calories: 159 }" ]
+            }
+          },
+          "returns": {
+            "type": "String",
+            "__exemption": [ "desc", "examples" ]
+          },
           "examples": [
-            "width: 500px",
-            "row => (row.calories % 2 === 0 ? 'width:10px' : 'font-size:2em')"
+            "'width: 500px'",
+            "row => (row.calories % 2 === 0 ? 'width: 10px' : 'font-size: 2em; font-weight: bold')"
           ]
         },
         "classes": {
           "type": [ "String", "Function" ],
           "desc": "Classes to add on normal cells of the column",
+          "params": {
+            "row": {
+              "type": "Object",
+              "required": true,
+              "desc": "The current row being processed",
+              "examples": [ "{ name: 'Frozen Yogurt', calories: 159 }" ]
+            }
+          },
+          "returns": {
+            "type": "String",
+            "__exemption": [ "desc", "examples" ]
+          },
           "examples": [
-            "my-special-class",
-            "row => (row.calories % 2 === 0 ? 'bg-green' : 'bg-yellow')"
+            "'my-special-class bg-primary'",
+            "row => (row.calories % 2 === 0 ? 'bg-green text-white' : 'bg-yellow')"
           ]
         },
         "headerStyle": {
@@ -328,7 +381,6 @@
       "desc": "Use a separator/border between rows, columns or all cells",
       "default": "horizontal",
       "values": [ "horizontal", "vertical", "cell", "none" ],
-      "examples": [ "cell" ],
       "category": "content"
     },
 
@@ -534,18 +586,16 @@
         "rows": {
           "type": "Array",
           "desc": "Array of rows",
-          "required": true,
           "__exemption": [ "examples" ]
         },
         "terms": {
           "type": [ "String", "Object" ],
           "desc": "Terms to filter with (is essentially the 'filter' prop value)",
-          "required": true,
           "__exemption": [ "examples" ]
         },
         "cols": {
           "type": "Array",
-          "desc": "Optional column definitions",
+          "desc": "Column definitions",
           "__exemption": [ "examples" ]
         },
         "getCellValue": {
@@ -554,11 +604,13 @@
           "params": {
             "col": {
               "type": "Object",
+              "required": true,
               "desc": "Column name from column definitions",
               "__exemption": [ "examples" ]
             },
             "row": {
               "type": "Object",
+              "required": true,
               "desc": "The row object",
               "__exemption": [ "examples" ]
             }
@@ -733,8 +785,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -751,8 +803,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -802,8 +853,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -820,8 +871,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -886,8 +936,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -904,8 +954,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -965,8 +1014,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -983,8 +1032,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1014,8 +1062,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -1032,8 +1080,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1077,8 +1124,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -1095,8 +1142,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1131,8 +1177,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -1149,8 +1195,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1200,8 +1245,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -1218,8 +1263,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1249,8 +1293,8 @@
           "params": {
             "col": {
               "type": [ "String", "Object" ],
-              "desc": "Column name or column definition object",
               "required": true,
+              "desc": "Column name or column definition object",
               "examples": [ "calories" ]
             }
           },
@@ -1267,8 +1311,7 @@
           "reactive": true
         },
         "color": {
-          "extends": "color",
-          "default": "grey-8"
+          "extends": "color"
         },
         "dark": {
           "extends": "dark"
@@ -1310,20 +1353,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1388,20 +1435,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1466,20 +1517,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1544,20 +1599,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1622,20 +1681,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1700,20 +1763,24 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "rowsPerPage": {
               "type": "Number",
+              "required": true,
               "desc": "How many rows per page? 0 means Infinite",
               "examples": [ 10 ]
             }
@@ -1793,7 +1860,6 @@
         "evt": {
           "type": "Object",
           "desc": "JS event object",
-          "required": true,
           "__exemption": [ "examples" ]
         },
 
@@ -1817,7 +1883,6 @@
         "evt": {
           "type": "Object",
           "desc": "JS event object",
-          "required": true,
           "__exemption": [ "examples" ]
         },
 
@@ -1841,7 +1906,6 @@
         "evt": {
           "type": "Object",
           "desc": "JS event object",
-          "required": true,
           "__exemption": [ "examples" ]
         },
 
@@ -1868,24 +1932,29 @@
           "definition": {
             "pagination": {
               "type": "Object",
+              "required": true,
               "desc": "Pagination object",
               "definition": {
                 "sortBy": {
                   "type": "String",
+                  "required": true,
                   "desc": "Column name (from column definition)",
                   "examples": [ "calories" ]
                 },
                 "descending": {
                   "type": "Boolean",
+                  "required": true,
                   "desc": "Is sorting in descending order?"
                 },
                 "page": {
                   "type": "Number",
+                  "required": true,
                   "desc": "Page number (1-based)",
                   "examples": [ 3 ]
                 },
                 "rowsPerPage": {
                   "type": "Number",
+                  "required": true,
                   "desc": "How many rows per page? 0 means Infinite",
                   "examples": [ 10 ]
                 }
@@ -1893,18 +1962,19 @@
             },
             "filter": {
               "type": "Function",
+              "required": true,
               "desc": "Filter method (the 'filter-method' prop)",
               "params": {
                 "rows": {
                   "type": "Array",
-                  "desc": "Array of rows",
                   "required": true,
+                  "desc": "Array of rows",
                   "__exemption": [ "examples" ]
                 },
                 "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)",
                   "__exemption": [ "examples" ]
                 },
                 "cols": {
@@ -1918,11 +1988,13 @@
                   "params": {
                     "col": {
                       "type": "Object",
+                      "required": true,
                       "desc": "Column name from column definitions",
                       "__exemption": [ "examples" ]
                     },
                     "row": {
                       "type": "Object",
+                      "required": true,
                       "desc": "The row object",
                       "__exemption": [ "examples" ]
                     }
@@ -1942,15 +2014,18 @@
             },
             "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",
                   "__exemption": [ "examples" ]
                 },
                 "row": {
                   "type": "Object",
+                  "required": true,
                   "desc": "The row object",
                   "__exemption": [ "examples" ]
                 }
@@ -1975,22 +2050,25 @@
           "definition": {
             "rows": {
               "type": "Array",
+              "required": true,
               "desc": "Array of row objects that were selected/unselected",
               "__exemption": [ "examples" ]
             },
             "keys": {
               "type": "Array",
+              "required": true,
               "desc": "Array of the keys of rows that were selected/unselected",
               "__exemption": [ "examples" ]
             },
             "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,
+              "desc": "JS event object",
               "__exemption": [ "examples" ]
             }
           }
@@ -2007,22 +2085,32 @@
           "definition": {
             "sortBy": {
               "type": "String",
+              "required": true,
               "desc": "Column name (from column definition)",
               "examples": [ "calories" ]
             },
             "descending": {
               "type": "Boolean",
+              "required": true,
               "desc": "Is sorting in descending order?"
             },
             "page": {
               "type": "Number",
+              "required": true,
               "desc": "Page number (1-based)",
               "examples": [ 3 ]
             },
             "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 ]
             }
           }
         }
@@ -2064,21 +2152,25 @@
           "definition": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Index of the list item that was scrolled into view (0 based)",
               "examples": [ 30 ]
             },
             "from": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the first list item that is rendered (0 based)",
               "examples": [ 10 ]
             },
             "to": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the last list item that is rendered (0 based)",
               "examples": [ 50 ]
             },
             "direction": {
               "type": "String",
+              "required": true,
               "desc": "Direction of change",
               "values": [ "increase", "decrease" ]
             }
@@ -2094,10 +2186,12 @@
       "params": {
         "props": {
           "type": "Object",
+          "required": false,
           "desc": "Request details",
           "definition": {
             "pagination": {
               "type": "Object",
+              "required": false,
               "desc": "Optional pagination object",
               "definition": {
                 "sortBy": {
@@ -2127,14 +2221,14 @@
               "params": {
                 "rows": {
                   "type": "Array",
-                  "desc": "Array of rows",
                   "required": true,
+                  "desc": "Array of rows",
                   "__exemption": [ "examples" ]
                 },
                 "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)",
                   "__exemption": [ "examples" ]
                 },
                 "cols": {
@@ -2180,8 +2274,8 @@
       "params": {
         "pagination": {
           "type": "Object",
-          "desc": "Pagination object",
           "required": true,
+          "desc": "Pagination object",
           "definition": {
             "sortBy": {
               "type": "String",
@@ -2232,8 +2326,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "Row key value",
           "required": true,
+          "desc": "Row key value",
           "examples": [ "calories" ]
         }
       },
@@ -2252,8 +2346,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "Row key value",
           "required": true,
+          "desc": "Row key value",
           "examples": [ "calories" ]
         }
       },
@@ -2268,8 +2362,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' ]" ]
         }
       }
@@ -2280,8 +2374,8 @@
       "params": {
         "col": {
           "type": [ "String", "Object" ],
-          "desc": "Column name or column definition object",
           "required": true,
+          "desc": "Column name or column definition object",
           "examples": [ "calories" ]
         }
       }
@@ -2300,14 +2394,15 @@
       "params": {
         "index": {
           "type": [ "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 ]
         },
         "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",
-          "values": [ "start", "center", "end", "start-force", "center-force", "end-force" ]
+          "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", "end", "start-force", "center-force", "end-force" ],
+          "default": "end (if scrolling towards the end) / start (if scrolling towards the start)"
         }
       }
     }