quasar 2.3.0 → 2.3.4

package/dist/api/QDate.json

@@ -26,7 +26,8 @@
         "YYYY-MM-DD",
         "MMMM Do, YYYY",
         "YYYY-MM-DD HH:mm:ss"
-      ]
+      ],
+      "required": false
     },
     "locale": {
       "type": "Object",
@@ -74,7 +75,8 @@
         "gregorian",
         "persian"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "color": {
       "type": "String",
@@ -175,7 +177,8 @@
         "Months",
         "Years"
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "years-in-month-view": {
       "type": "Boolean",
@@ -188,6 +191,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 +217,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 +247,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\"",
@@ -251,7 +300,8 @@
         "first-day-of-week=\"1\"",
         ":first-day-of-week=\"selectedFirstDayOfTheWeek\""
       ],
-      "category": "model"
+      "category": "model",
+      "required": false
     },
     "today-btn": {
       "type": "Boolean",
@@ -318,48 +368,59 @@
           "definition": {
             "year": {
               "type": "Number",
+              "required": true,
               "desc": "The year of the date that the user has clicked/tapped on"
             },
             "month": {
               "type": "Number",
+              "required": true,
               "desc": "The month of the date that the user has clicked/tapped on"
             },
             "day": {
               "type": "Number",
+              "required": true,
               "desc": "The day of the month that the user has clicked/tapped on"
             },
             "from": {
               "type": "Object",
+              "required": false,
               "desc": "Object of properties of the range starting point (only if range)",
               "definition": {
                 "year": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The year"
                 },
                 "month": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The month"
                 },
                 "day": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The day of month"
                 }
               }
             },
             "to": {
               "type": "Object",
+              "required": false,
               "desc": "Object of properties of the range ending point (only if range)",
               "definition": {
                 "year": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The year"
                 },
                 "month": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The month"
                 },
                 "day": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The day of month"
                 }
               }
@@ -377,10 +438,12 @@
           "definition": {
             "year": {
               "type": "Number",
+              "required": true,
               "desc": "The year"
             },
             "month": {
               "type": "Number",
+              "required": true,
               "desc": "The month"
             }
           }
@@ -396,14 +459,17 @@
           "definition": {
             "year": {
               "type": "Number",
+              "required": true,
               "desc": "The year"
             },
             "month": {
               "type": "Number",
+              "required": true,
               "desc": "The month"
             },
             "day": {
               "type": "Number",
+              "required": true,
               "desc": "The day of month"
             }
           }
@@ -419,36 +485,44 @@
           "definition": {
             "from": {
               "type": "Object",
+              "required": true,
               "desc": "Definition of date from where the range begins",
               "definition": {
                 "year": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The year"
                 },
                 "month": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The month"
                 },
                 "day": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The day of month"
                 }
               }
             },
             "to": {
               "type": "Object",
+              "required": true,
               "desc": "Definition of date to where the range ends",
               "definition": {
                 "year": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The year"
                 },
                 "month": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The month"
                 },
                 "day": {
                   "type": "Number",
+                  "required": true,
                   "desc": "The day of month"
                 }
               }
