quasar 2.3.2 → 2.3.3

package/src/components/table/table-pagination.js

@@ -64,6 +64,10 @@ export function useTablePaginationState (vm, getCellValue) {
     nextTick(() => {
       emit('request', {
         pagination: prop.pagination || computedPagination.value,
+        // FIXME: 'props.filter' is string/object, but 'prop.filter' can be controlled by the user, and the docs are suggesting 'prop.filter' is a function
+        // So, value of 'filter' becomes function/string/object, which makes a lot of things unpredictable and can break things
+        // Either update the docs to say 'prop.filter' should be a string/object, or use 'prop.filter || props.filterMethod' or maybe get 'computedFilterFunction' here and use that instead of 'props.filterMethod'
+        // The examples on our docs are using 'filter' as a string in onRequest handler, but the JSON API is saying 'filter' is a function
         filter: prop.filter || props.filter,
         getCellValue
       })

package/src/components/time/QTime.json

@@ -123,41 +123,49 @@
           "definition": {
             "year": {
               "type": "Number",
+              "required": true,
               "desc": "The year",
               "__exemption": [ "examples" ]
             },
             "month": {
               "type": "Number",
+              "required": true,
               "desc": "The month",
               "__exemption": [ "examples" ]
             },
             "day": {
               "type": "Number",
+              "required": true,
               "desc": "The day of the month",
               "__exemption": [ "examples" ]
             },
             "hour": {
               "type": "Number",
+              "required": true,
               "desc": "The hour",
               "__exemption": [ "examples" ]
             },
             "minute": {
               "type": "Number",
+              "required": true,
               "desc": "The minute",
               "__exemption": [ "examples" ]
             },
             "second": {
               "type": "Number",
+              "required": true,
               "desc": "The second",
               "__exemption": [ "examples" ]
             },
             "millisecond": {
               "type": "Number",
+              "required": true,
               "desc": "The millisecond",
               "__exemption": [ "examples" ]
             },
             "changed": {
               "type": "Boolean",
+              "required": true,
               "desc": "Did the model change?"
             }
           }

package/src/components/tree/QTree.json

@@ -354,21 +354,25 @@
           "definition": {
             "node": {
               "type": "Object",
+              "required": true,
               "desc": "The node to which the new nodes (the children) will be appended",
               "__exemption": [ "examples" ]
             },
             "key": {
               "type": "String",
+              "required": true,
               "desc": "The key of the node getting the newly loaded child nodes",
               "examples": [ "New Node" ]
             },
             "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",
+                  "default": "[]",
                   "__exemption": [ "examples" ]
                 }
               },
@@ -376,6 +380,7 @@
             },
             "fail": {
               "type": "Function",
+              "required": true,
               "desc": "The callback to be carried out should the loading fails",
               "params": null,
               "returns": null
@@ -422,8 +427,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [ "Node 1" ]
         }
       },
@@ -457,8 +462,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [ "Node 1" ]
         }
       },
@@ -481,14 +486,14 @@
       "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"
         }
       }
     },
@@ -498,8 +503,8 @@
       "params": {
         "key": {
           "type": "Any",
-          "desc": "The key of a node",
           "required": true,
+          "desc": "The key of a node",
           "examples": [ "Node 1" ]
         }
       },
@@ -514,14 +519,14 @@
       "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/src/components/uploader/xhr-uploader-plugin.json

@@ -223,11 +223,13 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Uploaded files",
               "__exemption": [ "examples" ]
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest that has been used to upload this batch of files",
               "__exemption": [ "examples" ]
             }
@@ -245,11 +247,13 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Files which encountered error",
               "__exemption": [ "examples" ]
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest that has been used to upload this batch of files",
               "__exemption": [ "examples" ]
             }
