quasar 2.2.2 → 2.3.1

package/dist/api/BottomSheet.json

@@ -133,8 +133,23 @@
                 "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": {

package/dist/api/Dialog.json

@@ -392,8 +392,23 @@
                 "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": {

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/QCircularProgress.json

@@ -125,6 +125,20 @@
       "type": "Boolean",
       "desc": "No animation when model changes",
       "category": "behavior"
+    },
+    "animation-speed": {
+      "type": [
+        "String",
+        "Number"
+      ],
+      "desc": "Animation speed (in milliseconds, without unit)",
+      "examples": [
+        500,
+        "1200"
+      ],
+      "category": "style",
+      "default": 600,
+      "addedIn": "v2.3"
     }
   },
   "slots": {

package/dist/api/QDate.json

@@ -188,6 +188,20 @@
         "Function"
       ],
       "desc": "A list of events to highlight on the calendar; If using a function, it receives the date as a String and must return a Boolean (matches or not); If using a function then for best performance, reference it from your scope and do not define it inline",
+      "params": {
+        "date": {
+          "type": "String",
+          "desc": "The current date being processed.",
+          "examples": [
+            "2018/11/05",
+            "2021/10/25"
+          ]
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, the current date will be highlighted"
+      },
       "examples": [
         ":events=\"['2018/11/05', '2018/11/06', '2018/11/09', '2018/11/23']\"",
         ":events=\"date => date[9] % 3 === 0\""
@@ -200,6 +214,24 @@
         "Function"
       ],
       "desc": "Color name (from the Quasar Color Palette); If using a function, it receives the date as a String and must return a String (color for the received date); If using a function then for best performance, reference it from your scope and do not define it inline",
+      "params": {
+        "date": {
+          "type": "String",
+          "desc": "The current date being processed.",
+          "examples": [
+            "2018/11/05",
+            "2021/10/25"
+          ]
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "Color for the current date.",
+        "examples": [
+          "teal",
+          "orange"
+        ]
+      },
       "examples": [
         "teal-10",
         ":event-color=\"(date) => date[9] % 2 === 0 ? 'teal' : 'orange'\""
@@ -212,6 +244,20 @@
         "Function"
       ],
       "desc": "Optionally configure the days that are selectable; If using a function, it receives the date as a String and must return a Boolean (is date acceptable or not); If using a function then for best performance, reference it from your scope and do not define it inline; Incompatible with 'range' prop",
+      "params": {
+        "date": {
+          "type": "String",
+          "desc": "The current date being processed.",
+          "examples": [
+            "2018/11/05",
+            "2021/10/25"
+          ]
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, the current date will be made available for selection"
+      },
       "examples": [
         ":options=\"['2018/11/05', '2018/11/12', '2018/11/19', '2018/11/26' ]\"",
         ":options=\"date => date[9] % 3 === 0\"",

package/dist/api/QEditor.json

@@ -157,9 +157,14 @@
             "Boolean",
             "Function"
           ],
-          "desc": "Is button disabled? If specifying a function, return a Boolean value.",
+          "desc": "Is button disabled?",
+          "returns": {
+            "type": "Boolean",
+            "desc": "If true, the button will be disabled"
+          },
           "examples": [
-            "() => this.userIsActive()"
+            "!user.active",
+            "() => !checkIfUserIsActive()"
           ]
         },
         "type": {

package/dist/api/QFooter.json

@@ -32,7 +32,7 @@
     "height-hint": {
       "type": [
         "Number",
-        "String "
+        "String"
       ],
       "desc": "When using SSR, you can optionally hint of the height (in pixels) of the QFooter",
       "default": 50,

package/dist/api/QHeader.json

@@ -41,7 +41,7 @@
     "height-hint": {
       "type": [
         "Number",
-        "String "
+        "String"
       ],
       "desc": "When using SSR, you can optionally hint of the height (in pixels) of the QHeader",
       "default": 50,

package/dist/api/QIntersection.json

@@ -66,6 +66,20 @@
       ],
       "category": "behavior"
     },
+    "transition-duration": {
+      "type": [
+        "String",
+        "Number"
+      ],
+      "desc": "Transition duration (in milliseconds, without unit)",
+      "default": 300,
+      "examples": [
+        500,
+        "1200"
+      ],
+      "category": "behavior",
+      "addedIn": "v2.3.1"
+    },
     "disable": {
       "type": "Boolean",
       "desc": "Disable visibility observable (content will remain as it was, visible or hidden)",

package/dist/api/QLinearProgress.json

@@ -84,6 +84,20 @@
       "type": "Boolean",
       "desc": "No transition when model changes",
       "category": "behavior"
+    },
+    "animation-speed": {
+      "type": [
+        "String",
+        "Number"
+      ],
+      "desc": "Animation speed (in milliseconds, without unit)",
+      "examples": [
+        500,
+        "1200"
+      ],
+      "category": "style",
+      "default": 300,
+      "addedIn": "v2.3"
     }
   },
   "slots": {

package/dist/api/QRouteTab.json

@@ -158,30 +158,7 @@
         "navigateFn": {
           "type": "Function",
           "desc": "When you need to control the time at which the tab should trigger the route navigation then set 'evt.navigate' to false and call this function; Useful if you have async work to be done before the actual route navigation",
-          "params": {
-            "to": {
-              "type": [
-                "String",
-                "Object"
-              ],
-              "desc": "Equivalent to Vue Router <router-link> 'to' property",
-              "examples": [
-                "/home/dashboard",
-                "{ name: 'my-route-name' }"
-              ],
-              "default": "Tab's 'to' property"
-            },
-            "append": {
-              "type": "Boolean",
-              "desc": "Equivalent to Vue Router <router-link> 'append' property",
-              "default": "Tab's 'append' property"
-            },
-            "replace": {
-              "type": "Boolean",
-              "desc": "Equivalent to Vue Router <router-link> 'replace' property",
-              "default": "Tab's 'replace' property"
-            }
-          },
+          "params": null,
           "returns": null
         }
       }

package/dist/api/QScrollArea.json

@@ -135,6 +135,7 @@
       "params": {
         "info": {
           "type": "Object",
+          "desc": "An object containing scroll information",
           "definition": {
             "ref": {
               "type": "Object",
@@ -230,6 +231,7 @@
       "desc": "Get current scroll position",
       "returns": {
         "type": "Object",
+        "desc": "An object containing scroll position information",
         "definition": {
           "top": {
             "type": "Number",
@@ -255,6 +257,7 @@
       "desc": "Get current scroll position in percentage (0.0 <= x <= 1.0)",
       "returns": {
         "type": "Object",
+        "desc": "An object containing scroll position information in percentage",
         "definition": {
           "top": {
             "type": "Number",

package/dist/api/QSelect.json

@@ -382,6 +382,28 @@
       ],
       "desc": "Property of option which holds the 'value'; If using a function then for best performance, reference it from your scope and do not define it inline",
       "default": "value",
+      "params": {
+        "option": {
+          "type": [
+            "String",
+            "Object"
+          ],
+          "desc": "The current option being processed",
+          "examples": [
+            "'BMW'",
+            "'Samsung Phone'",
+            "{ label: 'BMW', value: 'car', cannotSelect: true }"
+          ]
+        }
+      },
+      "returns": {
+        "type": "Any",
+        "desc": "Value of the current option",
+        "examples": [
+          "'car'",
+          "34"
+        ]
+      },
       "examples": [
         "option-value=\"modelNumber\"",
         ":option-value=\"(item) => item === null ? null : item.modelNumber\""
@@ -395,6 +417,28 @@
       ],
       "desc": "Property of option which holds the 'label'; If using a function then for best performance, reference it from your scope and do not define it inline",
       "default": "label",
+      "params": {
+        "option": {
+          "type": [
+            "String",
+            "Object"
+          ],
+          "desc": "The current option being processed",
+          "examples": [
+            "'BMW'",
+            "'Samsung Phone'",
+            "{ label: 'BMW', value: 'car', cannotSelect: true }"
+          ]
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "Label of the current option",
+        "examples": [
+          "'BMW'",
+          "'Samsung Phone'"
+        ]
+      },
       "examples": [
         "option-label=\"itemName\"",
         ":option-label=\"(item) => item === null ? 'Null value' : item.itemName\""
@@ -408,6 +452,24 @@
       ],
       "desc": "Property of option which tells it's disabled; The value of the property must be a Boolean; If using a function then for best performance, reference it from your scope and do not define it inline",
       "default": "disable",
+      "params": {
+        "option": {
+          "type": [
+            "String",
+            "Object"
+          ],
+          "desc": "The current option being processed",
+          "examples": [
+            "'BMW'",
+            "'Samsung Phone'",
+            "{ label: 'BMW', value: 'car', cannotSelect: true }"
+          ]
+        }
+      },
+      "returns": {
+        "type": "Boolean",
+        "desc": "If true, the current option will be disabled"
+      },
       "examples": [
         "option-disable=\"cannotSelect\"",
         ":option-disable=\"(item) => item === null ? true : item.cannotSelect\""

package/dist/api/QSkeleton.json

@@ -52,12 +52,12 @@
         "Number"
       ],
       "desc": "Animation speed (in milliseconds, without unit)",
-      "default": 300,
       "examples": [
         500,
         "1200"
       ],
       "category": "style",
+      "default": 300,
       "addedIn": "v2.2"
     },
     "square": {

package/dist/api/QTable.json

@@ -33,6 +33,23 @@
       ],
       "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\""
@@ -227,9 +244,25 @@
           ],
           "desc": "Row Object property to determine value for this column or function which maps to the required property",
           "required": true,
+          "params": {
+            "row": {
+              "type": "Object",
+              "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.some.nested.prop"
+            "row => row.prices.active"
           ]
         },
         "required": {
@@ -352,9 +385,21 @@
             "Function"
           ],
           "desc": "Style to apply on normal cells of the column",
+          "params": {
+            "row": {
+              "type": "Object",
+              "desc": "The current row being processed",
+              "examples": [
+                "{ name: 'Frozen Yogurt', calories: 159 }"
+              ]
+            }
+          },
+          "returns": {
+            "type": "String"
+          },
           "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": {
@@ -363,9 +408,21 @@
             "Function"
           ],
           "desc": "Classes to add on normal cells of the column",
+          "params": {
+            "row": {
+              "type": "Object",
+              "desc": "The current row being processed",
+              "examples": [
+                "{ name: 'Frozen Yogurt', calories: 159 }"
+              ]
+            }
+          },
+          "returns": {
+            "type": "String"
+          },
           "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": {

package/dist/api/QTree.json

@@ -84,6 +84,12 @@
       ],
       "category": "style"
     },
+    "dense": {
+      "type": "Boolean",
+      "desc": "Dense mode; occupies less space",
+      "category": "style",
+      "addedIn": "v2.2.4"
+    },
     "dark": {
       "type": "Boolean",
       "desc": "Notify the component that the background is a dark color",

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,6 +59,16 @@
         "POST",
         ":method=\"files => files.length > 10 ? 'POST' : 'PUT'\""
       ],
+      "params": {
+        "files": {
+          "type": "Array",
+          "desc": "Uploaded files"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "HTTP method to use for upload"
+      },
       "category": "upload"
     },
     "field-name": {
@@ -62,6 +82,16 @@
         "backgroundFile",
         ":field-name=\"(file) => 'background' + file.name\""
       ],
+      "params": {
+        "files": {
+          "type": "File",
+          "desc": "The current file being processed"
+        }
+      },
+      "returns": {
+        "type": "String",
+        "desc": "Field name for the current file upload"
+      },
       "category": "upload"
     },
     "headers": {
@@ -96,6 +126,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 +167,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 +189,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 +211,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 +232,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": {

package/dist/api/SessionStorage.json

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

package/dist/icon-set/bootstrap-icons.umd.prod.js

@@ -1,5 +1,5 @@
 /*!
- * Quasar Framework v2.2.2
+ * Quasar Framework v2.3.1
  * (c) 2015-present Razvan Stoenescu
  * Released under the MIT License.
  */