@@ -467,8 +541,8 @@
       "params": {
         "view": {
           "type": "String",
-          "desc": "QDate view name",
           "required": true,
+          "desc": "QDate view name",
           "values": [
             "Calendar",
             "Months",

package/dist/api/QDialog.json

@@ -12,7 +12,8 @@
         "slide-down"
       ],
       "category": "transition",
-      "default": "fade"
+      "default": "fade",
+      "required": false
     },
     "transition-hide": {
       "type": "String",
@@ -22,7 +23,8 @@
         "slide-down"
       ],
       "category": "transition",
-      "default": "fade"
+      "default": "fade",
+      "required": false
     },
     "transition-duration": {
       "type": [
@@ -35,7 +37,8 @@
         500,
         "1200"
       ],
-      "category": "transition"
+      "category": "transition",
+      "required": false
     },
     "model-value": {
       "type": "Boolean",
@@ -102,7 +105,8 @@
         "top",
         "right"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "square": {
       "type": "Boolean",

package/dist/api/QDrawer.json

@@ -20,7 +20,8 @@
       "examples": [
         "right"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "overlay": {
       "type": "Boolean",
@@ -34,7 +35,8 @@
       "examples": [
         ":width=\"350\""
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "mini": {
       "type": "Boolean",
@@ -48,7 +50,8 @@
       "examples": [
         ":mini-width=\"100\""
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "dark": {
       "type": "Boolean",
@@ -68,7 +71,8 @@
         1200,
         ":breakpoint=\"1400\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "behavior": {
       "type": "String",
@@ -82,7 +86,8 @@
       "examples": [
         "mobile"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "bordered": {
       "type": "Boolean",

package/dist/api/QEditor.json

@@ -65,7 +65,8 @@
         "15rem",
         "50vh"
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "max-height": {
       "type": "String",
@@ -157,9 +158,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": {
@@ -225,7 +231,8 @@
           "justify"
         ]
       ],
-      "category": "toolbar"
+      "category": "toolbar",
+      "required": false
     },
     "toolbar-color": {
       "type": "String",
@@ -253,7 +260,8 @@
         "secondary",
         "blue-3"
       ],
-      "category": "toolbar"
+      "category": "toolbar",
+      "required": false
     },
     "toolbar-bg": {
       "type": "String",
@@ -263,7 +271,8 @@
         "secondary",
         "blue-3"
       ],
-      "category": "toolbar"
+      "category": "toolbar",
+      "required": false
     },
     "toolbar-outline": {
       "type": "Boolean",
@@ -364,7 +373,8 @@
         "update": {
           "type": "Boolean",
           "desc": "Refresh the toolbar",
-          "default": true
+          "default": true,
+          "required": false
         }
       }
     },

package/dist/api/QExpansionItem.json

@@ -48,9 +48,10 @@
       "category": "state"
     },
     "model-value": {
-      "type": "Boolean",
       "desc": "Model of the component defining 'open' state; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
-      "category": "model"
+      "required": false,
+      "category": "model",
+      "type": "Boolean"
     },
     "icon": {
       "type": "String",
@@ -156,7 +157,8 @@
       "examples": [
         ":duration=\"1000\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "header-inset-level": {
       "type": "Number",

package/dist/api/QFab.json

@@ -14,7 +14,8 @@
         "button",
         "reset"
       ],
-      "category": "general"
+      "category": "general",
+      "required": false
     },
     "outline": {
       "type": "Boolean",
@@ -86,7 +87,8 @@
       "examples": [
         "Button Label"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "label-position": {
       "type": "String",
@@ -153,9 +155,10 @@
       "category": "general"
     },
     "model-value": {
-      "type": "Boolean",
       "desc": "Controls state of fab actions (showing/hidden); Works best with v-model directive, otherwise use along listening to 'update:modelValue' event",
-      "category": "model"
+      "required": false,
+      "category": "model",
+      "type": "Boolean"
     },
     "icon": {
       "type": "String",
@@ -197,7 +200,8 @@
       "examples": [
         "down"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "vertical-actions-align": {
       "type": "String",
@@ -208,7 +212,8 @@
         "center",
         "right"
       ],
-      "category": "style|content"
+      "category": "style|content",
+      "required": false
     },
     "persistent": {
       "type": "Boolean",

package/dist/api/QFabAction.json

@@ -14,7 +14,8 @@
         "button",
         "reset"
       ],
-      "category": "general"
+      "category": "general",
+      "required": false
     },
     "outline": {
       "type": "Boolean",
@@ -86,7 +87,8 @@
       "examples": [
         "Button Label"
       ],
-      "category": "content"
+      "category": "content",
+      "required": false
     },
     "label-position": {
       "type": "String",

package/dist/api/QField.json

@@ -298,7 +298,7 @@
           ]
         },
         "field": {
-          "type": "Object",
+          "type": "Element",
           "desc": "DOM element of the field"
         },
         "editable": {
@@ -327,6 +327,7 @@
           "params": {
             "value": {
               "type": "Any",
+              "required": true,
               "desc": "Value to be emitted",
               "examples": [
                 0,

package/dist/api/QFile.json

@@ -366,6 +366,7 @@
           "definition": {
             "totalSize": {
               "type": "String",
+              "required": true,
               "desc": "The total size of files in human readable format",
               "examples": [
                 "1.42MB"
@@ -373,6 +374,7 @@
             },
             "filesNumber": {
               "type": "Number",
+              "required": true,
               "desc": "Number of picked files",
               "examples": [
                 5
@@ -383,6 +385,7 @@
                 "Number",
                 "String"
               ],
+              "required": true,
               "desc": "Maximum number of files (same as 'max-files' prop, if specified); When 'max-files' is not specified, this has 'void 0' as value",
               "examples": [
                 5
@@ -485,7 +488,8 @@
           "desc": "File object"
         },
         "ref": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QFile",
           "desc": "Reference to the QFile component"
         }
       }
@@ -501,7 +505,8 @@
           "desc": "Array of File objects"
         },
         "ref": {
-          "type": "Object",
+          "type": "Component",
+          "tsType": "QFile",
           "desc": "Reference to the QFile component"
         }
       }

package/dist/api/QFooter.json

@@ -32,14 +32,15 @@
     "height-hint": {
       "type": [
         "Number",
-        "String "
+        "String"
       ],
       "desc": "When using SSR, you can optionally hint of the height (in pixels) of the QFooter",
       "default": 50,
       "examples": [
         "150"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     }
   },
   "slots": {

package/dist/api/QForm.json

@@ -44,7 +44,7 @@
       "desc": "Emitted after a validation was triggered and at least one of the inner Quasar components models are NOT valid",
       "params": {
         "ref": {
-          "type": "Object",
+          "type": "Component",
           "desc": "Vue reference to the first component that triggered the validation error"
         }
       }

package/dist/api/QHeader.json

@@ -26,7 +26,8 @@
       "examples": [
         ":reveal-offset=\"500\""
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "bordered": {
       "type": "Boolean",
@@ -41,14 +42,15 @@
     "height-hint": {
       "type": [
         "Number",
-        "String "
+        "String"
       ],
       "desc": "When using SSR, you can optionally hint of the height (in pixels) of the QHeader",
       "default": 50,
       "examples": [
         "150"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     }
   },
   "slots": {

package/dist/api/QIcon.json

@@ -25,7 +25,8 @@
         "i"
       ],
       "category": "content",
-      "default": "i"
+      "default": "i",
+      "required": false
     },
     "name": {
       "type": "String",

package/dist/api/QImg.json

@@ -74,7 +74,8 @@
         "(Number format) :initial-ratio=\"16/9\"",
         "(String format) initial-ratio=\"1\""
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "width": {
       "type": "String",
@@ -102,7 +103,8 @@
         "lazy",
         "eager"
       ],
-      "category": "behavior"
+      "category": "behavior",
+      "required": false
     },
     "crossorigin": {
       "type": "String",
@@ -139,7 +141,8 @@
         "none",
         "scale-down"
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "position": {
       "type": "String",
@@ -149,7 +152,8 @@
         "0 0",
         "20px 50px"
       ],
-      "category": "style"
+      "category": "style",
+      "required": false
     },
     "alt": {
       "type": "String",