@@ -267,11 +271,13 @@
           "definition": {
             "files": {
               "type": "Array",
+              "required": true,
               "desc": "Files which are now uploading",
               "__exemption": [ "examples" ]
             },
             "xhr": {
               "type": "Object",
+              "required": true,
               "desc": "XMLHttpRequest used for uploading",
               "__exemption": [ "examples" ]
             }
@@ -284,9 +290,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",
-          "__exemption": [ "examples" ]
+          "type": "Error",
+          "desc": "Error object which is the Promise rejection reason"
         },
         "files": {
           "type": "Array",

package/src/components/virtual-scroll/use-virtual-scroll.json

@@ -72,26 +72,31 @@
           "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" ]
             },
             "ref": {
               "type": "Object",
+              "required": true,
               "desc": "Vue reference to the QVirtualList which triggered the event",
               "__exemption": [
                 "examples"

package/src/composables/private/use-split-attrs.js

@@ -9,14 +9,11 @@ export default function (attrs, vnode) {
   }
 
   function update () {
-    const listeners = {}
     const attributes = {}
+    const listeners = {}
 
     Object.keys(attrs).forEach(key => {
-      if (listenerRE.test(key) === true) {
-        listeners[ key ] = attrs[ key ]
-      }
-      else if (key !== 'class' && key !== 'style') {
+      if (key !== 'class' && key !== 'style' && listenerRE.test(key) === false) {
         attributes[ key ] = attrs[ key ]
       }
     })
@@ -27,8 +24,8 @@ export default function (attrs, vnode) {
       }
     })
 
-    acc.listeners.value = listeners
     acc.attributes.value = attributes
+    acc.listeners.value = listeners
   }
 
   onBeforeUpdate(update)

package/src/directives/Mutation.json

@@ -27,9 +27,8 @@
           },
 
           "target": {
-            "type": "Object",
-            "desc": "The DOM element that the mutation affected, depending on the mutation type",
-            "__exemption": [ "examples" ]
+            "type": "Element",
+            "desc": "The DOM element that the mutation affected, depending on the mutation type"
           },
 
           "addedNodes": {

package/src/directives/ScrollFire.json

@@ -8,9 +8,8 @@
     "desc": "Function to call when scrolling and element comes into the viewport (use a non-function to disable)",
     "params": {
       "el": {
-        "type": "Object",
-        "desc": "DOM element that scroll-fire is applied to",
-        "__exemption": [ "examples" ]
+        "type": "Element",
+        "desc": "DOM element that scroll-fire is applied to"
       }
     },
     "returns": null,

package/src/plugins/AppFullscreen.json

@@ -17,9 +17,9 @@
     },
 
     "activeEl": {
-      "type": "Object",
+      "type": [ "Element", "null" ],
       "desc": "The DOM element used as root for fullscreen, otherwise 'null'",
-      "__exemption": [ "examples" ]
+      "examples": [ "document.fullscreenElement", "null" ]
     }
   },
 
