quasar 2.2.4 → 2.3.3

package/dist/api/AppFullscreen.json

@@ -14,8 +14,15 @@
       "desc": "Is Fullscreen active?"
     },
     "activeEl": {
-      "type": "Object",
-      "desc": "The DOM element used as root for fullscreen, otherwise 'null'"
+      "type": [
+        "Element",
+        "null"
+      ],
+      "desc": "The DOM element used as root for fullscreen, otherwise 'null'",
+      "examples": [
+        "document.fullscreenElement",
+        "null"
+      ]
     }
   },
   "methods": {
@@ -31,8 +38,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 => { ... })"
         ]
@@ -41,8 +48,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 => { ... })"
         ]
@@ -60,8 +67,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/dist/api/BottomSheet.json

@@ -127,14 +127,30 @@
         "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": {
                 "type": "Function",
                 "desc": "Tell what to do",
                 "required": true,
-                "params": null,
-                "returns": null
+                "params": {
+                  "payload": {
+                    "type": "Any",
+                    "desc": "The payload if called onDialogOK with the parameter or emitted one with the 'ok' event",
+                    "required": false,
+                    "examples": [
+                      "'Quasar Framework'",
+                      "[ 1, 2, 6, 3 ]",
+                      "{ book: { id: 1, name: 'Lorem Ipsum' }, user: { name: 'Lorem J. Ipsum', role: 'admin' } }"
+                    ]
+                  }
+                },
+                "returns": null,
+                "examples": [
+                  "() => console.log('OK!')",
+                  "(payload) => Notify.create({ type: 'positive', message: `Successfully saved '${payload.book.name}' book!` })"
+                ]
               }
             },
             "returns": {
@@ -145,6 +161,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": {
@@ -163,6 +180,7 @@
           },
           "onDismiss": {
             "type": "Function",
+            "required": true,
             "desc": "Receives a Function param to tell what to do when the dialog is closed",
             "params": {
               "callbackFn": {
@@ -181,6 +199,7 @@
           },
           "hide": {
             "type": "Function",
+            "required": true,
             "desc": "Hides the dialog when called",
             "params": null,
             "returns": {
@@ -191,10 +210,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"
               }
             },

package/dist/api/Cookies.json

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

package/dist/api/Dialog.json

@@ -62,7 +62,8 @@
                 "left",
                 "standard"
               ],
-              "default": "standard"
+              "default": "standard",
+              "required": false
             },
             "prompt": {
               "type": "Object",
@@ -73,8 +74,8 @@
               "definition": {
                 "model": {
                   "type": "String",
-                  "desc": "The initial value of the input",
-                  "required": true
+                  "required": true,
+                  "desc": "The initial value of the input"
                 },
                 "type": {
                   "type": "String",
@@ -84,7 +85,8 @@
                     "text",
                     "number",
                     "textarea"
-                  ]
+                  ],
+                  "required": false
                 },
                 "isValid": {
                   "type": "Function",
@@ -92,6 +94,7 @@
                   "params": {
                     "val": {
                       "type": "String",
+                      "required": true,
                       "desc": "The value of the input"
                     }
                   },
@@ -188,8 +191,8 @@
                     "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": [
                     "[]"
                   ]
@@ -202,7 +205,8 @@
                     "radio",
                     "checkbox",
                     "toggle"
-                  ]
+                  ],
+                  "required": false
                 },
                 "items": {
                   "type": "Array",
@@ -220,6 +224,7 @@
                         "String",
                         "Array"
                       ],
+                      "required": true,
                       "desc": "The current model (String if it's of type radio or Array otherwise)",
                       "examples": [
                         "opt2",
@@ -294,7 +299,8 @@
                 "cancel",
                 "none"
               ],
-              "default": "ok"
+              "default": "ok",
+              "required": false
             },
             "stackButtons": {
               "type": "Boolean",
@@ -354,7 +360,8 @@
                 "slide-down"
               ],
               "category": "transition",
-              "default": "scale"
+              "default": "scale",
+              "required": false
             },
             "transitionHide": {
               "type": "String",
@@ -364,7 +371,8 @@
                 "slide-down"
               ],
               "category": "transition",
