quasar 1.16.0 → 1.17.0

package/dist/api/QRating.json

@@ -60,7 +60,7 @@
         "map",
         "ion-add",
         "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
-        "img:statics/path/to/some_image.png"
+        "img:path/to/some_image.png"
       ],
       "category": "content"
     },
@@ -74,7 +74,7 @@
         "map",
         "ion-add",
         "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
-        "img:statics/path/to/some_image.png"
+        "img:path/to/some_image.png"
       ],
       "category": "content",
       "addedIn": "v1.1.0"
@@ -89,7 +89,7 @@
         "map",
         "ion-add",
         "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
-        "img:statics/path/to/some_image.png"
+        "img:path/to/some_image.png"
       ],
       "category": "content",
       "addedIn": "v1.7.4"

package/dist/api/QRouteTab.json

@@ -14,28 +14,27 @@
         "String",
         "Object"
       ],
-      "desc": "Equivalent to Vue Router <router-link> 'to' property",
+      "desc": "Equivalent to Vue Router <router-link> 'to' property; Superseeded by 'href' prop if used",
       "examples": [
         "/home/dashboard",
         ":to=\"{ name: 'my-route-name' }\""
       ],
-      "category": "general",
-      "required": true
+      "category": "navigation"
     },
     "exact": {
       "type": "Boolean",
-      "desc": "Equivalent to Vue Router <router-link> 'exact' property",
-      "category": "behavior"
+      "desc": "Equivalent to Vue Router <router-link> 'exact' property; Superseeded by 'href' prop if used",
+      "category": "navigation"
     },
     "append": {
       "type": "Boolean",
-      "desc": "Equivalent to Vue Router <router-link> 'append' property",
-      "category": "behavior"
+      "desc": "Equivalent to Vue Router <router-link> 'append' property; Superseeded by 'href' prop if used",
+      "category": "navigation"
     },
     "replace": {
       "type": "Boolean",
-      "desc": "Equivalent to Vue Router <router-link> 'replace' property",
-      "category": "behavior"
+      "desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseeded by 'href' prop if used",
+      "category": "navigation"
     },
     "active-class": {
       "type": "String",
@@ -43,7 +42,7 @@
       "examples": [
         "my-active-class"
       ],
-      "category": "behavior"
+      "category": "navigation"
     },
     "exact-active-class": {
       "type": "String",
@@ -51,7 +50,28 @@
       "examples": [
         "my-exact-active-class"
       ],
-      "category": "behavior"
+      "category": "navigation"
+    },
+    "href": {
+      "type": "String",
+      "desc": "Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace' props",
+      "examples": [
+        "http://quasar.dev"
+      ],
+      "category": "navigation",
+      "addedIn": "v1.17"
+    },
+    "target": {
+      "type": "String",
+      "desc": "Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace' props",
+      "examples": [
+        "_blank",
+        "_self",
+        "_parent",
+        "_top"
+      ],
+      "category": "navigation",
+      "addedIn": "v1.17"
     },
     "disable": {
       "type": "Boolean",
@@ -78,7 +98,7 @@
         "map",
         "ion-add",
         "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
-        "img:statics/path/to/some_image.png"
+        "img:path/to/some_image.png"
       ],
       "category": "content"
     },

package/dist/api/QScrollArea.json

@@ -16,21 +16,65 @@
         "String",
         "Object"
       ],
-      "desc": "Object with CSS properties and values for styling the custom scrollbar",
+      "desc": "Object with CSS properties and values for custom styling the scrollbars (both vertical and horizontal)",
       "examples": [
-        ":bar-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\""
+        ":bar-style=\"{ borderRadius: '5px', background: 'red', opacity: 1 }\""
       ],
       "category": "style",
       "addedIn": "v1.5.0"
     },
