quasar 2.2.4 → 2.3.3

package/dist/api/QSelect.json

@@ -28,7 +28,8 @@
       "examples": [
         "virtual-scroll-slice-size=\"60\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-slice-ratio-before": {
       "type": [
@@ -40,7 +41,8 @@
       "examples": [
         "virtual-scroll-slice-ratio-before=\"0.3\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-slice-ratio-after": {
       "type": [
@@ -52,7 +54,8 @@
       "examples": [
         "virtual-scroll-slice-ratio-after=\"2\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-item-size": {
       "type": [
@@ -64,7 +67,8 @@
       "examples": [
         "virtual-scroll-item-size=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-sticky-size-start": {
       "type": [
@@ -76,7 +80,8 @@
       "examples": [
         "virtual-scroll-sticky-size-start=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "virtual-scroll-sticky-size-end": {
       "type": [
@@ -88,7 +93,8 @@
       "examples": [
         "virtual-scroll-sticky-size-end=\"48\""
       ],
-      "category": "virtual-scroll"
+      "category": "virtual-scroll",
+      "required": false
     },
     "table-colspan": {
       "type": [
@@ -363,7 +369,8 @@
       "type": "Boolean",
       "default": "false",
       "desc": "Force render the selected option(s) as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'selected' or 'selected-item' slots!",
-      "category": "selection"
+      "category": "selection",
+      "required": false
     },
     "options": {
       "type": "Array",
@@ -373,7 +380,8 @@
         ":options=\"[ 'BMW', 'Samsung Phone' ]\"",
         ":options=\"[ { label: 'BMW', value: 'car' }, { label: 'Samsung Phone', value: 'phone' } ]\""
       ],
-      "category": "options"
+      "category": "options",
+      "required": false
     },
     "option-value": {
       "type": [
@@ -382,11 +390,34 @@
       ],
       "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\""
       ],
-      "category": "options"
+      "category": "options",
+      "required": false
     },
     "option-label": {
       "type": [
@@ -395,11 +426,34 @@
       ],
       "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\""
       ],
-      "category": "options"
+      "category": "options",
+      "required": false
     },
     "option-disable": {
       "type": [
@@ -408,11 +462,30 @@
       ],
       "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\""
       ],
-      "category": "options"
+      "category": "options",
+      "required": false
     },
     "hide-selected": {
       "type": "Boolean",
@@ -468,7 +541,8 @@
       "type": "Boolean",
       "default": "false",
       "desc": "Force render the options as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'option' slot!",
-      "category": "options"
+      "category": "options",
+      "required": false
     },
     "options-cover": {
       "type": "Boolean",
@@ -607,7 +681,8 @@
       "examples": [
         650
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "input-class": {
       "type": [
@@ -663,7 +738,8 @@
         "slide-down"
       ],
       "category": "behavior",
-      "default": "fade"
+      "default": "fade",
+      "required": false
     },
     "transition-hide": {
       "type": "String",
@@ -673,7 +749,8 @@
         "slide-down"
       ],
       "category": "behavior",
-      "default": "fade"
+      "default": "fade",
+      "required": false
     },
     "transition-duration": {
       "type": [
@@ -686,7 +763,8 @@
         500,
         "1200"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "behavior": {
       "type": "String",
@@ -697,7 +775,8 @@
         "dialog"
       ],
       "default": "default",
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     }
   },
   "slots": {
@@ -776,6 +855,7 @@
           "params": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Index at which to remove selection",
               "examples": [
                 0
@@ -790,6 +870,7 @@
           "params": {
             "opt": {
               "type": "Any",
+              "required": true,
               "desc": "Option to add to model"
             }
           },
@@ -833,6 +914,7 @@
           "params": {
             "opt": {
               "type": "Any",
+              "required": true,
               "desc": "Option to add to model"
             }
           },
@@ -844,6 +926,7 @@
           "params": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Index of option from menu",
               "examples": [
                 10
@@ -869,6 +952,7 @@
           "definition": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Index of the list item that was scrolled into view (0 based)",
               "examples": [
                 30
@@ -876,6 +960,7 @@
             },
             "from": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the first list item that is rendered (0 based)",
               "examples": [
                 10
@@ -883,6 +968,7 @@
             },
             "to": {
               "type": "Number",
+              "required": true,
               "desc": "The index of the last list item that is rendered (0 based)",
               "examples": [
                 50
@@ -890,6 +976,7 @@
             },
             "direction": {
               "type": "String",
+              "required": true,
               "desc": "Direction of change",
               "values": [
                 "increase",
@@ -898,6 +985,7 @@
             },
             "ref": {
               "type": "Object",
+              "required": true,
               "desc": "Vue reference to the QVirtualList which triggered the event"
             }
           }
@@ -930,8 +1018,7 @@
       "params": {
         "value": {
           "type": "String",
-          "desc": "New text value",
-          "required": true
+          "desc": "New text value"
         }
       }
     },
@@ -944,6 +1031,7 @@
           "definition": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Model index at which removal took place",
               "examples": [
                 2
@@ -951,6 +1039,7 @@
             },
             "value": {
               "type": "Any",
+              "required": true,
               "desc": "The actual value that was removed"
             }
           }
@@ -966,6 +1055,7 @@
           "definition": {
             "index": {
               "type": "Number",
+              "required": true,
               "desc": "Model index at which addition took place",
               "examples": [
                 2
@@ -973,6 +1063,7 @@
             },
             "value": {
               "type": "Any",
+              "required": true,
               "desc": "The actual value that was added"
             }
           }
@@ -995,10 +1086,12 @@
           "params": {
             "item": {
               "type": "Any",
+              "required": false,
               "desc": "Item to add"
             },
             "mode": {
               "type": "String",
+              "required": false,
               "desc": "Override 'new-value-mode' (prop) behavior should you wish to",
               "values": [
                 "add",
@@ -1028,16 +1121,19 @@
           "params": {
             "callbackFn": {
               "type": "Function",
+              "required": true,
               "desc": "Callback to call to make the actual updates",
               "params": null,
               "returns": null
             },
             "afterFn": {
               "type": "Function",
+              "required": false,
               "desc": "Callback to call at the end after the update has been fully processed by QSelect",
               "params": {
                 "ref": {
                   "type": "Object",
+                  "required": true,
                   "desc": "Vue reference to the QSelect which triggered the filtering"
                 }
               },
@@ -1166,8 +1262,8 @@
       "params": {
         "index": {
           "type": "Number",
-          "desc": "Index at which to remove selection",
           "required": true,
+          "desc": "Index at which to remove selection",
           "examples": [
             0
           ]
@@ -1179,8 +1275,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option to add to model",
-          "required": true
+          "required": true,
+          "desc": "Option to add to model"
         },
         "unique": {
           "type": "Boolean",
@@ -1193,8 +1289,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option to add to model",
-          "required": true
+          "required": true,
+          "desc": "Option to add to model"
         },
         "keepOpen": {
           "type": "Boolean",
@@ -1207,8 +1303,8 @@
       "params": {
         "index": {
           "type": "Number",
-          "desc": "Index of option from menu",
           "required": true,
+          "desc": "Index of option from menu",
           "examples": [
             10
           ]
@@ -1226,7 +1322,8 @@
             -1,
             1,
             5
-          ]
+          ],
+          "required": false
         },
         "skipInputValue": {
           "type": "Boolean",
@@ -1239,8 +1336,8 @@
       "params": {
         "value": {
           "type": "String",
-          "desc": "String to filter with",
           "required": true,
+          "desc": "String to filter with",
           "examples": [
             "car"
           ]
@@ -1255,6 +1352,7 @@
       "params": {
         "value": {
           "type": "String",
+          "required": true,
           "desc": "String to set the input value to",
           "examples": [
             "hotel"
@@ -1271,8 +1369,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option entry",
-          "required": true
+          "required": true,
+          "desc": "Option entry"
         }
       },
       "returns": {
@@ -1285,8 +1383,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option entry",
-          "required": true
+          "required": true,
+          "desc": "Option entry"
         }
       },
       "returns": {
@@ -1299,8 +1397,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option entry",
-          "required": true
+          "required": true,
+          "desc": "Option entry"
         }
       },
       "returns": {
@@ -1313,8 +1411,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option entry",
-          "required": true
+          "required": true,
+          "desc": "Option entry"
         }
       },
       "returns": {
@@ -1327,8 +1425,8 @@
       "params": {
         "opt": {
           "type": "Any",
-          "desc": "Option entry",
-          "required": true
+          "required": true,
+          "desc": "Option entry"
         }
       },
       "returns": {

package/dist/api/QSeparator.json

@@ -21,7 +21,8 @@
         "sm",
         "md"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "inset": {
       "type": [

package/dist/api/QSkeleton.json

@@ -29,7 +29,8 @@
         "QAvatar"
       ],
       "default": "rect",
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "animation": {
       "type": "String",
@@ -44,7 +45,8 @@
         "none"
       ],
       "default": "wave",
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "animation-speed": {
       "type": [
@@ -52,13 +54,14 @@
         "Number"
       ],
       "desc": "Animation speed (in milliseconds, without unit)",
-      "default": 300,
       "examples": [
         500,
         "1200"
       ],
       "category": "style",
-      "addedIn": "v2.2"
+      "default": 300,
+      "addedIn": "v2.2",
+      "required": false
     },
     "square": {
       "type": "Boolean",
@@ -107,7 +110,8 @@
         "span"
       ],
       "category": "content",
-      "default": "div"
+      "default": "div",
+      "required": false
     }
   },
   "slots": {

package/dist/api/QSlideItem.json

@@ -73,6 +73,7 @@
           "definition": {
             "reset": {
               "type": "Function",
+              "required": true,
               "desc": "When called, it resets the component to its initial non-slided state",
               "params": null,
               "returns": null
@@ -90,6 +91,7 @@
           "definition": {
             "reset": {
               "type": "Function",
+              "required": true,
               "desc": "When called, it resets the component to its initial non-slided state",
               "params": null,
               "returns": null
@@ -107,6 +109,7 @@
           "definition": {
             "reset": {
               "type": "Function",
+              "required": true,
               "desc": "When called, it resets the component to its initial non-slided state",
               "params": null,
               "returns": null
@@ -124,6 +127,7 @@
           "definition": {
             "reset": {
               "type": "Function",
+              "required": true,
               "desc": "When called, it resets the component to its initial non-slided state",
               "params": null,
               "returns": null
@@ -141,6 +145,7 @@
           "definition": {
             "side": {
               "type": "String",
+              "required": true,
               "desc": "Side to which sliding is taking effect",
               "values": [
                 "left",
@@ -151,6 +156,7 @@
             },
             "ratio": {
               "type": "Number",
+              "required": true,
               "desc": "Ratio of how much of the required slide was performed (0..1)",
               "examples": [
                 0,
@@ -160,6 +166,7 @@
             },
             "isReset": {
               "type": "Boolean",
+              "required": true,
               "desc": "Ratio has been reset"
             }
           }
@@ -175,6 +182,7 @@
           "definition": {
             "side": {
               "type": "String",
+              "required": true,
               "desc": "Side to which sliding has taken effect",
               "values": [
                 "left",
@@ -185,6 +193,7 @@
             },
             "reset": {
               "type": "Function",
+              "required": true,
               "desc": "When called, it resets the component to its initial non-slided state",
               "params": null,
               "returns": null

package/dist/api/QSlideTransition.json

@@ -17,7 +17,8 @@
         500,
         ":duration=\"500\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     }
   },
   "slots": {

package/dist/api/QSlider.json

@@ -32,7 +32,8 @@
       "examples": [
         ":min=\"0\""
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "max": {
       "type": "Number",
@@ -41,7 +42,8 @@
       "examples": [
         ":max=\"100\""
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "step": {
       "type": "Number",
@@ -50,7 +52,8 @@
       "examples": [
         ":step=\"1\""
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "reverse": {
       "type": "Boolean",
@@ -134,7 +137,8 @@
       "examples": [
         "M5 5 h10 v10 h-10 v-10"
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "dark": {
       "type": "Boolean",

package/dist/api/QSpinner.json

@@ -32,7 +32,8 @@
         "2",
         "5"
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     }
   }
 }