-              "default": "scale"
+              "default": "scale",
+              "required": false
             },
             "component": {
               "type": "Any",
@@ -386,14 +394,30 @@
         "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": {
                 "type": "Function",
                 "desc": "Tell what to do",
                 "required": true,
-                "params": null,
-                "returns": null
+                "params": {
+                  "payload": {
+                    "type": "Any",
+                    "desc": "The payload if called onDialogOK with the parameter or emitted one with the 'ok' event",
+                    "required": false,
+                    "examples": [
+                      "'Quasar Framework'",
+                      "[ 1, 2, 6, 3 ]",
+                      "{ book: { id: 1, name: 'Lorem Ipsum' }, user: { name: 'Lorem J. Ipsum', role: 'admin' } }"
+                    ]
+                  }
+                },
+                "returns": null,
+                "examples": [
+                  "() => console.log('OK!')",
+                  "(payload) => Notify.create({ type: 'positive', message: `Successfully saved '${payload.book.name}' book!` })"
+                ]
               }
             },
             "returns": {
@@ -404,6 +428,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": {
@@ -422,6 +447,7 @@
           },
           "onDismiss": {
             "type": "Function",
+            "required": true,
             "desc": "Receives a Function param to tell what to do when the dialog is closed",
             "params": {
               "callbackFn": {
@@ -440,6 +466,7 @@
           },
           "hide": {
             "type": "Function",
+            "required": true,
             "desc": "Hides the dialog when called",
             "params": null,
             "returns": {
@@ -450,10 +477,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"
               }
             },

package/dist/api/Loading.json

@@ -25,7 +25,8 @@
         "type": "Boolean",
         "default": "false",
         "desc": "Force render the message as HTML; This can lead to XSS attacks so make sure that you sanitize the content",
-        "category": "behavior"
+        "category": "behavior",
+        "required": false
       },
       "boxClass": {
         "type": "String",
@@ -118,7 +119,8 @@
               "type": "Boolean",
               "default": "false",
               "desc": "Render the message as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
-              "category": "behavior"
+              "category": "behavior",
+              "required": false
             },
             "boxClass": {
               "type": "String",

package/dist/api/LoadingBar.json

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

package/dist/api/LocalStorage.json

@@ -158,6 +158,14 @@
           ],
           "desc": "Entry value",
           "required": true,
+          "params": {
+            "...params": {
+              "type": "Any"
+            }
+          },
+          "returns": {
+            "type": "Any"
+          },
           "examples": [
             "john12"
           ]

package/dist/api/Morph.json

@@ -37,7 +37,8 @@
         "default": "300",
         "examples": [
           "500"
-        ]
+        ],
+        "required": false
       },
       "delay": {
         "type": "Number",
@@ -45,7 +46,8 @@
         "default": "0",
         "examples": [
           "500"
-        ]
+        ],
+        "required": false
       },
       "easing": {
         "type": "String",
@@ -53,7 +55,8 @@
         "default": "ease-in-out",
         "examples": [
           "ease-out"
-        ]
+        ],
+        "required": false
       },
       "fill": {
         "type": "String",
@@ -61,7 +64,8 @@
         "default": "none",
         "examples": [
           "forward"
-        ]
+        ],
+        "required": false
       },
       "classes": {
         "type": "String",
@@ -106,7 +110,8 @@
         "default": "0.6",
         "examples": [
           "1"
-        ]
+        ],
+        "required": false
       },
       "tweenToOpacity": {
         "type": "Number",
@@ -114,7 +119,8 @@
         "default": "0.5",
         "examples": [
           "0.3"
-        ]
+        ],
+        "required": false
       },
       "waitFor": {
         "type": [
@@ -127,7 +133,8 @@
         "examples": [
           "300",
           "transitionend"
-        ]
+        ],
+        "required": false
       },
       "onEnd": {
         "type": "Function",

package/dist/api/Mutation.json

@@ -30,7 +30,7 @@
             ]
           },
           "target": {
-            "type": "Object",
+            "type": "Element",
             "desc": "The DOM element that the mutation affected, depending on the mutation type"
           },
           "addedNodes": {

package/dist/api/Notify.json

@@ -92,7 +92,8 @@
         ],
         "examples": [
           "top-right"
-        ]
+        ],
+        "required": false
       },
       "group": {
         "type": [
@@ -104,7 +105,8 @@
         "default": "(message + caption + multiline + actions labels + position)",
         "examples": [
           "my-group"
-        ]
+        ],
+        "required": false
       },
       "badgeColor": {
         "type": "String",
@@ -136,7 +138,8 @@
         ],
         "examples": [
           "bottom-right"
-        ]
+        ],
+        "required": false
       },
       "badgeStyle": {
         "type": "String",
@@ -183,7 +186,8 @@
         "default": 5000,
         "examples": [
           2500
-        ]
+        ],
+        "required": false
       },
       "closeBtn": {
         "type": [
@@ -211,6 +215,7 @@
             "Object",
             "String"
           ],
+          "required": true,
           "desc": "Notification options",
           "definition": {
             "type": {
@@ -282,7 +287,11 @@
                 "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"
+              "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",
+              "examples": [
+                true,
+                "QSpinnerBars"
+              ]
             },
             "position": {
               "type": "String",
@@ -299,9 +308,7 @@
                 "right",
                 "center"
               ],
-              "examples": [
-                "top-right"
-              ]
+              "required": false
             },
             "group": {
               "type": [
@@ -313,7 +320,8 @@
               "default": "(message + caption + multiline + actions labels + position)",
               "examples": [
                 "my-group"
-              ]
+              ],
+              "required": false
             },
             "badgeColor": {
               "type": "String",
@@ -343,9 +351,7 @@
                 "bottom-left",
                 "bottom-right"
               ],
-              "examples": [
-                "bottom-right"
-              ]
+              "required": false
             },
             "badgeStyle": {
               "type": [
@@ -407,7 +413,8 @@
               "default": 5000,
               "examples": [
                 2500
-              ]
+              ],
+              "required": false
             },
             "actions": {
               "type": "Array",
@@ -443,8 +450,7 @@
               "type": "Boolean",
               "desc": "Ignore the default configuration (set by setDefaults()) for this instance only"
             }