+    "vertical-bar-style": {
+      "type": [
+        "Array",
+        "String",
+        "Object"
+      ],
+      "desc": "Object with CSS properties and values for custom styling the vertical scrollbar; Is applied on top of 'bar-style' prop",
+      "examples": [
+        ":bar-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\""
+      ],
+      "category": "style",
+      "addedIn": "v1.17"
+    },
+    "horizontal-bar-style": {
+      "type": [
+        "Array",
+        "String",
+        "Object"
+      ],
+      "desc": "Object with CSS properties and values for custom styling the horizontal scrollbar; Is applied on top of 'bar-style' prop",
+      "examples": [
+        ":bar-style=\"{ bottom: '4px', borderRadius: '5px', background: 'red', height: '10px', opacity: 1 }\""
+      ],
+      "category": "style",
+      "addedIn": "v1.17"
+    },
     "thumb-style": {
       "type": "Object",
-      "desc": "Object with CSS properties and values for styling the thumb of custom scrollbar",
+      "desc": "Object with CSS properties and values for custom styling the thumb of scrollbars (both vertical and horizontal)",
       "examples": [
-        ":thumb-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\""
+        ":thumb-style=\"{ borderRadius: '5px', background: 'red', opacity: 1 }\""
       ],
       "category": "style"
     },
+    "vertical-thumb-style": {
+      "type": "Object",
+      "desc": "Object with CSS properties and values for custom styling the thumb of the vertical scrollbar; Is applied on top of 'thumb-style' prop",
+      "examples": [
+        ":thumb-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\""
+      ],
+      "category": "style",
+      "addedIn": "v1.17"
+    },
+    "horizontal-thumb-style": {
+      "type": "Object",
+      "desc": "Object with CSS properties and values for custom styling the thumb of the horizontal scrollbar; Is applied on top of 'thumb-style' prop",
+      "examples": [
+        ":thumb-style=\"{ bottom: '4px', borderRadius: '5px', background: 'red', height: '10px', opacity: 1 }\""
+      ],
+      "category": "style",
+      "addedIn": "v1.17"
+    },
     "content-style": {
       "type": [
         "Array",
@@ -76,7 +120,7 @@
     },
     "horizontal": {
       "type": "Boolean",
-      "desc": "Register for horizontal scroll instead of vertical (which is default)",
+      "desc": "Changes the default axis to horizontal instead of vertical (which is default) for getScrollPosition, getScrollPercentage, setScrollPosition, and setScrollPercentage",
       "category": "behavior"
     },
     "tabindex": {
@@ -111,35 +155,35 @@
             },
             "verticalPosition": {
               "type": "Number",
-              "desc": "Vertical scroll position (in px); available only if QScrollArea is NOT in horizontal mode"
+              "desc": "Vertical scroll position (in px)"
             },
             "verticalPercentage": {
               "type": "Number",
-              "desc": "Vertical scroll percentage (0.0 < x < 1.0); available only if QScrollArea is NOT in horizontal mode"
+              "desc": "Vertical scroll percentage (0.0 <= x <= 1.0)"
             },
             "verticalSize": {
               "type": "Number",
-              "desc": "Vertical scroll size (in px); available only if QScrollArea is NOT in horizontal mode"
+              "desc": "Vertical scroll size (in px)"
             },
             "verticalContainerSize": {
               "type": "Number",
-              "desc": "Height of the container (in px); available only if QScrollArea is NOT in horizontal mode"
+              "desc": "Height of the container (in px)"
             },
             "horizontalPosition": {
               "type": "Number",
-              "desc": "Horizontal scroll position (in px); available only if QScrollArea is in horizontal mode"
+              "desc": "Horizontal scroll position (in px)"
             },
             "horizontalPercentage": {
               "type": "Number",
-              "desc": "Horizontal scroll percentage (0.0 < x < 1.0); available only if QScrollArea is in horizontal mode"
+              "desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)"
             },
             "horizontalSize": {
               "type": "Number",
-              "desc": "Horizontal scroll size (in px); available only if QScrollArea is in horizontal mode"
+              "desc": "Horizontal scroll size (in px)"
             },
             "horizontalContainerSize": {
               "type": "Number",
-              "desc": "Width of the container (in px); available only if QScrollArea is in horizontal mode"
+              "desc": "Width of the container (in px)"
             }
           }
         }
@@ -155,19 +199,134 @@
         "desc": "DOM element upon which scrolling takes place"
       }
     },
