hrms-bangkok/hrms-manual
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

first commit

Browse source
This commit is contained in:
Warunee Tamkoo 2023-09-06 14:51:44 +07:00
commit eb2f504652
32490 changed files with 5731109 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
node_modules/quasar/dist/api/AddressbarColor.json generated vendored Normal file
View file

@ -0,0 +1,22 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/addressbar-color"
},
"injection": "$q.addressbarColor",
"methods": {
"set": {
"desc": "Sets addressbar color (for browsers that support it)",
"params": {
"hexColor": {
"type": "String",
"desc": "Color in hex format",
"required": true,
"examples": [
"#ff0000"
]
}
}
}
}
}

78
node_modules/quasar/dist/api/AppFullscreen.json generated vendored Normal file
View file

@ -0,0 +1,78 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/app-fullscreen"
},
"injection": "$q.fullscreen",
"props": {
"isCapable": {
"type": "Boolean",
"desc": "Does browser support it?"
},
"isActive": {
"type": "Boolean",
"desc": "Is Fullscreen active?"
},
"activeEl": {
"type": [
"Element",
"null"
],
"desc": "The DOM element used as root for fullscreen, otherwise 'null'",
"examples": [
"document.fullscreenElement",
"null"
]
}
},
"methods": {
"request": {
"desc": "Request going into Fullscreen (with optional target)",
"params": {
"target": {
"type": "Element",
"desc": "Optional Element of target to request Fullscreen on",
"examples": [
"document.getElementById('example')"
]
}
},
"returns": {
"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 => { ... })"
]
}
},
"exit": {
"desc": "Request exiting out of Fullscreen mode",
"returns": {
"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 => { ... })"
]
}
},
"toggle": {
"desc": "Request toggling Fullscreen mode (with optional target if requesting going into Fullscreen only)",
"params": {
"target": {
"type": "Element",
"desc": "Optional Element of target to request Fullscreen on",
"examples": [
"document.getElementById('example')"
]
}
},
"returns": {
"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 => { ... })"
]
}
}
}
}

15
node_modules/quasar/dist/api/AppVisibility.json generated vendored Normal file
View file

@ -0,0 +1,15 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/app-visibility"
},
"injection": "$q.appVisible",
"props": {
"appVisible": {
"tsInjectionPoint": true,
"type": "Boolean",
"desc": "Does the app have user focus? Or the app runs in the background / another tab has the user's attention",
"reactive": true
}
}
}

259
node_modules/quasar/dist/api/BottomSheet.json generated vendored Normal file
View file

@ -0,0 +1,259 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/bottom-sheet"
},
"injection": "$q.bottomSheet",
"methods": {
"create": {
"desc": "Creates an ad-hoc Bottom Sheet; Same as calling $q.bottomSheet(...)",
"params": {
"opts": {
"type": "Object",
"required": true,
"definition": {
"class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS Class name to apply to the Dialog's QCard",
"examples": [
"my-class"
]
},
"style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "CSS style to apply to the Dialog's QCard",
"examples": [
"border: 2px solid black"
]
},
"title": {
"type": "String",
"desc": "Title",
"examples": [
"Share"
]
},
"message": {
"type": "String",
"desc": "Message",
"examples": [
"Please select how to share"
]
},
"actions": {
"type": "Array",
"desc": "Array of Objects, each Object defining an action",
"definition": {
"classes": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes for this action",
"examples": [
"my-class"
]
},
"style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to this action element",
"examples": [
"{ padding: '2px' }"
],
"addedIn": "v2.11.7"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"img": {
"type": "String",
"desc": "Path to an image for this action",
"examples": [
"(public folder) img/something.png",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) https://some-site.net/some-img.gif"
]
},
"avatar": {
"type": "String",
"desc": "Path to an avatar image for this action",
"examples": [
"(public folder) img/avatar.png",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) https://some-site.net/some-img.gif"
]
},
"label": {
"type": [
"String",
"Number"
],
"desc": "Action label",
"examples": [
"Facebook"
]
},
"...": {
"type": "Any",
"desc": "Any other custom props"
}
}
},
"grid": {
"type": "Boolean",
"desc": "Display actions as a grid instead of as a list"
},
"dark": {
"type": "Boolean",
"desc": "Apply dark mode",
"category": "style"
},
"seamless": {
"type": "Boolean",
"desc": "Put Bottom Sheet into seamless mode; Does not use a backdrop so user is able to interact with the rest of the page too"
},
"persistent": {
"type": "Boolean",
"desc": "User cannot dismiss Bottom Sheet if clicking outside of it or hitting ESC key"
}
},
"desc": "Bottom Sheet options"
}
},
"returns": {
"type": "Object",
"desc": "Chainable Object",
"tsType": "DialogChainObject",
"autoDefineTsType": true,
"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": {
"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": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"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": {
"type": "Function",
"desc": "Tell what to do",
"required": true,
"params": null,
"returns": null
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"onDismiss": {
"type": "Function",
"required": true,
"desc": "Receives a Function param to tell what to do when the dialog is closed",
"params": {
"callbackFn": {
"type": "Function",
"desc": "Tell what to do",
"required": true,
"params": null,
"returns": null
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"hide": {
"type": "Function",
"required": true,
"desc": "Hides the dialog when called",
"params": null,
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"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"
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
}
}
},
"tsInjectionPoint": true
}
}
}

49
node_modules/quasar/dist/api/Brand.json generated vendored Normal file
View file

@ -0,0 +1,49 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/style/color-palette"
},
"quasarConfOptions": {
"propName": "brand",
"type": "Object",
"definition": {
"primary": {
"type": "String",
"desc": "Main color of your app"
},
"secondary": {
"type": "String",
"desc": "Secondary color of your app"
},
"accent": {
"type": "String",
"desc": "Accent color of your app"
},
"dark": {
"type": "String",
"desc": "Dark color of your app"
},
"positive": {
"type": "String",
"desc": "Positive color of your app"
},
"negative": {
"type": "String",
"desc": "Negative color of your app"
},
"info": {
"type": "String",
"desc": "Info color of your app"
},
"warning": {
"type": "String",
"desc": "Warning color of your app"
},
"...customColors": {
"type": "String",
"desc": "Custom colors of your app, if any"
}
}
},
"internal": true
}

21
node_modules/quasar/dist/api/ClosePopup.json generated vendored Normal file
View file

@ -0,0 +1,21 @@
{
"type": "directive",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-directives/close-popup"
},
"value": {
"type": [
"Boolean",
"Number",
"String"
],
"desc": "If value is 0 or 'false' then directive is disabled; if value is < 0 then it closes all popups in the chain; if value is 1 or 'true' or undefined then it closes only the parent popup; if value is > 1 it closes the specified number of parent popups in the chain (note that chained QMenus are considered 1 popup only & QPopupProxy separates chained menus)",
"examples": [
"v-close-popup",
"v-close-popup=\"booleanState\"",
"v-close-popup=\"-1\"",
"v-close-popup=\"2\"",
"v-close-popup=\"0\""
]
}
}

190
node_modules/quasar/dist/api/Cookies.json generated vendored Normal file
View file

@ -0,0 +1,190 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/cookies"
},
"injection": "$q.cookies",
"methods": {
"get": {
"tsType": "CookiesGetMethodType",
"desc": "Get cookie",
"params": {
"name": {
"type": "String",
"desc": "Cookie name",
"required": true,
"examples": [
"userId"
]
}
},
"returns": {
"type": [
"String",
"null"
],
"desc": "Cookie value; Returns null if cookie not found",
"examples": [
"john12"
]
}
},
"getAll": {
"desc": "Get all cookies",
"returns": {
"type": "Object",
"desc": "Object with cookie names (as keys) and their values",
"examples": [
"{ userId: 'john12', XFrame: 'x534' }"
]
}
},
"set": {
"desc": "Set cookie",
"params": {
"name": {
"type": "String",
"desc": "Cookie name",
"required": true,
"examples": [
"userId"
]
},
"value": {
"type": "String",
"desc": "Cookie value",
"required": true,
"examples": [
"john12"
]
},
"options": {
"type": "Object",
"desc": "Cookie options",
"definition": {
"expires": {
"type": [
"Number",
"String",
"Date"
],
"desc": "Cookie expires detail; If specified as Number, then the unit is days; If specified as String, it can either be raw stringified date or in Xd Xh Xm Xs format (see examples)",
"examples": [
30,
"Wed, 13 Jan 2021 22:23:01 GMT",
"1d",
"15m",
"13d",
"1d 15m",
"1d 3h 5m 3s"
]
},
"path": {
"type": "String",
"desc": "Cookie path",
"examples": [
"/accounts"
]
},
"domain": {
"type": "String",
"desc": "Cookie domain",
"examples": [
".foo.com"
]
},
"sameSite": {
"type": "String",
"desc": "SameSite cookie option",
"values": [
"Lax",
"Strict",
"None"
]
},
"httpOnly": {
"type": "Boolean",
"desc": "Is cookie Http Only?"
},
"secure": {
"type": "Boolean",
"desc": "Is cookie secure? (https only)"
},
"other": {
"type": "String",
"desc": "Raw string for other cookie options; To be used as a last resort for possible newer props that are currently not yet implemented in Quasar",
"examples": [
"SomeNewCookieProp"
]
}
}
}
}
},
"has": {
"desc": "Check if cookie exists",
"params": {
"name": {
"type": "String",
"desc": "Cookie name",
"required": true,
"examples": [
"userId"
]
}
},
"returns": {
"type": "Boolean",
"desc": "Does cookie exists or not?"
}
},
"remove": {
"desc": "Remove a cookie",
"params": {
"name": {
"type": "String",
"desc": "Cookie name",
"required": true,
"examples": [
"userId"
]
},
"options": {
"type": "Object",
"desc": "Cookie options",
"definition": {
"path": {
"type": "String",
"desc": "Cookie path",
"examples": [
"/accounts"
]
},
"domain": {
"type": "String",
"desc": "Cookie domain",
"examples": [
".foo.com"
]
}
}
}
}
},
"parseSSR": {
"desc": "For SSR usage only, and only on the global import (not on $q.cookies)",
"params": {
"ssrContext": {
"type": "Object",
"desc": "SSR Context Object",
"required": true
}
},
"returns": {
"type": "Object",
"tsType": "Cookies",
"desc": "Cookie object (like $q.cookies) for SSR usage purposes"
}
}
}
}

63
node_modules/quasar/dist/api/Dark.json generated vendored Normal file
View file

@ -0,0 +1,63 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/dark"
},
"injection": "$q.dark",
"quasarConfOptions": {
"propName": "dark",
"type": [
"Boolean",
"String"
],
"desc": "\"'auto'\" uses the OS/browser preference. \"true\" forces dark mode. \"false\" forces light mode.",
"values": [
"auto",
"(Boolean) true",
"(Boolean) false"
]
},
"props": {
"isActive": {
"type": "Boolean",
"desc": "Is Dark mode active?",
"reactive": true
},
"mode": {
"type": [
"Boolean",
"String"
],
"desc": "Dark mode configuration (not status)",
"values": [
"auto",
"(Boolean) true",
"(Boolean) false"
],
"reactive": true
}
},
"methods": {
"set": {
"desc": "Set dark mode status",
"params": {
"status": {
"type": [
"Boolean",
"String"
],
"desc": "Dark mode status",
"values": [
"(Boolean) true",
"(Boolean) false",
"auto"
],
"required": true
}
}
},
"toggle": {
"desc": "Toggle dark mode status"
}
}
}

474
node_modules/quasar/dist/api/Dialog.json generated vendored Normal file
View file

@ -0,0 +1,474 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/dialog"
},
"injection": "$q.dialog",
"methods": {
"create": {
"desc": "Creates an ad-hoc Dialog; Same as calling $q.dialog(...)",
"params": {
"opts": {
"type": "Object",
"required": true,
"definition": {
"class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS Class name to apply to the Dialog's QCard",
"examples": [
"my-class"
]
},
"style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "CSS style to apply to the Dialog's QCard",
"examples": [
"border: 2px solid black"
]
},
"title": {
"type": "String",
"desc": "A text for the heading title of the dialog",
"examples": [
"Continue?"
]
},
"message": {
"type": "String",
"desc": "A text with more information about what needs to be input, selected or confirmed.",
"examples": [
"Are you certain you want to continue?"
]
},
"html": {
"type": "Boolean",
"desc": "Render title and message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"position": {
"type": "String",
"desc": "Position of the Dialog on screen. Standard is centered.",
"values": [
"top",
"right",
"bottom",
"left",
"standard"
],
"default": "standard",
"required": false
},
"prompt": {
"type": "Object",
"tsType": "QDialogInputPrompt",
"desc": "An object definition of the input field for the prompting question.",
"examples": [
"prompt: { model: this.promptVal, type: 'number' }"
],
"definition": {
"model": {
"type": "String",
"required": true,
"desc": "The initial value of the input"
},
"type": {
"type": "String",
"desc": "Optional property to determine the input field type",
"default": "text",
"examples": [
"text",
"number",
"textarea"
],
"required": false
},
"isValid": {
"type": "Function",
"desc": "Is typed content valid?",
"params": {
"val": {
"type": "String",
"required": true,
"desc": "The value of the input"
}
},
"returns": {
"type": "Boolean",
"desc": "The text passed validation or not"
}
},
"...QInputProps": {
"type": "Any",
"desc": "Any QInput props, like color, label, stackLabel, filled, outlined, rounded, prefix etc",
"examples": [
"label: 'My Label'",
"standout: true",
"counter: true",
"maxlength: 12"
]
},
"...nativeAttributes": {
"type": "Object",
"desc": "Any native attributes to pass to the prompt control",
"examples": [
"autocomplete: 'off'"
]
}
}
},
"options": {
"type": "Object",
"tsType": "QDialogSelectionPrompt",
"desc": "An object definition for creating the selection form content",
"examples": [
"{ model: this.dialogSelection, type: 'radio', items: [...listOfItems] }"
],
"definition": {
"model": {
"type": [
"String",
"Array"
],
"required": true,
"desc": "The value of the selection (String if it's of type radio or Array otherwise)",
"examples": [
"[]"
]
},
"type": {
"type": "String",
"desc": "The type of selection",
"default": "radio",
"values": [
"radio",
"checkbox",
"toggle"
],
"required": false
},
"items": {
"type": "Array",
"desc": "The list of options to interact with; Equivalent to options prop of the QOptionGroup component",
"examples": [
"[ { label: 'Option 1', value: 'op1' }, { label: 'Option 2', value: 'op2' }, { label: 'Option 3', value: 'op3' } ]"
]
},
"isValid": {
"type": "Function",
"desc": "Is the model valid?",
"params": {
"model": {
"type": [
"String",
"Array"
],
"required": true,
"desc": "The current model (String if it's of type radio or Array otherwise)",
"examples": [
"opt2",
"[ 'opt1' ]",
"[]",
"[ 'opt1', 'opt3' ]"
]
}
},
"returns": {
"type": "Boolean",
"desc": "The selection passed validation or not"
}
},
"...QOptionGroupProps": {
"type": "Any",
"desc": "Any QOptionGroup props",
"examples": [
"color: 'deep-purple-4'",
"inline: true",
"dense: true",
"leftLabel: true"
]
},
"...nativeAttributes": {
"type": "Object",
"desc": "Any native attributes to pass to the inner QOptionGroup"
}
}
},
"progress": {
"type": [
"Boolean",
"Object"
],
"desc": "Display a Quasar spinner (if value is true, then the defaults are used); Useful for conveying the idea that something is happening behind the covers; Tip: use along with persistent, ok: false and update() method",
"definition": {
"spinner": {
"type": "Component",
"desc": "One of the QSpinners"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
},
"ok": {
"type": [
"String",
"Object",
"Boolean"
],
"desc": "Props for an 'OK' button",
"definition": {
"...props": {
"type": "Any",
"desc": "See QBtn for available props"
}
}
},
"cancel": {
"type": [
"String",
"Object",
"Boolean"
],
"desc": "Props for a 'CANCEL' button",
"definition": {
"...props": {
"type": "Any",
"desc": "See QBtn for available props"
}
}
},
"focus": {
"type": "String",
"desc": "What button to focus, unless you also have 'prompt' or 'options'",
"values": [
"ok",
"cancel",
"none"
],
"default": "ok",
"required": false
},
"stackButtons": {
"type": "Boolean",
"desc": "Makes buttons be stacked instead of vertically aligned"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Apply dark mode",
"category": "style"
},
"persistent": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog if clicking outside of it or hitting ESC key; Also, an app route change won't dismiss it"
},
"noEscDismiss": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog by hitting ESC key; No need to set it if 'persistent' prop is also set"
},
"noBackdropDismiss": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog by clicking outside of it; No need to set it if 'persistent' prop is also set"
},
"noRouteDismiss": {
"type": "Boolean",
"desc": "Changing route app won't dismiss Dialog; No need to set it if 'persistent' prop is also set"
},
"seamless": {
"type": "Boolean",
"desc": "Put Dialog into seamless mode; Does not use a backdrop so user is able to interact with the rest of the page too"
},
"maximized": {
"type": "Boolean",
"desc": "Put Dialog into maximized mode"
},
"fullWidth": {
"type": "Boolean",
"desc": "Dialog will try to render with same width as the window"
},
"fullHeight": {
"type": "Boolean",
"desc": "Dialog will try to render with same height as the window"
},
"transitionShow": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "scale",
"required": false
},
"transitionHide": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "scale",
"required": false
},
"component": {
"type": [
"Component",
"String"
],
"desc": "Use custom dialog component; use along with 'componentProps' prop where possible",
"examples": [
"CustomComponent",
"'custom-component'"
]
},
"componentProps": {
"type": "Object",
"desc": "User defined props which will be forwarded to underlying custom component if 'component' prop is used"
}
},
"desc": "Dialog options",
"tsType": "QDialogOptions",
"autoDefineTsType": true
}
},
"returns": {
"type": "Object",
"desc": "Chainable Object",
"tsType": "DialogChainObject",
"autoDefineTsType": true,
"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": {
"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": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"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": {
"type": "Function",
"desc": "Tell what to do",
"required": true,
"params": null,
"returns": null
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"onDismiss": {
"type": "Function",
"required": true,
"desc": "Receives a Function param to tell what to do when the dialog is closed",
"params": {
"callbackFn": {
"type": "Function",
"desc": "Tell what to do",
"required": true,
"params": null,
"returns": null
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"hide": {
"type": "Function",
"required": true,
"desc": "Hides the dialog when called",
"params": null,
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
},
"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"
}
},
"returns": {
"type": "Object",
"desc": "Chained Object",
"tsType": "DialogChainObject"
}
}
}
},
"tsInjectionPoint": true
}
}
}

204
node_modules/quasar/dist/api/Intersection.json generated vendored Normal file
View file

@ -0,0 +1,204 @@
{
"type": "directive",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-directives/intersection"
},
"value": {
"type": [
"Object",
"Function"
],
"desc": "Function to call when scrolling occurs (identical to description of 'handler' prop of the Object form); If using the Object form, it is HIGHLY recommended to reference it from your vue component scope, otherwise the directive update cycle will continuously recreate the observer which hits performance hard",
"examples": [
"v-intersection=\"myFunction\"",
"v-intersection=\"{ handler: myFunction, cfg: { root: myScrollingParentEl, rootMargin: '10px 20px 30px 40px', threshold: [0, 0.25, 0.5, 0.75, 1] } }\""
],
"definition": {
"handler": {
"type": "Function",
"desc": "The handler function to be called",
"returns": {
"type": "Boolean",
"desc": "If you return Boolean false from the handler, the observer stops"
},
"params": {
"entry": {
"type": "Object",
"desc": "The IntersectionObserverEntry object",
"definition": {
"boundingClientRect": {
"type": "Object",
"desc": "Object containing the client rect information",
"definition": {
"bottom": {
"type": "Number",
"desc": "The bottom of the client rect"
},
"height": {
"type": "Number",
"desc": "The height of the client rect"
},
"left": {
"type": "Number",
"desc": "The left of the client rect"
},
"right": {
"type": "Number",
"desc": "The right of the client rect"
},
"top": {
"type": "Number",
"desc": "The top of the client rect"
},
"width": {
"type": "Number",
"desc": "The width of the client rect"
},
"x": {
"type": "Number",
"desc": "The x position of the client rect"
},
"y": {
"type": "Number",
"desc": "The y position of the client rect"
}
}
},
"intersectionRatio": {
"type": "Number",
"desc": "The ratio of the observed objects visibility"
},
"intersectionRect": {
"type": "Object",
"desc": "Object containing the client rect information",
"definition": {
"bottom": {
"type": "Number",
"desc": "The bottom of the client rect"
},
"height": {
"type": "Number",
"desc": "The height of the client rect"
},
"left": {
"type": "Number",
"desc": "The left of the client rect"
},
"right": {
"type": "Number",
"desc": "The right of the client rect"
},
"top": {
"type": "Number",
"desc": "The top of the client rect"
},
"width": {
"type": "Number",
"desc": "The width of the client rect"
},
"x": {
"type": "Number",
"desc": "The x position of the client rect"
},
"y": {
"type": "Number",
"desc": "The y position of the client rect"
}
}
},
"isIntersecting": {
"type": "Boolean",
"desc": "It is Boolean true if intersecting the scrollable area"
},
"rootBounds": {
"type": "Object",
"desc": "Object containing the client rect information",
"definition": {
"bottom": {
"type": "Number",
"desc": "The bottom of the client rect"
},
"height": {
"type": "Number",
"desc": "The height of the client rect"
},
"left": {
"type": "Number",
"desc": "The left of the client rect"
},
"right": {
"type": "Number",
"desc": "The right of the client rect"
},
"top": {
"type": "Number",
"desc": "The top of the client rect"
},
"width": {
"type": "Number",
"desc": "The width of the client rect"
},
"x": {
"type": "Number",
"desc": "The x position of the client rect"
},
"y": {
"type": "Number",
"desc": "The y position of the client rect"
}
}
},
"target": {
"type": "Element",
"desc": "The target element"
},
"time": {
"type": "Number",
"desc": "The timestamp of the event",
"examples": [
"6316.879999998491"
]
}
}
}
}
},
"cfg": {
"type": "Object",
"desc": "Intersection observer options (can be omitted and all its props are optional)",
"definition": {
"root": {
"type": "Element",
"desc": "Lets you define an alternative to the viewport as your root (through its DOM element); It is important to keep in mind that root needs to be an ancestor of the observed element",
"examples": [
"myScrollingParentEl"
]
},
"rootMargin": {
"type": "String",
"desc": "Allows you to specify the margins for the root, effectively allowing you to either grow or shrink the area used for intersections",
"examples": [
"10px 20px 30px 40px"
]
},
"threshold": {
"type": "Array",
"desc": "Threshold(s) at which to trigger callback, specified as a ratio, or list of ratios, of (visible area / total area) of the observed element",
"examples": [
"[ 0, 0.25, 0.5, 0.75, 1 ]"
]
}
}
}
}
},
"modifiers": {
"once": {
"type": "Boolean",
"desc": "Call handler only once, when the conditions are first met",
"examples": [
"v-intersection.once"
]
}
}
}

18
node_modules/quasar/dist/api/Lang.json generated vendored Normal file
View file

@ -0,0 +1,18 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/options/quasar-language-packs"
},
"quasarConfOptions": {
"propName": "lang",
"type": "Object",
"definition": {
"noHtmlAttrs": {
"type": "Boolean",
"addedIn": "v2.11.3",
"desc": "Whether to disable `dir` and `lang` HTML attributes getting added to the `<html>` tag. `dir` attribute is crucial when using RTL support. Disable this only if you need to handle these yourself for some reason."
}
}
},
"internal": true
}

317
node_modules/quasar/dist/api/Loading.json generated vendored Normal file
View file

@ -0,0 +1,317 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/loading"
},
"injection": "$q.loading",
"quasarConfOptions": {
"propName": "loading",
"type": "Object",
"definition": {
"delay": {
"type": "Number",
"desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time",
"examples": [
400
]
},
"message": {
"type": "String",
"desc": "Message to display",
"examples": [
"Processing your request"
]
},
"group": {
"type": "String",
"desc": "Default Loading group name",
"default": "__default_quasar_group__",
"examples": [
"default-group-name"
],
"addedIn": "v2.8",
"required": false
},
"html": {
"type": "Boolean",
"desc": "Force render the message as HTML; This can lead to XSS attacks so make sure that you sanitize the content",
"category": "behavior"
},
"boxClass": {
"type": "String",
"desc": "Content wrapped element custom classes",
"examples": [
"bg-amber text-black",
"q-pa-xl"
]
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)"
},
"spinnerColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"spinner": {
"type": "Component",
"configFileType": "String",
"desc": "One of the QSpinners",
"examples": [
"QSpinnerAudio"
]
},
"customClass": {
"type": "String",
"desc": "Add a CSS class to the container element to easily customize the component",
"examples": [
"my-class"
]
}
}
},
"props": {
"isActive": {
"type": "Boolean",
"desc": "Is Loading active?",
"reactive": true
}
},
"methods": {
"show": {
"desc": "Activate and show",
"params": {
"opts": {
"type": "Object",
"tsType": "QLoadingShowOptions",
"autoDefineTsType": true,
"desc": "All props are optional",
"definition": {
"delay": {
"type": "Number",
"desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time"
},
"message": {
"type": "String",
"desc": "Message to display",
"examples": [
"Processing your request"
]
},
"group": {
"type": "String",
"desc": "Loading group name",
"examples": [
"some-api-call"
],
"addedIn": "v2.8"
},
"html": {
"type": "Boolean",
"desc": "Render the message as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
"category": "behavior"
},
"boxClass": {
"type": "String",
"desc": "Content wrapped element custom classes",
"examples": [
"bg-amber text-black",
"q-pa-xl"
]
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)"
},
"spinnerColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"spinner": {
"type": "Component",
"desc": "One of the QSpinners"
},
"customClass": {
"type": "String",
"desc": "Add a CSS class to easily customize the component",
"examples": [
"my-class"
]
},
"ignoreDefaults": {
"type": "Boolean",
"desc": "Ignore the default configuration (set by setDefaults()) for this instance only"
}
}
}
},
"returns": {
"type": "Function",
"desc": "Calling this function with no parameters hides the group; When called with one Object parameter then it updates the Loading group (specified properties are shallow merged with the group ones; note that group cannot be changed while updating and it is ignored)",
"params": {
"props": {
"type": "Object",
"tsType": "QLoadingUpdateOptions",
"required": false,
"desc": "Loading properties that will be shallow merged to the group ones; (See 'opts' param of 'show()' for object properties, except 'group')"
}
},
"returns": null,
"addedIn": "v2.8"
}
},
"hide": {
"desc": "Hide it",
"params": {
"group": {
"type": "String",
"desc": "Optional Loading group name to hide instead of hiding all groups",
"required": false,
"examples": [
"some-api-call"
],
"addedIn": "v2.8"
}
}
},
"setDefaults": {
"desc": "Merge options into the default ones",
"params": {
"opts": {
"type": "Object",
"desc": "Pick the subprop you want to define",
"required": true,
"definition": {
"delay": {
"type": "Number",
"desc": "Wait a number of millisecond before showing; Not worth showing for 100ms for example then hiding it, so wait until you're sure it's a process that will take some considerable amount of time"
},
"message": {
"type": "String",
"desc": "Message to display",
"examples": [
"Processing your request"
]
},
"group": {
"type": "String",
"desc": "Default Loading group name",
"default": "__default_quasar_group__",
"examples": [
"default-group-name"
],
"addedIn": "v2.8",
"required": false
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)"
},
"spinnerColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"spinner": {
"type": "Component",
"desc": "One of the QSpinners"
},
"customClass": {
"type": "String",
"desc": "Add a CSS class to easily customize the component",
"examples": [
"my-class"
]
}
}
}
}
}
}
}

62
node_modules/quasar/dist/api/LoadingBar.json generated vendored Normal file
View file

@ -0,0 +1,62 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/loading-bar"
},
"injection": "$q.loadingBar",
"quasarConfOptions": {
"propName": "loadingBar",
"type": "Object",
"tsType": "QLoadingBarOptions",
"desc": "QAjaxBar component props, EXCEPT for 'hijack-filter' in quasar.config file (if using Quasar CLI)",
"examples": [
"{ position: 'bottom', reverse: true }"
]
},
"props": {
"isActive": {
"type": "Boolean",
"desc": "Is LoadingBar active?",
"reactive": true
}
},
"methods": {
"start": {
"desc": "Notify bar you've started a background activity",
"params": {
"speed": {
"type": "Number",
"desc": "Delay (in milliseconds) between bar progress increments",
"default": 300,
"required": false
}
}
},
"stop": {
"desc": "Notify bar one background activity has finalized"
},
"increment": {
"desc": "Manually trigger a bar progress increment",
"params": {
"amount": {
"type": "Number",
"desc": "Amount (0.0 < x < 1.0) to increment with"
}
}
},
"setDefaults": {
"desc": "Set the inner QAjaxBar's props",
"params": {
"props": {
"type": "Object",
"tsType": "QLoadingBarOptions",
"required": true,
"desc": "QAjaxBar component props",
"examples": [
"{ position: 'bottom', reverse: true }"
]
}
}
}
}
}

187
node_modules/quasar/dist/api/LocalStorage.json generated vendored Normal file
View file

@ -0,0 +1,187 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/web-storage"
},
"injection": "$q.localStorage",
"methods": {
"has": {
"desc": "Check if storage item exists",
"params": {
"key": {
"type": "String",
"desc": "Entry key",
"required": true,
"examples": [
"userId"
]
}
},
"returns": {
"type": "Boolean",
"desc": "Does the item exists or not?"
}
},
"getLength": {
"desc": "Get storage number of entries",
"returns": {
"type": "Number",
"desc": "Number of entries"
}
},
"getItem": {
"tsType": "WebStorageGetItemMethodType",
"desc": "Get a storage item value",
"params": {
"key": {
"type": "String",
"desc": "Entry key",
"required": true,
"examples": [
"userId"
]
}
},
"returns": {
"type": [
"Date",
"RegExp",
"Number",
"Boolean",
"Function",
"Object",
"Array",
"String",
"null"
],
"desc": "Storage item value",
"examples": [
"john12",
702
]
}
},
"getIndex": {
"tsType": "WebStorageGetIndexMethodType",
"desc": "Get the storage item value at specific index",
"params": {
"index": {
"type": "Number",
"desc": "Entry index",
"required": true
}
},
"returns": {
"type": [
"Number",
"null"
],
"desc": "Storage item index"
}
},
"getKey": {
"tsType": "WebStorageGetKeyMethodType",
"desc": "Get the storage key at specific index",
"params": {
"index": {
"type": "Number",
"desc": "Entry index",
"required": true
}
},
"returns": {
"type": [
"String",
"null"
],
"desc": "Storage key",
"examples": [
"userId"
]
}
},
"getAll": {
"desc": "Retrieve all items in storage",
"returns": {
"type": "Object",
"desc": "Object syntax: item name as Object key and its value",
"examples": [
"{ userId: 'jon12', timesLoggedIn: 14 }"
]
}
},
"getAllKeys": {
"tsType": "WebStorageGetAllKeysMethodType",
"desc": "Retrieve all keys in storage",
"returns": {
"type": "Array",
"desc": "Storage keys (Array of Strings)",
"examples": [
"['userId', 'password']"
]
}
},
"set": {
"desc": "Set item in storage",
"params": {
"key": {
"type": "String",
"desc": "Entry key",
"required": true,
"examples": [
"userId"
]
},
"value": {
"type": [
"Date",
"RegExp",
"Number",
"Boolean",
"Function",
"Object",
"Array",
"String",
"null"
],
"desc": "Entry value",
"required": true,
"params": {
"...params": {
"type": "Any"
}
},
"returns": {
"type": "Any"
},
"examples": [
"john12"
]
}
}
},
"remove": {
"desc": "Remove a storage item",
"params": {
"key": {
"type": "String",
"desc": "Storage key",
"required": true,
"examples": [
"userId"
]
}
}
},
"clear": {
"desc": "Remove everything from the storage"
},
"isEmpty": {
"desc": "Determine if storage has any items",
"returns": {
"type": "Boolean",
"desc": "Tells if storage is empty or not"
}
}
}
}