@@ -34,8 +34,8 @@
         }
       },
       "returns": {
-        "type": "Promise<any>",
-        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
+        "type": "Promise<void>",
+        "desc": "A Promise which is resolved when transitioned to fullscreen mode. It gets rejected with 'Not capable' if the browser is not capable, and with an Error object if something else went wrong.",
         "examples": [
           "request().then(response => { ... }).catch(err => { ... })"
         ]
@@ -45,8 +45,8 @@
     "exit": {
       "desc": "Request exiting out of Fullscreen mode",
       "returns": {
-        "type": "Promise<any>",
-        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
+        "type": "Promise<void>",
+        "desc": "A Promise which is resolved when exited out of fullscreen mode. It gets rejected with 'Not capable' if the browser is not capable, and with an Error object if something else went wrong.",
         "examples": [
           "exit().then(response => { ... }).catch(err => { ... })"
         ]
@@ -63,8 +63,8 @@
         }
       },
       "returns": {
-        "type": "Promise<any>",
-        "desc": "A Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
+        "type": "Promise<void>",
+        "desc": "A Promise which is resolved when transitioned to / exited out of fullscreen mode. It gets rejected with 'Not capable' if the browser is not capable, and with an Error object if something else went wrong.",
         "examples": [
           "toggle().then(response => { ... }).catch(err => { ... })"
         ]

package/src/plugins/Cookies.json

@@ -73,8 +73,8 @@
             },
             "sameSite": {
               "type": "String",
-              "desc": "SameSite cookie option (not supported by IE11)",
-              "examples": [ "Strict", "Lax" ]
+              "desc": "SameSite cookie option",
+              "values": [ "Lax", "Strict", "None" ]
             },
             "httpOnly": {
               "type": "Boolean",

package/src/plugins/Dialog.json

@@ -46,8 +46,8 @@
               "definition": {
                 "model": {
                   "type": "String",
-                  "desc": "The initial value of the input",
                   "required": true,
+                  "desc": "The initial value of the input",
                   "__exemption": [ "examples" ]
                 },
 
@@ -64,6 +64,7 @@
                   "params": {
                     "val": {
                       "type": "String",
+                      "required": true,
                       "desc": "The value of the input",
                       "__exemption": [ "examples" ]
                     }
@@ -151,8 +152,8 @@
               "definition": {
                 "model": {
                   "type": [ "String", "Array" ],
-                  "desc": "The value of the selection (String if it's of type radio or Array otherwise)",
                   "required": true,
+                  "desc": "The value of the selection (String if it's of type radio or Array otherwise)",
                   "examples": [ "[]" ]
                 },
 
@@ -177,6 +178,7 @@
                   "params": {
                     "model": {
                       "type": [ "String", "Array" ],
+                      "required": true,
                       "desc": "The current model (String if it's of type radio or Array otherwise)",
                       "examples": [
                         "opt2",

package/src/plugins/LoadingBar.json

@@ -23,6 +23,7 @@
         "speed": {
           "type": "Number",
           "desc": "Delay (in milliseconds) between bar progress increments",
+          "default": 300,
           "examples": [ 150 ]
         }
       }
@@ -46,11 +47,11 @@
     "setDefaults": {
       "desc": "Set the inner QAjaxBar's props",
       "params": {
-        "...props": {
+        "props": {
           "type": "Object",
-          "desc": "QAjaxBar component props",
           "required": true,
-          "__exemption": [ "examples" ]
+          "desc": "QAjaxBar component props",
+          "examples": [ "{ position: 'bottom', reverse: true }" ]
         }
       }
     }

package/src/plugins/Notify.json

@@ -164,6 +164,7 @@
       "params": {
         "opts": {
           "type": [ "Object", "String" ],
+          "required": true,
           "desc": "Notification options",
           "definition": {
             "type": {
@@ -214,7 +215,7 @@
             "spinner": {
               "type": [ "Boolean", "Component" ],
               "desc": "Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown",
-              "__exemption": [ "examples" ]
+              "examples": [ true, "QSpinnerBars" ]
             },
 
             "position": {
@@ -225,8 +226,7 @@
                 "top-left", "top-right",
                 "bottom-left", "bottom-right",
                 "top", "bottom", "left", "right", "center"
-              ],
-              "examples": [ "top-right" ]
+              ]
             },
 
             "group": {
@@ -251,8 +251,7 @@
               "values": [
                 "top-left", "top-right",
                 "bottom-left", "bottom-right"
-              ],
-              "examples": [ "bottom-right" ]
+              ]
             },
             "badgeStyle": {
               "type": [ "Array", "String", "Object" ],
@@ -339,9 +338,7 @@
               "type": "Boolean",
               "desc": "Ignore the default configuration (set by setDefaults()) for this instance only"
             }
-          },
-          "required": true,
-          "__exemption": [ "examples" ]
+          }
         }
       },
       "returns": {
@@ -350,6 +347,7 @@
         "params": {
           "props": {
             "type": "Object",
+            "required": false,
             "desc": "Notification properties that will be shallow merged to previous ones in order to update the non-grouped notification",
             "definition": {
               "type": {
@@ -483,6 +481,7 @@
       "params": {
         "opts": {
           "type": "Object",
+          "required": true,
           "desc": "Notification options",
           "definition": {
             "type": {
@@ -607,8 +606,7 @@
             "attrs": {
               "type": "Object",
               "desc": "Key-value for attributes to be set on the notification",
-              "examples": [ "{ role: 'alertdialog' }" ],
-              "__exemption": [ "definition" ]
+              "examples": [ "{ role: 'alertdialog' }" ]
             },
 
             "timeout": {
@@ -646,9 +644,7 @@
               "type": "Boolean",
               "desc": "Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"
             }
-          },
-          "required": true,
-          "__exemption": [ "examples" ]
+          }
         }
       }
     },
@@ -658,13 +654,14 @@
       "params": {
         "typeName": {
           "type": "String",
-          "desc": "Name of the type (to be used as 'type' prop later on)",
           "required": true,
+          "desc": "Name of the type (to be used as 'type' prop later on)",
           "examples": [ "my-type" ]
         },
 
         "typeOpts": {
           "type": "Object",
+          "required": true,
           "desc": "Notification options",
           "definition": {
             "type": {
@@ -789,8 +786,7 @@
             "attrs": {
               "type": "Object",
               "desc": "Key-value for attributes to be set on the notification",
-              "examples": [ "{ role: 'alertdialog' }" ],
-              "__exemption": [ "definition" ]
+              "examples": [ "{ role: 'alertdialog' }" ]
             },
 
             "timeout": {
@@ -828,9 +824,7 @@
               "type": "Boolean",
               "desc": "Put notification into multi-line mode; If this prop isn't used and more than one 'action' is specified then notification goes into multi-line mode by default"
             }
-          },
-          "required": true,
-          "__exemption": [ "examples" ]
+          }
         }
       }
     }

package/src/utils/private/global-dialog.json

@@ -29,6 +29,7 @@
         "definition": {
           "onOk": {
             "type": "Function",
+            "required": true,
             "desc": "Receives a Function param to tell what to do when OK is pressed / option is selected",
             "params": {
               "callbackFn": {
@@ -57,6 +58,7 @@
 
           "onCancel": {
             "type": "Function",
+            "required": true,
             "desc": "Receives a Function as param to tell what to do when Cancel is pressed / dialog is dismissed",
             "params": {
               "callbackFn": {
@@ -77,6 +79,7 @@
 
           "onDismiss": {
             "type": "Function",
+            "required": true,
             "desc": "Receives a Function param to tell what to do when the dialog is closed",
             "params": {
               "callbackFn": {
@@ -97,6 +100,7 @@
 
           "hide": {
             "type": "Function",
+            "required": true,
             "desc": "Hides the dialog when called",
             "params": null,
             "returns": {
@@ -109,10 +113,12 @@
 
           "update": {
             "type": "Function",
+            "required": true,
             "desc": "Updates the initial properties (given as create() param) except for 'component'",
             "params": {
               "opts": {
                 "type": "Object",
+                "required": true,
                 "desc": "Props (except 'component') which will overwrite the initial create() params; If create() was invoked with a custom dialog component then this param should contain the new componentProps",
                 "__exemption": [ "examples" ]
               }