+    "getScroll": {
+      "desc": "Get the current scroll information",
+      "returns": {
+        "type": "Object",
+        "desc": "Scroll information",
+        "definition": {
+          "verticalPosition": {
+            "type": "Number",
+            "desc": "Vertical scroll position (in px)"
+          },
+          "verticalPercentage": {
+            "type": "Number",
+            "desc": "Vertical scroll percentage (0.0 <= x <= 1.0)"
+          },
+          "verticalSize": {
+            "type": "Number",
+            "desc": "Vertical scroll size (in px)"
+          },
+          "verticalContainerSize": {
+            "type": "Number",
+            "desc": "Height of the container (in px)"
+          },
+          "horizontalPosition": {
+            "type": "Number",
+            "desc": "Horizontal scroll position (in px)"
+          },
+          "horizontalPercentage": {
+            "type": "Number",
+            "desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)"
+          },
+          "horizontalSize": {
+            "type": "Number",
+            "desc": "Horizontal scroll size (in px)"
+          },
+          "horizontalContainerSize": {
+            "type": "Number",
+            "desc": "Width of the container (in px)"
+          }
+        }
+      },
+      "addedIn": "v1.17"
+    },
     "getScrollPosition": {
       "desc": "Get current scroll position",
+      "params": {
+        "axis": {
+          "type": "String",
+          "desc": "Scroll axis - defaults to 'vertical' (or to 'horizontal' if horizontal prop is set)",
+          "values": [
+            "vertical",
+            "horizontal",
+            "both"
+          ]
+        }
+      },
       "returns": {
-        "type": "Number",
-        "desc": "Scroll position offset from top (in pixels)",
+        "type": "Object",
+        "definition": {
+          "top": {
+            "type": "Number",
+            "desc": "Scroll offset from top (vertical)",
+            "examples": [
+              120
+            ]
+          },
+          "left": {
+            "type": "Number",
+            "desc": "Scroll offset from left (horizontal)",
+            "examples": [
+              10
+            ]
+          }
+        },
         "examples": [
-          110
+          "{ top: 10, left: 0 }"
         ]
-      }
+      },
+      "addedIn": "v1.17"
+    },
+    "getScrollPercentage": {
+      "desc": "Get current scroll position in percentage (0.0 <= x <= 1.0)",
+      "params": {
+        "axis": {
+          "type": "String",
+          "desc": "Scroll axis - defaults to 'vertical' (or to 'horizontal' if horizontal prop is set)",
+          "values": [
+            "vertical",
+            "horizontal",
+            "both"
+          ]
+        }
+      },
+      "returns": {
+        "type": "Object",
+        "definition": {
+          "top": {
+            "type": "Number",
+            "desc": "Scroll percentage (0.0 <= x <= 1.0) offset from top (vertical)",
+            "examples": [
+              0.12
+            ]
+          },
+          "left": {
+            "type": "Number",
+            "desc": "Scroll percentage (0.0 <= x <= 1.0) offset from left (horizontal)",
+            "examples": [
+              0.92
+            ]
+          }
+        },
+        "examples": [
+          "{ top: 0.212, left: 0 }"
+        ]
+      },
+      "addedIn": "v1.17"
     },
     "setScrollPosition": {
       "desc": "Set scroll position to an offset; If a duration (in milliseconds) is specified then the scroll is animated",
       "params": {
+        "axis": {
+          "type": "String",
+          "desc": "Scroll axis",
+          "values": [
+            "vertical",
+            "horizontal"
+          ],
+          "required": true
+        },
         "offset": {
           "type": "Number",
           "desc": "Scroll position offset from top (in pixels)",
@@ -186,11 +345,20 @@
       }
     },
     "setScrollPercentage": {
-      "desc": "Set scroll position to a percentage (0.0 < x < 1.0) of the total scrolling size; If a duration (in milliseconds) is specified then the scroll is animated",
+      "desc": "Set scroll position to a percentage (0.0 <= x <= 1.0) of the total scrolling size; If a duration (in milliseconds) is specified then the scroll is animated",
       "params": {
+        "axis": {
+          "type": "String",
+          "desc": "Scroll axis",
+          "values": [
+            "vertical",
+            "horizontal"
+          ],
+          "required": true
+        },
         "offset": {
           "type": "Number",
-          "desc": "Scroll percentage (0.0 < x < 1.0) of the total scrolling size",
+          "desc": "Scroll percentage (0.0 <= x <= 1.0) of the total scrolling size",
           "required": true,
           "examples": [
             220
@@ -204,7 +372,7 @@
           ]
         }
       },
-      "addedIn": "v1.13.2"
+      "addedIn": "v1.17"
     }
   }
 }

package/dist/api/QSelect.json

@@ -367,7 +367,6 @@
     },
     "display-value-sanitize": {
       "type": "Boolean",
-      "default": "false",
       "desc": "Force use of textContent instead of innerHTML to render selected option(s); Use it when the selected option(s) might be unsafe (from user input); Does NOT apply when using 'selected' or 'selected-item' slots!",
       "category": "selection"
     },