6
node_modules/quasar/dist/api/Meta.json generated vendored Normal file
View file

@ -0,0 +1,6 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/meta"
}
}

188
node_modules/quasar/dist/api/Morph.json generated vendored Normal file
View file

@ -0,0 +1,188 @@
{
"type": "directive",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-directives/morph"
},
"value": {
"type": [
"Object",
"Any"
],
"desc": "Configuration object or trigger value",
"definition": {
"group": {
"type": "String",
"desc": "Name of the morph group the element belongs to",
"examples": [
"dialogGroup"
]
},
"name": {
"type": "String",
"desc": "Name of the morph inside the group that the element belongs to",
"examples": [
"btn"
]
},
"model": {
"type": "String",
"desc": "Current value of the group model; when it becomes the same as the 'name' it triggers the morphing",
"examples": [
"btn"
]
},
"duration": {
"type": "Number",
"desc": "Duration of the animation (in milliseconds)",
"default": "300",
"required": false
},
"delay": {
"type": "Number",
"desc": "Delay for the animation (in milliseconds)",
"default": "0",
"required": false
},
"easing": {
"type": "String",
"desc": "Timing function for the animation (CSS easing format)",
"default": "ease-in-out",
"examples": [
"ease-out"
],
"required": false
},
"fill": {
"type": "String",
"desc": "Fill mode for the animation",
"default": "none",
"examples": [
"forward"
],
"required": false
},
"classes": {
"type": "String",
"desc": "Class names to be added to the destination element during the animation",
"examples": [
"bg-grey-2"
]
},
"style": {
"type": [
"String",
"Object"
],
"desc": "Styles to be added to the destination element during the animation",
"examples": [
"border-radius: 20px"
]
},
"resize": {
"type": "Boolean",
"desc": "Use resize instead of scaling during animation"
},
"useCSS": {
"type": "Boolean",
"desc": "Use CSS animations instead of the Animation API"
},
"hideFromClone": {
"type": "Boolean",
"desc": "Hide the spacer for the initial element during animation; Use it if the initial element is not removed or resizing of the space occupied by the initial element is not desired"
},
"keepToClone": {
"type": "Boolean",
"desc": "Keep a clone of the final element visible during animation"
},
"tween": {
"type": "Boolean",
"desc": "Use an opacity tween between the initial and final elements"
},
"tweenFromOpacity": {
"type": "Number",
"desc": "If using tween it is the initial opacity of the initial element (will be animated to 0) - the initial element is placed on top of the final element",
"default": 0.6,
"required": false
},
"tweenToOpacity": {
"type": "Number",
"desc": "If using tween it is the initial opacity of the final element (will be animated to 1)",
"default": 0.5,
"required": false
},
"waitFor": {
"type": [
"Number",
"String",
"Promise<void>"
],
"desc": "Delay animation start for that number of milliseconds, or until a 'transitionend' event is emitted by the destination element, or until the promise is resolved (if the promise is rejected the morphing will abort, but the `toggle function` was already called)",
"default": "0",
"examples": [
"300",
"transitionend"
],
"required": false
},
"onEnd": {
"type": "Function",
"desc": "A function that will be called once the morphing is finished; Not called if morphing is aborted",
"returns": null,
"params": {
"direction": {
"type": "String",
"desc": "'to' if the morphing was finished in the final state or 'from' if it was finished in the initial state",
"values": [
"to",
"from"
]
},
"aborted": {
"type": "Boolean",
"desc": "Was the morphing aborted?"
}
},
"examples": [
"(direction, aborted) => { if (direction !== 'to') { revertLogic() } }"
]
}
},
"examples": [
"v-morph:element2:group1=\"groupModel\"",
"v-morph=\"{ name: 'element2', group: 'group1', model: 'element1' }\""
]
},
"arg": {
"type": "String",
"desc": "x:x2:y:z, where x is the morph element name, x2 is the morph group, y is the animation duration (in milliseconds) and z is the amount of time to wait (in milliseconds) or the 'transitionend' string",
"examples": [
"v-morph:name=\"options\"",
"v-morph:name:groupName=\"options\"",
"v-morph:name:groupName:400=\"options\"",
"v-morph:name:groupName:400:100=\"options\"",
"v-morph:name:groupName:400:transitionend=\"options\""
]
},
"modifiers": {
"resize": {
"type": "Boolean",
"desc": "Use resize instead of scale transform for morph (forceResize option of the morph function)"
},
"useCSS": {
"type": "Boolean",
"desc": "Use CSS animations for morph (forceCssAnimation option of the morph function)"
},
"hideFromClone": {
"type": "Boolean",
"desc": "Hide the spacer for the initial element (hideFromClone option of the morph function)"
},
"keepToClone": {
"type": "Boolean",
"desc": "Keep the final element visible while morphing (keepToClone option of the morph function)"
},
"tween": {
"type": "Boolean",
"desc": "Use opacity tween morphing between initial and final elements (tween option of the morph function)"
}
}
}

122
node_modules/quasar/dist/api/Mutation.json generated vendored Normal file
View file

@ -0,0 +1,122 @@
{
"type": "directive",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-directives/mutation"
},
"value": {
"type": [
"Function"
],
"desc": "Function to call when mutation occurs; It is HIGHLY recommended to reference it from your vue component scope, otherwise the directive update cycle will continuously recreate the observer which hits performance hard",
"examples": [
"v-intersection=\"myHandler\""
],
"returns": {
"type": "Boolean",
"desc": "If you return Boolean false from the handler, the observer stops"
},
"params": {
"mutationList": {
"type": "Array",
"desc": "Array of MutationRecord items",
"definition": {
"type": {
"type": "String",
"desc": "Type of mutation",
"values": [
"childList",
"attributes",
"characterData"
]
},
"target": {
"type": "Element",
"desc": "The DOM element that the mutation affected, depending on the mutation type"
},
"addedNodes": {
"type": "Array",
"desc": "The NodeList of the nodes that have been added"
},
"removedNodes": {
"type": "Array",
"desc": "The NodeList of the nodes that have been removed"
},
"previousSibling": {
"type": "Object",
"desc": "The previous sibling of the added or removed nodes, or null"
},
"nextSibling": {
"type": "Object",
"desc": "The next sibling of the added or removed nodes, or null"
},
"attributeName": {
"type": "String",
"desc": "The local name of the changed attribute, or null",
"examples": [
"some-attribute"
]
},
"attributeNamespace": {
"type": "String",
"desc": "The namespace of the changed attribute, or null"
},
"oldValue": {
"type": "String",
"desc": "Value depends on the mutation type; For attributes, it is the value of the changed attribute before the change; For characterData it is data of the changed node before the change; For childList it is null; Note that for this to work as expected, attributeOldValue or characterDataOldValue must be set"
}
}
}
}
},
"modifiers": {
"once": {
"type": "Boolean",
"desc": "Call handler only once, when the first mutation was triggered, then stop monitoring",
"examples": [
"v-mutation.once"
]
},
"childList": {
"type": "Boolean",
"desc": "Monitor the target node (and, if 'subtree' is also set, its descendants) for the addition of new child nodes or removal of existing child nodes",
"examples": [
"v-mutation.childList"
]
},
"subtree": {
"type": "Boolean",
"desc": "Extend monitoring to the entire subtree of nodes rooted at target",
"examples": [
"v-mutation.subtree"
]
},
"attributes": {
"type": "Boolean",
"desc": "Watch for changes to the value of attributes on the node or nodes being monitored",
"examples": [
"v-mutation.attributes"
]
},
"characterData": {
"type": "Boolean",
"desc": "Monitor the specified target node or subtree for changes to the character data contained within the node or nodes",
"examples": [
"v-mutation.characterData"
]
},
"attributeOldValue": {
"type": "Boolean",
"desc": "Record the previous value of any attribute that changes when monitoring the node or nodes for attribute changes",
"examples": [
"v-mutation.attributeOldValue"
]
},
"characterDataOldValue": {
"type": "Boolean",
"desc": "Record the previous value of a node's text whenever the text changes on nodes being monitored",
"examples": [
"v-mutation.characterDataOldValue"
]
}
}
}

690
node_modules/quasar/dist/api/Notify.json generated vendored Normal file
View file

@ -0,0 +1,690 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/quasar-plugins/notify"
},
"injection": "$q.notify",
"quasarConfOptions": {
"propName": "notify",
"type": "Object",
"definition": {
"type": {
"type": "String",
"desc": "Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')",
"examples": [
"negative",
"custom-type"
]
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"textColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"message": {
"type": "String",
"desc": "The content of your message",
"examples": [
"John Doe pinged you"
]
},
"caption": {
"type": "String",
"desc": "The content of your optional caption",
"examples": [
"5 minutes ago"
]
},
"html": {
"type": "Boolean",
"desc": "Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"iconColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.5.5"
},
"iconSize": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style",
"addedIn": "v2.5.5"
},
"avatar": {
"type": "String",
"desc": "URL to an avatar/image; Suggestion: use public folder",
"examples": [
"(public folder) img/something.png",
"(relative path format) require('./my_img.jpg')",
"(URL) https://some-site.net/some-img.gif"
]
},
"spinner": {
"type": "Boolean",
"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"
]
},
"spinnerColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.5.5"
},
"spinnerSize": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style",
"addedIn": "v2.5.5"
},
"position": {
"type": "String",
"desc": "Window side/corner to stick to",
"default": "bottom",
"values": [
"top-left",
"top-right",
"bottom-left",
"bottom-right",
"top",
"bottom",
"left",
"right",
"center"
],
"required": false
},
"group": {
"type": [
"Boolean",
"String",
"Number"
],
"desc": "Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered",
"default": "(message + caption + multiline + actions labels + position)",
"examples": [
"my-group"
],
"required": false
},
"badgeColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the badge from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"badgeTextColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the badge text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"badgePosition": {
"type": "String",
"desc": "Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left",
"default": "(top-left/top-right)",
"values": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
],
"required": false
},
"badgeStyle": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the badge",
"examples": [
"background-color: #ff0000",
"{ backgroundColor: '#ff0000' }"
]
},
"badgeClass": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the badge",
"examples": [
"my-special-class",
"{ 'my-special-class': <condition> }"
]
},
"progress": {
"type": "Boolean",
"desc": "Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"
},
"progressClass": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the progress bar",
"examples": [
"my-special-class",
"{ 'my-special-class': <condition> }"
]
},
"classes": {
"type": "String",
"desc": "Add CSS class(es) to the notification for easier customization",
"examples": [
"my-notif-class"
]
},
"attrs": {
"type": "Object",
"desc": "Key-value for attributes to be set on the notification",
"examples": [
"{ role: 'alertdialog' }"
]
},
"timeout": {
"type": "Number",
"desc": "Amount of time to display (in milliseconds)",
"default": 5000,
"required": false
},
"actions": {
"type": "Array",
"tsType": "QNotifyAction",
"desc": "Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop",
"definition": {
"handler": {
"type": "Function",
"configFileType": null,
"desc": "Function to be executed when the button is clicked/tapped",
"params": null,
"returns": null,
"examples": [
"() => { console.log('button clicked') }"
]
},
"noDismiss": {
"type": "Boolean",
"desc": "Do not dismiss the notification when the button is clicked/tapped"
},
"...": {
"type": "Any",
"desc": "Any other QBtn prop expect 'onClick' (use 'handler' instead, only possible with UI config)",
"examples": [
"label: 'Learn more'",
"color: 'primary'"
]
}
},
"examples": [
"[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"
]
},
"onDismiss": {
"type": "Function",
"configFileType": null,
"desc": "Function to call when notification gets dismissed",
"params": null,
"returns": null,
"examples": [
"() => { console.log('Dismissed') }"
]
},
"closeBtn": {
"type": [
"Boolean",
"String"
],
"desc": "Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language",
"examples": [
"Close me"
]
},
"multiLine": {
"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"
}
}
},
"methods": {
"create": {
"tsInjectionPoint": true,
"desc": "Creates a notification; Same as calling $q.notify(...)",
"params": {
"opts": {
"type": [
"Object",
"String"
],
"tsType": "QNotifyCreateOptions",
"autoDefineTsType": true,
"required": true,
"desc": "Notification options",
"definition": {
"type": {
"type": "String",
"desc": "Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')",
"examples": [
"negative",
"custom-type"
]
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"textColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"message": {
"type": "String",
"desc": "The content of your message",
"examples": [
"John Doe pinged you"
]
},
"caption": {
"type": "String",
"desc": "The content of your optional caption",
"examples": [
"5 minutes ago"
]
},
"html": {
"type": "Boolean",
"desc": "Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"iconColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.5.5"
},
"iconSize": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style",
"addedIn": "v2.5.5"
},
"avatar": {
"type": "String",
"desc": "URL to an avatar/image; Suggestion: use public folder",
"examples": [
"(public folder) img/something.png",
"(relative path format) require('./my_img.jpg')",
"(URL) https://some-site.net/some-img.gif"
]
},
"spinner": {
"type": [
"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",
"examples": [
true,
"QSpinnerBars"
]
},
"spinnerColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.5.5"
},
"spinnerSize": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style",
"addedIn": "v2.5.5"
},
"position": {
"type": "String",
"desc": "Window side/corner to stick to",
"default": "bottom",
"values": [
"top-left",
"top-right",
"bottom-left",
"bottom-right",
"top",
"bottom",
"left",
"right",
"center"
],
"required": false
},
"group": {
"type": [
"Boolean",
"String",
"Number"
],
"desc": "Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered",
"default": "(message + caption + multiline + actions labels + position)",
"examples": [
"my-group"
],
"required": false
},
"badgeColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the badge from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"badgeTextColor": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the badge text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"badgePosition": {
"type": "String",
"desc": "Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left",
"default": "(top-left/top-right)",
"values": [
"top-left",
"top-right",
"bottom-left",
"bottom-right"
],
"required": false
},
"badgeStyle": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the badge",
"examples": [
"background-color: #ff0000",
"{ backgroundColor: '#ff0000' }"
]
},
"badgeClass": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the badge",
"examples": [
"my-special-class",
"{ 'my-special-class': <condition> }"
]
},
"progress": {
"type": "Boolean",
"desc": "Show progress bar to detail when notification will disappear automatically (unless timeout is 0)"
},
"progressClass": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the progress bar",
"examples": [
"my-special-class",
"{ 'my-special-class': <condition> }"
]
},
"classes": {
"type": "String",
"desc": "Add CSS class(es) to the notification for easier customization",
"examples": [
"my-notif-class"
]
},
"attrs": {
"type": "Object",
"desc": "Key-value for attributes to be set on the notification",
"examples": [
"{ role: 'alertdialog' }"
]
},
"timeout": {
"type": "Number",
"desc": "Amount of time to display (in milliseconds)",
"default": 5000,
"examples": [
2500
],
"required": false
},
"actions": {
"type": "Array",
"tsType": "QNotifyAction",
"desc": "Notification actions (buttons); Unless 'noDismiss' is true, clicking/tapping on the button will close the notification; Also check 'closeBtn' convenience prop",
"definition": {
"handler": {
"type": "Function",
"desc": "Function to be executed when the button is clicked/tapped",
"params": null,
"returns": null,
"examples": [
"() => { console.log('button clicked') }"
]
},
"noDismiss": {
"type": "Boolean",
"desc": "Do not dismiss the notification when the button is clicked/tapped"
},
"...": {
"type": "Any",
"desc": "Any other QBtn prop expect 'onClick' (use 'handler' instead)",
"examples": [
"label: 'Learn more'",
"color: 'primary'"
]
}
},
"examples": [
"[ { label: 'Show', handler: () => {}, 'aria-label': 'Button label' }, { icon: 'map', handler: () => {}, color: 'yellow' }, { label: 'Learn more', noDismiss: true, handler: () => {} } ]"
]
},
"onDismiss": {
"type": "Function",
"desc": "Function to call when notification gets dismissed",
"params": null,
"returns": null,
"examples": [
"() => { console.log('Dismissed') }"
]
},
"closeBtn": {
"type": [
"Boolean",
"String"
],
"desc": "Convenient way to add a dismiss button with a specific label, without using the 'actions' prop; If set to true, it uses a label according to the current Quasar language",
"examples": [
"Close me"
]
},
"multiLine": {
"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"
},
"ignoreDefaults": {
"type": "Boolean",
"desc": "Ignore the default configuration (set by setDefaults()) for this instance only"
}
}
}
},
"returns": {
"type": "Function",
"desc": "Calling this function with no parameters hides the notification; When called with one Object parameter (the original notification must NOT be grouped), it updates the notification (specified properties are shallow merged with previous ones; note that group and position cannot be changed while updating and so they are ignored)",
"params": {
"props": {
"type": "Object",
"tsType": "QNotifyUpdateOptions",
"required": false,
"desc": "Notification properties that will be shallow merged to previous ones in order to update the non-grouped notification; (See 'opts' param of 'create()' for object properties, except 'group' and 'position')"
}
},
"returns": null
}
},
"setDefaults": {
"desc": "Merge options into the default ones",
"params": {
"opts": {
"type": "Object",
"tsType": "QNotifyOptions",
"required": true,
"desc": "Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"
}
}
},
"registerType": {
"desc": "Register a new type of notification (or override an existing one)",
"params": {
"typeName": {
"type": "String",
"required": true,
"desc": "Name of the type (to be used as 'type' prop later on)",
"examples": [
"my-type"
]
},
"typeOpts": {
"type": "Object",
"tsType": "QNotifyOptions",
"required": true,
"desc": "Notification options except 'ignoreDefaults' (See 'opts' param of 'create()' for object properties)"
}
}
}
}
}

238
node_modules/quasar/dist/api/Platform.json generated vendored Normal file
View file

@ -0,0 +1,238 @@
{
"type": "plugin",
"meta": {
"docsUrl": "https://v2.quasar.dev/options/platform-detection"
},
"injection": "$q.platform",
"props": {
"userAgent": {
"type": "String",
"desc": "Client browser User Agent",
"examples": [
"mozilla/5.0 (macintosh; intel mac os x 10_14_5) applewebkit/537.36 (khtml, like gecko) chrome/75.0.3770.100 safari/537.36"
]
},
"is": {
"type": "Object",
"desc": "Client browser details (property names depend on browser)",
"definition": {
"name": {
"type": "String",
"desc": "Browser name",
"examples": [
"chrome"
]
},
"platform": {
"type": "String",
"desc": "Platform name",
"examples": [
"mac"
]
},
"version": {
"type": "String",
"required": false,
"desc": "Detailed browser version",
"examples": [
"71.0.3578.98"
]
},
"versionNumber": {
"type": "Number",
"required": false,
"desc": "Major browser version as a number"
},
"desktop": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is desktop"
},
"mobile": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is mobile"
},
"electron": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is Electron"
},
"bex": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is BEX(Browser Extension)"
},
"capacitor": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is Capacitor"
},
"cordova": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is Cordova"
},
"nativeMobile": {
"type": "Boolean",
"required": false,
"desc": "Whether the platform is a native mobile wrapper"
},
"nativeMobileWrapper": {
"type": "String",
"required": false,
"values": [
"cordova",
"capacitor"
],
"desc": "Type of the native mobile wrapper"
},
"chrome": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Google Chrome"
},
"firefox": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Firefox"
},
"safari": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Safari"
},
"edgeChromium": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Microsoft Edge (Chromium)"
},
"edge": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Microsoft Edge Legacy"
},
"opera": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Opera"
},
"vivaldi": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Vivaldi"
},
"win": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Windows"
},
"linux": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Linux"
},
"mac": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Mac OS"
},
"cros": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Chrome OS"
},
"android": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Android"
},
"ios": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is iOS"
},
"winphone": {
"type": "Boolean",
"required": false,
"desc": "Whether the operating system is Windows Phone"
},
"iphone": {
"type": "Boolean",
"required": false,
"desc": "Whether the device is an iPhone"
},
"ipad": {
"type": "Boolean",
"required": false,
"desc": "Whether the device is an iPad"
},
"ipod": {
"type": "Boolean",
"required": false,
"desc": "Whether the device is an iPod"
},
"kindle": {
"type": "Boolean",
"required": false,
"desc": "Whether the device is a Kindle"
},
"silk": {
"type": "Boolean",
"required": false,
"desc": "Whether the browser is Amazon Silk"
}
},
"examples": [
"{ chrome: true, version: '71.0.3578.98', versionNumber: 71, mac: true, desktop: true, webkit: true, name: 'chrome', platform: 'mac' }"
]
},
"has": {
"type": "Object",
"desc": "Client browser detectable properties",
"definition": {
"touch": {
"type": "Boolean",
"desc": "Client browser runs on device with touch support"
},
"webStorage": {
"type": "Boolean",
"desc": "Client browser has Web Storage support"
}
},
"examples": [
"{ touch: false, webStorage: true }"
]
},
"within": {
"type": "Object",
"desc": "Client browser environment",
"definition": {
"iframe": {
"type": "Boolean",
"desc": "Does the app run under an iframe?"
}
},
"examples": [
"{ iframe: false }"
]
}
},
"methods": {
"parseSSR": {
"desc": "For SSR usage only, and only on the global import (not on $q.platform)",
"params": {
"ssrContext": {
"type": "Object",
"desc": "SSR Context Object",
"required": true
}
},
"returns": {
"type": "Object",
"tsType": "Platform",
"desc": "Platform object (like $q.platform) for SSR usage purposes"
}
}
}
}

117
node_modules/quasar/dist/api/QAjaxBar.json generated vendored Normal file
View file

@ -0,0 +1,117 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/ajax-bar"
},
"props": {
"position": {
"type": "String",
"desc": "Position within window of where QAjaxBar should be displayed",
"default": "top",
"values": [
"top",
"right",
"bottom",
"left"
],
"category": "style",
"required": false
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style",
"default": "2px",
"required": false
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"reverse": {
"type": "Boolean",
"desc": "Reverse direction of progress",
"category": "behavior"
},
"skip-hijack": {
"type": "Boolean",
"desc": "Skip Ajax hijacking (not a reactive prop)",
"category": "behavior"
},
"hijack-filter": {
"type": "Function",
"desc": "Filter which URL should trigger start() + stop()",
"params": {
"url": {
"type": "String",
"desc": "The URL being triggered",
"examples": [
"https://some.url/path"
]
}
},
"returns": {
"type": "Boolean",
"desc": "Should the URL received as param trigger start() + stop()?"
},
"category": "behavior",
"addedIn": "v2.4.5"
}
},
"events": {
"start": {
"desc": "Emitted when bar is triggered to appear"
},
"stop": {
"desc": "Emitted when bar has finished its job"
}
},
"methods": {
"start": {
"desc": "Notify bar you are waiting for a new process to finish",
"params": {
"speed": {
"type": "Number",
"default": 300,
"desc": "Delay (in milliseconds) between progress auto-increments; If delay is 0 then it disables auto-incrementing",
"required": false
}
},
"returns": {
"type": "Number",
"desc": "Number of active simultaneous sessions"
}
},
"increment": {
"desc": "Manually trigger a bar progress increment",
"params": {
"amount": {
"type": "Number",
"desc": "Amount (0 < x <= 100) to increment with"
}
},
"returns": {
"type": "Number",
"desc": "Number of active simultaneous sessions"
}
},
"stop": {
"desc": "Notify bar that one process you were waiting has finished",
"returns": {
"type": "Number",
"desc": "Number of active simultaneous sessions"
}
}
}
}

76
node_modules/quasar/dist/api/QAvatar.json generated vendored Normal file
View file

@ -0,0 +1,76 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/avatar"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"font-size": {
"type": "String",
"desc": "The size in CSS units, including unit name, of the content (icon, text)",
"examples": [
"18px",
"2rem"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
}
},
"slots": {
"default": {
"desc": "Optional; Suggestions: one character string, <img> tag"
}
}
}

82
node_modules/quasar/dist/api/QBadge.json generated vendored Normal file
View file

@ -0,0 +1,82 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/badge"
},
"props": {
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"floating": {
"type": "Boolean",
"desc": "Tell QBadge if it should float to the top right side of the relative positioned parent element or not",
"category": "content"
},
"transparent": {
"type": "Boolean",
"desc": "Applies a 0.8 opacity; Useful especially for floating QBadge",
"category": "style"
},
"multi-line": {
"type": "Boolean",
"desc": "Content can wrap to multiple lines",
"category": "content"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "Badge's content as string; overrides default slot if specified",
"examples": [
"John Doe",
22
],
"category": "content"
},
"align": {
"type": "String",
"desc": "Sets vertical-align CSS prop",
"values": [
"top",
"middle",
"bottom"
],
"category": "content"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design (colored text and borders only)",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Makes a rounded shaped badge",
"category": "style"
}
},
"slots": {
"default": {
"desc": "This is where QBadge content goes, if not using 'label' property"
}
}
}

39
node_modules/quasar/dist/api/QBanner.json generated vendored Normal file
View file

@ -0,0 +1,39 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/banner"
},
"props": {
"inline-actions": {
"type": "Boolean",
"desc": "Display actions on same row as content",
"category": "content"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
}
},
"slots": {
"default": {
"desc": "This is where Banner content goes"
},
"avatar": {
"desc": "Slot for displaying an avatar (suggestions: QIcon, QAvatar)"
},
"action": {
"desc": "Slot for Banner action (suggestions: QBtn)"
}
}
}

23
node_modules/quasar/dist/api/QBar.json generated vendored Normal file
View file

@ -0,0 +1,23 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/bar"
},
"props": {
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "The component background color lights up the parent's background (as opposed to default behavior which is to darken it); Works unless you specify a CSS background color for it",
"category": "style"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

82
node_modules/quasar/dist/api/QBreadcrumbs.json generated vendored Normal file
View file

@ -0,0 +1,82 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/breadcrumbs"
},
"props": {
"separator": {
"type": "String",
"desc": "The string used to separate the breadcrumbs",
"default": "/",
"examples": [
"-",
"|",
">"
],
"category": "content",
"required": false
},
"active-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "The color of the active breadcrumb, which can be any color from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"default": "primary",
"required": false
},
"gutter": {
"type": "String",
"desc": "The gutter value allows you control over the space between the breadcrumb elements.",
"default": "sm",
"values": [
"none",
"xs",
"sm",
"md",
"lg",
"xl"
],
"category": "content",
"required": false
},
"separator-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "The color used to color the separator, which can be any color from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"align": {
"type": "String",
"default": "left",
"desc": "Specify how to align the breadcrumbs horizontally",
"values": [
"left",
"center",
"right",
"between",
"around",
"evenly"
],
"category": "content",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
},
"separator": {
"desc": "HTML or component you can slot in to separate the breadcrumbs"
}
}
}

162
node_modules/quasar/dist/api/QBreadcrumbsEl.json generated vendored Normal file
View file

@ -0,0 +1,162 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/breadcrumbs"
},
"props": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"exact": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-active-class"
],
"category": "navigation"
},
"exact-active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-exact-active-class"
],
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"https://quasar.dev"
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"label": {
"type": "String",
"desc": "The label text for the breadcrumb",
"examples": [
"Home",
"Index"
],
"category": "content"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"span"
],
"category": "content",
"default": "span",
"required": false
}
},
"slots": {
"default": {
"desc": "This is where custom content goes, unless 'icon' and 'label' props are not enough"
}
},
"events": {
"click": {
"desc": "Emitted when the component is clicked",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"
},
"go": {
"type": "Function",
"desc": "Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else",
"required": false,
"addedIn": "v2.9",
"params": {
"opts": {
"type": "Object",
"desc": "Optional options",
"required": false,
"definition": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop",
"required": false,
"examples": [
"/home/dashboard",
"{ name: 'my-route-name' }"
]
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop",
"required": false
},
"returnRouterError": {
"type": "Boolean",
"desc": "Return the router error, if any; Otherwise the returned Promise will always fulfill",
"required": false
}
}
}
},
"returns": {
"type": "Promise<any>",
"desc": "Returns the router's navigation promise"
}
}
}
}
}
}

349
node_modules/quasar/dist/api/QBtn.json generated vendored Normal file
View file

@ -0,0 +1,349 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/button"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"type": {
"type": "String",
"desc": "1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag",
"default": "button",
"examples": [
"a",
"submit",
"button",
"reset",
"image/png",
"href=\"https://quasar.dev\" target=\"_blank\""
],
"category": "general",
"required": false
},
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to' and 'replace' props",
"examples": [
"https://quasar.dev",
"href=\"https://quasar.dev\" target=\"_blank\""
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only with 'to' or 'href' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "The text that will be shown on the button",
"examples": [
"Button Label"
],
"category": "content"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-right": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a more prominent border-radius for a squared shape button",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style",
"addedIn": "v2.7.6"
},
"glossy": {
"type": "Boolean",
"desc": "Applies a glossy effect",
"category": "style"
},
"fab": {
"type": "Boolean",
"desc": "Makes button size and shape to fit a Floating Action Button",
"category": "style"
},
"fab-mini": {
"type": "Boolean",
"desc": "Makes button size and shape to fit a small Floating Action Button",
"category": "style"
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg",
"2px 2px 5px 7px"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"no-caps": {
"type": "Boolean",
"desc": "Avoid turning label text into caps (which happens by default)",
"category": "content"
},
"no-wrap": {
"type": "Boolean",
"desc": "Avoid label text wrapping",
"category": "content"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure material ripple (disable it by setting it to 'false' or supply a config object)",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"align": {
"type": "String",
"desc": "Label or content alignment",
"default": "center",
"values": [
"left",
"right",
"center",
"around",
"between",
"evenly"
],
"category": "content",
"required": false
},
"stack": {
"type": "Boolean",
"desc": "Stack icon and label vertically instead of on same line (like it is by default)",
"category": "content"
},
"stretch": {
"type": "Boolean",
"desc": "When used on flexbox parent, button will stretch to parent's height",
"category": "content"
},
"loading": {
"type": "Boolean",
"desc": "Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)",
"category": "behavior|state"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"round": {
"type": "Boolean",
"desc": "Makes a circle shaped button",
"category": "style"
},
"percentage": {
"type": "Number",
"desc": "Percentage (0.0 < x < 100.0); To be used along 'loading' prop; Display a progress bar on the background",
"category": "behavior"
},
"dark-percentage": {
"type": "Boolean",
"desc": "Progress bar on the background should have dark color; To be used along with 'percentage' and 'loading' props",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Use for custom content, instead of relying on 'icon' and 'label' props"
},
"loading": {
"desc": "Override the default QSpinner when in 'loading' state"
}
},
"events": {
"click": {
"desc": "Emitted when the component is clicked",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"
},
"go": {
"type": "Function",
"desc": "Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else",
"required": false,
"addedIn": "v2.9",
"params": {
"opts": {
"type": "Object",
"desc": "Optional options",
"required": false,
"definition": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop",
"required": false,
"examples": [
"/home/dashboard",
"{ name: 'my-route-name' }"
]
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop",
"required": false
},
"returnRouterError": {
"type": "Boolean",
"desc": "Return the router error, if any; Otherwise the returned Promise will always fulfill",
"required": false
}
}
}
},
"returns": {
"type": "Promise<any>",
"desc": "Returns the router's navigation promise"
}
}
}
}
},
"methods": {
"click": {
"desc": "Emulate click on QBtn",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
}
}
}

