quasar 2.3.0 → 2.3.4

package/dist/api/QTabs.json

@@ -46,7 +46,8 @@
       "examples": [
         "right"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "breakpoint": {
       "type": [
@@ -58,7 +59,8 @@
       "examples": [
         ":breakpoint=\"500\""
       ],
-      "category": "content|behavior"
+      "category": "content|behavior",
+      "required": false
     },
     "active-color": {
       "type": "String",

package/dist/api/QTime.json

@@ -26,7 +26,8 @@
         "HH:mm:ss",
         "YYYY-MM-DD HH:mm:ss",
         "HH:mm MMMM Do, YYYY"
-      ]
+      ],
+      "required": false
     },
     "locale": {
       "type": "Object",
@@ -74,7 +75,8 @@
         "gregorian",
         "persian"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "color": {
       "type": "String",
@@ -141,7 +143,8 @@
       "type": "Boolean",
       "desc": "Forces 24 hour time display instead of AM/PM system",
       "default": "(based on Quasar lang language being used)",
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "default-date": {
       "type": "String",
@@ -150,7 +153,8 @@
       "examples": [
         "1995/02/23"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "options": {
       "type": "Function",
@@ -242,34 +246,42 @@
           "definition": {
             "year": {
               "type": "Number",
+              "required": true,
               "desc": "The year"
             },
             "month": {
               "type": "Number",
+              "required": true,
               "desc": "The month"
             },
             "day": {
               "type": "Number",
+              "required": true,
               "desc": "The day of the month"
             },
             "hour": {
               "type": "Number",
+              "required": true,
               "desc": "The hour"
             },
             "minute": {
               "type": "Number",
+              "required": true,
               "desc": "The minute"
             },
             "second": {
               "type": "Number",
+              "required": true,
               "desc": "The second"
             },
             "millisecond": {
               "type": "Number",
+              "required": true,
               "desc": "The millisecond"
             },
             "changed": {
               "type": "Boolean",
+              "required": true,
               "desc": "Did the model change?"
             }
           }

package/dist/api/QTimeline.json

@@ -21,7 +21,8 @@
         "left",
         "right"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "layout": {
       "type": "String",
@@ -32,7 +33,8 @@
         "comfortable",
         "loose"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "dark": {
       "type": "Boolean",

package/dist/api/QTimelineEntry.json

@@ -18,7 +18,8 @@
         "h1"
       ],
       "category": "content",
-      "default": "h3"
+      "default": "h3",
+      "required": false
     },
     "side": {
       "type": "String",
@@ -28,7 +29,8 @@
         "left",
         "right"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "icon": {
       "type": "String",

package/dist/api/QToggle.json

@@ -51,7 +51,8 @@
       "examples": [
         "Agreed"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "false-value": {
       "type": "Any",
@@ -60,7 +61,8 @@
       "examples": [
         "Disagree"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "indeterminate-value": {
       "type": "Any",
@@ -70,7 +72,8 @@
         0,
         "not_answered"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "toggle-order": {
       "type": "String",
@@ -80,7 +83,8 @@
         "tf",
         "ft"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "toggle-indeterminate": {
       "type": "Boolean",

package/dist/api/QTooltip.json

@@ -12,7 +12,8 @@
         "slide-down"
       ],
       "category": "transition",
-      "default": "jump-down"
+      "default": "jump-down",
+      "required": false
     },
     "transition-hide": {
       "type": "String",
@@ -22,7 +23,8 @@
         "slide-down"
       ],
       "category": "transition",
-      "default": "jump-up"
+      "default": "jump-up",
+      "required": false
     },
     "transition-duration": {
       "type": [
@@ -35,7 +37,8 @@
         500,
         "1200"
       ],
-      "category": "transition"
+      "category": "transition",
+      "required": false
     },
     "model-value": {
       "type": "Boolean",
@@ -85,7 +88,8 @@
         "top left",
         "bottom right"
       ],
-      "category": "position"
+      "category": "position",
+      "required": false
     },
     "self": {
       "type": "String",
@@ -112,7 +116,8 @@
         "top left",
         "bottom right"
       ],
-      "category": "position"
+      "category": "position",
+      "required": false
     },
     "offset": {
       "type": "Array",
@@ -122,7 +127,8 @@
         "[8, 8]",
         "[5, 10]"
       ],
-      "category": "position"
+      "category": "position",
+      "required": false
     },
     "scroll-target": {
       "type": [
@@ -154,7 +160,8 @@
         ":target=\"false\"",
         "target=\".my-parent\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "no-parent-event": {
       "type": "Boolean",
@@ -168,7 +175,8 @@
       "examples": [
         ":delay=\"550\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "hide-delay": {
       "type": "Number",
@@ -177,7 +185,8 @@
       "examples": [
         ":hide-delay=\"650\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     }
   },
   "slots": {

package/dist/api/QTree.json

@@ -31,7 +31,8 @@
         "name",
         "description"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "children-key": {
       "type": "String",
@@ -41,7 +42,8 @@
         "roles",
         "relatives"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "no-connectors": {
       "type": "Boolean",
@@ -116,7 +118,8 @@
         "leaf",
         "leaf-filtered"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "ticked": {
       "type": "Array",
@@ -181,7 +184,8 @@
         "type": "Boolean",
         "desc": "Matches or not"
       },
-      "category": "filter"
+      "category": "filter",
+      "required": false
     },
     "duration": {
       "type": "Number",
@@ -190,7 +194,8 @@
       "examples": [
         ":duration=\"500\""
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "no-nodes-label": {
       "type": "String",
@@ -224,7 +229,8 @@
           "reactive": true
         },
         "tree": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QTree",
           "desc": "QTree instance"
         },
         "node": {
@@ -262,7 +268,8 @@
           "reactive": true
         },
         "tree": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QTree",
           "desc": "QTree instance"
         },
         "node": {
@@ -300,7 +307,8 @@
           "reactive": true
         },
         "tree": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QTree",
           "desc": "QTree instance"
         },
         "node": {
@@ -338,7 +346,8 @@
           "reactive": true
         },
         "tree": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QTree",
           "desc": "QTree instance"
         },
         "node": {
@@ -385,10 +394,12 @@
           "definition": {
             "node": {
               "type": "Object",
+              "required": true,
               "desc": "The node to which the new nodes (the children) will be appended"
             },
             "key": {
               "type": "String",
+              "required": true,
               "desc": "The key of the node getting the newly loaded child nodes",
               "examples": [
                 "New Node"
@@ -396,17 +407,21 @@
             },
             "done": {
               "type": "Function",
+              "required": true,
               "desc": "The callback to be carried out when the loading is successful",
               "params": {
                 "children": {
                   "type": "Array",
-                  "desc": "Array of nodes"
+                  "desc": "Array of nodes",
+                  "default": "[]",
+                  "required": false
                 }
               },
               "returns": null
             },
             "fail": {
               "type": "Function",
+              "required": true,
               "desc": "The callback to be carried out should the loading fails",
               "params": null,
               "returns": null
@@ -452,8 +467,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [
             "Node 1"
           ]
@@ -483,8 +498,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [
             "Node 1"
           ]
@@ -506,16 +521,16 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [
             "Node 1"
           ]
         },
         "state": {
           "type": "Boolean",
-          "desc": "Set to 'true' to expand the branch of the tree, otherwise 'false' collapses it",
-          "required": true
+          "required": true,
+          "desc": "Set to 'true' to expand the branch of the tree, otherwise 'false' collapses it"
         }
       }
     },
@@ -524,8 +539,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [
             "Node 1"
           ]
@@ -541,16 +556,16 @@
       "params": {
         "keys": {
           "type": "Array",
-          "desc": "The keys of nodes to tick/untick",
           "required": true,
+          "desc": "The keys of nodes to tick/untick",
           "examples": [
             "[ 'Node 1', 'Node 2' ]"
           ]
         },
         "state": {
           "type": "Boolean",
-          "desc": "Set to 'true' to tick the checkbox of nodes, otherwise 'false' unticks them",
-          "required": true
+          "required": true,
+          "desc": "Set to 'true' to tick the checkbox of nodes, otherwise 'false' unticks them"
         }
       }
     }

package/dist/api/QUploader.json

@@ -16,7 +16,7 @@
       "returns": {
         "type": [
           "Object",
-          "Promise"
+          "Promise<any>"
         ],
         "desc": "Optional configuration for the upload process; You can override QUploader props in this Object (url, method, headers, formFields, fieldName, withCredentials, sendRaw); Props of these Object can also be Functions with the form of (file[s]) => value"
       },
@@ -32,6 +32,16 @@
         "https://example.com/path",
         "files => `https://example.com?count=${files.length}`"
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "URL or path to the server which handles the upload"
+      },
       "category": "upload"
     },
     "method": {
@@ -49,7 +59,18 @@
         "POST",
         ":method=\"files => files.length > 10 ? 'POST' : 'PUT'\""
       ],
-      "category": "upload"
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "HTTP method to use for upload"
+      },
+      "category": "upload",
+      "required": false
     },
     "field-name": {
       "type": [
@@ -62,7 +83,18 @@
         "backgroundFile",
         ":field-name=\"(file) => 'background' + file.name\""
       ],
-      "category": "upload"
+      "params": {
+        "files": {
+          "type": "File",
+          "desc": "The current file being processed"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "Field name for the current file upload"
+      },
+      "category": "upload",
+      "required": false
     },
     "headers": {
       "type": [
@@ -96,6 +128,16 @@
         "() => [{name: 'X-Custom-Timestamp', value: Date.now()}]",
         "files => [{name: 'X-Custom-Count', value: files.length}]"
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "An array consists of objects with header definitions"
+      },
       "category": "upload"
     },
     "form-fields": {
@@ -127,6 +169,16 @@
         "() => [{name: 'my-field', value: 'my-value'}]",
         "files => [{name: 'my-field', value: 'my-value' + files.length}]"
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "An array consists of objects with additional fields definitions (used by Form to be uploaded)"
+      },
       "category": "upload"
     },
     "with-credentials": {
@@ -139,6 +191,16 @@
         "with-credentials",
         ":with-credentials=\"files => ...\""
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, withCredentials will be set to true on the XHR that manages the upload"
+      },
       "category": "upload"
     },
     "send-raw": {
@@ -151,6 +213,16 @@
         "send-raw",
         ":send-raw=\"files => ...\""
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, raw files will get sent without wrapping into a Form()"
+      },
       "category": "upload"
     },
     "batch": {
@@ -162,6 +234,16 @@
       "examples": [
         "files => files.length > 10"
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, files will be uploaded in a batch (in one XHR request)"
+      },
       "category": "upload"
     },
     "multiple": {
@@ -334,10 +416,12 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Uploaded files"
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest that has been used to upload this batch of files"
             }
           }
@@ -353,10 +437,12 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Files which encountered error"
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest that has been used to upload this batch of files"
             }
           }
@@ -372,10 +458,12 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Files which are now uploading"
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest used for uploading"
             }
           }
@@ -386,8 +474,8 @@
       "desc": "Emitted when factory function is supplied with a Promise which is rejected",
       "params": {
         "err": {
-          "type": "Object",
-          "desc": "Error Object which is the Promise rejection reason"
+          "type": "Error",
+          "desc": "Error object which is the Promise rejection reason"
         },
         "files": {
           "type": "Array",