@@ -437,7 +436,7 @@
         "map",
         "ion-add",
         "img:https://cdn.quasar.dev/logo/svg/quasar-logo.svg",
-        "img:statics/path/to/some_image.png"
+        "img:path/to/some_image.png"
       ],
       "category": "content"
     },
@@ -472,7 +471,6 @@
     },
     "options-sanitize": {
       "type": "Boolean",
-      "default": "false",
       "desc": "Force use of textContent instead of innerHTML to render options; Use it when the options might be unsafe (from user input); Does NOT apply when using 'option' slot!",
       "category": "options"
     },
@@ -721,12 +719,6 @@
       "desc": "Slot for label; Used only if 'label-slot' prop is set or the 'label' prop is set; When it is used the text in the 'label' prop is ignored",
       "addedIn": "v1.12.9"
     },
-    "error": {
-      "desc": "Slot for errors; Enabled only if 'bottom-slots' prop is used; Suggestion: <div>"
-    },
-    "hint": {
-      "desc": "Slot for hint text; Enabled only if 'bottom-slots' prop is used; Suggestion: <div>"
-    },
     "counter": {
       "desc": "Slot for counter text; Enabled only if 'bottom-slots' prop is used; Suggestion: <div>"
     },
@@ -746,6 +738,86 @@
     }
   },
   "scopedSlots": {
+    "error": {
+      "desc": "Slot for errors; Enabled only if 'bottom-slots' prop is used; Suggestion: <div>",
+      "scope": {
+        "id": {
+          "type": "String",
+          "desc": "Element id used in the `for` attribute of the field label. Can be used to link the control to the label",
+          "examples": [
+            "qf_363270c0-7a83-62b1-8dcf-6dfd64ee38fa"
+          ]
+        },
+        "field": {
+          "type": "Object",
+          "desc": "DOM element of the field"
+        },
+        "editable": {
+          "type": "Boolean",
+          "desc": "Field is editable"
+        },
+        "focused": {
+          "type": "Boolean",
+          "desc": "Field has focus"
+        },
+        "value": {
+          "type": "Any",
+          "desc": "Field's value",
+          "examples": [
+            0.241,
+            "Text"
+          ]
+        },
+        "errorMessage": {
+          "type": "String",
+          "desc": "Error message (from errorMessage prop or generated by rules)",
+          "examples": [
+            "The field is required"
+          ]
+        }
+      },
+      "addedIn": "v1.17"
+    },
+    "hint": {
+      "desc": "Slot for hint text; Enabled only if 'bottom-slots' prop is used; Suggestion: <div>",
+      "scope": {
+        "id": {
+          "type": "String",
+          "desc": "Element id used in the `for` attribute of the field label. Can be used to link the control to the label",
+          "examples": [
+            "qf_363270c0-7a83-62b1-8dcf-6dfd64ee38fa"
+          ]
+        },
+        "field": {
+          "type": "Object",
+          "desc": "DOM element of the field"
+        },
+        "editable": {
+          "type": "Boolean",
+          "desc": "Field is editable"
+        },
+        "focused": {
+          "type": "Boolean",
+          "desc": "Field has focus"
+        },
+        "value": {
+          "type": "Any",
+          "desc": "Field's value",
+          "examples": [
+            0.241,
+            "Text"
+          ]
+        },
+        "errorMessage": {
+          "type": "String",
+          "desc": "Error message (from errorMessage prop or generated by rules)",
+          "examples": [
+            "The field is required"
+          ]
+        }
+      },
+      "addedIn": "v1.17"
+    },
     "no-option": {
       "desc": "What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>",
       "scope": {

package/dist/api/QSeparator.json

@@ -33,7 +33,7 @@
         "Boolean",
         "String"
       ],
-      "desc": "if set to true, the left and right margins will be set to 16px. If set to item, the left and right margins will be set to 72px. If set to item-thumbnail, the left margin is set to 116px and right margin is set to 0px",
+      "desc": "If set to Boolean true, the left and right margins will be set to 16px. If set to 'item' then it will match a QItem's design. If set to 'item-thumbnail' then it will match the design of a QItem with a thumbnail on the left side",
       "examples": [
         "item",
         "item-thumbnail"