555
node_modules/quasar/dist/api/QBtnDropdown.json generated vendored Normal file
View file

@ -0,0 +1,555 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/button-dropdown"
},
"props": {
"transition-show": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-hide": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "transition",
"required": false
},
"model-value": {
"desc": "Controls Menu show/hidden state; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean",
"examples": [
"v-model=\"menuState\""
]
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"type": {
"type": "String",
"desc": "1) Define the button native type attribute (submit, reset, button) or 2) render component with <a> tag so you can access events even if disable or 3) Use 'href' prop and specify 'type' as a media tag",
"default": "button",
"examples": [
"a",
"submit",
"button",
"reset",
"image/png",
"href=\"https://quasar.dev\" target=\"_blank\""
],
"category": "general",
"required": false
},
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to' and 'replace' props",
"examples": [
"https://quasar.dev",
"href=\"https://quasar.dev\" target=\"_blank\""
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only with 'to' or 'href' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "The text that will be shown on the button",
"examples": [
"Button Label"
],
"category": "content"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-right": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a more prominent border-radius for a squared shape button",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style",
"addedIn": "v2.7.6"
},
"glossy": {
"type": "Boolean",
"desc": "Applies a glossy effect",
"category": "style"
},
"fab": {
"type": "Boolean",
"desc": "Makes button size and shape to fit a Floating Action Button",
"category": "style"
},
"fab-mini": {
"type": "Boolean",
"desc": "Makes button size and shape to fit a small Floating Action Button",
"category": "style"
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg",
"2px 2px 5px 7px"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"no-caps": {
"type": "Boolean",
"desc": "Avoid turning label text into caps (which happens by default)",
"category": "content"
},
"no-wrap": {
"type": "Boolean",
"desc": "Avoid label text wrapping",
"category": "content"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure material ripple (disable it by setting it to 'false' or supply a config object)",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"align": {
"type": "String",
"desc": "Label or content alignment",
"default": "center",
"values": [
"left",
"right",
"center",
"around",
"between",
"evenly"
],
"category": "content",
"required": false
},
"stack": {
"type": "Boolean",
"desc": "Stack icon and label vertically instead of on same line (like it is by default)",
"category": "content"
},
"stretch": {
"type": "Boolean",
"desc": "When used on flexbox parent, button will stretch to parent's height",
"category": "content"
},
"loading": {
"type": "Boolean",
"desc": "Put button into loading state (displays a QSpinner -- can be overridden by using a 'loading' slot)",
"category": "behavior|state"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"split": {
"type": "Boolean",
"desc": "Split dropdown icon into its own button",
"category": "content|behavior"
},
"dropdown-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"disable-main-btn": {
"type": "Boolean",
"desc": "Disable main button (useful along with 'split' prop)",
"category": "behavior"
},
"disable-dropdown": {
"type": "Boolean",
"desc": "Disables dropdown (dropdown button if using along 'split' prop)",
"category": "behavior"
},
"no-icon-animation": {
"type": "Boolean",
"desc": "Disables the rotation of the dropdown icon when state is toggled",
"category": "style"
},
"content-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the menu",
"examples": [
"background-color: #ff0000",
":content-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
},
"content-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the menu",
"examples": [
"my-special-class",
":content-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"cover": {
"type": "Boolean",
"desc": "Allows the menu to cover the button. When used, the 'menu-self' and 'menu-fit' props are no longer effective",
"category": "position"
},
"persistent": {
"type": "Boolean",
"desc": "Allows the menu to not be dismissed by a click/tap outside of the menu or by hitting the ESC key",
"category": "behavior"
},
"no-route-dismiss": {
"type": "Boolean",
"desc": "Changing route app won't dismiss the popup; No need to set it if 'persistent' prop is also set",
"category": "behavior"
},
"auto-close": {
"type": "Boolean",
"desc": "Allows any click/tap in the menu to close it; Useful instead of attaching events to each menu item that should close the menu on click/tap",
"category": "behavior"
},
"menu-anchor": {
"type": "String",
"desc": "Two values setting the starting position or anchor point of the menu relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"default": "bottom end",
"category": "position",
"required": false
},
"menu-self": {
"type": "String",
"desc": "Two values setting the menu's own position relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"default": "top end",
"category": "position",
"required": false
},
"menu-offset": {
"type": "Array",
"desc": "An array of two numbers to offset the menu horizontally and vertically in pixels",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "position"
},
"toggle-aria-label": {
"type": "String",
"desc": "aria-label to be used on the dropdown toggle element",
"examples": [
"Open menu"
],
"category": "accessibility",
"addedIn": "v2.8.4"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
},
"label": {
"desc": "Customize main button's content through this slot, unless you're using the 'icon' and 'label' props"
},
"loading": {
"desc": "Override the default QSpinner when in 'loading' state",
"addedIn": "v2.8"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when showing/hidden state changes; Is also used by v-model",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"click": {
"desc": "Emitted when user clicks/taps on the main button (not the icon one, if using 'split')",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
}
}
}

59
node_modules/quasar/dist/api/QBtnGroup.json generated vendored Normal file
View file

@ -0,0 +1,59 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/button-group"
},
"props": {
"spread": {
"type": "Boolean",
"desc": "Spread horizontally to all available space",
"category": "content"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design for buttons",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design for buttons",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow on buttons",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a more prominent border-radius for squared shape buttons",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style",
"addedIn": "v2.7.6"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design for buttons",
"category": "style"
},
"stretch": {
"type": "Boolean",
"desc": "When used on flexbox parent, buttons will stretch to parent's height",
"category": "content"
},
"glossy": {
"type": "Boolean",
"desc": "Applies a glossy effect",
"category": "style"
}
},
"slots": {
"default": {
"desc": "Suggestion: QBtn"
}
}
}

263
node_modules/quasar/dist/api/QBtnToggle.json generated vendored Normal file
View file

@ -0,0 +1,263 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/button-toggle"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "Any",
"examples": [
"v-model=\"selected\""
]
},
"options": {
"type": "Array",
"desc": "Array of Objects defining each option",
"required": true,
"definition": {
"attrs": {
"type": "Object",
"desc": "Key-value for attributes to be set on the button",
"examples": [
"{ 'aria-label': 'Button label' }"
]
},
"label": {
"type": "String",
"desc": "Label of option button; Use this prop and/or 'icon', but at least one is required",
"examples": [
"Option 1"
]
},
"icon": {
"type": "String",
"desc": "Icon of option button; Use this prop and/or 'label', but at least one is required",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"value": {
"type": "Any",
"desc": "Value of the option that will be used by component model",
"required": true
},
"slot": {
"type": "String",
"desc": "Slot name to use for this button content; Useful for customizing content or even add tooltips",
"examples": [
"mySlot"
]
},
"...props": {
"type": "Any",
"desc": "Any other QBtn props (including class and style)"
}
},
"examples": [
"[ {label: 'One', value: 'one'}, {label: 'Two', value: 'two'} ]"
],
"category": "model"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"toggle-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"default": "primary",
"required": false
},
"toggle-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"spread": {
"type": "Boolean",
"desc": "Spread horizontally to all available space",
"category": "content"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a more prominent border-radius for a squared shape button",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design",
"category": "style"
},
"glossy": {
"type": "Boolean",
"desc": "Applies a glossy effect",
"category": "style"
},
"size": {
"type": "String",
"desc": "Button size name or a CSS unit including unit name",
"examples": [
"xs",
"sm",
"md",
"lg",
"xl",
"25px",
"2rem"
],
"category": "style"
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg",
"2px 2px 5px 7px"
],
"category": "style"
},
"no-caps": {
"type": "Boolean",
"desc": "Avoid turning label text into caps (which happens by default)",
"category": "content"
},
"no-wrap": {
"type": "Boolean",
"desc": "Avoid label text wrapping",
"category": "content"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure material ripple (disable it by setting it to 'false' or supply a config object)",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"stack": {
"type": "Boolean",
"desc": "Stack icon and label vertically instead of on same line (like it is by default)",
"category": "content"
},
"stretch": {
"type": "Boolean",
"desc": "When used on flexbox parent, button will stretch to parent's height",
"category": "content"
},
"clearable": {
"type": "Boolean",
"desc": "Clears model on click of the already selected button",
"category": "model"
}
},
"slots": {
"default": {
"desc": "Suggestions: QTooltip, QBadge"
},
"...": {
"desc": "Any other dynamic slots to be used with 'slot' property of the 'options' prop"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"clear": {
"desc": "When using the 'clearable' property, this event is emitted when the already selected button is clicked"
}
}
}

46
node_modules/quasar/dist/api/QCard.json generated vendored Normal file
View file

@ -0,0 +1,46 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/card"
},
"props": {
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Applies a 'flat' design (no default shadow)",
"category": "style"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"form"
],
"category": "content",
"default": "div",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

34
node_modules/quasar/dist/api/QCardActions.json generated vendored Normal file
View file

@ -0,0 +1,34 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/card"
},
"props": {
"align": {
"type": "String",
"desc": "Specify how to align the actions",
"default": "left (for horizontal mode) / stretch (for vertical mode)",
"values": [
"left",
"center",
"right",
"between",
"around",
"evenly",
"stretch"
],
"category": "content",
"required": false
},
"vertical": {
"type": "Boolean",
"desc": "Display actions one below the other",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Suggestions: QBtn"
}
}
}

31
node_modules/quasar/dist/api/QCardSection.json generated vendored Normal file
View file

@ -0,0 +1,31 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/card"
},
"props": {
"horizontal": {
"type": "Boolean",
"desc": "Display a horizontal section (will have no padding and can contain other QCardSection)",
"category": "content"
},
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"form"
],
"category": "content",
"default": "div",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

416
node_modules/quasar/dist/api/QCarousel.json generated vendored Normal file
View file

@ -0,0 +1,416 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/carousel"
},
"props": {
"fullscreen": {
"type": "Boolean",
"sync": true,
"desc": "Fullscreen mode",
"examples": [
"v-model:fullscreen=\"isFullscreen\""
],
"category": "behavior",
"syncable": true
},
"no-route-fullscreen-exit": {
"type": "Boolean",
"desc": "Changing route app won't exit fullscreen",
"category": "behavior"
},
"model-value": {
"type": "Any",
"desc": "Model of the component defining the current panel's name; If a Number is used, it does not define the panel's index, but rather the panel's name which can also be an Integer; Either use this property (along with a listener for 'update:model-value' event) OR use the v-model directive.",
"examples": [
"v-model=\"panelName\""
],
"category": "model"
},
"keep-alive": {
"type": "Boolean",
"desc": "Equivalent to using Vue's native <keep-alive> component on the content",
"category": "behavior"
},
"keep-alive-include": {
"type": [
"String",
"Array",
"RegExp"
],
"desc": "Equivalent to using Vue's native include prop for <keep-alive>; Values must be valid Vue component names",
"examples": [
"a,b",
"/a|b/",
"['a', 'b']"
],
"category": "behavior"
},
"keep-alive-exclude": {
"type": [
"String",
"Array",
"RegExp"
],
"desc": "Equivalent to using Vue's native exclude prop for <keep-alive>; Values must be valid Vue component names",
"examples": [
"a,b",
"/a|b/",
"['a', 'b']"
],
"category": "behavior"
},
"keep-alive-max": {
"type": "Number",
"desc": "Equivalent to using Vue's native max prop for <keep-alive>",
"category": "behavior"
},
"animated": {
"type": "Boolean",
"desc": "Enable transitions between panel (also see 'transition-prev' and 'transition-next' props)",
"category": "behavior"
},
"infinite": {
"type": "Boolean",
"desc": "Makes component appear as infinite (when reaching last panel, next one will become the first one)",
"category": "behavior"
},
"swipeable": {
"type": "Boolean",
"desc": "Enable swipe events (may interfere with content's touch/mouse events)",
"category": "behavior"
},
"vertical": {
"type": "Boolean",
"desc": "Default transitions and swipe actions will be on the vertical axis",
"category": "behavior"
},
"transition-prev": {
"type": "String",
"desc": "One of Quasar's embedded transitions (has effect only if 'animated' prop is set)",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-next": {
"type": "String",
"desc": "One of Quasar's embedded transitions (has effect only if 'animated' prop is set)",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "transition",
"addedIn": "v2.2",
"required": false
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"height": {
"type": "String",
"desc": "Height of Carousel in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"padding": {
"type": "Boolean",
"desc": "Applies a default padding to each slide, according to the usage of 'arrows' and 'navigation' props",
"category": "content"
},
"control-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for QCarousel button controls (arrows, navigation) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"control-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for text color of QCarousel button controls (arrows, navigation) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"control-type": {
"type": "String",
"desc": "Type of button to use for controls (arrows, navigation)",
"values": [
"regular",
"flat",
"outline",
"push",
"unelevated"
],
"category": "style"
},
"autoplay": {
"type": [
"Number",
"Boolean"
],
"desc": "Jump to next slide (if 'true' or val > 0) or previous slide (if val < 0) at fixed time intervals (in milliseconds); 'false' disables autoplay, 'true' enables it for 5000ms intervals",
"default": false,
"examples": [
":autoplay=\"2500\"",
true,
false
],
"category": "behavior",
"required": false
},
"arrows": {
"type": "Boolean",
"desc": "Show navigation arrow buttons",
"category": "content"
},
"prev-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"next-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"navigation": {
"type": "Boolean",
"desc": "Show navigation dots",
"category": "content"
},
"navigation-position": {
"type": "String",
"desc": "Side to stick navigation to",
"default": "bottom/right",
"values": [
"top",
"right",
"bottom",
"left"
],
"category": "content",
"required": false
},
"navigation-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"navigation-active-icon": {
"type": "String",
"desc": "Icon name following Quasar convention for the active (current slide) navigation icon; Make sure you have the icon library installed unless you are using 'img:' prefix",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"thumbnails": {
"type": "Boolean",
"desc": "Show thumbnails",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Suggestion: QCarouselSlide"
},
"control": {
"desc": "Slot specific for QCarouselControl"
},
"navigation-icon": {
"desc": "Slot for navigation icon/btn; Suggestion: QBtn",
"scope": {
"index": {
"type": "Number",
"desc": "The 0-based index of corresponding slide"
},
"maxIndex": {
"type": "Number",
"desc": "The available number of slides"
},
"name": {
"type": "Any",
"desc": "The name of the corresponding slide"
},
"active": {
"type": "Boolean",
"desc": "Is this the current slide?"
},
"btnProps": {
"type": "Object",
"desc": "Default QBtn props that can be binded to your own QBtn"
},
"onClick": {
"type": "Function",
"desc": "Default trigger when clicked/tapped on",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
},
"returns": null
}
}
}
},
"events": {
"fullscreen": {
"desc": "Emitted when fullscreen state changes",
"params": {
"value": {
"type": "Boolean",
"desc": "Fullscreen state (showing/hidden)"
}
}
},
"update:model-value": {
"desc": "Emitted when the component changes the model; This event _isn't_ fired if the model is changed externally; Is also used by v-model",
"params": {
"value": {
"type": [
"String",
"Number"
],
"desc": "New current panel name",
"examples": [
"dashboard"
]
}
}
},
"before-transition": {
"desc": "Emitted before transitioning to a new panel",
"params": {
"newVal": {
"type": [
"String",
"Number"
],
"desc": "Panel name towards transition is going",
"examples": [
"dashboard"
]
},
"oldVal": {
"type": [
"String",
"Number"
],
"desc": "Panel name from which transition is happening",
"examples": [
"dashboard"
]
}
}
},
"transition": {
"desc": "Emitted after component transitioned to a new panel",
"params": {
"newVal": {
"type": [
"String",
"Number"
],
"desc": "Panel name towards transition has occurred",
"examples": [
"dashboard"
]
},
"oldVal": {
"type": [
"String",
"Number"
],
"desc": "Panel name from which transition has happened",
"examples": [
"dashboard"
]
}
}
}
},
"methods": {
"toggleFullscreen": {
"desc": "Toggle the view to be fullscreen or not fullscreen"
},
"setFullscreen": {
"desc": "Enter the fullscreen view"
},
"exitFullscreen": {
"desc": "Leave the fullscreen view"
},
"next": {
"desc": "Go to next panel"
},
"previous": {
"desc": "Go to previous panel"
},
"goTo": {
"desc": "Go to specific panel",
"params": {
"panelName": {
"type": [
"String",
"Number"
],
"desc": "Panel's name, which may be a String or Number; Number does not refers to panel index, but to its name, which may be an Integer",
"required": true,
"examples": [
"dashboard"
]
}
}
}
}
}

41
node_modules/quasar/dist/api/QCarouselControl.json generated vendored Normal file
View file

@ -0,0 +1,41 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/carousel"
},
"props": {
"position": {
"type": "String",
"desc": "Side/corner to stick to",
"default": "bottom-right",
"values": [
"top-right",
"top-left",
"bottom-right",
"bottom-left",
"top",
"right",
"bottom",
"left"
],
"category": "position",
"required": false
},
"offset": {
"type": "Array",
"desc": "An array of two numbers to offset the component horizontally and vertically (in pixels)",
"default": "[18, 18]",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "position",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

44
node_modules/quasar/dist/api/QCarouselSlide.json generated vendored Normal file
View file

@ -0,0 +1,44 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/carousel"
},
"props": {
"name": {
"type": "Any",
"desc": "Slide name",
"required": true,
"examples": [
"accounts",
"firstPanel",
":name=\"1\"",
"accounts",
"firstSlide",
":name=\"1\""
],
"category": "model"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"img-src": {
"type": "String",
"desc": "URL pointing to a slide background image (use public folder)",
"transformAssetUrls": true,
"examples": [
"(public folder) src=\"img/my-bg.png\"",
"(assets folder) src=\"~assets/my-img.png\"",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) src=\"https://picsum.photos/500/300\""
],
"category": "model"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

128
node_modules/quasar/dist/api/QChatMessage.json generated vendored Normal file
View file

@ -0,0 +1,128 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/chat"
},
"props": {
"sent": {
"type": "Boolean",
"desc": "Render as a sent message (so from current user)",
"category": "content"
},
"label": {
"type": "String",
"desc": "Renders a label header/section only",
"examples": [
"Friday, 18th"
],
"category": "content"
},
"bg-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name (from the Quasar Color Palette) for chat bubble background",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name (from the Quasar Color Palette) for chat bubble text",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"name": {
"type": "String",
"desc": "Author's name",
"examples": [
"John Doe"
],
"category": "content"
},
"avatar": {
"type": "String",
"desc": "URL to the avatar image of the author",
"transformAssetUrls": true,
"examples": [
"(public folder) src=\"boy-avatar.png\"",
"(assets folder) src=\"~assets/boy-avatar.png\"",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) src=\"https://picsum.photos/500/300\""
],
"category": "content"
},
"text": {
"type": "Array",
"desc": "Array of strings that are the message body. Strings are not sanitized (see details in docs)",
"examples": [
":text=\"['How are you?']\"",
":text=\"['I\\'m good, thank you!', 'And you?']\""
],
"category": "content"
},
"stamp": {
"type": "String",
"desc": "Creation timestamp",
"examples": [
"13:55",
"Yesterday at 13:51"
],
"category": "content"
},
"size": {
"type": "String",
"desc": "1-12 out of 12 (same as col-*)",
"examples": [
"4",
"6",
"12"
],
"category": "style"
},
"label-html": {
"type": "Boolean",
"desc": "Render the label as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
"category": "behavior"
},
"name-html": {
"type": "Boolean",
"desc": "Render the name as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
"category": "behavior"
},
"text-html": {
"type": "Boolean",
"desc": "Render the text as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
"category": "behavior"
},
"stamp-html": {
"type": "Boolean",
"desc": "Render the stamp as HTML; This can lead to XSS attacks so make sure that you sanitize the message first",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "You can use this slot to define a custom message (overrides props)"
},
"avatar": {
"desc": "Slot for avatar; Suggestion: QAvatar, img"
},
"name": {
"desc": "Slot for name; Overrides the 'name' prop"
},
"stamp": {
"desc": "Slot for stamp; Overrides the 'stamp' prop"
},
"label": {
"desc": "Slot for label; Overrides the 'label' prop"
}
}
}

206
node_modules/quasar/dist/api/QCheckbox.json generated vendored Normal file
View file

@ -0,0 +1,206 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/checkbox"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"Any",
"Array"
],
"examples": [
"false",
"['car', 'building']"
]
},
"val": {
"type": "Any",
"desc": "Works when model ('value') is Array. It tells the component which value should add/remove when ticked/unticked",
"examples": [
"car"
],
"category": "model"
},
"true-value": {
"type": "Any",
"desc": "What model value should be considered as checked/ticked/on?",
"default": true,
"examples": [
"Agreed"
],
"category": "model",
"required": false
},
"false-value": {
"type": "Any",
"desc": "What model value should be considered as unchecked/unticked/off?",
"default": false,
"examples": [
"Disagree"
],
"category": "model",
"required": false
},
"indeterminate-value": {
"type": "Any",
"desc": "What model value should be considered as 'indeterminate'?",
"default": null,
"examples": [
0,
"not_answered"
],
"category": "behavior",
"required": false
},
"toggle-order": {
"type": "String",
"desc": "Determines toggle order of the two states ('t' stands for state of true, 'f' for state of false); If 'toggle-indeterminate' is true, then the order is: indet -> first state -> second state -> indet (and repeat), otherwise: indet -> first state -> second state -> first state -> second state -> ...",
"default": "tf",
"values": [
"tf",
"ft"
],
"category": "behavior",
"required": false
},
"toggle-indeterminate": {
"type": "Boolean",
"desc": "When user clicks/taps on the component, should we toggle through the indeterminate state too?",
"category": "behavior"
},
"label": {
"type": "String",
"desc": "Label to display along the component (or use the default slot instead of this prop)",
"examples": [
"I agree with the Terms and Conditions"
],
"category": "label"
},
"left-label": {
"type": "Boolean",
"desc": "Label (if any specified) should be displayed on the left side of the component",
"category": "label"
},
"checked-icon": {
"type": "String",
"examples": [
"visibility"
],
"category": "icons",
"desc": "The icon to be used when the model is truthy (instead of the default design)",
"addedIn": "v2.5"
},
"unchecked-icon": {
"type": "String",
"examples": [
"visibility_off"
],
"category": "icons",
"desc": "The icon to be used when the toggle is falsy (instead of the default design)",
"addedIn": "v2.5"
},
"indeterminate-icon": {
"type": "String",
"examples": [
"help"
],
"category": "icons",
"desc": "The icon to be used when the model is indeterminate (instead of the default design)",
"addedIn": "v2.5"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"keep-color": {
"type": "Boolean",
"desc": "Should the color (if specified any) be kept when the component is unticked/ off?",
"category": "behavior"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
}
},
"slots": {
"default": {
"desc": "Default slot can be used as label, unless 'label' prop is specified; Suggestion: string"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
},
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"toggle": {
"desc": "Toggle the state (of the model)"
}
}
}

222
node_modules/quasar/dist/api/QChip.json generated vendored Normal file
View file

@ -0,0 +1,222 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/chip"
},
"props": {
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"size": {
"type": "String",
"desc": "QChip size name or a CSS unit including unit name",
"examples": [
"xs",
"sm",
"md",
"lg",
"xl",
"25px",
"2rem"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-right": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-remove": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-selected": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "Chip's content as string; overrides default slot if specified",
"examples": [
"John Doe",
"Book"
],
"category": "content"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"model-value": {
"desc": "Model of the component determining if QChip should be rendered or not",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean",
"default": true
},
"selected": {
"type": "Boolean",
"sync": true,
"desc": "Model for QChip if it's selected or not",
"examples": [
"v-model:selected=\"myState\""
],
"category": "model",
"syncable": true
},
"square": {
"type": "Boolean",
"desc": "Sets a low value for border-radius instead of the default one, making it close to a square",
"category": "style"
},
"outline": {
"type": "Boolean",
"desc": "Display using the 'outline' design",
"category": "style"
},
"clickable": {
"type": "Boolean",
"desc": "Is QChip clickable? If it's the case, then it will add hover effects and emit 'click' events",
"category": "state"
},
"removable": {
"type": "Boolean",
"desc": "If set, then it displays a 'remove' icon that when clicked the QChip emits 'remove' event",
"category": "state"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure material ripple (disable it by setting it to 'false' or supply a config object)",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
},
"remove-aria-label": {
"type": "String",
"desc": "aria-label to be used on the remove icon",
"examples": [
"Remove item"
],
"category": "accessibility",
"addedIn": "v2.8.4"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
}
},
"slots": {
"default": {
"desc": "This is where QChip content goes, if not using 'label' property"
}
},
"events": {
"click": {
"desc": "Emitted on QChip click if 'clickable' property is set",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"update:selected": {
"desc": "Used by Vue on 'v-model:selected' for updating its value",
"params": {
"state": {
"type": "Boolean",
"desc": "Selected state"
}
}
},
"remove": {
"desc": "Works along with 'value' and 'removable' prop. Emitted when toggling rendering state of the QChip",
"params": {
"state": {
"type": "Boolean",
"desc": "Render state (render or not)"
}
}
}
}
}

145
node_modules/quasar/dist/api/QCircularProgress.json generated vendored Normal file
View file

@ -0,0 +1,145 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/circular-progress"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"value": {
"type": "Number",
"default": 0,
"desc": "Current progress (must be between min/max)",
"category": "model",
"required": false
},
"min": {
"type": "Number",
"default": 0,
"desc": "Minimum value defining 'no progress' (must be lower than 'max')",
"category": "model",
"required": false
},
"max": {
"type": "Number",
"default": 100,
"desc": "Maximum value defining 100% progress made (must be higher than 'min')",
"category": "model",
"required": false
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the arc progress from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"center-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the center part of the component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the track of the component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"font-size": {
"type": "String",
"desc": "Size of text in CSS units, including unit name. Suggestion: use 'em' units to sync with component size",
"default": "0.25em",
"examples": [
"1em",
"16px",
"2rem"
],
"category": "style",
"required": false
},
"rounded": {
"type": "Boolean",
"desc": "Rounding the arc of progress",
"category": "style",
"addedIn": "v2.8.4"
},
"thickness": {
"type": "Number",
"default": 0.2,
"desc": "Thickness of progress arc as a ratio (0.0 < x < 1.0) of component size",
"category": "style",
"required": false
},
"angle": {
"type": "Number",
"desc": "Angle to rotate progress arc by",
"default": 0,
"category": "content",
"required": false
},
"indeterminate": {
"type": "Boolean",
"desc": "Put component into 'indeterminate' state; Ignores 'value' prop",
"category": "behavior"
},
"show-value": {
"type": "Boolean",
"desc": "Enables the default slot and uses it (if available), otherwise it displays the 'value' prop as text; Make sure the text has enough space to be displayed inside the component",
"category": "content|behavior"
},
"reverse": {
"type": "Boolean",
"desc": "Reverses the direction of progress; Only for determined state",
"category": "behavior"
},
"instant-feedback": {
"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",
"required": false
}
},
"slots": {
"default": {
"desc": "Used for component content only if 'show-value' prop is set; Make sure the content has enough space to be displayed inside the component"
}
}
}

145
node_modules/quasar/dist/api/QColor.json generated vendored Normal file
View file

@ -0,0 +1,145 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/color-picker"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"String",
"null",
"undefined"
],
"examples": [
"v-model=\"myColor\""
]
},
"default-value": {
"type": "String",
"desc": "The default value to show when the model doesn't have one",
"examples": [
"default-value=\"#c0c0c0\""
],
"category": "model"
},
"default-view": {
"type": "String",
"desc": "The default view of the picker",
"default": "spectrum",
"values": [
"spectrum",
"tune",
"palette"
],
"category": "behavior",
"required": false
},
"format-model": {
"type": "String",
"desc": "Forces a certain model format upon the model",
"default": "auto",
"values": [
"auto",
"hex",
"rgb",
"hexa",
"rgba"
],
"category": "model",
"required": false
},
"palette": {
"type": "Array",
"desc": "Use a custom palette of colors for the palette tab",
"default": "(hard-coded palette)",
"examples": [
":palette=\"[ '#019A9D', '#D9B801', 'rgb(23,120,0)', '#B2028A' ]\""
],
"category": "content",
"required": false
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Applies a 'flat' design (no default shadow)",
"category": "style"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"no-header": {
"type": "Boolean",
"desc": "Do not render header",
"category": "content"
},
"no-header-tabs": {
"type": "Boolean",
"desc": "Do not render header tabs (only the input)",
"category": "content",
"addedIn": "v2.2"
},
"no-footer": {
"type": "Boolean",
"desc": "Do not render footer; Useful when you want a specific view ('default-view' prop) and don't want the user to be able to switch it",
"category": "content"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": [
"String",
"null"
],
"desc": "New model value",
"required": true
}
}
},
"change": {
"desc": "Emitted on lazy model value change (after user finishes selecting a color)",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
}
}
}

632
node_modules/quasar/dist/api/QDate.json generated vendored Normal file
View file