-          },
-          "required": true
+          }
         }
       },
       "returns": {
@@ -453,6 +459,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": {
@@ -562,7 +569,8 @@
                 "default": 5000,
                 "examples": [
                   2500
-                ]
+                ],
+                "required": false
               },
               "actions": {
                 "type": "Array",
@@ -609,6 +617,7 @@
       "params": {
         "opts": {
           "type": "Object",
+          "required": true,
           "desc": "Notification options",
           "definition": {
             "type": {
@@ -699,7 +708,8 @@
               ],
               "examples": [
                 "top-right"
-              ]
+              ],
+              "required": false
             },
             "badgeColor": {
               "type": "String",
@@ -731,7 +741,8 @@
               ],
               "examples": [
                 "bottom-right"
-              ]
+              ],
+              "required": false
             },
             "badgeStyle": {
               "type": [
@@ -793,7 +804,8 @@
               "default": 5000,
               "examples": [
                 2500
-              ]
+              ],
+              "required": false
             },
             "actions": {
               "type": "Array",
@@ -825,8 +837,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
+          }
         }
       }
     },
@@ -835,14 +846,15 @@
       "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": {
@@ -933,7 +945,8 @@
               ],
               "examples": [
                 "top-right"
-              ]
+              ],
+              "required": false
             },
             "badgeColor": {
               "type": "String",
@@ -965,7 +978,8 @@
               ],
               "examples": [
                 "bottom-right"
-              ]
+              ],
+              "required": false
             },
             "badgeStyle": {
               "type": [
@@ -1027,7 +1041,8 @@
               "default": 5000,
               "examples": [
                 2500
-              ]
+              ],
+              "required": false
             },
             "actions": {
               "type": "Array",
@@ -1059,8 +1074,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
+          }
         }
       }
     }