@ -0,0 +1,632 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/date"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"landscape": {
"type": "Boolean",
"desc": "Display the component in landscape mode",
"category": "behavior"
},
"mask": {
"type": "String",
"desc": "Mask (formatting string) used for parsing and formatting value",
"category": "model",
"default": "YYYY/MM/DD",
"examples": [
"YYYY-MM-DD",
"MMMM Do, YYYY",
"YYYY-MM-DD HH:mm:ss"
],
"required": false
},
"locale": {
"type": "Object",
"desc": "Locale formatting options",
"examples": [
":locale=\"{ monthsShort: ['Ian', 'Feb', 'Mar', '...'] }\""
],
"definition": {
"days": {
"type": "Array",
"desc": "List of full day names (DDDD), starting with Sunday",
"examples": [
"['Duminica', 'Luni', 'Marti', '...']"
]
},
"daysShort": {
"type": "Array",
"desc": "List of short day names (DDD), starting with Sunday",
"examples": [
"['Dum', 'Lun', 'Mar', '...']"
]
},
"months": {
"type": "Array",
"desc": "List of full month names (MMMM), starting with January",
"examples": [
"['Ianuarie', 'Februarie', 'Martie', '...']"
]
},
"monthsShort": {
"type": "Array",
"desc": "List of short month names (MMM), starting with January",
"examples": [
"['Ian', 'Feb', 'Mar', '...']"
]
}
},
"category": "model"
},
"calendar": {
"type": "String",
"desc": "Specify calendar type",
"default": "gregorian",
"values": [
"gregorian",
"persian"
],
"category": "model",
"required": false
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Applies a 'flat' design (no default shadow)",
"category": "style"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"model-value": {
"desc": "Date(s) of the component; Must be Array if using 'multiple' prop; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"String",
"Array",
"Object",
"null",
"undefined"
],
"examples": [
"v-model=\"myDate\"",
"v-model=\"[myDate1, myDate2]\"",
"v-model=\"[{ from: myDateFrom, to: myDateTo }]\"",
"v-model=\"[myDate1, { from: myDateFrom, to: myDateTo }, myDate2]\""
]
},
"title": {
"type": "String",
"desc": "When specified, it overrides the default header title; Makes sense when not in 'minimal' mode",
"examples": [
"Birthday"
],
"category": "content"
},
"subtitle": {
"type": "String",
"desc": "When specified, it overrides the default header subtitle; Makes sense when not in 'minimal' mode",
"examples": [
"John Doe"
],
"category": "content"
},
"default-year-month": {
"type": "String",
"desc": "The default year and month to display (in YYYY/MM format) when model is unfilled (undefined or null); Please ensure it is within the navigation min/max year-month (if using them)",
"examples": [
"1986/02"
],
"category": "model"
},
"default-view": {
"type": "String",
"desc": "The view which will be displayed by default",
"default": "Calendar",
"values": [
"Calendar",
"Months",
"Years"
],
"category": "model",
"required": false
},
"years-in-month-view": {
"type": "Boolean",
"desc": "Show the years selector in months view",
"category": "behavior"
},
"events": {
"type": [
"Array",
"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\""
],
"category": "model"
},
"event-color": {
"type": [
"String",
"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'\""
],
"category": "style"
},
"options": {
"type": [
"Array",
"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\"",
":options=\"date => date >= '2018/11/03' && date <= '2018/11/15'\""
],
"category": "model"
},
"navigation-min-year-month": {
"type": "String",
"desc": "Lock user from navigating below a specific year+month (in YYYY/MM format); This prop is not used to correct the model; You might want to also use 'default-year-month' prop",
"examples": [
"2020/07"
],
"category": "selection"
},
"navigation-max-year-month": {
"type": "String",
"desc": "Lock user from navigating above a specific year+month (in YYYY/MM format); This prop is not used to correct the model; You might want to also use 'default-year-month' prop",
"examples": [
"2020/10"
],
"category": "selection"
},
"no-unset": {
"type": "Boolean",
"desc": "Remove ability to unselect a date; It does not apply to selecting a range over already selected dates",
"category": "selection"
},
"first-day-of-week": {
"type": [
"String",
"Number"
],
"desc": "Sets the day of the week that is considered the first day (0 - Sunday, 1 - Monday, ...); This day will show in the left-most column of the calendar",
"default": "(based on configured Quasar lang language)",
"examples": [
"first-day-of-week=\"1\"",
":first-day-of-week=\"selectedFirstDayOfTheWeek\""
],
"category": "model",
"required": false
},
"today-btn": {
"type": "Boolean",
"desc": "Display a button that selects the current day",
"category": "content"
},
"minimal": {
"type": "Boolean",
"desc": "Don’t display the header",
"category": "content"
},
"multiple": {
"type": "Boolean",
"desc": "Allow multiple selection; Model must be Array",
"category": "model|selection"
},
"range": {
"type": "Boolean",
"desc": "Allow range selection; Partial compatibility with 'options' prop: selected ranges might also include 'unselectable' days",
"category": "model|selection"
},
"emit-immediately": {
"type": "Boolean",
"desc": "Emit model when user browses month and year too; ONLY for single selection (non-multiple, non-range)",
"category": "model"
}
},
"slots": {
"default": {
"desc": "This is where additional buttons can go"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": [
"String",
"Array",
"Object",
"null"
],
"desc": "New model value",
"required": true
},
"reason": {
"type": "String",
"desc": "Reason of the user interaction (what was picked)",
"values": [
"add-day",
"remove-day",
"add-range",
"remove-range",
"mask",
"locale",
"year",
"month"
]
},
"details": {
"type": "Object",
"desc": "Object of properties on the new model",
"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"
}
}
}
}
}
}
},
"navigation": {
"desc": "Emitted when user navigates to a different month or year (and even when the model changes from an outside source)",
"params": {
"view": {
"type": "Object",
"desc": "Definition of the current view (year, month)",
"definition": {
"year": {
"type": "Number",
"required": true,
"desc": "The year"
},
"month": {
"type": "Number",
"required": true,
"desc": "The month"
}
}
}
}
},
"range-start": {
"desc": "User has started a range selection",
"params": {
"from": {
"type": "Object",
"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"
}
}
}
}
},
"range-end": {
"desc": "User has ended a range selection",
"params": {
"range": {
"type": "Object",
"desc": "Definition of the range",
"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"
}
}
}
}
}
}
}
},
"methods": {
"setToday": {
"desc": "Change model to today"
},
"setView": {
"desc": "Change current view",
"params": {
"view": {
"type": "String",
"required": true,
"desc": "QDate view name",
"values": [
"Calendar",
"Months",
"Years"
]
}
}
},
"offsetCalendar": {
"desc": "Increment or decrement calendar view's month or year",
"params": {
"type": {
"type": "String",
"required": true,
"desc": "What to increment/decrement",
"values": [
"month",
"year"
]
},
"descending": {
"type": "Boolean",
"desc": "Decrement?"
}
}
},
"setCalendarTo": {
"desc": "Change current year and month of the Calendar view; It gets corrected if using navigation-min/max-year-month and sets the current view to Calendar",
"params": {
"year": {
"type": "Number",
"desc": "The year"
},
"month": {
"type": "Number",
"desc": "The month"
}
}
},
"setEditingRange": {
"desc": "Configure the current editing range",
"params": {
"from": {
"type": "Object",
"desc": "Definition of date from where the range begins",
"definition": {
"year": {
"type": "Number",
"desc": "The year"
},
"month": {
"type": "Number",
"desc": "The month"
},
"day": {
"type": "Number",
"desc": "The day of month"
}
}
},
"to": {
"type": "Object",
"desc": "Definition of date to where the range ends",
"definition": {
"year": {
"type": "Number",
"desc": "The year"
},
"month": {
"type": "Number",
"desc": "The month"
},
"day": {
"type": "Number",
"desc": "The day of month"
}
}
}
}
}
}
}

259
node_modules/quasar/dist/api/QDialog.json generated vendored Normal file
View file

@ -0,0 +1,259 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/dialog"
},
"props": {
"transition-show": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-hide": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "transition",
"required": false
},
"model-value": {
"type": "Boolean",
"desc": "Model of the component defining shown/hidden state; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"category": "model"
},
"persistent": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog if clicking outside of it or hitting ESC key; Also, an app route change won't dismiss it",
"category": "behavior"
},
"no-esc-dismiss": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog by hitting ESC key; No need to set it if 'persistent' prop is also set",
"category": "behavior"
},
"no-backdrop-dismiss": {
"type": "Boolean",
"desc": "User cannot dismiss Dialog by clicking outside of it; No need to set it if 'persistent' prop is also set",
"category": "behavior"
},
"no-route-dismiss": {
"type": "Boolean",
"desc": "Changing route app won't dismiss Dialog; No need to set it if 'persistent' prop is also set",
"category": "behavior"
},
"auto-close": {
"type": "Boolean",
"desc": "Any click/tap inside of the dialog will close it",
"category": "behavior"
},
"seamless": {
"type": "Boolean",
"desc": "Put Dialog into seamless mode; Does not use a backdrop so user is able to interact with the rest of the page too",
"category": "content"
},
"maximized": {
"type": "Boolean",
"desc": "Put Dialog into maximized mode",
"category": "content"
},
"full-width": {
"type": "Boolean",
"desc": "Dialog will try to render with same width as the window",
"category": "content"
},
"full-height": {
"type": "Boolean",
"desc": "Dialog will try to render with same height as the window",
"category": "content"
},
"position": {
"type": "String",
"desc": "Stick dialog to one of the sides (top, right, bottom or left)",
"default": "standard",
"values": [
"standard",
"top",
"right",
"bottom",
"left"
],
"category": "content",
"required": false
},
"square": {
"type": "Boolean",
"desc": "Forces content to have squared borders",
"category": "style"
},
"no-refocus": {
"type": "Boolean",
"desc": "(Accessibility) When Dialog gets hidden, do not refocus on the DOM element that previously had focus",
"category": "behavior"
},
"no-focus": {
"type": "Boolean",
"desc": "(Accessibility) When Dialog gets shown, do not switch focus on it",
"category": "behavior"
},
"no-shake": {
"type": "Boolean",
"desc": "Do not shake up the Dialog to catch user's attention",
"category": "behavior",
"addedIn": "v2.1.1"
},
"allow-focus-outside": {
"type": "Boolean",
"desc": "Allow elements outside of the Dialog to be focusable; By default, for accessibility reasons, QDialog does not allow outer focus",
"category": "behavior",
"addedIn": "v2.7.2"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when showing/hidden state changes; Is also used by v-model",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"shake": {
"desc": "Emitted when the Dialog shakes in order to catch user's attention, unless the 'no-shake' property is set"
},
"escape-key": {
"desc": "Emitted when ESC key is pressed; Does not get emitted if Dialog is 'persistent' or it has 'no-esc-key' set"
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
},
"focus": {
"desc": "Focus dialog; if you have content with autofocus attribute, it will directly focus it",
"params": {
"selector": {
"type": "String",
"required": false,
"desc": "Optional CSS selector to override default focusable element",
"examples": [
"[tabindex]:not([tabindex=\"-1\"])"
],
"addedIn": "v2.6.5"
}
}
},
"shake": {
"desc": "Shakes dialog",
"params": {
"focusTarget": {
"type": "Element",
"desc": "Optional DOM Element to be focused after shake",
"examples": [
"document.getElementById('example')"
],
"addedIn": "v2.10.1"
}
}
}
},
"computedProps": {
"contentEl": {
"type": "Element",
"desc": "The DOM Element of the rendered content",
"addedIn": "v2.10.1"
}
}
}

267
node_modules/quasar/dist/api/QDrawer.json generated vendored Normal file
View file

@ -0,0 +1,267 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/drawer"
},
"props": {
"model-value": {
"type": "Boolean",
"desc": "Model of the component defining shown/hidden state; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"category": "model"
},
"side": {
"type": "String",
"desc": "Side to attach to",
"values": [
"left",
"right"
],
"default": "left",
"category": "behavior",
"required": false
},
"overlay": {
"type": "Boolean",
"desc": "Puts drawer into overlay mode (does not occupy space on screen, narrowing the page)",
"category": "behavior"
},
"width": {
"type": "Number",
"desc": "Width of drawer (in pixels)",
"default": 300,
"examples": [
":width=\"350\""
],
"category": "style",
"required": false
},
"mini": {
"type": "Boolean",
"desc": "Puts drawer into mini mode",
"category": "behavior"
},
"mini-width": {
"type": "Number",
"desc": "Width of drawer (in pixels) when in mini mode",
"default": 60,
"examples": [
":mini-width=\"100\""
],
"category": "style",
"required": false
},
"mini-to-overlay": {
"type": "Boolean",
"desc": "Mini mode will expand as an overlay",
"category": "behavior"
},
"no-mini-animation": {
"type": "Boolean",
"desc": "Disables animation of the drawer when toggling mini mode",
"category": "behavior",
"addedIn": "v2.12.0"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"breakpoint": {
"type": "Number",
"desc": "Breakpoint (in pixels) of layout width up to which mobile mode is used",
"default": 1023,
"examples": [
1200,
":breakpoint=\"1400\""
],
"category": "behavior",
"required": false
},
"behavior": {
"type": "String",
"desc": "Overrides the default dynamic mode into which the drawer is put on",
"values": [
"default",
"desktop",
"mobile"
],
"default": "default",
"category": "behavior",
"required": false
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"elevated": {
"type": "Boolean",
"desc": "Adds a default shadow to the header",
"category": "style"
},
"persistent": {
"type": "Boolean",
"desc": "Prevents drawer from auto-closing when app's route changes",
"category": "behavior"
},
"show-if-above": {
"type": "Boolean",
"desc": "Forces drawer to be shown on screen on initial render if the layout width is above breakpoint, regardless of v-model; This is the default behavior when SSR is taken over by client on initial render",
"category": "behavior"
},
"no-swipe-open": {
"type": "Boolean",
"desc": "Disables the default behavior where drawer can be swiped into view; Useful for iOS platforms where it might interfere with Safari's 'swipe to go to previous/next page' feature",
"category": "behavior"
},
"no-swipe-close": {
"type": "Boolean",
"desc": "Disables the default behavior where drawer can be swiped out of view (applies to drawer content only); Useful for iOS platforms where it might interfere with Safari's 'swipe to go to previous/next page' feature",
"category": "behavior"
},
"no-swipe-backdrop": {
"type": "Boolean",
"desc": "Disables the default behavior where drawer backdrop can be swiped",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component (overridden by 'mini' slot if used and drawer is in mini mode)"
},
"mini": {
"desc": "Content to show when in mini mode (overrides 'default' slot)"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when showing/hidden state changes; Is also used by v-model",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"on-layout": {
"desc": "Emitted when drawer toggles between occupying space on page or not",
"params": {
"state": {
"type": "Boolean",
"desc": "New state"
}
}
},
"click": {
"desc": "Emitted when user clicks/taps on the component and drawer is NOT in mobile mode; Useful for when taking a decision to toggle mini mode",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"mouseover": {
"desc": "Emitted when user moves mouse cursor over the component and drawer is NOT in mobile mode; Useful for when taking a decision to toggle mini mode",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"mouseout": {
"desc": "Emitted when user moves mouse cursor out of the component and drawer is NOT in mobile mode; Useful for when taking a decision to toggle mini mode",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"mini-state": {
"desc": "Emitted when drawer changes the mini-mode state (sometimes it is forced to do so)",
"params": {
"state": {
"type": "Boolean",
"desc": "New state"
}
}
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
}
}
}

480
node_modules/quasar/dist/api/QEditor.json generated vendored Normal file
View file

@ -0,0 +1,480 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/editor"
},
"props": {
"fullscreen": {
"type": "Boolean",
"sync": true,
"desc": "Fullscreen mode",
"examples": [
"v-model:fullscreen=\"isFullscreen\""
],
"category": "behavior",
"syncable": true
},
"no-route-fullscreen-exit": {
"type": "Boolean",
"desc": "Changing route app won't exit fullscreen",
"category": "behavior"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "String",
"examples": [
"v-model=\"content\""
]
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Applies a 'flat' design (no borders)",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; toolbar buttons are shown on one-line only",
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"min-height": {
"type": "String",
"desc": "CSS unit for the minimum height of the editable area",
"default": "10rem",
"examples": [
"15rem",
"50vh"
],
"category": "style",
"required": false
},
"max-height": {
"type": "String",
"desc": "CSS unit for maximum height of the input area",
"examples": [
"1000px",
"90vh"
],
"category": "style"
},
"height": {
"type": "String",
"desc": "CSS value to set the height of the editable area",
"examples": [
"100px",
"50vh"
],
"category": "style"
},
"definitions": {
"type": "Object",
"desc": "Definition of commands and their buttons to be included in the 'toolbar' prop",
"examples": [
":definitions=\"{ save: { tip: 'Save your work', icon: 'save', label: 'Save', handler: saveWork }, upload: { tip: 'Upload to cloud', icon: 'cloud_upload', label: 'Upload', handler: uploadIt } }\""
],
"definition": {
"...commandName": {
"type": "Object",
"tsType": "QEditorCommand",
"autoDefineTsType": true,
"desc": "Command definition",
"definition": {
"label": {
"type": "String",
"desc": "Label of the button",
"examples": [
"Addresses"
]
},
"tip": {
"type": "String",
"desc": "Text to be displayed as a tooltip on hover",
"examples": [
"Add a contact from the Address Book"
]
},
"htmlTip": {
"type": "String",
"desc": "HTML formatted text to be displayed within a tooltip on hover",
"examples": [
"Add a <span class=\"red\">user</span> from the address book"
]
},
"icon": {
"type": "String",
"desc": "Icon of the button",
"examples": [
"fas fa-address-book"
]
},
"key": {
"type": "Number",
"desc": "Keycode of a key to be used together with the <ctrl> key for use as a shortcut to trigger this element",
"examples": [
"12",
"36"
]
},
"handler": {
"type": "Function",
"desc": "Either this or \"cmd\" is required. Function for when button gets clicked/tapped.",
"params": null,
"returns": null,
"examples": [
"() => this.uploadFile()"
]
},
"cmd": {
"type": "String",
"desc": "Either this or \"handler\" is required. This must be a valid execCommand method according to the designMode API.",
"examples": [
"insertHTML",
"justifyFull"
]
},
"param": {
"type": "String",
"desc": "Only set a param if using a \"cmd\". This is commonly text or HTML to inject, but is highly dependent upon the specific cmd being called.",
"examples": [
"<img src=\"://uploads/001.jpg\" alt=\"nice pic\" />"
]
},
"disable": {
"type": [
"Boolean",
"Function"
],
"desc": "Is button disabled?",
"returns": {
"type": "Boolean",
"desc": "If true, the button will be disabled"
},
"examples": [
"!user.active",
"() => !checkIfUserIsActive()"
]
},
"type": {
"type": "String",
"desc": "Pass the value \"no-state\" if the button should not have an \"active\" state",
"values": [
null,
"no-state"
],
"examples": [
"no-state"
]
},
"fixedLabel": {
"type": "Boolean",
"desc": "Lock the button label, so it doesn't change based on the child option selected."
},
"fixedIcon": {
"type": "Boolean",
"desc": "Lock the button icon, so it doesn't change based on the child option selected."
},
"highlight": {
"type": "Boolean",
"desc": "Highlight the toolbar button, when a child option has been selected."
}
}
}
},
"category": "toolbar"
},
"fonts": {
"type": "Object",
"desc": "Object with definitions of fonts",
"examples": [
":fonts=\"{ arial: 'Arial', arial_black: 'Arial Black', comic_sans: 'Comic Sans MS' }\""
],
"category": "toolbar"
},
"toolbar": {
"type": "Array",
"desc": "An array of arrays of Objects/Strings that you use to define the construction of the elements and commands available in the toolbar",
"default": [
[
"left",
"center",
"right",
"justify"
],
[
"bold",
"italic",
"underline",
"strike"
],
[
"undo",
"redo"
]
],
"examples": [
[
"left",
"center",
"right",
"justify"
]
],
"category": "toolbar",
"required": false
},
"toolbar-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Font color (from the Quasar Palette) of buttons and text in the toolbar",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "toolbar"
},
"toolbar-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Text color (from the Quasar Palette) of toolbar commands",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "toolbar"
},
"toolbar-toggle-color": {
"type": "String",
"desc": "Choose the active color (from the Quasar Palette) of toolbar commands button",
"default": "primary",
"examples": [
"secondary",
"blue-3"
],
"category": "toolbar",
"required": false
},
"toolbar-bg": {
"type": "String",
"desc": "Toolbar background color (from Quasar Palette)",
"default": "grey-3",
"examples": [
"secondary",
"blue-3"
],
"category": "toolbar",
"required": false
},
"toolbar-outline": {
"type": "Boolean",
"desc": "Toolbar buttons are rendered \"outlined\"",
"category": "toolbar|style"
},
"toolbar-push": {
"type": "Boolean",
"desc": "Toolbar buttons are rendered as a \"push-button\" type",
"category": "toolbar|style"
},
"toolbar-rounded": {
"type": "Boolean",
"desc": "Toolbar buttons are rendered \"rounded\"",
"category": "toolbar|style"
},
"paragraph-tag": {
"type": "String",
"desc": "Paragraph tag to be used",
"values": [
"div",
"p"
],
"category": "behavior"
},
"content-style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Object with CSS properties and values for styling the container of QEditor",
"examples": [
":content-style=\"{ backgroundColor: '#C0C0C0' }\""
],
"category": "style"
},
"content-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes for the input area",
"examples": [
"my-special-class",
":content-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"placeholder": {
"type": "String",
"desc": "Text to display as placeholder",
"examples": [
"Type your story here ..."
],
"category": "content"
}
},
"slots": {
"[command]": {
"desc": "Content for the given command in the toolbar"
}
},
"events": {
"fullscreen": {
"desc": "Emitted when fullscreen state changes",
"params": {
"value": {
"type": "Boolean",
"desc": "Fullscreen state (showing/hidden)"
}
}
},
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "String",
"desc": "The pure HTML of the content",
"required": true
}
}
},
"dropdown-show": {
"desc": "Emitted after a dropdown in the toolbar has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
},
"addedIn": "v2.11.8"
},
"dropdown-before-show": {
"desc": "Emitted when a dropdown in the toolbar triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
},
"addedIn": "v2.11.8"
},
"dropdown-hide": {
"desc": "Emitted after a dropdown in the toolbar has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
},
"addedIn": "v2.11.8"
},
"dropdown-before-hide": {
"desc": "Emitted when a dropdown in the toolbar triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
},
"addedIn": "v2.11.8"
},
"link-show": {
"desc": "Emitted when the toolbar for editing a link is shown",
"addedIn": "v2.11.9"
},
"link-hide": {
"desc": "Emitted when the toolbar for editing a link is hidden",
"addedIn": "v2.11.9"
}
},
"methods": {
"toggleFullscreen": {
"desc": "Toggle the view to be fullscreen or not fullscreen"
},
"setFullscreen": {
"desc": "Enter the fullscreen view"
},
"exitFullscreen": {
"desc": "Leave the fullscreen view"
},
"runCmd": {
"desc": "Run contentEditable command at caret position and range",
"params": {
"cmd": {
"type": "String",
"desc": "Must be a valid execCommand method according to the designMode API",
"examples": [
"copy",
"cut",
"paste"
],
"required": true
},
"param": {
"type": "String",
"desc": "The argument to pass to the command",
"examples": [
"<small>Small Text</small>"
]
},
"update": {
"type": "Boolean",
"desc": "Refresh the toolbar",
"default": true,
"required": false
}
}
},
"refreshToolbar": {
"desc": "Hide the link editor if visible and force the instance to re-render"
},
"focus": {
"desc": "Focus on the contentEditable at saved cursor position"
},
"getContentEl": {
"desc": "Retrieve the content of the Editor",
"returns": {
"type": "Element",
"desc": "Provides the pure HTML within the editable area"
}
}
},
"computedProps": {
"caret": {
"type": "Object",
"tsType": "QEditorCaret",
"desc": "The current caret state"
}
}
}

429
node_modules/quasar/dist/api/QExpansionItem.json generated vendored Normal file
View file

@ -0,0 +1,429 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/expansion-item"
},
"props": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"exact": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-active-class"
],
"category": "navigation"
},
"exact-active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-exact-active-class"
],
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"https://quasar.dev"
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"model-value": {
"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",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"expand-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"expanded-icon": {
"type": "String",
"desc": "Expand icon name (following Quasar convention) for when QExpansionItem is expanded; When used, it also disables the rotation animation of the expand icon; Make sure you have the icon library installed unless you are using 'img:' prefix",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"expand-icon-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Apply custom class(es) to the expand icon item section",
"examples": [
"text-purple"
],
"category": "style"
},
"toggle-aria-label": {
"type": "String",
"desc": "aria-label to be used on the expansion toggle element",
"examples": [
"Open details"
],
"category": "accessibility",
"addedIn": "v2.8.4"
},
"label": {
"type": "String",
"desc": "Header label (unless using 'header' slot)",
"examples": [
"My expansion item"
],
"category": "content"
},
"label-lines": {
"type": [
"Number",
"String"
],
"desc": "Apply ellipsis when there's not enough space to render on the specified number of lines; If more than one line specified, then it will only work on webkit browsers because it uses the '-webkit-line-clamp' CSS property!",
"examples": [
"1",
"3",
":label-lines=\"2\""
],
"category": "content"
},
"caption": {
"type": "String",
"desc": "Header sub-label (unless using 'header' slot)",
"examples": [
"Unread message: 5"
],
"category": "content"
},
"caption-lines": {
"type": [
"Number",
"String"
],
"desc": "Apply ellipsis when there's not enough space to render on the specified number of lines; If more than one line specified, then it will only work on webkit browsers because it uses the '-webkit-line-clamp' CSS property!",
"examples": [
"1",
"3",
":caption-lines=\"2\""
],
"category": "content"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"duration": {
"type": "Number",
"desc": "Animation duration (in milliseconds)",
"default": 300,
"category": "behavior",
"required": false
},
"header-inset-level": {
"type": "Number",
"desc": "Apply an inset to header (unless using 'header' slot); Useful when header avatar/left side is missing but you want to align content with other items that do have a left side, or when you're building a menu",
"examples": [
":header-inset-level=\"1\""
],
"category": "content"
},
"content-inset-level": {
"type": "Number",
"desc": "Apply an inset to content (changes content padding)",
"examples": [
":content-inset-level=\"1\""
],
"category": "content"
},
"expand-separator": {
"type": "Boolean",
"desc": "Apply a top and bottom separator when expansion item is opened",
"category": "content"
},
"default-opened": {
"type": "Boolean",
"desc": "Puts expansion item into open state on initial render; Overridden by v-model if used",
"category": "behavior"
},
"hide-expand-icon": {
"type": "Boolean",
"desc": "Do not show the expand icon",
"category": "content",
"addedIn": "v2.8.4"
},
"expand-icon-toggle": {
"type": "Boolean",
"desc": "Applies the expansion events to the expand icon only and not to the whole header",
"category": "behavior"
},
"switch-toggle-side": {
"type": "Boolean",
"desc": "Switch expand icon side (from default 'right' to 'left')",
"category": "content"
},
"dense-toggle": {
"type": "Boolean",
"desc": "Use dense mode for expand icon",
"category": "style"
},
"group": {
"type": "String",
"desc": "Register expansion item into a group (unique name that must be applied to all expansion items in that group) for coordinated open/close state within the group a.k.a. 'accordion mode'",
"examples": [
"my-emails"
],
"category": "content|behavior"
},
"popup": {
"type": "Boolean",
"desc": "Put expansion list into 'popup' mode",
"category": "behavior"
},
"header-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Apply custom style to the header",
"examples": [
"background: '#ff0000'",
":header-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
},
"header-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Apply custom class(es) to the header",
"examples": [
"my-custom-class",
":header-class=\"{ 'my-custom-class': someCondition }\""
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Slot used for expansion item's content"
},
"header": {
"desc": "Slot used for overriding default header",
"scope": {
"expanded": {
"type": "Boolean",
"desc": "QExpansionItem expanded status",
"addedIn": "v2.7.6"
},
"detailsId": {
"type": "String",
"desc": "QExpansionItem details panel id (for use in aria-controls)",
"addedIn": "v2.8.4"
},
"show": {
"type": "Function",
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Object",
"required": false,
"desc": "JS event object"
}
},
"returns": null,
"addedIn": "v2.8.4"
},
"hide": {
"type": "Function",
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Object",
"required": false,
"desc": "JS event object"
}
},
"returns": null,
"addedIn": "v2.8.4"
},
"toggle": {
"type": "Function",
"desc": "Triggers component to toggle between show/hide",
"params": {
"evt": {
"type": "Object",
"required": false,
"desc": "JS event object"
}
},
"returns": null,
"addedIn": "v2.8.4"
}
}
}
},
"events": {
"update:model-value": {
"desc": "Emitted when showing/hidden state changes; Is also used by v-model",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"after-show": {
"desc": "Emitted when component show animation is finished"
},
"after-hide": {
"desc": "Emitted when component hide animation is finished"
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
}
}
}

347
node_modules/quasar/dist/api/QFab.json generated vendored Normal file
View file

@ -0,0 +1,347 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/floating-action-button"
},
"props": {
"type": {
"type": "String",
"desc": "Define the button HTML DOM type",
"default": "a",
"values": [
"a",
"submit",
"button",
"reset"
],
"category": "general",
"required": false
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design for Fab button",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design for Fab button",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design for Fab button",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow",
"category": "style"
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"glossy": {
"type": "Boolean",
"desc": "Apply the glossy effect over the button",
"category": "style"
},
"external-label": {
"type": "Boolean",
"desc": "Display label besides the FABs, as external content",
"category": "style|content"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "The label that will be shown when Fab is extended",
"examples": [
"Button Label"
],
"category": "content"
},
"label-position": {
"type": "String",
"desc": "Position of the label around the icon",
"values": [
"top",
"right",
"bottom",
"left"
],
"category": "style|content"
},
"hide-label": {
"type": "Boolean",
"desc": "Hide the label; Useful for animation purposes where you toggle the visibility of the label",
"category": "style|content"
},
"label-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the label container",
"examples": [
"my-special-class",
":input-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"label-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the label container",
"examples": [
"background-color: #ff0000",
":input-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Apply a rectangle aspect to the FAB",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"model-value": {
"desc": "Controls state of fab actions (showing/hidden); Works best with v-model directive, otherwise use along listening to 'update:modelValue' event",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"active-icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"hide-icon": {
"type": "Boolean",
"desc": "Hide the icon (don't use any)",
"category": "style|content"
},
"direction": {
"type": "String",
"desc": "Direction to expand Fab Actions to",
"default": "right",
"values": [
"up",
"right",
"down",
"left"
],
"category": "behavior",
"required": false
},
"vertical-actions-align": {
"type": "String",
"desc": "The side of the Fab where Fab Actions will expand (only when direction is 'up' or 'down')",
"default": "center",
"values": [
"left",
"center",
"right"
],
"category": "style|content",
"required": false
},
"persistent": {
"type": "Boolean",
"desc": "By default, Fab Actions are hidden when user navigates to another route and this prop disables this behavior",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "This is where QFabActions may go into"
},
"tooltip": {
"desc": "Slot specifically designed for a QTooltip"
},
"icon": {
"desc": "Slot for icon shown when FAB is closed; Suggestion: QIcon",
"scope": {
"opened": {
"type": "Boolean",
"desc": "FAB is opened"
}
},
"addedIn": "v2.4"
},
"active-icon": {
"desc": "Slot for icon shown when FAB is opened; Suggestion: QIcon",
"scope": {
"opened": {
"type": "Boolean",
"desc": "FAB is opened"
}
},
"addedIn": "v2.4"
},
"label": {
"desc": "Slot for label",
"scope": {
"opened": {
"type": "Boolean",
"desc": "FAB is opened"
}
},
"addedIn": "v2.4"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when fab actions are shown/hidden; Captured by v-model directive",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"show": {
"desc": "Expands fab actions list",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Collapses fab actions list",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
}
}
}

236
node_modules/quasar/dist/api/QFabAction.json generated vendored Normal file
View file

@ -0,0 +1,236 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/floating-action-button"
},
"props": {
"type": {
"type": "String",
"desc": "Define the button HTML DOM type",
"default": "a",
"values": [
"a",
"submit",
"button",
"reset"
],
"category": "general",
"required": false
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design for Fab button",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design for Fab button",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design for Fab button",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow",
"category": "style"
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Overrides text color (if needed); Color name from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"glossy": {
"type": "Boolean",
"desc": "Apply the glossy effect over the button",
"category": "style"
},
"external-label": {
"type": "Boolean",
"desc": "Display label besides the FABs, as external content",
"category": "style|content"
},
"label": {
"type": [
"String",
"Number"
],
"desc": "The label that will be shown when Fab is extended",
"examples": [
"Button Label"
],
"category": "content"
},
"label-position": {
"type": "String",
"desc": "Position of the label around the icon",
"values": [
"top",
"right",
"bottom",
"left"
],
"category": "style|content"
},
"hide-label": {
"type": "Boolean",
"desc": "Hide the label; Useful for animation purposes where you toggle the visibility of the label",
"category": "style|content"
},
"label-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the label container",
"examples": [
"my-special-class",
":input-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"label-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the label container",
"examples": [
"background-color: #ff0000",
":input-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Apply a rectangle aspect to the FAB",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"anchor": {
"type": "String",
"desc": "How to align the Fab Action relative to Fab expand side; By default it uses the align specified in QFab",
"values": [
"start",
"center",
"end"
],
"category": "style|content"
},
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "router"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property",
"category": "router"
}
},
"slots": {
"default": {
"desc": "Suggestion for this slot: QTooltip"
},
"icon": {
"desc": "Slot for icon; Suggestion: QIcon",
"addedIn": "v2.4"
},
"label": {
"desc": "Slot for label",
"addedIn": "v2.4"
}
},
"events": {
"click": {
"desc": "Emitted when user clicks/taps on the component",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"click": {
"desc": "Emulate click on QFabAction",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
}
}
}

427
node_modules/quasar/dist/api/QField.json generated vendored Normal file
View file

@ -0,0 +1,427 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/field"
},
"props": {
"model-value": {
"type": "Any",
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"category": "model"
},
"error": {
"type": "Boolean",
"desc": "Does field have validation errors?",
"category": "behavior"
},
"error-message": {
"type": "String",
"desc": "Validation error message (gets displayed only if 'error' is set to 'true')",
"examples": [
"Username must have at least 5 characters"
],
"category": "content"
},
"no-error-icon": {
"type": "Boolean",
"desc": "Hide error icon when there is an error",
"category": "content"
},
"rules": {
"type": "Array",
"tsType": "ValidationRule",
"desc": "Array of Functions/Strings; If String, then it must be a name of one of the embedded validation rules",
"examples": [
":rules=\"[ val => val.length <= 3 || 'Please use maximum 3 characters' ]\"",
":rules=\"[ 'fulltime' ]\"",
":rules=\"[ (val, rules) => rules.email(val) || 'Please enter a valid email address' ]\""
],
"category": "behavior"
},
"reactive-rules": {
"type": "Boolean",
"desc": "By default a change in the rules does not trigger a new validation until the model changes; If set to true then a change in the rules will trigger a validation; Has a performance penalty, so use it only when you really need it",
"category": "behavior"
},
"lazy-rules": {
"type": [
"Boolean",
"String"
],
"desc": "If set to boolean true then it checks validation status against the 'rules' only after field loses focus for first time; If set to 'ondemand' then it will trigger only when component's validate() method is manually called or when the wrapper QForm submits itself",
"values": [
"(Boolean) true",
"(Boolean) false",
"ondemand"
],
"category": "behavior"
},
"label": {
"type": "String",
"desc": "A text label that will “float” up above the input field, once the field gets focus",
"examples": [
"Username"
],
"category": "content"
},
"stack-label": {
"type": "Boolean",
"desc": "Label will be always shown above the field regardless of field content (if any)",
"category": "content"
},
"hint": {
"type": "String",
"desc": "Helper (hint) text which gets placed below your wrapped form component",
"examples": [
"Fill in between 3 and 12 characters"
],
"category": "content"
},
"hide-hint": {
"type": "Boolean",
"desc": "Hide the helper (hint) text when field doesn't have focus",
"category": "content"
},
"prefix": {
"type": "String",
"desc": "Prefix",
"examples": [
"$"
],
"category": "content"
},
"suffix": {
"type": "String",
"desc": "Suffix",
"examples": [
"@gmail.com"
],
"category": "content"
},
"label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the label from the Quasar Color Palette; Overrides the 'color' prop; The difference from 'color' prop is that the label will always have this color, even when field is not focused",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"bg-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"loading": {
"type": "Boolean",
"desc": "Signals the user a process is in progress by displaying a spinner; Spinner can be customized by using the 'loading' slot.",
"category": "behavior|content"
},
"clearable": {
"type": "Boolean",
"desc": "Appends clearable icon when a value (not undefined or null) is set; When clicked, model becomes null",
"category": "behavior|content"
},
"clear-icon": {
"type": "String",
"desc": "Custom icon to use for the clear button when using along with 'clearable' prop",
"examples": [
"close"
],
"category": "content"
},
"filled": {
"type": "Boolean",
"desc": "Use 'filled' design for the field",
"category": "style"
},
"outlined": {
"type": "Boolean",
"desc": "Use 'outlined' design for the field",
"category": "style"
},
"borderless": {
"type": "Boolean",
"desc": "Use 'borderless' design for the field",
"category": "style"
},
"standout": {
"type": [
"Boolean",
"String"
],
"desc": "Use 'standout' design for the field; Specifies classes to be applied when focused (overriding default ones)",
"examples": [
"standout",
"standout=\"bg-primary text-white\""
],
"category": "style"
},
"label-slot": {
"type": "Boolean",
"desc": "Enables label slot; You need to set it to force use of the 'label' slot if the 'label' prop is not set",
"category": "content"
},
"bottom-slots": {
"type": "Boolean",
"desc": "Enables bottom slots ('error', 'hint', 'counter')",
"category": "content"
},
"hide-bottom-space": {
"type": "Boolean",
"desc": "Do not reserve space for hint/error/counter anymore when these are not used; As a result, it also disables the animation for those; It also allows the hint/error area to stretch vertically based on its content",
"category": "style"
},
"counter": {
"type": "Boolean",
"desc": "Show an automatic counter on bottom right",
"category": "content"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Remove border-radius so borders are squared; Overrides 'rounded' prop",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"item-aligned": {
"type": "Boolean",
"desc": "Match inner content alignment to that of QItem",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"autofocus": {
"type": "Boolean",
"desc": "Focus field on initial component render",
"category": "behavior"
},
"for": {
"type": "String",
"desc": "Used to specify the 'id' of the control and also the 'for' attribute of the label that wraps it; If no 'name' prop is specified, then it is used for this attribute as well",
"examples": [
"myFieldsId"
],
"category": "behavior"
},
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms; If not specified, it takes the value of 'for' prop, if it exists",
"examples": [
"car_id"
],
"category": "behavior"
},
"maxlength": {
"type": [
"String",
"Number"
],
"desc": "Specify a max length of model",
"category": "model"
}
},
"slots": {
"default": {
"desc": "Field main content"
},
"prepend": {
"desc": "Prepend inner field; Suggestions: QIcon, QBtn"
},
"append": {
"desc": "Append to inner field; Suggestions: QIcon, QBtn"
},
"before": {
"desc": "Prepend outer field; Suggestions: QIcon, QBtn"
},
"after": {
"desc": "Append outer field; Suggestions: QIcon, QBtn"
},
"label": {
"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"
},
"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>"
},
"loading": {
"desc": "Override default spinner when component is in loading mode; Use in conjunction with 'loading' prop"
},
"control": {
"desc": "Slot for controls; Suggestion QSlider, QRange, QKnob, ...",
"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": "Element",
"desc": "DOM element of the field"
},
"editable": {
"type": "Boolean",
"desc": "Field is editable"
},
"focused": {
"type": "Boolean",
"desc": "Field has focus"
},
"floatingLabel": {
"type": "Boolean",
"desc": "Field's label is floating"
},
"modelValue": {
"type": "Any",
"desc": "Field's value",
"examples": [
0.241,
"Text"
]
},
"emitValue": {
"type": "Function",
"desc": "Function that emits an @input event in the context of the field",
"params": {
"value": {
"type": "Any",
"required": true,
"desc": "Value to be emitted",
"examples": [
0,
"Changed text"
]
}
},
"returns": null
}
}
},
"rawControl": {
"internal": true
}
},
"events": {
"clear": {
"desc": "When using the 'clearable' property, this event is emitted when the clear icon is clicked",
"params": {
"value": {
"type": "Any",
"desc": "The previous value before clearing it"
}
}
},
"update:model-value": {
"desc": "Emitted when the model changes, only when used with 'clearable' or the 'control' scoped slot.",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"focus": {
"desc": "Emitted when component gets focused",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"blur": {
"desc": "Emitted when component loses focus",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
}
},
"methods": {
"resetValidation": {
"desc": "Reset validation status"
},
"validate": {
"desc": "Trigger a validation",
"params": {
"value": {
"type": "Any",
"desc": "Optional value to validate against"
}
},
"returns": {
"type": [
"Boolean",
"Promise<boolean>"
],
"desc": "True/false if no async rules, otherwise a Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
"examples": [
"true",
"validate().then(outcome => { ... })"
]
}
},
"focus": {
"desc": "Focus field"
},
"blur": {
"desc": "Blur field (lose focus)"
}
},
"computedProps": {
"hasError": {
"type": "Boolean",
"desc": "Whether the component is in error state"
}
}
}

633
node_modules/quasar/dist/api/QFile.json generated vendored Normal file
View file

@ -0,0 +1,633 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/file"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms; If not specified, it takes the value of 'for' prop, if it exists",
"examples": [
"car_id",
"car_id"
],
"category": "behavior"
},
"multiple": {
"type": "Boolean",
"desc": "Allow multiple file uploads",
"category": "behavior"
},
"accept": {
"type": "String",
"desc": "Comma separated list of unique file type specifiers. Maps to 'accept' attribute of native input type=file element",
"examples": [
".jpg, .pdf, image/*",
"image/jpeg, .pdf"
],
"category": "behavior"
},
"capture": {
"type": "String",
"desc": "Optionally, specify that a new file should be captured, and which device should be used to capture that new media of a type defined by the 'accept' prop. Maps to 'capture' attribute of native input type=file element",
"values": [
"user",
"environment"
],
"category": "behavior"
},
"max-file-size": {
"type": [
"Number",
"String"
],
"desc": "Maximum size of individual file in bytes",
"examples": [
1024,
1048576
],
"category": "behavior"
},
"max-total-size": {
"type": [
"Number",
"String"
],
"desc": "Maximum size of all files combined in bytes",
"category": "behavior"
},
"max-files": {
"type": [
"Number",
"String"
],
"desc": "Maximum number of files to contain",
"category": "behavior"
},
"filter": {
"type": "Function",
"desc": "Custom filter for added files; Only files that pass this filter will be added to the queue and uploaded; For best performance, reference it from your scope and do not define it inline",
"params": {
"files": {
"type": [
"FileList",
"Array"
],
"desc": "Candidate files to be added to queue"
}
},
"returns": {
"type": "Array",
"desc": "Filtered files to be added to queue"
},
"examples": [
":filter=\"files => files.filter(file => file.size === 1024)\""
],
"category": "behavior"
},
"model-value": {
"desc": "Model of the component; Must be FileList or Array if using 'multiple' prop; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"File",
"FileList",
"Array",
"null",
"undefined"
],
"examples": [
"v-model=\"myModel\""
]
},
"error": {
"type": "Boolean",
"desc": "Does field have validation errors?",
"category": "behavior"
},
"error-message": {
"type": "String",
"desc": "Validation error message (gets displayed only if 'error' is set to 'true')",
"examples": [
"Username must have at least 5 characters"
],
"category": "content"
},
"no-error-icon": {
"type": "Boolean",
"desc": "Hide error icon when there is an error",
"category": "content"
},
"rules": {
"type": "Array",
"tsType": "ValidationRule",
"desc": "Array of Functions/Strings; If String, then it must be a name of one of the embedded validation rules",
"examples": [
":rules=\"[ val => val.length <= 3 || 'Please use maximum 3 characters' ]\"",
":rules=\"[ 'fulltime' ]\"",
":rules=\"[ (val, rules) => rules.email(val) || 'Please enter a valid email address' ]\""
],
"category": "behavior"
},
"reactive-rules": {
"type": "Boolean",
"desc": "By default a change in the rules does not trigger a new validation until the model changes; If set to true then a change in the rules will trigger a validation; Has a performance penalty, so use it only when you really need it",
"category": "behavior"
},
"lazy-rules": {
"type": [
"Boolean",
"String"
],
"desc": "If set to boolean true then it checks validation status against the 'rules' only after field loses focus for first time; If set to 'ondemand' then it will trigger only when component's validate() method is manually called or when the wrapper QForm submits itself",
"values": [
"(Boolean) true",
"(Boolean) false",
"ondemand"
],
"category": "behavior"
},
"label": {
"type": "String",
"desc": "A text label that will “float” up above the input field, once the field gets focus",
"examples": [
"Username"
],
"category": "content"
},
"stack-label": {
"type": "Boolean",
"desc": "Label will be always shown above the field regardless of field content (if any)",
"category": "content"
},
"hint": {
"type": "String",
"desc": "Helper (hint) text which gets placed below your wrapped form component",
"examples": [
"Fill in between 3 and 12 characters"
],
"category": "content"
},
"hide-hint": {
"type": "Boolean",
"desc": "Hide the helper (hint) text when field doesn't have focus",
"category": "content"
},
"prefix": {
"type": "String",
"desc": "Prefix",
"examples": [
"$"
],
"category": "content"
},
"suffix": {
"type": "String",
"desc": "Suffix",
"examples": [
"@gmail.com"
],
"category": "content"
},
"label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the label from the Quasar Color Palette; Overrides the 'color' prop; The difference from 'color' prop is that the label will always have this color, even when field is not focused",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"bg-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"loading": {
"type": "Boolean",
"desc": "Signals the user a process is in progress by displaying a spinner; Spinner can be customized by using the 'loading' slot.",
"category": "behavior|content"
},
"clearable": {
"type": "Boolean",
"desc": "Appends clearable icon when a value (not undefined or null) is set; When clicked, model becomes null",
"category": "behavior|content"
},
"clear-icon": {
"type": "String",
"desc": "Custom icon to use for the clear button when using along with 'clearable' prop",
"examples": [
"close"
],
"category": "content"
},
"filled": {
"type": "Boolean",
"desc": "Use 'filled' design for the field",
"category": "style"
},
"outlined": {
"type": "Boolean",
"desc": "Use 'outlined' design for the field",
"category": "style"
},
"borderless": {
"type": "Boolean",
"desc": "Use 'borderless' design for the field",
"category": "style"
},
"standout": {
"type": [
"Boolean",
"String"
],
"desc": "Use 'standout' design for the field; Specifies classes to be applied when focused (overriding default ones)",
"examples": [
"standout",
"standout=\"bg-primary text-white\""
],
"category": "style"
},
"label-slot": {
"type": "Boolean",
"desc": "Enables label slot; You need to set it to force use of the 'label' slot if the 'label' prop is not set",
"category": "content"
},
"bottom-slots": {
"type": "Boolean",
"desc": "Enables bottom slots ('error', 'hint', 'counter')",
"category": "content"
},
"hide-bottom-space": {
"type": "Boolean",
"desc": "Do not reserve space for hint/error/counter anymore when these are not used; As a result, it also disables the animation for those; It also allows the hint/error area to stretch vertically based on its content",
"category": "style"
},
"counter": {
"type": "Boolean",
"desc": "Show an automatic counter on bottom right",
"category": "content"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Remove border-radius so borders are squared; Overrides 'rounded' prop",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"item-aligned": {
"type": "Boolean",
"desc": "Match inner content alignment to that of QItem",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"autofocus": {
"type": "Boolean",
"desc": "Focus field on initial component render",
"category": "behavior"
},
"for": {
"type": "String",
"desc": "Used to specify the 'id' of the control and also the 'for' attribute of the label that wraps it; If no 'name' prop is specified, then it is used for this attribute as well",
"examples": [
"myFieldsId"
],
"category": "behavior"
},
"append": {
"type": "Boolean",
"desc": "Append file(s) to current model rather than replacing them; Has effect only when using 'multiple' mode",
"category": "behavior"
},
"display-value": {
"type": [
"Number",
"String"
],
"desc": "Override default selection string, if not using 'file' or 'selected' scoped slots and if not using 'use-chips' prop",
"examples": [
"Options: x, y, z"
],
"category": "selection"
},
"use-chips": {
"type": "Boolean",
"desc": "Use QChip to show picked files",
"category": "selection"
},
"counter-label": {
"type": "Function",
"desc": "Label for the counter; The 'counter' prop is necessary to enable this one",
"params": {
"props": {
"type": "Object",
"desc": "Object containing counter label information",
"definition": {
"totalSize": {
"type": "String",
"required": true,
"desc": "The total size of files in human readable format",
"examples": [
"1.42MB"
]
},
"filesNumber": {
"type": "Number",
"required": true,
"desc": "Number of picked files"
},
"maxFiles": {
"type": [
"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"
}
}
}
},
"returns": {
"type": "String",
"desc": "String to display for the counter label"
},
"examples": [
":counter-label=\"counterLabelFn\""
],
"category": "behavior"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"input-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the underlying selection container",
"examples": [
"my-special-class",
":input-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"input-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the underlying selection container",
"examples": [
"background-color: #ff0000",
":input-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Field main content"
},
"prepend": {
"desc": "Prepend inner field; Suggestions: QIcon, QBtn"
},
"append": {
"desc": "Append to inner field; Suggestions: QIcon, QBtn"
},
"before": {
"desc": "Prepend outer field; Suggestions: QIcon, QBtn"
},
"after": {
"desc": "Append outer field; Suggestions: QIcon, QBtn"
},
"label": {
"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"
},
"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>"
},
"loading": {
"desc": "Override default spinner when component is in loading mode; Use in conjunction with 'loading' prop"
},
"file": {
"desc": "Override default node to render a file from the user picked list",
"scope": {
"index": {
"type": "Number",
"desc": "Selection index"
},
"file": {
"type": "File",
"desc": "File object"
},
"ref": {
"type": "Component",
"tsType": "QFile",
"desc": "Reference to the QFile component"
}
}
},
"selected": {
"desc": "Override default selection slot; Suggestion: QChip",
"scope": {
"files": {
"type": [
"FileList",
"Array"
],
"desc": "Array of File objects"
},
"ref": {
"type": "Component",
"tsType": "QFile",
"desc": "Reference to the QFile component"
}
}
}
},
"events": {
"rejected": {
"desc": "Emitted after files are picked and some do not pass the validation props (accept, max-file-size, max-total-size, filter, etc)",
"params": {
"rejectedEntries": {
"type": "Array",
"tsType": "QRejectedEntry",
"desc": "Array of { failedPropValidation: string, file: File } Objects for files that do not pass the validation"
}
}
},
"clear": {
"desc": "When using the 'clearable' property, this event is emitted when the clear icon is clicked",
"params": {
"value": {
"type": "Any",
"desc": "The previous value before clearing it"
}
}
},
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
}
},
"methods": {
"pickFiles": {
"desc": "Trigger file pick; Must be called as a direct consequence of user interaction (eg. in a click handler), due to browsers security policy",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"addFiles": {
"desc": "Add files programmatically",
"params": {
"files": {
"type": [
"FileList",
"Array"
],
"desc": "Array of files (instances of File)",
"required": true
}
}
},
"resetValidation": {
"desc": "Reset validation status"
},
"validate": {
"desc": "Trigger a validation",
"params": {
"value": {
"type": "Any",
"desc": "Optional value to validate against"
}
},
"returns": {
"type": [
"Boolean",
"Promise<boolean>"
],
"desc": "True/false if no async rules, otherwise a Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
"examples": [
"true",
"validate().then(outcome => { ... })"
]
}
},
"focus": {
"desc": "Focus component"
},
"blur": {
"desc": "Blur component (lose focus)"
},
"removeAtIndex": {
"desc": "Remove file located at specific index in the model",
"params": {
"index": {
"type": "Number",
"desc": "Index at which to remove selection",
"required": true
}
}
},
"removeFile": {
"desc": "Remove specified file from the model",
"params": {
"file": {
"type": "File",
"desc": "File to remove (instance of File)",
"required": true
}
}
},
"getNativeElement": {
"desc": "DEPRECATED; Access 'nativeEl' directly; Gets the native input DOM Element",
"returns": {
"type": "Element",
"tsType": "QFileNativeElement",
"desc": "The underlying native input DOM Element"
}
}
},
"computedProps": {
"hasError": {
"type": "Boolean",
"desc": "Whether the component is in error state"
},
"nativeEl": {
"type": "Element",
"tsType": "QFileNativeElement",
"desc": "The native input DOM Element",
"addedIn": "v2.10.1"
}
}
}

60
node_modules/quasar/dist/api/QFooter.json generated vendored Normal file
View file

@ -0,0 +1,60 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/header-and-footer"
},
"props": {
"model-value": {
"desc": "Model of the component defining if it is shown or hidden to the user; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean",
"default": true,
"examples": [
"v-model=\"footerState\""
]
},
"reveal": {
"type": "Boolean",
"desc": "Enable 'reveal' mode; Takes into account user scroll to temporarily show/hide footer",
"category": "behavior"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"elevated": {
"type": "Boolean",
"desc": "Adds a default shadow to the footer",
"category": "style"
},
"height-hint": {
"type": [
"Number",
"String"
],
"desc": "When using SSR, you can optionally hint of the height (in pixels) of the QFooter",
"default": 50,
"category": "behavior",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component; Suggestion: QToolbar"
}
},
"events": {
"reveal": {
"desc": "Emitted when 'reveal' state gets changed",
"params": {
"value": {
"type": "Boolean",
"desc": "New 'reveal' state"
}
}
}
}
}

112
node_modules/quasar/dist/api/QForm.json generated vendored Normal file
View file

@ -0,0 +1,112 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/form"
},
"props": {
"autofocus": {
"type": "Boolean",
"desc": "Focus first focusable element on initial component render",
"category": "behavior"
},
"no-error-focus": {
"type": "Boolean",
"desc": "Do not try to focus on first component that has a validation error when submitting form",
"category": "behavior"
},
"no-reset-focus": {
"type": "Boolean",
"desc": "Do not try to focus on first component when resetting form",
"category": "behavior"
},
"greedy": {
"type": "Boolean",
"desc": "Validate all fields in form (by default it stops after finding the first invalid field with synchronous validation)",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"submit": {
"desc": "Emitted when all validations have passed when tethered to a submit button",
"params": {
"evt": {
"type": [
"Event",
"SubmitEvent"
],
"desc": "Form submission event object"
}
}
},
"reset": {
"desc": "Emitted when all validations have been reset when tethered to a reset button; It is recommended to manually reset the wrapped components models in this handler"
},
"validation-success": {
"desc": "Emitted after a validation was triggered and all inner Quasar components models are valid"
},
"validation-error": {
"desc": "Emitted after a validation was triggered and at least one of the inner Quasar components models are NOT valid",
"params": {
"ref": {
"type": "Component",
"desc": "Vue reference to the first component that triggered the validation error"
}
}
}
},
"methods": {
"focus": {
"desc": "Focus on first focusable element/component in the form"
},
"validate": {
"desc": "Triggers a validation on all applicable inner Quasar components",
"params": {
"shouldFocus": {
"type": "Boolean",
"desc": "Tell if it should focus or not on component with error on submitting form; Overrides 'no-focus-error' prop if specified"
}
},
"returns": {
"type": "Promise<boolean>",
"desc": "Promise is always fulfilled and receives the outcome (true -> validation was a success, false -> invalid models detected)",
"examples": [
"validate().then(outcome => { ... })"
]
}
},
"resetValidation": {
"desc": "Resets the validation on all applicable inner Quasar components"
},
"submit": {
"desc": "Manually trigger form validation and submit",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"reset": {
"desc": "Manually trigger form reset",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"getValidationComponents": {
"desc": "Get an array of children Vue component instances that support Quasar validation API (derived from QField, or using useFormChild()/QFormChildMixin)",
"returns": {
"type": "Array",
"tsType": "QFormChildComponent",
"desc": "Quasar validation API-compatible Vue component instances"
}
}
}
}

24
node_modules/quasar/dist/api/QFormChildMixin.json generated vendored Normal file
View file

@ -0,0 +1,24 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/form"
},
"methods": {
"validate": {
"desc": "Needs to be overwritten when getting extended/mixed in",
"returns": {
"type": [
"Boolean",
"Promise<boolean>"
],
"desc": "Promise is always fulfilled and receives the outcome (true -> validation was a success, false -> invalid models detected)",
"examples": [
"validate().then(outcome => { ... })"
]
}
},
"resetValidation": {
"desc": "Needs to be overwritten when getting extended/mixed in"
}
}
}

67
node_modules/quasar/dist/api/QHeader.json generated vendored Normal file
View file

@ -0,0 +1,67 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/header-and-footer"
},
"props": {
"model-value": {
"desc": "Model of the component defining if it is shown or hidden to the user; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean",
"default": true,
"examples": [
"v-model=\"headerState\""
]
},
"reveal": {
"type": "Boolean",
"desc": "Enable 'reveal' mode; Takes into account user scroll to temporarily show/hide header",
"category": "behavior"
},
"reveal-offset": {
"type": "Number",
"desc": "Amount of scroll (in pixels) that should trigger a 'reveal' state change",
"default": 250,
"category": "behavior",
"required": false
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"elevated": {
"type": "Boolean",
"desc": "Adds a default shadow to the header",
"category": "style"
},
"height-hint": {
"type": [
"Number",
"String"
],
"desc": "When using SSR, you can optionally hint of the height (in pixels) of the QHeader",
"default": 50,
"category": "behavior",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component; Suggestion: QToolbar"
}
},
"events": {
"reveal": {
"desc": "Emitted when 'reveal' state gets changed",
"params": {
"value": {
"type": "Boolean",
"desc": "New 'reveal' state"
}
}
}
}
}

69
node_modules/quasar/dist/api/QIcon.json generated vendored Normal file
View file

@ -0,0 +1,69 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/icon"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"tag": {
"type": "String",
"desc": "HTML tag to render, unless no icon is supplied or it's an svg icon",
"examples": [
"div",
"span",
"div",
"i"
],
"category": "content",
"default": "i",
"required": false
},
"name": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "model"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"left": {
"type": "Boolean",
"desc": "Useful if icon is on the left side of something: applies a standard margin on the right side of Icon",
"category": "content"
},
"right": {
"type": "Boolean",
"desc": "Useful if icon is on the right side of something: applies a standard margin on the left side of Icon",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Suggestions: QTooltip or QMenu"
}
}
}

279
node_modules/quasar/dist/api/QImg.json generated vendored Normal file
View file

@ -0,0 +1,279 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/img"
},
"props": {
"ratio": {
"type": [
"String",
"Number"
],
"desc": "Force the component to maintain an aspect ratio",
"examples": [
":ratio=\"4/3\"",
":ratio=\"16/9\"",
"ratio=\"1\"",
"(Number format) :ratio=\"16/9\"",
"(String format) ratio=\"1\""
],
"category": "style"
},
"src": {
"type": "String",
"desc": "Path to image",
"transformAssetUrls": true,
"examples": [
"(public folder) src=\"img/something.png\"",
"(assets folder) src=\"~assets/my-img.gif\"",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) src=\"https://picsum.photos/500/300\""
],
"category": "model"
},
"srcset": {
"type": "String",
"desc": "Same syntax as <img> srcset attribute",
"link": "https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images#Resolution_switching_Different_sizes",
"examples": [
"elva-fairy-320w.jpg 320w, elva-fairy-480w.jpg 480w"
],
"category": "model"
},
"sizes": {
"type": "String",
"desc": "Same syntax as <img> sizes attribute",
"link": "https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images#Resolution_switching_Different_sizes",
"examples": [
"(max-width: 320px) 280px, (max-width: 480px) 440px, 800px"
],
"category": "model"
},
"placeholder-src": {
"type": "String",
"desc": "While waiting for your image to load, you can use a placeholder image",
"transformAssetUrls": true,
"examples": [
"(public folder) src=\"img/some-placeholder.png\"",
"(assets folder) src=\"~assets/my-placeholder.gif\"",
"(relative path format) :src=\"require('./placeholder.jpg')\"",
"(URL) src=\"https://picsum.photos/500/300\""
],
"category": "model"
},
"initial-ratio": {
"type": [
"String",
"Number"
],
"desc": "Use it when not specifying 'ratio' but still wanting an initial aspect ratio",
"default": "16/9",
"examples": [
"(Number format) :initial-ratio=\"16/9\"",
"(String format) initial-ratio=\"1\""
],
"category": "style",
"required": false
},
"width": {
"type": "String",
"desc": "Forces image width; Must also include the unit (px or %)",
"examples": [
"280px",
"70%"
],
"category": "style"
},
"height": {
"type": "String",
"desc": "Forces image height; Must also include the unit (px or %)",
"examples": [
"280px",
"70%"
],
"category": "style"
},
"loading": {
"type": "String",
"desc": "Lazy or immediate load; Same syntax as <img> loading attribute",
"default": "lazy",
"values": [
"lazy",
"eager"
],
"category": "behavior",
"required": false
},
"crossorigin": {
"type": "String",
"desc": "Same syntax as <img> crossorigin attribute",
"values": [
"anonymous",
"use-credentials"
],
"category": "behavior"
},
"decoding": {
"type": "String",
"desc": "Same syntax as <img> decoding attribute",
"values": [
"sync",
"async",
"auto"
],
"category": "behavior"
},
"referrerpolicy": {
"type": "String",
"desc": "Same syntax as <img> referrerpolicy attribute",
"values": [
"no-referrer",
"no-referrer-when-downgrade",
"origin",
"origin-when-cross-origin",
"same-origin",
"strict-origin",
"strict-origin-when-cross-origin",
"unsafe-url"
],
"category": "behavior"
},
"fetchpriority": {
"type": "String",
"desc": "Provides a hint of the relative priority to use when fetching the image",
"default": "auto",
"values": [
"high",
"low",
"auto"
],
"category": "behavior",
"addedIn": "v2.6.6",
"required": false
},
"fit": {
"type": "String",
"desc": "How the image will fit into the container; Equivalent of the object-fit prop; Can be coordinated with 'position' prop",
"default": "cover",
"values": [
"cover",
"fill",
"contain",
"none",
"scale-down"
],
"category": "style",
"required": false
},
"position": {
"type": "String",
"desc": "The alignment of the image into the container; Equivalent of the object-position CSS prop",
"default": "50% 50%",
"examples": [
"0 0",
"20px 50px"
],
"category": "style",
"required": false
},
"alt": {
"type": "String",
"desc": "Specifies an alternate text for the image, if the image cannot be displayed",
"examples": [
"Two cats"
],
"category": "content"
},
"draggable": {
"type": "Boolean",
"desc": "Adds the native 'draggable' attribute",
"category": "behavior"
},
"img-class": {
"type": "String",
"desc": "CSS classes to be attributed to the native img element",
"examples": [
"my-special-class"
],
"category": "style"
},
"img-style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Apply CSS to the native img element",
"examples": [
":img-style=\"{ transform: 'rotate(45deg)' }\" "
],
"category": "style"
},
"spinner-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for default Spinner (unless using a 'loading' slot)",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"spinner-size": {
"type": "String",
"desc": "Size in CSS units, including unit name, for default Spinner (unless using a 'loading' slot)",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"no-spinner": {
"type": "Boolean",
"desc": "Do not display the default spinner while waiting for the image to be loaded; It is overriden by the 'loading' slot when one is present",
"category": "behavior"
},
"no-native-menu": {
"type": "Boolean",
"desc": "Disables the native context menu for the image",
"category": "behavior"
},
"no-transition": {
"type": "Boolean",
"desc": "Disable default transition when switching between old and new image",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot can be used for captions. See examples"
},
"loading": {
"desc": "While image is loading, this slot is being displayed on top of the component; Suggestions: a spinner or text"
},
"error": {
"desc": "Optional slot to be used when image could not be loaded; make sure you assign a min-height and min-width to the component through CSS"
}
},
"events": {
"load": {
"desc": "Emitted when image has been loaded by the browser",
"params": {
"src": {
"type": "String",
"desc": "URL of image that has been loaded; useful when using 'srcset' and/or 'sizes'",
"examples": [
"https://some-site.net/some-img.gif"
]
}
}
},
"error": {
"desc": "Emitted when browser could not load the image",
"params": {
"src": {
"type": "Error",
"desc": "JS Error object"
}
}
}
}
}

116
node_modules/quasar/dist/api/QInfiniteScroll.json generated vendored Normal file
View file

@ -0,0 +1,116 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/infinite-scroll"
},
"props": {
"offset": {
"type": "Number",
"desc": "Offset (pixels) to bottom of Infinite Scroll container from which the component should start loading more content in advance",
"default": 500,
"category": "behavior",
"required": false
},
"debounce": {
"type": [
"String",
"Number"
],
"desc": "Debounce amount (in milliseconds)",
"default": 100,
"category": "behavior",
"required": false
},
"initial-index": {
"type": "Number",
"desc": "Initialize the pagination index (used for the @load event)",
"default": 0,
"category": "behavior",
"required": false
},
"scroll-target": {
"type": [
"Element",
"String"
],
"desc": "CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one",
"examples": [
":scroll-target=\"$refs.scrollTarget\"",
"scroll-target=\".scroll-target-class\"",
"scroll-target=\"#scroll-target-id\"",
"scroll-target=\"body\""
],
"category": "behavior"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"reverse": {
"type": "Boolean",
"desc": "Scroll area should behave like a messenger - starting scrolled to bottom and loading when reaching the top",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
},
"loading": {
"desc": "Slot displaying something while loading content; Example: QSpinner"
}
},
"events": {
"load": {
"desc": "Emitted when Infinite Scroll needs to load more data",
"params": {
"index": {
"type": "Number",
"desc": "The index parameter can be used to make some sort of pagination on the content you load. It takes numeric values starting with 1 and incrementing with each call"
},
"done": {
"type": "Function",
"desc": "Function to call when you made all necessary updates. DO NOT forget to call it otherwise your loading message will continue to be displayed",
"params": {
"stop": {
"type": "Boolean",
"desc": "Stops QInfiniteScroll if it's Boolean 'true'; Specify it in case there's nothing more to load"
}
},
"returns": null
}
}
}
},
"methods": {
"poll": {
"desc": "Checks scroll position and loads more content if necessary"
},
"trigger": {
"desc": "Tells Infinite Scroll to load more content, regardless of the scroll position"
},
"reset": {
"desc": "Resets calling index to 0"
},
"stop": {
"desc": "Stops working, regardless of scroll position"
},
"resume": {
"desc": "Starts working. Checks scroll position upon call and if trigger is hit, it loads more content"
},
"setIndex": {
"desc": "Overwrite the current pagination index",
"params": {
"newIndex": {
"type": "Number",
"desc": "New pagination index",
"required": true
}
}
},
"updateScrollTarget": {
"desc": "Updates the scroll target; Useful when the parent elements change so that the scrolling target also changes"
}
}
}

112
node_modules/quasar/dist/api/QInnerLoading.json generated vendored Normal file
View file

@ -0,0 +1,112 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/inner-loading"
},
"props": {
"transition-show": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-hide": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "transition",
"required": false
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name, or standard size name (xs|sm|md|lg|xl), for the inner Spinner (unless using the default slot)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style",
"default": "42px",
"required": false
},
"showing": {
"type": "Boolean",
"desc": "State - loading or not",
"category": "state"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette for the inner Spinner (unless using the default slot)",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"label": {
"type": "String",
"desc": "Add a label; Gets overriden when using the default slot",
"examples": [
"Please wait..."
],
"category": "label",
"addedIn": "v2.2"
},
"label-class": {
"type": "String",
"desc": "Add CSS class(es) to the label; Works along the 'label' prop only",
"examples": [
"text-red q-mt-xl"
],
"category": "label",
"addedIn": "v2.2"
},
"label-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Apply custom style to the label; Works along the 'label' prop only",
"examples": [
"font-size: 28px",
":label-style=\"{ color: '#ff0000' }\""
],
"category": "label",
"addedIn": "v2.2"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
}
},
"slots": {
"default": {
"desc": "Default slot is used for replacing default Spinner; Suggestions: a spinner or text"
}
}
}

510
node_modules/quasar/dist/api/QInput.json generated vendored Normal file
View file

@ -0,0 +1,510 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/input"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms; If not specified, it takes the value of 'for' prop, if it exists",
"examples": [
"car_id",
"car_id"
],
"category": "behavior"
},
"mask": {
"type": "String",
"desc": "Custom mask or one of the predefined mask names",
"examples": [
"###-##",
"date",
"datetime",
"time",
"fulltime",
"phone",
"card"
],
"category": "behavior"
},
"fill-mask": {
"type": [
"Boolean",
"String"
],
"desc": "Fills string with specified characters (or underscore if value is not string) to fill mask's length",
"examples": [
"true",
"'0'",
"'_'"
],
"category": "behavior"
},
"reverse-fill-mask": {
"type": "Boolean",
"desc": "Fills string from the right side of the mask",
"category": "behavior"
},
"unmasked-value": {
"type": "Boolean",
"desc": "Model will be unmasked (won't contain tokens/separation characters)",
"category": "behavior"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"String",
"Number",
"null",
"undefined"
],
"examples": [
"v-model=\"myText\""
]
},
"error": {
"type": "Boolean",
"desc": "Does field have validation errors?",
"category": "behavior"
},
"error-message": {
"type": "String",
"desc": "Validation error message (gets displayed only if 'error' is set to 'true')",
"examples": [
"Username must have at least 5 characters"
],
"category": "content"
},
"no-error-icon": {
"type": "Boolean",
"desc": "Hide error icon when there is an error",
"category": "content"
},
"rules": {
"type": "Array",
"tsType": "ValidationRule",
"desc": "Array of Functions/Strings; If String, then it must be a name of one of the embedded validation rules",
"examples": [
":rules=\"[ val => val.length <= 3 || 'Please use maximum 3 characters' ]\"",
":rules=\"[ 'fulltime' ]\"",
":rules=\"[ (val, rules) => rules.email(val) || 'Please enter a valid email address' ]\""
],
"category": "behavior"
},
"reactive-rules": {
"type": "Boolean",
"desc": "By default a change in the rules does not trigger a new validation until the model changes; If set to true then a change in the rules will trigger a validation; Has a performance penalty, so use it only when you really need it",
"category": "behavior"
},
"lazy-rules": {
"type": [
"Boolean",
"String"
],
"desc": "If set to boolean true then it checks validation status against the 'rules' only after field loses focus for first time; If set to 'ondemand' then it will trigger only when component's validate() method is manually called or when the wrapper QForm submits itself",
"values": [
"(Boolean) true",
"(Boolean) false",
"ondemand"
],
"category": "behavior"
},
"label": {
"type": "String",
"desc": "A text label that will “float” up above the input field, once the field gets focus",
"examples": [
"Username"
],
"category": "content"
},
"stack-label": {
"type": "Boolean",
"desc": "Label will be always shown above the field regardless of field content (if any)",
"category": "content"
},
"hint": {
"type": "String",
"desc": "Helper (hint) text which gets placed below your wrapped form component",
"examples": [
"Fill in between 3 and 12 characters"
],
"category": "content"
},
"hide-hint": {
"type": "Boolean",
"desc": "Hide the helper (hint) text when field doesn't have focus",
"category": "content"
},
"prefix": {
"type": "String",
"desc": "Prefix",
"examples": [
"$"
],
"category": "content"
},
"suffix": {
"type": "String",
"desc": "Suffix",
"examples": [
"@gmail.com"
],
"category": "content"
},
"label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the label from the Quasar Color Palette; Overrides the 'color' prop; The difference from 'color' prop is that the label will always have this color, even when field is not focused",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"bg-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"loading": {
"type": "Boolean",
"desc": "Signals the user a process is in progress by displaying a spinner; Spinner can be customized by using the 'loading' slot.",
"category": "behavior|content"
},
"clearable": {
"type": "Boolean",
"desc": "Appends clearable icon when a value (not undefined or null) is set; When clicked, model becomes null",
"category": "behavior|content"
},
"clear-icon": {
"type": "String",
"desc": "Custom icon to use for the clear button when using along with 'clearable' prop",
"examples": [
"close"
],
"category": "content"
},
"filled": {
"type": "Boolean",
"desc": "Use 'filled' design for the field",
"category": "style"
},
"outlined": {
"type": "Boolean",
"desc": "Use 'outlined' design for the field",
"category": "style"
},
"borderless": {
"type": "Boolean",
"desc": "Use 'borderless' design for the field",
"category": "style"
},
"standout": {
"type": [
"Boolean",
"String"
],
"desc": "Use 'standout' design for the field; Specifies classes to be applied when focused (overriding default ones)",
"examples": [
"standout",
"standout=\"bg-primary text-white\""
],
"category": "style"
},
"label-slot": {
"type": "Boolean",
"desc": "Enables label slot; You need to set it to force use of the 'label' slot if the 'label' prop is not set",
"category": "content"
},
"bottom-slots": {
"type": "Boolean",
"desc": "Enables bottom slots ('error', 'hint', 'counter')",
"category": "content"
},
"hide-bottom-space": {
"type": "Boolean",
"desc": "Do not reserve space for hint/error/counter anymore when these are not used; As a result, it also disables the animation for those; It also allows the hint/error area to stretch vertically based on its content",
"category": "style"
},
"counter": {
"type": "Boolean",
"desc": "Show an automatic counter on bottom right",
"category": "content"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Remove border-radius so borders are squared; Overrides 'rounded' prop",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"item-aligned": {
"type": "Boolean",
"desc": "Match inner content alignment to that of QItem",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"autofocus": {
"type": "Boolean",
"desc": "Focus field on initial component render",
"category": "behavior"
},
"for": {
"type": "String",
"desc": "Used to specify the 'id' of the control and also the 'for' attribute of the label that wraps it; If no 'name' prop is specified, then it is used for this attribute as well",
"examples": [
"myFieldsId"
],
"category": "behavior"
},
"shadow-text": {
"type": "String",
"desc": "Text to be displayed as shadow at the end of the text in the control; Does NOT applies to type=file",
"examples": [
"rest of the fill value"
],
"category": "content"
},
"type": {
"type": "String",
"desc": "Input type",
"default": "text",
"values": [
"text",
"password",
"textarea",
"email",
"search",
"tel",
"file",
"number",
"url",
"time",
"date"
],
"category": "general",
"required": false
},
"debounce": {
"type": [
"String",
"Number"
],
"desc": "Debounce amount (in milliseconds) when updating model",
"category": "model"
},
"maxlength": {
"type": [
"String",
"Number"
],
"desc": "Specify a max length of model",
"category": "model"
},
"autogrow": {
"type": "Boolean",
"desc": "Make field autogrow along with its content (uses a textarea)",
"category": "content"
},
"input-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the underlying input tag",
"examples": [
"my-special-class",
":input-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"input-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the underlying input tag",
"examples": [
"background-color: #ff0000",
":input-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Field main content"
},
"prepend": {
"desc": "Prepend inner field; Suggestions: QIcon, QBtn"
},
"append": {
"desc": "Append to inner field; Suggestions: QIcon, QBtn"
},
"before": {
"desc": "Prepend outer field; Suggestions: QIcon, QBtn"
},
"after": {
"desc": "Append outer field; Suggestions: QIcon, QBtn"
},
"label": {
"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"
},
"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>"
},
"loading": {
"desc": "Override default spinner when component is in loading mode; Use in conjunction with 'loading' prop"
}
},
"events": {
"clear": {
"desc": "When using the 'clearable' property, this event is emitted when the clear icon is clicked",
"params": {
"value": {
"type": "Any",
"desc": "The previous value before clearing it"
}
}
},
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": [
"String",
"Number",
"null"
],
"desc": "New model value",
"required": true
}
}
},
"focus": {
"desc": "Emitted when component gets focused",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
},
"blur": {
"desc": "Emitted when component loses focus",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object"
}
}
}
},
"methods": {
"resetValidation": {
"desc": "Reset validation status"
},
"validate": {
"desc": "Trigger a validation",
"params": {
"value": {
"type": "Any",
"desc": "Optional value to validate against"
}
},
"returns": {
"type": [
"Boolean",
"Promise<boolean>"
],
"desc": "True/false if no async rules, otherwise a Promise with the outcome (true -> validation was a success, false -> invalid models detected)",
"examples": [
"true",
"validate().then(outcome => { ... })"
]
}
},
"focus": {
"desc": "Focus underlying input tag"
},
"blur": {
"desc": "Lose focus on underlying input tag"
},
"select": {
"desc": "Select input text"
},
"getNativeElement": {
"desc": "DEPRECATED; Access 'nativeEl' directly instead; Get the native input/textarea DOM Element",
"returns": {
"type": "Element",
"tsType": "QInputNativeElement",
"desc": "The underlying native input/textarea DOM Element"
}
}
},
"computedProps": {
"hasError": {
"type": "Boolean",
"desc": "Whether the component is in error state"
},
"nativeEl": {
"type": "Element",
"tsType": "QInputNativeElement",
"desc": "The native input/textarea DOM Element",
"addedIn": "v2.10.1"
}
}
}

107
node_modules/quasar/dist/api/QIntersection.json generated vendored Normal file
View file

@ -0,0 +1,107 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/intersection"
},
"props": {
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"span",
"blockquote"
],
"category": "content",
"default": "div",
"required": false
},
"once": {
"type": "Boolean",
"desc": "Get triggered only once",
"category": "behavior"
},
"ssr-prerender": {
"type": "Boolean",
"desc": "Pre-render content on server side if using SSR (use it to pre-render above the fold content)",
"category": "behavior"
},
"root": {
"type": "Element",
"desc": "[Intersection API root prop] Lets you define an alternative to the viewport as your root (through its DOM element); It is important to keep in mind that root needs to be an ancestor of the observed element",
"examples": [
"$refs.myTable.$el",
"getElementById(\"myTable\")"
],
"category": "behavior"
},
"margin": {
"type": "String",
"desc": "[Intersection API rootMargin prop] Allows you to specify the margins for the root, effectively allowing you to either grow or shrink the area used for intersections",
"examples": [
"-20px 0px",
"10px 20px 30px 40px"
],
"category": "behavior"
},
"threshold": {
"type": [
"Array",
"Number"
],
"desc": "[Intersection API threshold prop] Threshold(s) at which to trigger, specified as a ratio, or list of ratios, of (visible area / total area) of the observed element",
"examples": [
"[ 0, 0.25, 0.5, 0.75, 1 ]",
":threshold=\"1\""
],
"category": "behavior"
},
"transition": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "behavior"
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "behavior",
"addedIn": "v2.3.1",
"required": false
},
"disable": {
"type": "Boolean",
"desc": "Disable visibility observable (content will remain as it was, visible or hidden)",
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
},
"hidden": {
"desc": "Slot for content to render when component is not on screen; Example: a text that the user can search for with the browser's search function",
"addedIn": "v2.12.0"
}
},
"events": {
"visibility": {
"desc": "Fires when visibility changes",
"params": {
"isVisible": {
"type": "Boolean",
"desc": "Visibility status (true/false)"
}
}
}
}
}

195
node_modules/quasar/dist/api/QItem.json generated vendored Normal file
View file

@ -0,0 +1,195 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/list-and-list-items"
},
"props": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"exact": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-active-class"
],
"category": "navigation"
},
"exact-active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-exact-active-class"
],
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"https://quasar.dev"
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"active": {
"type": "Boolean",
"desc": "Put item into 'active' state",
"category": "state",
"default": null,
"required": false
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"clickable": {
"type": "Boolean",
"desc": "Is QItem clickable? If it's the case, then it will add hover effects and emit 'click' events",
"category": "state"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"inset-level": {
"type": "Number",
"desc": "Apply an inset; Useful when avatar/left side is missing but you want to align content with other items that do have a left side, or when you're building a menu",
"examples": [
":inset-level=\"1\""
],
"category": "content"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"tag": {
"type": "String",
"desc": "HTML tag to render; Suggestion: use 'label' when encapsulating a QCheckbox/QRadio/QToggle so that when user clicks/taps on the whole item it will trigger a model change for the mentioned components",
"examples": [
"div",
"span",
"a",
"label",
"div"
],
"category": "content",
"default": "div",
"required": false
},
"manual-focus": {
"type": "Boolean",
"desc": "Put item into a manual focus state; Enables 'focused' prop which will determine if item is focused or not, rather than relying on native hover/focus states",
"category": "state"
},
"focused": {
"type": "Boolean",
"desc": "Determines focus state, ONLY if 'manual-focus' is enabled / set to true",
"category": "state"
}
},
"slots": {
"default": {
"desc": "This is where QItem's content goes"
}
},
"events": {
"click": {
"desc": "Emitted when the component is clicked",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object; If you are using route navigation ('to'/'replace' props) and you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"
},
"go": {
"type": "Function",
"desc": "Available ONLY if you are using route navigation ('to'/'replace' props); When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else",
"required": false,
"addedIn": "v2.9",
"params": {
"opts": {
"type": "Object",
"desc": "Optional options",
"required": false,
"definition": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop",
"required": false,
"examples": [
"/home/dashboard",
"{ name: 'my-route-name' }"
]
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop",
"required": false
},
"returnRouterError": {
"type": "Boolean",
"desc": "Return the router error, if any; Otherwise the returned Promise will always fulfill",
"required": false
}
}
}
},
"returns": {
"type": "Promise<any>",
"desc": "Returns the router's navigation promise"
}
}
}
}
}
}

36
node_modules/quasar/dist/api/QItemLabel.json generated vendored Normal file
View file

@ -0,0 +1,36 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/list-and-list-items"
},
"props": {
"overline": {
"type": "Boolean",
"desc": "Renders an overline label",
"category": "content"
},
"caption": {
"type": "Boolean",
"desc": "Renders a caption label",
"category": "content"
},
"header": {
"type": "Boolean",
"desc": "Renders a header label",
"category": "content"
},
"lines": {
"type": [
"Number",
"String"
],
"desc": "Apply ellipsis when there's not enough space to render on the specified number of lines;",
"category": "content|behavior"
}
},
"slots": {
"default": {
"desc": "The content of the label; Suggestion: text"
}
}
}

38
node_modules/quasar/dist/api/QItemSection.json generated vendored Normal file
View file

@ -0,0 +1,38 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/list-and-list-items"
},
"props": {
"avatar": {
"type": "Boolean",
"desc": "Render an avatar item side (does not needs 'side' prop to be set)",
"category": "content"
},
"thumbnail": {
"type": "Boolean",
"desc": "Render a thumbnail item side (does not needs 'side' prop to be set)",
"category": "content"
},
"side": {
"type": "Boolean",
"desc": "Renders as a side of the item",
"category": "content"
},
"top": {
"type": "Boolean",
"desc": "Align content to top (useful for multi-line items)",
"category": "content"
},
"no-wrap": {
"type": "Boolean",
"desc": "Do not wrap text (useful for item's main content)",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Section's actual content"
}
}
}

197
node_modules/quasar/dist/api/QKnob.json generated vendored Normal file
View file

@ -0,0 +1,197 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/knob"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"model-value": {
"desc": "Any number to indicate the given value of the knob. Either use this property (along with a listener for 'update:modelValue' event) OR use the v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "Number",
"examples": [
"v-model=\"myValue\""
]
},
"min": {
"type": "Number",
"desc": "The minimum value that the model (the knob value) should start at",
"category": "model"
},
"max": {
"type": "Number",
"desc": "The maximum value that the model (the knob value) should go to",
"category": "model"
},
"inner-min": {
"type": "Number",
"desc": "Inner minimum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be higher or equal to 'min' prop; Defaults to 'min' prop",
"category": "model",
"addedIn": "v2.5.4"
},
"inner-max": {
"type": "Number",
"desc": "Inner maximum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be lower or equal to 'max' prop; Defaults to 'max' prop",
"category": "model",
"addedIn": "v2.5.4"
},
"step": {
"type": "Number",
"default": 1,
"desc": "A number representing steps in the value of the model, while adjusting the knob",
"category": "model",
"required": false
},
"reverse": {
"type": "Boolean",
"desc": "Reverses the direction of progress",
"category": "behavior"
},
"instant-feedback": {
"type": "Boolean",
"desc": "No animation when model changes",
"category": "behavior"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"center-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the center part of the component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the track of the component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"font-size": {
"type": "String",
"desc": "Size of text in CSS units, including unit name. Suggestion: use 'em' units to sync with component size",
"default": "0.25em",
"examples": [
"1em",
"16px",
"2rem"
],
"category": "style",
"required": false
},
"thickness": {
"type": "Number",
"default": 0.2,
"desc": "Thickness of progress arc as a ratio (0.0 < x < 1.0) of component size",
"category": "style",
"required": false
},
"angle": {
"type": "Number",
"desc": "Angle to rotate progress arc by",
"default": 0,
"category": "content",
"required": false
},
"show-value": {
"type": "Boolean",
"desc": "Enables the default slot and uses it (if available), otherwise it displays the 'value' prop as text; Make sure the text has enough space to be displayed inside the component",
"category": "content|behavior"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Number",
"desc": "New model value",
"required": true
}
}
},
"change": {
"desc": "Fires at the end of a knob's adjustment and offers the value of the model",
"params": {
"value": {
"type": "Number",
"desc": "New model value"
}
}
},
"drag-value": {
"desc": "The value of the model while dragging is still in progress",
"params": {
"value": {
"type": "Number",
"desc": "New model value"
}
}
}
}
}

100
node_modules/quasar/dist/api/QLayout.json generated vendored Normal file
View file

@ -0,0 +1,100 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/layout"
},
"props": {
"view": {
"type": "String",
"desc": "Defines how your layout components (header/footer/drawer) should be placed on screen; See docs examples",
"default": "hhh lpr fff",
"examples": [
"hHh lpR fFf"
],
"category": "content",
"required": false
},
"container": {
"type": "Boolean",
"desc": "Containerize the layout which means it changes the default behavior of expanding to the whole window; Useful (but not limited to) for when using on a QDialog",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Suggestion: QHeader, QFooter, QDrawer, QPageContainer"
}
},
"events": {
"resize": {
"desc": "Emitted when layout size (height, width) changes",
"params": {
"size": {
"type": "Object",
"desc": "New size",
"definition": {
"height": {
"type": "Number",
"required": true,
"desc": "Layout height"
},
"width": {
"type": "Number",
"required": true,
"desc": "Layout width"
}
}
}
}
},
"scroll": {
"desc": "Emitted when user scrolls within layout",
"params": {
"details": {
"type": "Object",
"desc": "Scroll details",
"definition": {
"position": {
"type": "Number",
"required": true,
"desc": "Scroll offset from top (vertical)"
},
"direction": {
"type": "String",
"required": true,
"desc": "Direction of scroll",
"values": [
"up",
"down"
]
},
"directionChanged": {
"type": "Boolean",
"required": true,
"desc": "Has scroll direction changed since event was last emitted?"
},
"delta": {
"type": "Number",
"required": true,
"desc": "Vertical delta distance since event was last emitted"
},
"inflectionPoint": {
"type": "Number",
"required": true,
"desc": "Scroll offset from top (vertical)"
}
}
}
}
},
"scroll-height": {
"desc": "Emitted when the scroll size of layout changes",
"params": {
"height": {
"type": "Number",
"desc": "New scroll height of layout"
}
}
}
}
}

108
node_modules/quasar/dist/api/QLinearProgress.json generated vendored Normal file
View file

@ -0,0 +1,108 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/linear-progress"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"value": {
"type": "Number",
"desc": "Progress value (0.0 < x < 1.0)",
"default": 0,
"category": "model",
"required": false
},
"buffer": {
"type": "Number",
"desc": "Optional buffer value (0.0 < x < 1.0)",
"category": "behavior"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component's track from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"reverse": {
"type": "Boolean",
"desc": "Reverse direction of progress",
"category": "behavior"
},
"stripe": {
"type": "Boolean",
"desc": "Draw stripes; For determinate state only (for performance reasons)",
"category": "content"
},
"indeterminate": {
"type": "Boolean",
"desc": "Put component into indeterminate mode",
"category": "behavior"
},
"query": {
"type": "Boolean",
"desc": "Put component into query mode",
"category": "behavior"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a small standard border-radius for a squared shape of the component",
"category": "style"
},
"instant-feedback": {
"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": 2100,
"addedIn": "v2.3",
"required": false
}
},
"slots": {
"default": {
"desc": "Suggestion: QTooltip"
}
}
}

53
node_modules/quasar/dist/api/QList.json generated vendored Normal file
View file

@ -0,0 +1,53 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/list-and-list-items"
},
"props": {
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"separator": {
"type": "Boolean",
"desc": "Applies a separator between contained items",
"category": "content"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"padding": {
"type": "Boolean",
"desc": "Applies a material design-like padding on top and bottom",
"category": "content"
},
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"ul",
"ol"
],
"category": "content",
"default": "div",
"addedIn": "v2.10.1",
"required": false
}
},
"slots": {
"default": {
"desc": "This is where the content goes; Suggestion: QItem, QExpansionItem, ..."
}
}
}

59
node_modules/quasar/dist/api/QMarkupTable.json generated vendored Normal file
View file

@ -0,0 +1,59 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/markup-table"
},
"props": {
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"flat": {
"type": "Boolean",
"desc": "Applies a 'flat' design (no default shadow)",
"category": "style"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"separator": {
"type": "String",
"desc": "Use a separator/border between rows, columns or all cells",
"default": "horizontal",
"values": [
"horizontal",
"vertical",
"cell",
"none"
],
"examples": [
"cell"
],
"category": "content",
"required": false
},
"wrap-cells": {
"type": "Boolean",
"desc": "Wrap text within table cells",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

322
node_modules/quasar/dist/api/QMenu.json generated vendored Normal file
View file

@ -0,0 +1,322 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/menu"
},
"props": {
"transition-show": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-hide": {
"type": "String",
"desc": "One of Quasar's embedded transitions",
"examples": [
"fade",
"slide-down"
],
"category": "transition",
"default": "fade",
"required": false
},
"transition-duration": {
"type": [
"String",
"Number"
],
"desc": "Transition duration (in milliseconds, without unit)",
"default": 300,
"category": "transition",
"required": false
},
"target": {
"type": [
"Boolean",
"String",
"Element"
],
"desc": "Configure a target element to trigger component toggle; 'true' means it enables the parent DOM element, 'false' means it disables attaching events to any DOM elements; By using a String (CSS selector) or a DOM element it attaches the events to the specified DOM element (if it exists)",
"default": true,
"values": [
"(Boolean) true",
"(Boolean) false",
"(CSS selector)",
"(DOM Element)"
],
"examples": [
":target=\"false\"",
":target=\"$refs.target\"",
"target=\".my-parent\"",
"target=\"#target-id\""
],
"category": "behavior",
"required": false
},
"no-parent-event": {
"type": "Boolean",
"desc": "Skips attaching events to the target DOM element (that trigger the element to get shown)",
"category": "behavior"
},
"context-menu": {
"type": "Boolean",
"desc": "Allows the component to behave like a context menu, which opens with a right mouse click (or long tap on mobile)",
"category": "behavior"
},
"model-value": {
"type": "Boolean",
"desc": "Model of the component defining shown/hidden state; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"category": "model"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"fit": {
"type": "Boolean",
"desc": "Allows the menu to match at least the full width of its target",
"category": "position"
},
"cover": {
"type": "Boolean",
"desc": "Allows the menu to cover its target. When used, the 'self' and 'fit' props are no longer effective",
"category": "position"
},
"anchor": {
"type": "String",
"desc": "Two values setting the starting position or anchor point of the menu relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"category": "position"
},
"self": {
"type": "String",
"desc": "Two values setting the menu's own position relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"category": "position"
},
"offset": {
"type": "Array",
"desc": "An array of two numbers to offset the menu horizontally and vertically in pixels",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "position"
},
"scroll-target": {
"type": [
"Element",
"String"
],
"desc": "CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one",
"examples": [
":scroll-target=\"$refs.scrollTarget\"",
"scroll-target=\".scroll-target-class\"",
"scroll-target=\"#scroll-target-id\"",
"scroll-target=\"body\""
],
"category": "behavior"
},
"touch-position": {
"type": "Boolean",
"desc": "Allows for the target position to be set by the mouse position, when the target of the menu is either clicked or touched",
"category": "behavior"
},
"persistent": {
"type": "Boolean",
"desc": "Allows the menu to not be dismissed by a click/tap outside of the menu or by hitting the ESC key",
"category": "behavior"
},
"no-route-dismiss": {
"type": "Boolean",
"desc": "Changing route app won't dismiss the popup; No need to set it if 'persistent' prop is also set",
"category": "behavior"
},
"auto-close": {
"type": "Boolean",
"desc": "Allows any click/tap in the menu to close it; Useful instead of attaching events to each menu item that should close the menu on click/tap",
"category": "behavior"
},
"separate-close-popup": {
"type": "Boolean",
"desc": "Separate from parent menu, marking it as a separate closing point for v-close-popup (without this, chained menus close all together)",
"category": "behavior"
},
"square": {
"type": "Boolean",
"desc": "Forces content to have squared borders",
"category": "style"
},
"no-refocus": {
"type": "Boolean",
"desc": "(Accessibility) When Menu gets hidden, do not refocus on the DOM element that previously had focus",
"category": "behavior"
},
"no-focus": {
"type": "Boolean",
"desc": "(Accessibility) When Menu gets shown, do not switch focus on it",
"category": "behavior"
},
"max-height": {
"type": "String",
"desc": "The maximum height of the menu; Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"max-width": {
"type": "String",
"desc": "The maximum width of the menu; Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when showing/hidden state changes; Is also used by v-model",
"params": {
"value": {
"type": "Boolean",
"desc": "New state (showing/hidden)"
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"escape-key": {
"desc": "Emitted when ESC key is pressed; Does not get emitted if Menu is 'persistent'"
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
},
"updatePosition": {
"desc": "There are some custom scenarios for which Quasar cannot automatically reposition the menu without significant performance drawbacks so the optimal solution is for you to call this method when you need it"
},
"focus": {
"desc": "Focus menu; if you have content with autofocus attribute, it will directly focus it"
}
},
"computedProps": {
"contentEl": {
"type": "Element",
"desc": "The DOM Element of the rendered content",
"addedIn": "v2.10.1"
}
}
}

38
node_modules/quasar/dist/api/QNoSsr.json generated vendored Normal file
View file

@ -0,0 +1,38 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/no-ssr"
},
"props": {
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"span",
"blockquote"
],
"category": "content",
"default": "div",
"required": false
},
"placeholder": {
"type": "String",
"desc": "Text to display on server-side render (unless using 'placeholder' slot)",
"examples": [
"This is server-side only"
],
"category": "content"
}
},
"slots": {
"default": {
"desc": "Default slot is used to render content on client-side"
},
"placeholder": {
"desc": "Slot used as placeholder on server-side render, which gets replaced by the default slot on client-side; overrides 'placeholder' prop"
}
}
}

237
node_modules/quasar/dist/api/QOptionGroup.json generated vendored Normal file
View file

@ -0,0 +1,237 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/option-group"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "Any",
"examples": [
"v-model=\"group\""
]
},
"options": {
"type": "Array",
"desc": "Array of objects with value, label, and disable (optional) props. The binary components will be created according to this array; Props from QToggle, QCheckbox or QRadio can also be added as key/value pairs to control the components singularly",
"definition": {
"label": {
"type": "String",
"desc": "Label to display along the component",
"required": true,
"examples": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": {
"type": "Any",
"desc": "Value of the option that will be used by the component model",
"required": true,
"examples": [
"op1",
"op2",
"op3"
]
},
"disable": {
"type": "Boolean",
"desc": "If true, the option will be disabled"
},
"...props": {
"type": "Any",
"desc": "Any other props from QToggle, QCheckbox, or QRadio",
"examples": [
"val=\"car\"",
":true-value=\"trueValue\"",
"checked-icon=\"visibility\""
]
}
},
"examples": [
":options=\"[ { label: 'Option 1', value: 'op1' }, { label: 'Option 2', value: 'op2' }, { label: 'Option 3', value: 'op3', disable: true } ]\""
],
"category": "model"
},
"name": {
"type": "String",
"desc": "Used to specify the name of the controls; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"type": {
"type": "String",
"desc": "The type of input component to be used",
"values": [
"radio",
"checkbox",
"toggle"
],
"default": "radio",
"category": "content",
"required": false
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"keep-color": {
"type": "Boolean",
"desc": "Should the color (if specified any) be kept when input components are unticked?",
"category": "behavior"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"left-label": {
"type": "Boolean",
"desc": "Label (if any specified) should be displayed on the left side of the input components",
"category": "content"
},
"inline": {
"type": "Boolean",
"desc": "Show input components as inline-block rather than each having their own row",
"category": "content"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
}
},
"slots": {
"label": {
"desc": "Generic slot for all labels",
"scope": {
"...self": {
"type": "Object",
"desc": "The corresponding option entry from the 'options' prop",
"definition": {
"label": {
"type": "String",
"desc": "Label to display along the component",
"required": true,
"examples": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": {
"type": "Any",
"desc": "Value of the option that will be used by the component model",
"required": true,
"examples": [
"op1",
"op2",
"op3"
]
},
"disable": {
"type": "Boolean",
"desc": "If true, the option will be disabled"
},
"...props": {
"type": "Any",
"desc": "Any other props from QToggle, QCheckbox, or QRadio",
"examples": [
"val=\"car\"",
":true-value=\"trueValue\"",
"checked-icon=\"visibility\""
]
}
}
}
},
"addedIn": "v2.2"
},
"label-[name]": {
"desc": "Slot to define the specific label for the option at '[name]' where name is a 0-based index; Overrides the generic 'label' slot if used",
"scope": {
"...self": {
"type": "Object",
"desc": "The corresponding option entry from the 'options' prop",
"definition": {
"label": {
"type": "String",
"desc": "Label to display along the component",
"required": true,
"examples": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": {
"type": "Any",
"desc": "Value of the option that will be used by the component model",
"required": true,
"examples": [
"op1",
"op2",
"op3"
]
},
"disable": {
"type": "Boolean",
"desc": "If true, the option will be disabled"
},
"...props": {
"type": "Any",
"desc": "Any other props from QToggle, QCheckbox, or QRadio",
"examples": [
"val=\"car\"",
":true-value=\"trueValue\"",
"checked-icon=\"visibility\""
]
}
}
}
},
"addedIn": "v2.2"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
}
}
}

42
node_modules/quasar/dist/api/QPage.json generated vendored Normal file
View file

@ -0,0 +1,42 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/page"
},
"props": {
"padding": {
"type": "Boolean",
"desc": "Applies a default responsive page padding",
"category": "content"
},
"style-fn": {
"type": "Function",
"desc": "Override default CSS style applied to the component (sets minHeight); Function(offset: Number) => CSS props/value: Object; For best performance, reference it from your scope and do not define it inline",
"params": {
"offset": {
"type": "Number",
"desc": "Header + Footer height (in pixels)"
},
"height": {
"type": "Number",
"desc": "Value in pixels of container height (if containerized) or window height otherwise"
}
},
"returns": {
"type": "Object",
"desc": "Object with CSS properties to apply to Page DOM element"
},
"default": "(see source code)",
"examples": [
"(see source code)"
],
"category": "style",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

11
node_modules/quasar/dist/api/QPageContainer.json generated vendored Normal file
View file

@ -0,0 +1,11 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/page"
},
"slots": {
"default": {
"desc": "Encapsulates a QPage (either directly or through <router-view>)"
}
}
}

68
node_modules/quasar/dist/api/QPageScroller.json generated vendored Normal file
View file

@ -0,0 +1,68 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/page-scroller"
},
"props": {
"position": {
"type": "String",
"desc": "Page side/corner to stick to",
"default": "bottom-right",
"values": [
"top-right",
"top-left",
"bottom-right",
"bottom-left",
"top",
"right",
"bottom",
"left"
],
"category": "position",
"required": false
},
"offset": {
"type": "Array",
"desc": "An array of two numbers to offset the component horizontally and vertically in pixels",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "content",
"default": [
18,
18
],
"required": false
},
"expand": {
"type": "Boolean",
"desc": "By default the component shrinks to content's size; By using this prop you make the component fully expand horizontally or vertically, based on 'position' prop",
"category": "content"
},
"scroll-offset": {
"type": "Number",
"desc": "Scroll offset (in pixels) from which point the component is shown on page; Measured from the top of the page (or from the bottom if in 'reverse' mode)",
"default": 1000,
"category": "behavior",
"required": false
},
"reverse": {
"type": "Boolean",
"desc": "Work in reverse (shows when scrolling to the top of the page and scrolls to bottom when triggered)",
"category": "behavior"
},
"duration": {
"type": "Number",
"desc": "Duration (in milliseconds) of the scrolling until it reaches its target",
"default": 300,
"category": "behavior",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

44
node_modules/quasar/dist/api/QPageSticky.json generated vendored Normal file
View file

@ -0,0 +1,44 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/layout/page-sticky"
},
"props": {
"position": {
"type": "String",
"desc": "Page side/corner to stick to",
"default": "bottom-right",
"values": [
"top-right",
"top-left",
"bottom-right",
"bottom-left",
"top",
"right",
"bottom",
"left"
],
"category": "position",
"required": false
},
"offset": {
"type": "Array",
"desc": "An array of two numbers to offset the component horizontally and vertically in pixels",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "position"
},
"expand": {
"type": "Boolean",
"desc": "By default the component shrinks to content's size; By using this prop you make the component fully expand horizontally or vertically, based on 'position' prop",
"category": "content"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

350
node_modules/quasar/dist/api/QPagination.json generated vendored Normal file
View file

@ -0,0 +1,350 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/pagination"
},
"props": {
"model-value": {
"desc": "Current page (must be between min/max)",
"required": true,
"syncable": true,
"category": "model",
"type": "Number"
},
"min": {
"type": [
"Number",
"String"
],
"desc": "Minimum page (must be lower than 'max')",
"default": 1,
"category": "model",
"required": false
},
"max": {
"type": [
"Number",
"String"
],
"desc": "Number of last page (must be higher than 'min')",
"required": true,
"category": "model"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color (useful when you are using it along with the 'input' prop)",
"category": "style"
},
"size": {
"type": "String",
"desc": "Button size in CSS units, including unit name",
"examples": [
"20px"
],
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"input": {
"type": "Boolean",
"desc": "Use an input instead of buttons",
"category": "content"
},
"icon-prev": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-next": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-first": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-last": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"to-fn": {
"type": "Function",
"desc": "Generate link for page buttons; For best performance, reference it from your scope and do not define it inline",
"params": {
"page": {
"type": "Number",
"desc": "Page number to navigate to"
}
},
"returns": {
"type": [
"Object",
"String"
],
"desc": "Object or String that can be passed to a <router-link> as `to` parameter"
},
"examples": [
":to-fn=\"page => ({ query: { page } })\""
],
"category": "content"
},
"boundary-links": {
"type": "Boolean",
"desc": "Show boundary button links",
"category": "content"
},
"boundary-numbers": {
"type": "Boolean",
"desc": "Always show first and last page buttons (if not using 'input')",
"category": "content"
},
"direction-links": {
"type": "Boolean",
"desc": "Show direction buttons",
"category": "content"
},
"ellipses": {
"type": "Boolean",
"desc": "Show ellipses (...) when pages are available",
"category": "content"
},
"max-pages": {
"type": [
"Number",
"String"
],
"default": 0,
"desc": "Maximum number of page links to display at a time; 0 means Infinite",
"category": "content",
"required": false
},
"flat": {
"type": "Boolean",
"desc": "Use 'flat' design for non-active buttons (it's the default option)",
"category": "style"
},
"outline": {
"type": "Boolean",
"desc": "Use 'outline' design for non-active buttons",
"category": "style"
},
"unelevated": {
"type": "Boolean",
"desc": "Remove shadow for non-active buttons",
"category": "style"
},
"push": {
"type": "Boolean",
"desc": "Use 'push' design for non-active buttons",
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name from the Quasar Color Palette for the non-active buttons",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"default": "primary",
"required": false
},
"text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Text color name from the Quasar Color Palette for the ACTIVE buttons",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"active-design": {
"type": "String",
"desc": "The design of the ACTIVE button, similar to the flat/outline/push/unelevated props (but those are used for non-active buttons)",
"values": [
"flat",
"outline",
"push",
"unelevated"
],
"category": "style",
"addedIn": "v2.10"
},
"active-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name from the Quasar Color Palette for the ACTIVE button",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"default": "primary",
"required": false
},
"active-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Text color name from the Quasar Color Palette for the ACTIVE button",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"round": {
"type": "Boolean",
"desc": "Makes a circle shaped button for all buttons",
"category": "style"
},
"rounded": {
"type": "Boolean",
"desc": "Applies a more prominent border-radius for a squared shape button for all buttons",
"category": "style"
},
"glossy": {
"type": "Boolean",
"desc": "Applies a glossy effect for all buttons",
"category": "style"
},
"gutter": {
"type": "String",
"desc": "Apply custom gutter; Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl)",
"default": "2px",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg",
"2px 2px 5px 7px"
],
"category": "style",
"addedIn": "v2.10",
"required": false
},
"padding": {
"type": "String",
"desc": "Apply custom padding (vertical [horizontal]); Size in CSS units, including unit name or standard size name (none|xs|sm|md|lg|xl); Also removes the min width and height when set",
"examples": [
"16px",
"10px 5px",
"2rem",
"xs",
"md lg",
"2px 2px 5px 7px"
],
"category": "style"
},
"input-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Style definitions to be attributed to the input (if using one)",
"examples": [
"background-color: #ff0000",
":input-style=\"{ backgroundColor: '#ff0000' }\""
],
"category": "style"
},
"input-class": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "Class definitions to be attributed to the input (if using one)",
"examples": [
"my-special-class",
":input-class=\"{ 'my-special-class': <condition> }\""
],
"category": "style"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure buttons material ripple (disable it by setting it to 'false' or supply a config object); Does not applies to boundary and ellipsis buttons",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Number",
"desc": "New model value",
"required": true
}
}
}
},
"methods": {
"set": {
"desc": "Go directly to the specified page",
"params": {
"pageNumber": {
"type": "Number",
"desc": "Page number to go to"
}
}
},
"setByOffset": {
"desc": "Increment/Decrement current page by offset",
"params": {
"offset": {
"type": "Number",
"desc": "Offset page, can be negative or positive"
}
}
}
}
}

74
node_modules/quasar/dist/api/QParallax.json generated vendored Normal file
View file

@ -0,0 +1,74 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/parallax"
},
"props": {
"src": {
"type": "String",
"desc": "Path to image (unless a 'media' slot is used)",
"transformAssetUrls": true,
"examples": [
"(public folder) src=\"img/something.png\"",
"(assets folder) src=\"~assets/my-img.png\"",
"(relative path format) :src=\"require('./my_img.jpg')\"",
"(URL) src=\"https://some-site.net/some-img.jpg\""
],
"category": "model"
},
"height": {
"type": "Number",
"desc": "Height of component (in pixels)",
"default": 500,
"category": "style",
"required": false
},
"speed": {
"type": "Number",
"desc": "Speed of parallax effect (0.0 < x < 1.0)",
"category": "behavior"
},
"scroll-target": {
"type": [
"Element",
"String"
],
"desc": "CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one",
"examples": [
":scroll-target=\"$refs.scrollTarget\"",
"scroll-target=\".scroll-target-class\"",
"scroll-target=\"#scroll-target-id\"",
"scroll-target=\"body\""
],
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Default slot can be used for content that gets displayed on top of the component"
},
"media": {
"desc": "Slot for describing <img> or <video> tags"
},
"content": {
"desc": "Scoped slot for describing content that gets displayed on top of the component; If specified, it overrides the default slot",
"scope": {
"percentScrolled": {
"type": "Number",
"desc": "Percentage (0.0 < x < 1.0) of scroll in regards to QParallax"
}
}
}
},
"events": {
"scroll": {
"desc": "Emitted when scrolling occurs",
"params": {
"percentage": {
"type": "Number",
"desc": "Number between 0.0 and 1.0 defining the scrolled percentage of the component"
}
}
}
}
}

335
node_modules/quasar/dist/api/QPopupEdit.json generated vendored Normal file
View file

@ -0,0 +1,335 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/popup-edit"
},
"props": {
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "Any",
"examples": [
"v-model=\"myValue\""
]
},
"title": {
"type": "String",
"desc": "Optional title (unless 'title' slot is used)",
"examples": [
"Calories"
],
"category": "content"
},
"buttons": {
"type": "Boolean",
"desc": "Show Set and Cancel buttons",
"category": "content"
},
"label-set": {
"type": "String",
"desc": "Override Set button label",
"examples": [
"OK"
],
"category": "content"
},
"label-cancel": {
"type": "String",
"desc": "Override Cancel button label",
"examples": [
"Cancel"
],
"category": "content"
},
"auto-save": {
"type": "Boolean",
"desc": "Automatically save the model (if changed) when user clicks/taps outside of the popup; It does not apply to ESC key",
"category": "behavior"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"default": "primary",
"required": false
},
"validate": {
"type": "Function",
"desc": "Validates model then triggers 'save' and closes Popup; Returns a Boolean ('true' means valid, 'false' means abort); Syntax: validate(value); For best performance, reference it from your scope and do not define it inline",
"params": {
"value": {
"type": "Any",
"desc": "Model to validate",
"examples": [
"My car"
]
}
},
"returns": {
"type": "Boolean",
"desc": "Is the model valid or not?"
},
"examples": [
":validate=\"myValidation\""
],
"category": "model"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"fit": {
"type": "Boolean",
"desc": "Allows the menu to match at least the full width of its target",
"category": "position"
},
"cover": {
"type": "Boolean",
"default": true,
"desc": "Allows the menu to cover its target. When used, the 'self' and 'fit' props are no longer effective",
"category": "position",
"required": false
},
"anchor": {
"type": "String",
"desc": "Two values setting the starting position or anchor point of the menu relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"category": "position"
},
"self": {
"type": "String",
"desc": "Two values setting the menu's own position relative to its target",
"values": [
"top left",
"top middle",
"top right",
"top start",
"top end",
"center left",
"center middle",
"center right",
"center start",
"center end",
"bottom left",
"bottom middle",
"bottom right",
"bottom start",
"bottom end"
],
"category": "position"
},
"offset": {
"type": "Array",
"desc": "An array of two numbers to offset the menu horizontally and vertically in pixels",
"examples": [
"[8, 8]",
"[5, 10]"
],
"category": "style"
},
"touch-position": {
"type": "Boolean",
"desc": "Allows for the target position to be set by the mouse position, when the target of the menu is either clicked or touched",
"category": "behavior"
},
"persistent": {
"type": "Boolean",
"desc": "Avoid menu closing by hitting ESC key or by clicking/tapping outside of the Popup",
"category": "behavior"
},
"separate-close-popup": {
"type": "Boolean",
"desc": "Separate from parent menu, marking it as a separate closing point for v-close-popup (without this, chained menus close all together)",
"category": "behavior"
},
"square": {
"type": "Boolean",
"desc": "Forces menu to have squared borders",
"category": "style"
},
"max-height": {
"type": "String",
"desc": "The maximum height of the menu; Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"max-width": {
"type": "String",
"desc": "The maximum width of the menu; Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Used for injecting the form component; Do NOT destructure it",
"scope": {
"initialValue": {
"type": "Any",
"desc": "Initial value",
"examples": [
0.241,
"Text"
]
},
"value": {
"type": "Any",
"desc": "Current value",
"examples": [
0.241,
"Text"
]
},
"validate": {
"type": "Function",
"desc": "Function that checks if the value is valid",
"params": {
"value": {
"type": "Any",
"required": true,
"desc": "Value to be checked",
"examples": [
0,
"Changed text"
]
}
},
"returns": {
"type": "Boolean",
"desc": "Checked value is valid or not"
}
},
"set": {
"type": "Function",
"desc": "Function that sets the value and closes the popup",
"params": null,
"returns": null
},
"cancel": {
"type": "Function",
"desc": "Function that cancels the editing and reverts the value to the initialValue",
"params": null,
"returns": null
},
"updatePosition": {
"type": "Function",
"desc": "There are some custom scenarios for which Quasar cannot automatically reposition the component without significant performance drawbacks so the optimal solution is for you to call this method when you need it",
"params": null,
"returns": null
}
}
}
},
"events": {
"update:model-value": {
"desc": "Emitted when Popup gets cancelled in order to reset model to its initial value; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"before-show": {
"desc": "Emitted right before Popup gets shown"
},
"show": {
"desc": "Emitted right after Popup gets shown"
},
"before-hide": {
"desc": "Emitted right before Popup gets dismissed"
},
"hide": {
"desc": "Emitted right after Popup gets dismissed"
},
"save": {
"desc": "Emitted when value has been successfully validated and it should be saved",
"params": {
"value": {
"type": "Any",
"desc": "Validated value to be saved"
},
"initialValue": {
"type": "Any",
"desc": "Initial value, before changes"
}
}
},
"cancel": {
"desc": "Emitted when user cancelled the change (hit ESC key or clicking outside of Popup or hit 'Cancel' button)",
"params": {
"value": {
"type": "Any",
"desc": "Edited value"
},
"initialValue": {
"type": "Any",
"desc": "Initial value, before changes"
}
}
}
},
"methods": {
"set": {
"desc": "Trigger a model update; Validates model (and emits 'save' event if it's the case) then closes Popup"
},
"cancel": {
"desc": "Triggers a model reset to its initial value ('cancel' event is emitted) then closes Popup"
},
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"updatePosition": {
"desc": "There are some custom scenarios for which Quasar cannot automatically reposition the component without significant performance drawbacks so the optimal solution is for you to call this method when you need it"
}
}
}

168
node_modules/quasar/dist/api/QPopupProxy.json generated vendored Normal file
View file

@ -0,0 +1,168 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/popup-proxy"
},
"props": {
"target": {
"type": [
"Boolean",
"String",
"Element"
],
"desc": "Configure a target element to trigger component toggle; 'true' means it enables the parent DOM element, 'false' means it disables attaching events to any DOM elements; By using a String (CSS selector) or a DOM element it attaches the events to the specified DOM element (if it exists)",
"default": true,
"values": [
"(Boolean) true",
"(Boolean) false",
"(CSS selector)",
"(DOM Element)"
],
"examples": [
":target=\"false\"",
":target=\"$refs.target\"",
"target=\".my-parent\"",
"target=\"#target-id\""
],
"category": "behavior",
"required": false
},
"no-parent-event": {
"type": "Boolean",
"desc": "Skips attaching events to the target DOM element (that trigger the element to get shown)",
"category": "behavior"
},
"context-menu": {
"type": "Boolean",
"desc": "Allows the component to behave like a context menu, which opens with a right mouse click (or long tap on mobile)",
"category": "behavior"
},
"model-value": {
"desc": "Defines the state of the component (shown/hidden); Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": false,
"syncable": true,
"category": "model",
"type": "Boolean"
},
"breakpoint": {
"type": [
"Number",
"String"
],
"desc": "Breakpoint (in pixels) of window width/height (whichever is smaller) from where a Menu will get to be used instead of a Dialog",
"default": 450,
"category": "behavior",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"before-show": {
"desc": "Emitted when component triggers show() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"show": {
"desc": "Emitted after component has triggered show()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"before-hide": {
"desc": "Emitted when component triggers hide() but before it finishes doing it",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
},
"hide": {
"desc": "Emitted after component has triggered hide()",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"show": {
"desc": "Triggers component to show",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"hide": {
"desc": "Triggers component to hide",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
}
},
"toggle": {
"params": {
"evt": {
"type": "Event",
"desc": "JS event object",
"required": false
}
},
"desc": "Triggers component to toggle between show/hide"
}
},
"computedProps": {
"currentComponent": {
"type": "Object",
"desc": "Access current underlying component (QMenu or QDialog)",
"definition": {
"type": {
"type": "String",
"desc": "Component type",
"values": [
"dialog",
"menu"
]
},
"ref": {
"type": "Component",
"tsType": "QPopupProxyInnerComponent",
"desc": "The actual component (QMenu or QDialog); Access it directly, without '.value'"
}
}
}
}
}

91
node_modules/quasar/dist/api/QPullToRefresh.json generated vendored Normal file
View file

@ -0,0 +1,91 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/pull-to-refresh"
},
"props": {
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the icon from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"bg-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for background of the icon container from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"icon": {
"type": "String",
"desc": "Icon to display when refreshing the content",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"no-mouse": {
"type": "Boolean",
"desc": "Don't listen for mouse events",
"category": "behavior"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"scroll-target": {
"type": [
"Element",
"String"
],
"desc": "CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one",
"examples": [
":scroll-target=\"$refs.scrollTarget\"",
"scroll-target=\".scroll-target-class\"",
"scroll-target=\"#scroll-target-id\"",
"scroll-target=\"body\""
],
"category": "behavior"
}
},
"slots": {
"default": {
"desc": "Content (area controlled by the component) goes here"
}
},
"events": {
"refresh": {
"desc": "Called whenever a refresh is triggered; at this time, your function should load more data",
"params": {
"done": {
"type": "Function",
"desc": "Call the done() function when your data has been refreshed",
"params": null,
"returns": null
}
}
}
},
"methods": {
"trigger": {
"desc": "Triggers a refresh"
},
"updateScrollTarget": {
"desc": "Updates the scroll target; Useful when the parent elements change so that the scrolling target also changes"
}
}
}

158
node_modules/quasar/dist/api/QRadio.json generated vendored Normal file
View file

@ -0,0 +1,158 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/radio"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"Number",
"String",
"null",
"undefined"
],
"examples": [
"v-model=\"option\""
]
},
"val": {
"type": [
"Number",
"String",
"null",
"undefined"
],
"required": true,
"desc": "The actual value of the option with which model value is changed",
"examples": [
"opt1",
50
],
"category": "model"
},
"label": {
"type": "String",
"desc": "Label to display along the radio control (or use the default slot instead of this prop)",
"examples": [
"label=\"Option 1\""
],
"category": "label"
},
"left-label": {
"type": "Boolean",
"desc": "Label (if any specified) should be displayed on the left side of the checkbox",
"category": "label"
},
"checked-icon": {
"type": "String",
"desc": "The icon to be used when selected (instead of the default design)",
"examples": [
"visibility"
],
"category": "icons",
"addedIn": "v2.5"
},
"unchecked-icon": {
"type": "String",
"desc": "The icon to be used when un-selected (instead of the default design)",
"examples": [
"visibility_off"
],
"category": "icons",
"addedIn": "v2.5"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"keep-color": {
"type": "Boolean",
"desc": "Should the color (if specified any) be kept when checkbox is unticked?",
"category": "behavior"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
}
},
"slots": {
"default": {
"desc": "Default slot can be used as label, unless 'label' prop is specified; Suggestion: string"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
},
"evt": {
"type": "Event",
"desc": "JS event object",
"required": true
}
}
}
},
"methods": {
"set": {
"desc": "Sets the Radio's v-model to equal the val"
}
}
}

784
node_modules/quasar/dist/api/QRange.json generated vendored Normal file
View file

@ -0,0 +1,784 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/range"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"min": {
"type": "Number",
"desc": "Minimum value of the model; Set track's minimum value",
"default": 0,
"examples": [
":min=\"0\""
],
"category": "model",
"required": false
},
"max": {
"type": "Number",
"desc": "Maximum value of the model; Set track's maximum value",
"default": 100,
"category": "model",
"required": false
},
"inner-min": {
"type": "Number",
"desc": "Inner minimum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be higher or equal to 'min' prop; Defaults to 'min' prop",
"category": "model",
"addedIn": "v2.4"
},
"inner-max": {
"type": "Number",
"desc": "Inner maximum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be lower or equal to 'max' prop; Defaults to 'max' prop",
"category": "model",
"addedIn": "v2.4"
},
"step": {
"type": "Number",
"desc": "Specify step amount between valid values (> 0.0); When step equals to 0 it defines infinite granularity",
"default": 1,
"category": "model",
"required": false
},
"snap": {
"type": "Boolean",
"desc": "Snap on valid values, rather than sliding freely; Suggestion: use with 'step' prop",
"category": "behavior"
},
"reverse": {
"type": "Boolean",
"desc": "Work in reverse (changes direction)",
"category": "behavior"
},
"vertical": {
"type": "Boolean",
"desc": "Display in vertical direction",
"category": "behavior"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the track (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"track-img": {
"type": "String",
"desc": "Apply a pattern image on the track",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"inner-track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the inner track (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"inner-track-img": {
"type": "String",
"desc": "Apply a pattern image on the inner track",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"selection-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the selection bar (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"selection-img": {
"type": "String",
"desc": "Apply a pattern image on the selection bar",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"label": {
"type": "Boolean",
"desc": "Popup a label when user clicks/taps on the slider thumb and moves it",
"category": "content"
},
"label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"label-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"switch-label-side": {
"type": "Boolean",
"desc": "Switch the position of the label (top <-> bottom or left <-> right)",
"category": "style",
"addedIn": "v2.4"
},
"label-always": {
"type": "Boolean",
"desc": "Always display the label",
"category": "behavior|content"
},
"markers": {
"type": [
"Boolean",
"Number"
],
"desc": "Display markers on the track, one for each possible value for the model or using a custom step (when specifying a Number)",
"category": "content",
"examples": [
"markers",
":markers=\"5\""
]
},
"marker-labels": {
"type": [
"Boolean",
"Array",
"Object",
"Function"
],
"tsType": "SliderMarkerLabels",
"desc": "Configure the marker labels (or show the default ones if 'true'); Array of definition Objects or Object with key-value where key is the model and the value is the marker label definition",
"definition": {
"value": {
"type": "Number",
"required": true,
"desc": "Value of equivalent model where to position the marker"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Label to use"
},
"classes": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes to be attributed to the marker label",
"examples": [
"my-class-name"
]
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
},
"params": {
"value": {
"type": "Number",
"desc": "The marker value to transform",
"required": true
}
},
"returns": {
"type": [
"String",
"Object"
],
"desc": "Marker definition Object or directly a String for the label of the marker",
"definition": {
"value": {
"type": "Number",
"desc": "Value of equivalent model where to position the marker"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Label to use"
},
"classes": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes to be attributed to the marker label",
"examples": [
"my-class-name"
]
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"category": "content",
"examples": [
true,
"[ { value: 0, label: '0%' }, { value: 5, classes: 'my-class', style: { width: '24px' } } ]",
"{ 0: '0%', 5: { label: '5%', classes: 'my-class', style: { width: '24px' } } }",
"val => (10 * val) + '%'",
"val => ({ label: (10 * val) + '%', classes: 'my-class', style: { width: '24px' } })"
],
"addedIn": "v2.4"
},
"marker-labels-class": {
"type": "String",
"desc": "CSS class(es) to apply to the marker labels container",
"examples": [
"text-orange"
],
"category": "style",
"addedIn": "v2.4"
},
"switch-marker-labels-side": {
"type": "Boolean",
"desc": "Switch the position of the marker labels (top <-> bottom or left <-> right)",
"category": "style",
"addedIn": "v2.4"
},
"track-size": {
"type": "String",
"desc": "Track size (including CSS unit)",
"default": "4px",
"examples": [
"35px"
],
"category": "style",
"addedIn": "v2.4",
"required": false
},
"thumb-size": {
"type": "String",
"desc": "Thumb size (including CSS unit)",
"default": "20px",
"examples": [
"20px"
],
"category": "style",
"addedIn": "v2.4",
"required": false
},
"thumb-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"thumb-path": {
"type": "String",
"desc": "Set custom thumb svg path",
"default": "M 4, 10 a 6,6 0 1,0 12,0 a 6,6 0 1,0 -12,0",
"examples": [
"M5 5 h10 v10 h-10 v-10"
],
"category": "style",
"required": false
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"model-value": {
"desc": "Model of the component of type { min, max } (both values must be between global min/max); Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"Object",
"null",
"undefined"
],
"definition": {
"min": {
"type": [
"Number",
"null"
],
"desc": "Model value for left thumb"
},
"max": {
"type": [
"Number",
"null"
],
"desc": "Model value for right thumb"
}
},
"examples": [
"v-model=\"positionModel\""
]
},
"drag-range": {
"type": "Boolean",
"desc": "User can drag range instead of just the two thumbs",
"category": "content"
},
"drag-only-range": {
"type": "Boolean",
"desc": "User can drag only the range instead and NOT the two thumbs",
"category": "content"
},
"left-label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for left label background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels"
},
"left-label-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for left label text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels"
},
"right-label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for right label background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels"
},
"right-label-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for right label text from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels"
},
"left-label-value": {
"type": [
"String",
"Number"
],
"desc": "Override default label for min value",
"examples": [
":left-label-value=\"model.min + 'px'\""
],
"category": "labels"
},
"right-label-value": {
"type": [
"String",
"Number"
],
"desc": "Override default label for max value",
"examples": [
":right-label-value=\"model.max + 'px'\""
],
"category": "labels"
},
"left-thumb-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name (from the Quasar Color Palette) for left thumb",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels",
"addedIn": "v2.4"
},
"right-thumb-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name (from the Quasar Color Palette) for right thumb",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "labels",
"addedIn": "v2.4"
}
},
"slots": {
"marker-label": {
"desc": "What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>",
"addedIn": "v2.4",
"scope": {
"marker": {
"type": "Object",
"tsType": "SliderMarkerLabelConfig",
"desc": "Config for current marker label",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerList": {
"type": "Array",
"tsType": "SliderMarkerLabelArrayConfig",
"desc": "Array of marker label configs",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerMap": {
"type": "Object",
"tsType": "SliderMarkerLabelObjectConfig",
"desc": "Object with key-value where key is the model and the value is the marker label config",
"definition": {
"...key": {
"type": "Object",
"desc": "Marker label config",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
}
}
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"getStyle": {
"type": "Function",
"desc": "Get CSS style Object to apply to a marker element at respective model value; For perf reasons, use only if requested model value is not already part of markerMap",
"params": {
"value": {
"type": "Number",
"desc": "The marker label equivalent model value",
"required": true
}
},
"returns": {
"type": "Object",
"desc": "CSS style Object to apply to a marker element at respective model value"
}
}
}
},
"marker-label-group": {
"desc": "What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>",
"addedIn": "v2.4",
"scope": {
"markerList": {
"type": "Array",
"tsType": "SliderMarkerLabelArrayConfig",
"desc": "Array of marker label configs",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerMap": {
"type": "Object",
"tsType": "SliderMarkerLabelObjectConfig",
"desc": "Object with key-value where key is the model and the value is the marker label config",
"definition": {
"...key": {
"type": "Object",
"desc": "Marker label config",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
}
}
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"getStyle": {
"type": "Function",
"desc": "Get CSS style Object to apply to a marker element at respective model value; For perf reasons, use only if requested model value is not already part of markerMap",
"params": {
"value": {
"type": "Number",
"desc": "The marker label equivalent model value",
"required": true
}
},
"returns": {
"type": "Object",
"desc": "CSS style Object to apply to a marker element at respective model value"
}
}
}
}
},
"events": {
"change": {
"desc": "Emitted on lazy model value change (after user slides then releases the thumb)",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"pan": {
"desc": "Triggered when user starts panning on the component",
"params": {
"phase": {
"type": "String",
"desc": "Phase of panning",
"values": [
"start",
"end"
]
}
}
},
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
}
}
}

186
node_modules/quasar/dist/api/QRating.json generated vendored Normal file
View file

@ -0,0 +1,186 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/rating"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"model-value": {
"desc": "Model of the component; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": "Number",
"examples": [
"v-model=\"rating\"",
":model-value=\"rating\"",
":model-value=\"2\""
]
},
"max": {
"type": [
"Number",
"String"
],
"desc": "Number of icons to display",
"default": 5,
"category": "general",
"required": false
},
"icon": {
"type": [
"String",
"Array"
],
"desc": "Icon name following Quasar convention; make sure you have the icon library installed unless you are using 'img:' prefix; If an array is provided each rating value will use the corresponding icon in the array (0 based)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-selected": {
"type": [
"String",
"Array"
],
"desc": "Icon name following Quasar convention to be used when selected (optional); make sure you have the icon library installed unless you are using 'img:' prefix; If an array is provided each rating value will use the corresponding icon in the array (0 based)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-half": {
"type": [
"String",
"Array"
],
"desc": "Icon name following Quasar convention to be used when selected (optional); make sure you have the icon library installed unless you are using 'img:' prefix; If an array is provided each rating value will use the corresponding icon in the array (0 based)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"icon-aria-label": {
"type": [
"String",
"Array"
],
"desc": "Label to be set on aria-label for Icon; If an array is provided each rating value will use the corresponding aria-label in the array (0 based); If string value is provided the rating value will be appended; If not provided the name of the icon will be used",
"examples": [
"Rating",
"[\"Bad\", \"Normal\", \"Good\"]"
],
"category": "accessibility",
"addedIn": "v1.20.3"
},
"color": {
"type": [
"String",
"Array"
],
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette; v1.5.0+: If an array is provided each rating value will use the corresponding color in the array (0 based)",
"examples": [
"primary",
"teal",
"teal-10",
"primary",
"teal-10",
"[\"accent\", \"grey-7\"] "
],
"category": "style"
},
"color-selected": {
"type": [
"String",
"Array"
],
"tsType": "NamedColor",
"desc": "Color name from the Quasar Palette for selected icons",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"color-half": {
"type": [
"String",
"Array"
],
"tsType": "NamedColor",
"desc": "Color name from the Quasar Palette for half selected icons",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"no-dimming": {
"type": "Boolean",
"desc": "Does not lower opacity for unselected icons",
"category": "style"
},
"no-reset": {
"type": "Boolean",
"desc": "When used, disables default behavior of clicking/tapping on icon which represents current model value to reset model to 0",
"category": "model"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
}
},
"slots": {
"tip-[name]": {
"desc": "Slot to define the tooltip of icon at '[name]' where name is a 1-based index; Suggestion: QTooltip"
}
},
"events": {
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
}
}
}

56
node_modules/quasar/dist/api/QResizeObserver.json generated vendored Normal file
View file

@ -0,0 +1,56 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/resize-observer"
},
"props": {
"debounce": {
"type": [
"String",
"Number"
],
"desc": "Debounce amount (in milliseconds)",
"default": 100,
"examples": [
"0",
"530"
],
"category": "behavior",
"required": false
}
},
"events": {
"resize": {
"desc": "Parent element has resized (width or height changed)",
"params": {
"size": {
"type": "Object",
"desc": "New size",
"definition": {
"height": {
"type": "Number",
"required": true,
"desc": "Layout height"
},
"width": {
"type": "Number",
"required": true,
"desc": "Layout width"
}
}
}
}
}
},
"methods": {
"trigger": {
"desc": "Emit a 'resize' event",
"params": {
"immediately": {
"type": "Boolean",
"desc": "Skip over the debounce amount"
}
}
}
}
}

26
node_modules/quasar/dist/api/QResponsive.json generated vendored Normal file
View file

@ -0,0 +1,26 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/responsive"
},
"props": {
"ratio": {
"type": [
"String",
"Number"
],
"desc": "Aspect ratio for the content; If value is a String, then avoid using a computational statement (like '16/9') and instead specify the String value of the result directly (eg. '1.7777')",
"examples": [
":ratio=\"4/3\"",
":ratio=\"16/9\"",
"ratio=\"1\""
],
"category": "style"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

225
node_modules/quasar/dist/api/QRouteTab.json generated vendored Normal file
View file

@ -0,0 +1,225 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/tabs"
},
"props": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Superseded by 'href' prop if used",
"examples": [
"/home/dashboard",
":to=\"{ name: 'my-route-name' }\""
],
"category": "navigation"
},
"exact": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'exact' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Superseded by 'href' prop if used",
"category": "navigation"
},
"active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-active-class"
],
"category": "navigation"
},
"exact-active-class": {
"type": "String",
"desc": "Equivalent to Vue Router <router-link> 'active-class' property; Superseded by 'href' prop if used",
"examples": [
"my-exact-active-class"
],
"category": "navigation"
},
"href": {
"type": "String",
"desc": "Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"https://quasar.dev"
],
"category": "navigation",
"addedIn": "v2.4"
},
"target": {
"type": "String",
"desc": "Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace'/'active-class'/'exact-active-class' props",
"examples": [
"_blank",
"_self",
"_parent",
"_top"
],
"category": "navigation",
"addedIn": "v2.4"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"icon": {
"type": "String",
"desc": "Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)",
"examples": [
"map",
"ion-add",
"img:https://cdn.quasar.dev/logo-v2/svg/logo.svg",
"img:path/to/some_image.png"
],
"category": "content"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "A number or string to label the tab",
"examples": [
"Home"
],
"category": "content"
},
"alert": {
"type": [
"Boolean",
"String"
],
"desc": "Adds an alert symbol to the tab, notifying the user there are some updates; If its value is not a Boolean, then you can specify a color",
"examples": [
"alert",
"alert=\"purple\""
],
"category": "content"
},
"alert-icon": {
"type": "String",
"desc": "Adds a floating icon to the tab, notifying the user there are some updates; It's displayed only if 'alert' is set; Can use the color specified by 'alert' prop",
"examples": [
"alert-icon=\"alarm_on\""
],
"category": "content"
},
"name": {
"type": [
"Number",
"String"
],
"desc": "Panel name",
"default": "A random UID",
"examples": [
"home",
":name=\"1\""
],
"category": "general",
"required": false
},
"no-caps": {
"type": "Boolean",
"desc": "Turns off capitalizing all letters within the tab (which is the default)",
"category": "content"
},
"content-class": {
"type": "String",
"desc": "Class definitions to be attributed to the content wrapper",
"examples": [
"my-special-class"
],
"category": "style"
},
"ripple": {
"type": [
"Boolean",
"Object"
],
"desc": "Configure material ripple (disable it by setting it to 'false' or supply a config object)",
"default": true,
"examples": [
false,
"{ early: true, center: true, color: 'teal', keyCodes: [] }"
],
"category": "style",
"required": false
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
}
},
"slots": {
"default": {
"desc": "Suggestion: QMenu, QTooltip"
}
},
"events": {
"click": {
"desc": "Emitted when the component is clicked",
"params": {
"evt": {
"type": "Event",
"desc": "JS event object; If you want to cancel navigation then call evt.preventDefault() synchronously in your event handler"
},
"go": {
"type": "Function",
"desc": "When you need to control the time at which the component should trigger the route navigation then call evt.preventDefault() synchronously and then call this function at your convenience; Useful if you have async work to be done before the actual route navigation or if you want to redirect somewhere else",
"required": false,
"params": {
"opts": {
"type": "Object",
"desc": "Optional options",
"required": false,
"definition": {
"to": {
"type": [
"String",
"Object"
],
"desc": "Equivalent to Vue Router <router-link> 'to' property; Specify it explicitly otherwise it will be set with same value as component's 'to' prop",
"required": false,
"examples": [
"/home/dashboard",
"{ name: 'my-route-name' }"
]
},
"replace": {
"type": "Boolean",
"desc": "Equivalent to Vue Router <router-link> 'replace' property; Specify it explicitly otherwise it will be set with same value as component's 'replace' prop",
"required": false
},
"returnRouterError": {
"type": "Boolean",
"desc": "Return the router error, if any; Otherwise the returned Promise will always fulfill",
"required": false
}
},
"addedIn": "v2.9"
}
},
"returns": {
"type": "Promise<any>",
"desc": "Returns the router's navigation promise",
"addedIn": "v2.9"
}
}
}
}
}
}

344
node_modules/quasar/dist/api/QScrollArea.json generated vendored Normal file
View file

@ -0,0 +1,344 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/scroll-area"
},
"props": {
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"bar-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Object with CSS properties and values for custom styling the scrollbars (both vertical and horizontal)",
"examples": [
":bar-style=\"{ borderRadius: '5px', background: 'red', opacity: 1 }\""
],
"category": "style"
},
"vertical-bar-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"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"
},
"horizontal-bar-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"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"
},
"thumb-style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"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 }\""
],
"category": "style"
},
"vertical-thumb-style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"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"
},
"horizontal-thumb-style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"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"
},
"content-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Object with CSS properties and values for styling the container of QScrollArea",
"examples": [
":content-style=\"{ backgroundColor: '#C0C0C0' }\""
],
"category": "style"
},
"content-active-style": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueStyleProp",
"desc": "Object with CSS properties and values for styling the container of QScrollArea when scroll area becomes active (is mouse hovered)",
"examples": [
":content-active-style=\"{ backgroundColor: 'white' }\""
],
"category": "style"
},
"visible": {
"type": "Boolean",
"desc": "Manually control the visibility of the scrollbar; Overrides default mouse over/leave behavior",
"category": "behavior"
},
"delay": {
"type": [
"Number",
"String"
],
"desc": "When content changes, the scrollbar appears; this delay defines the amount of time (in milliseconds) before scrollbars disappear again (if component is not hovered)",
"default": 1000,
"category": "behavior",
"required": false
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
},
"events": {
"scroll": {
"desc": "Emitted when scroll information changes (and listener is configured)",
"params": {
"info": {
"type": "Object",
"desc": "An object containing scroll information",
"definition": {
"ref": {
"type": "Component",
"tsType": "QScrollArea",
"required": true,
"desc": "Vue reference to the QScrollArea which triggered the event"
},
"verticalPosition": {
"type": "Number",
"required": true,
"desc": "Vertical scroll position (in px)"
},
"verticalPercentage": {
"type": "Number",
"required": true,
"desc": "Vertical scroll percentage (0.0 <= x <= 1.0)"
},
"verticalSize": {
"type": "Number",
"required": true,
"desc": "Vertical scroll size (in px)"
},
"verticalContainerSize": {
"type": "Number",
"required": true,
"desc": "Height of the container (in px)"
},
"horizontalPosition": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll position (in px)"
},
"horizontalPercentage": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)"
},
"horizontalSize": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll size (in px)"
},
"horizontalContainerSize": {
"type": "Number",
"required": true,
"desc": "Width of the container (in px)"
}
}
}
}
}
},
"methods": {
"getScrollTarget": {
"desc": "Get the scrolling DOM element target",
"returns": {
"type": "Element",
"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",
"required": true,
"desc": "Vertical scroll position (in px)"
},
"verticalPercentage": {
"type": "Number",
"required": true,
"desc": "Vertical scroll percentage (0.0 <= x <= 1.0)"
},
"verticalSize": {
"type": "Number",
"required": true,
"desc": "Vertical scroll size (in px)"
},
"verticalContainerSize": {
"type": "Number",
"required": true,
"desc": "Height of the container (in px)"
},
"horizontalPosition": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll position (in px)"
},
"horizontalPercentage": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)"
},
"horizontalSize": {
"type": "Number",
"required": true,
"desc": "Horizontal scroll size (in px)"
},
"horizontalContainerSize": {
"type": "Number",
"required": true,
"desc": "Width of the container (in px)"
}
}
}
},
"getScrollPosition": {
"desc": "Get current scroll position",
"returns": {
"type": "Object",
"desc": "An object containing scroll position information",
"definition": {
"top": {
"type": "Number",
"required": true,
"desc": "Scroll offset from top (vertical)"
},
"left": {
"type": "Number",
"required": true,
"desc": "Scroll offset from left (horizontal)"
}
},
"examples": [
"{ top: 10, left: 0 }"
]
}
},
"getScrollPercentage": {
"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",
"required": true,
"desc": "Scroll percentage (0.0 <= x <= 1.0) offset from top (vertical)"
},
"left": {
"type": "Number",
"required": true,
"desc": "Scroll percentage (0.0 <= x <= 1.0) offset from left (horizontal)"
}
},
"examples": [
"{ top: 0.212, left: 0 }"
]
}
},
"setScrollPosition": {
"desc": "Set scroll position to an offset; If a duration (in milliseconds) is specified then the scroll is animated",
"params": {
"axis": {
"type": "String",
"required": true,
"desc": "Scroll axis",
"values": [
"vertical",
"horizontal"
]
},
"offset": {
"type": "Number",
"required": true,
"desc": "Scroll position offset from top (in pixels)"
},
"duration": {
"type": "Number",
"desc": "Duration (in milliseconds) enabling animated scroll"
}
}
},
"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",
"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",
"required": true
},
"duration": {
"type": "Number",
"desc": "Duration (in milliseconds) enabling animated scroll"
}
}
}
}
}

140
node_modules/quasar/dist/api/QScrollObserver.json generated vendored Normal file
View file

@ -0,0 +1,140 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/scroll-observer"
},
"props": {
"debounce": {
"type": [
"String",
"Number"
],
"desc": "Debounce amount (in milliseconds)",
"examples": [
"0",
"530"
],
"category": "behavior"
},
"axis": {
"type": "String",
"desc": "Axis on which to detect changes",
"values": [
"both",
"vertical",
"horizontal"
],
"default": "vertical",
"category": "behavior",
"required": false
},
"scroll-target": {
"type": [
"Element",
"String"
],
"desc": "CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one",
"examples": [
":scroll-target=\"$refs.scrollTarget\"",
"scroll-target=\".scroll-target-class\"",
"scroll-target=\"#scroll-target-id\"",
"scroll-target=\"body\""
],
"category": "behavior"
}
},
"events": {
"scroll": {
"desc": "Emitted when scroll position changes",
"params": {
"details": {
"type": "Object",
"desc": "Scroll details",
"definition": {
"position": {
"type": "Object",
"required": true,
"desc": "Scroll offset (from top and left)",
"definition": {
"top": {
"type": "Number",
"required": true,
"desc": "Scroll offset from top (vertical)"
},
"left": {
"type": "Number",
"required": true,
"desc": "Scroll offset from left (horizontal)"
}
}
},
"direction": {
"type": "String",
"required": true,
"desc": "Direction of scroll",
"values": [
"up",
"down",
"left",
"right"
]
},
"directionChanged": {
"type": "Boolean",
"required": true,
"desc": "Has scroll direction changed since event was last emitted?"
},
"delta": {
"type": "Object",
"required": true,
"desc": "Delta of distance (in pixels) since event was last emitted",
"definition": {
"top": {
"type": "Number",
"required": true,
"desc": "Vertical delta distance since event was last emitted"
},
"left": {
"type": "Number",
"required": true,
"desc": "Horizontal delta distance since event was last emitted"
}
}
},
"inflectionPoint": {
"type": "Object",
"required": true,
"desc": "Last scroll offset where scroll direction has changed",
"definition": {
"top": {
"type": "Number",
"required": true,
"desc": "Scroll offset from top (vertical)"
},
"left": {
"type": "Number",
"required": true,
"desc": "Scroll offset from left (horizontal)"
}
}
}
}
}
}
}
},
"methods": {
"trigger": {
"desc": "Emit a 'scroll' event",
"params": {
"immediately": {
"type": "Boolean",
"desc": "Skip over the debounce amount"
}
}
},
"getPosition": {
"desc": "Get current scroll details under the form of an Object: { position, direction, directionChanged, inflectionPoint }"
}
}
}

1371
node_modules/quasar/dist/api/QSelect.json generated vendored Normal file
View file

File diff suppressed because it is too large Load diff

67
node_modules/quasar/dist/api/QSeparator.json generated vendored Normal file
View file

@ -0,0 +1,67 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/separator"
},
"props": {
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"spaced": {
"type": [
"Boolean",
"String"
],
"desc": "If set to true, the corresponding direction margins will be set to 8px; It can also be set to a size in CSS units, including unit name, or one of the xs|sm|md|lg|xl predefined sizes",
"default": "md",
"examples": [
"12px",
"sm",
"md"
],
"category": "content",
"required": false
},
"inset": {
"type": [
"Boolean",
"String"
],
"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",
"values": [
"(Boolean) true",
"(Boolean) false",
"item",
"item-thumbnail"
],
"category": "content"
},
"vertical": {
"type": "Boolean",
"desc": "If set to true, the separator will be vertical.",
"category": "content"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
}

122
node_modules/quasar/dist/api/QSkeleton.json generated vendored Normal file
View file

@ -0,0 +1,122 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/skeleton"
},
"props": {
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"type": {
"type": "String",
"desc": "Type of skeleton placeholder",
"values": [
"text",
"rect",
"circle",
"QBtn",
"QBadge",
"QChip",
"QToolbar",
"QCheckbox",
"QRadio",
"QToggle",
"QSlider",
"QRange",
"QInput",
"QAvatar"
],
"default": "rect",
"category": "content",
"required": false
},
"animation": {
"type": "String",
"desc": "The animation effect of the skeleton placeholder",
"values": [
"wave",
"pulse",
"pulse-x",
"pulse-y",
"fade",
"blink",
"none"
],
"default": "wave",
"category": "style",
"required": false
},
"animation-speed": {
"type": [
"String",
"Number"
],
"desc": "Animation speed (in milliseconds, without unit)",
"examples": [
500,
"1200"
],
"category": "style",
"default": 300,
"addedIn": "v2.2",
"required": false
},
"square": {
"type": "Boolean",
"desc": "Removes border-radius so borders are squared",
"category": "style"
},
"bordered": {
"type": "Boolean",
"desc": "Applies a default border to the component",
"category": "style"
},
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name; Overrides 'height' and 'width' props and applies the value to both height and width",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"width": {
"type": "String",
"desc": "Width in CSS units, including unit name; Apply custom width; Use this prop or through CSS; Overridden by 'size' prop if used",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"height": {
"type": "String",
"desc": "Height in CSS units, including unit name; Apply custom height; Use this prop or through CSS; Overridden by 'size' prop if used",
"examples": [
"16px",
"2rem"
],
"category": "style"
},
"tag": {
"type": "String",
"desc": "HTML tag to use",
"examples": [
"div",
"span",
"div",
"span"
],
"category": "content",
"default": "div",
"required": false
}
},
"slots": {
"default": {
"desc": "Default slot in the devland unslotted content of the component"
}
}
}

214
node_modules/quasar/dist/api/QSlideItem.json generated vendored Normal file
View file

@ -0,0 +1,214 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/slide-item"
},
"props": {
"left-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for left-side background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"right-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for right-side background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"top-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for top-side background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"bottom-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for bottom-side background from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
}
},
"slots": {
"default": {
"desc": "This is where item's sections go; Suggestion: QItemSection"
},
"left": {
"desc": "Left side content when sliding"
},
"right": {
"desc": "Right side content when sliding"
},
"top": {
"desc": "Top side content when sliding"
},
"bottom": {
"desc": "Bottom side content when sliding"
}
},
"events": {
"left": {
"desc": "Emitted when user finished sliding the item to the left",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"reset": {
"type": "Function",
"required": true,
"desc": "When called, it resets the component to its initial non-slided state",
"params": null,
"returns": null
}
}
}
}
},
"right": {
"desc": "Emitted when user finished sliding the item to the right",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"reset": {
"type": "Function",
"required": true,
"desc": "When called, it resets the component to its initial non-slided state",
"params": null,
"returns": null
}
}
}
}
},
"top": {
"desc": "Emitted when user finished sliding the item up",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"reset": {
"type": "Function",
"required": true,
"desc": "When called, it resets the component to its initial non-slided state",
"params": null,
"returns": null
}
}
}
}
},
"bottom": {
"desc": "Emitted when user finished sliding the item down",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"reset": {
"type": "Function",
"required": true,
"desc": "When called, it resets the component to its initial non-slided state",
"params": null,
"returns": null
}
}
}
}
},
"slide": {
"desc": "Emitted while user is sliding the item to one of the available sides",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"side": {
"type": "String",
"required": true,
"desc": "Side to which sliding is taking effect",
"values": [
"left",
"right",
"top",
"bottom"
]
},
"ratio": {
"type": "Number",
"required": true,
"desc": "Ratio of how much of the required slide was performed (0 <= x <= 1)"
},
"isReset": {
"type": "Boolean",
"required": true,
"desc": "Ratio has been reset"
}
}
}
}
},
"action": {
"desc": "Emitted when user finished sliding the item to either sides",
"params": {
"details": {
"type": "Object",
"desc": "Details",
"definition": {
"side": {
"type": "String",
"required": true,
"desc": "Side to which sliding has taken effect",
"values": [
"left",
"right",
"top",
"bottom"
]
},
"reset": {
"type": "Function",
"required": true,
"desc": "When called, it resets the component to its initial non-slided state",
"params": null,
"returns": null
}
}
}
}
}
},
"methods": {
"reset": {
"desc": "Reset to initial state (not swiped to any side)"
}
}
}

33
node_modules/quasar/dist/api/QSlideTransition.json generated vendored Normal file
View file

@ -0,0 +1,33 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/slide-transition"
},
"props": {
"appear": {
"type": "Boolean",
"desc": "If set to true, the transition will be applied on the initial render.",
"category": "behavior"
},
"duration": {
"type": "Number",
"desc": "Duration (in milliseconds) enabling animated scroll.",
"default": 300,
"category": "behavior",
"required": false
}
},
"slots": {
"default": {
"desc": "This is where content goes"
}
},
"events": {
"show": {
"desc": "Emitted when component show animation is finished"
},
"hide": {
"desc": "Emitted when component hide animation is finished"
}
}
}

682
node_modules/quasar/dist/api/QSlider.json generated vendored Normal file
View file

@ -0,0 +1,682 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/slider"
},
"props": {
"name": {
"type": "String",
"desc": "Used to specify the name of the control; Useful if dealing with forms submitted directly to a URL",
"examples": [
"car_id"
],
"category": "behavior"
},
"min": {
"type": "Number",
"desc": "Minimum value of the model; Set track's minimum value",
"default": 0,
"examples": [
":min=\"0\""
],
"category": "model",
"required": false
},
"max": {
"type": "Number",
"desc": "Maximum value of the model; Set track's maximum value",
"default": 100,
"category": "model",
"required": false
},
"inner-min": {
"type": "Number",
"desc": "Inner minimum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be higher or equal to 'min' prop; Defaults to 'min' prop",
"category": "model",
"addedIn": "v2.4"
},
"inner-max": {
"type": "Number",
"desc": "Inner maximum value of the model; Use in case you need the model value to be inside of the track's min-max values; Needs to be lower or equal to 'max' prop; Defaults to 'max' prop",
"category": "model",
"addedIn": "v2.4"
},
"step": {
"type": "Number",
"desc": "Specify step amount between valid values (> 0.0); When step equals to 0 it defines infinite granularity",
"default": 1,
"category": "model",
"required": false
},
"snap": {
"type": "Boolean",
"desc": "Snap on valid values, rather than sliding freely; Suggestion: use with 'step' prop",
"category": "behavior"
},
"reverse": {
"type": "Boolean",
"desc": "Work in reverse (changes direction)",
"category": "behavior"
},
"vertical": {
"type": "Boolean",
"desc": "Display in vertical direction",
"category": "behavior"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the track (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"track-img": {
"type": "String",
"desc": "Apply a pattern image on the track",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"inner-track-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the inner track (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"inner-track-img": {
"type": "String",
"desc": "Apply a pattern image on the inner track",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"selection-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for the selection bar (can be 'transparent' too) from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"selection-img": {
"type": "String",
"desc": "Apply a pattern image on the selection bar",
"transformAssetUrls": true,
"examples": [
"~assets/my-pattern.png"
],
"category": "style",
"addedIn": "v2.4"
},
"label": {
"type": "Boolean",
"desc": "Popup a label when user clicks/taps on the slider thumb and moves it",
"category": "content"
},
"label-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"label-text-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"switch-label-side": {
"type": "Boolean",
"desc": "Switch the position of the label (top <-> bottom or left <-> right)",
"category": "style",
"addedIn": "v2.4"
},
"label-always": {
"type": "Boolean",
"desc": "Always display the label",
"category": "behavior|content"
},
"markers": {
"type": [
"Boolean",
"Number"
],
"desc": "Display markers on the track, one for each possible value for the model or using a custom step (when specifying a Number)",
"category": "content",
"examples": [
"markers",
":markers=\"5\""
]
},
"marker-labels": {
"type": [
"Boolean",
"Array",
"Object",
"Function"
],
"tsType": "SliderMarkerLabels",
"desc": "Configure the marker labels (or show the default ones if 'true'); Array of definition Objects or Object with key-value where key is the model and the value is the marker label definition",
"definition": {
"value": {
"type": "Number",
"required": true,
"desc": "Value of equivalent model where to position the marker"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Label to use"
},
"classes": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes to be attributed to the marker label",
"examples": [
"my-class-name"
]
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
},
"params": {
"value": {
"type": "Number",
"desc": "The marker value to transform",
"required": true
}
},
"returns": {
"type": [
"String",
"Object"
],
"desc": "Marker definition Object or directly a String for the label of the marker",
"definition": {
"value": {
"type": "Number",
"desc": "Value of equivalent model where to position the marker"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Label to use"
},
"classes": {
"type": [
"String",
"Array",
"Object"
],
"tsType": "VueClassProp",
"desc": "CSS classes to be attributed to the marker label",
"examples": [
"my-class-name"
]
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"category": "content",
"examples": [
true,
"[ { value: 0, label: '0%' }, { value: 5, classes: 'my-class', style: { width: '24px' } } ]",
"{ 0: '0%', 5: { label: '5%', classes: 'my-class', style: { width: '24px' } } }",
"val => (10 * val) + '%'",
"val => ({ label: (10 * val) + '%', classes: 'my-class', style: { width: '24px' } })"
],
"addedIn": "v2.4"
},
"marker-labels-class": {
"type": "String",
"desc": "CSS class(es) to apply to the marker labels container",
"examples": [
"text-orange"
],
"category": "style",
"addedIn": "v2.4"
},
"switch-marker-labels-side": {
"type": "Boolean",
"desc": "Switch the position of the marker labels (top <-> bottom or left <-> right)",
"category": "style",
"addedIn": "v2.4"
},
"track-size": {
"type": "String",
"desc": "Track size (including CSS unit)",
"default": "4px",
"examples": [
"35px"
],
"category": "style",
"addedIn": "v2.4",
"required": false
},
"thumb-size": {
"type": "String",
"desc": "Thumb size (including CSS unit)",
"default": "20px",
"examples": [
"20px"
],
"category": "style",
"addedIn": "v2.4",
"required": false
},
"thumb-color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style",
"addedIn": "v2.4"
},
"thumb-path": {
"type": "String",
"desc": "Set custom thumb svg path",
"default": "M 4, 10 a 6,6 0 1,0 12,0 a 6,6 0 1,0 -12,0",
"examples": [
"M5 5 h10 v10 h-10 v-10"
],
"category": "style",
"required": false
},
"dark": {
"type": "Boolean",
"desc": "Notify the component that the background is a dark color",
"category": "style"
},
"dense": {
"type": "Boolean",
"desc": "Dense mode; occupies less space",
"category": "style"
},
"disable": {
"type": "Boolean",
"desc": "Put component in disabled mode",
"category": "state"
},
"readonly": {
"type": "Boolean",
"desc": "Put component in readonly mode",
"category": "state"
},
"tabindex": {
"type": [
"Number",
"String"
],
"desc": "Tabindex HTML attribute value",
"examples": [
"0",
"100"
],
"category": "general"
},
"model-value": {
"desc": "Model of the component (must be between min/max); Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive",
"required": true,
"syncable": true,
"category": "model",
"type": [
"Number",
"null",
"undefined"
],
"examples": [
"v-model=\"positionModel\""
]
},
"label-value": {
"type": [
"String",
"Number"
],
"desc": "Override default label value",
"examples": [
":label-value=\"model + 'px'\""
],
"category": "content"
}
},
"slots": {
"marker-label": {
"desc": "What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>",
"addedIn": "v2.4",
"scope": {
"marker": {
"type": "Object",
"tsType": "SliderMarkerLabelConfig",
"desc": "Config for current marker label",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerList": {
"type": "Array",
"tsType": "SliderMarkerLabelArrayConfig",
"desc": "Array of marker label configs",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerMap": {
"type": "Object",
"tsType": "SliderMarkerLabelObjectConfig",
"desc": "Object with key-value where key is the model and the value is the marker label config",
"definition": {
"...key": {
"type": "Object",
"desc": "Marker label config",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
}
}
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"getStyle": {
"type": "Function",
"desc": "Get CSS style Object to apply to a marker element at respective model value; For perf reasons, use only if requested model value is not already part of markerMap",
"params": {
"value": {
"type": "Number",
"desc": "The marker label equivalent model value",
"required": true
}
},
"returns": {
"type": "Object",
"desc": "CSS style Object to apply to a marker element at respective model value"
}
}
}
},
"marker-label-group": {
"desc": "What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>",
"addedIn": "v2.4",
"scope": {
"markerList": {
"type": "Array",
"tsType": "SliderMarkerLabelArrayConfig",
"desc": "Array of marker label configs",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
},
"markerMap": {
"type": "Object",
"tsType": "SliderMarkerLabelObjectConfig",
"desc": "Object with key-value where key is the model and the value is the marker label config",
"definition": {
"...key": {
"type": "Object",
"desc": "Marker label config",
"definition": {
"index": {
"type": "Number",
"desc": "Index of the marker label (0-based)"
},
"value": {
"type": "Number",
"desc": "Equivalent model value for the marker label"
},
"label": {
"type": [
"Number",
"String"
],
"desc": "Configured label for the marker"
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"style": {
"type": "Object",
"tsType": "VueStyleObjectProp",
"desc": "Style definitions to be attributed to the marker label",
"examples": [
"{ height: '24px' }"
]
}
}
}
}
},
"classes": {
"type": "String",
"desc": "Required CSS classes to be applied to the marker element"
},
"getStyle": {
"type": "Function",
"desc": "Get CSS style Object to apply to a marker element at respective model value; For perf reasons, use only if requested model value is not already part of markerMap",
"params": {
"value": {
"type": "Number",
"desc": "The marker label equivalent model value",
"required": true
}
},
"returns": {
"type": "Object",
"desc": "CSS style Object to apply to a marker element at respective model value"
}
}
}
}
},
"events": {
"change": {
"desc": "Emitted on lazy model value change (after user slides then releases the thumb)",
"params": {
"value": {
"type": "Any",
"desc": "New model value",
"required": true
}
}
},
"pan": {
"desc": "Triggered when user starts panning on the component",
"params": {
"phase": {
"type": "String",
"desc": "Phase of panning",
"values": [
"start",
"end"
]
}
}
},
"update:model-value": {
"desc": "Emitted when the component needs to change the model; Is also used by v-model",
"params": {
"value": {
"type": [
"Number",
"null"
],
"desc": "New model value",
"required": true
}
}
}
}
}

6
node_modules/quasar/dist/api/QSpace.json generated vendored Normal file
View file

@ -0,0 +1,6 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/space"
}
}

37
node_modules/quasar/dist/api/QSpinner.json generated vendored Normal file
View file

@ -0,0 +1,37 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/spinners"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
},
"thickness": {
"type": "Number",
"desc": "Override value to use for stroke-width",
"default": 5,
"category": "style",
"required": false
}
}
}

30
node_modules/quasar/dist/api/QSpinnerAudio.json generated vendored Normal file
View file

@ -0,0 +1,30 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/spinners"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
}

30
node_modules/quasar/dist/api/QSpinnerBall.json generated vendored Normal file
View file

@ -0,0 +1,30 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/spinners"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
}

30
node_modules/quasar/dist/api/QSpinnerBars.json generated vendored Normal file
View file

@ -0,0 +1,30 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/spinners"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
}

30
node_modules/quasar/dist/api/QSpinnerBox.json generated vendored Normal file
View file

@ -0,0 +1,30 @@
{
"type": "component",
"meta": {
"docsUrl": "https://v2.quasar.dev/vue-components/spinners"
},
"props": {
"size": {
"type": "String",
"desc": "Size in CSS units, including unit name or standard size name (xs|sm|md|lg|xl)",
"examples": [
"16px",
"2rem",
"xs",
"md"
],
"category": "style"
},
"color": {
"type": "String",
"tsType": "NamedColor",
"desc": "Color name for component from the Quasar Color Palette",
"examples": [
"primary",
"teal",
"teal-10"
],
"category": "style"
}
}
}

Some files were not shown because too many files have changed in this diff Show more