quasar
Version:
Build high-performance VueJS user interfaces (SPA, PWA, SSR, Mobile and Desktop) in record time
241 lines • 7.16 kB
JSON
{
"type": "plugin",
"meta": {
"docsUrl": "https://v1.quasar.dev/quasar-plugins/loading"
},
"injection": "$q.loading",
"quasarConfOptions": {
"propName": "loading",
"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"
]
},
"sanitize": {
"type": "Boolean",
"default": "false",
"desc": "Force use of textContent instead of innerHTML to render message; Use it when the message might be unsafe (from user input)",
"category": "behavior"
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)",
"examples": [
60
]
},
"spinnerColor": {
"type": "String",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"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"
]
}
}
},
"props": {
"isActive": {
"type": "Boolean",
"desc": "Is Loading active?",
"reactive": true
}
},
"methods": {
"show": {
"desc": "Activate and show",
"params": {
"opts": {
"type": "Object",
"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",
"examples": [
400
]
},
"message": {
"type": "String",
"desc": "Message to display",
"examples": [
"Processing your request"
]
},
"sanitize": {
"type": "Boolean",
"default": "false",
"desc": "Force use of textContent instead of innerHTML to render message; Use it when the message might be unsafe (from user input)",
"category": "behavior"
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)",
"examples": [
60
]
},
"spinnerColor": {
"type": "String",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"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",
"addedIn": "v1.1.0"
}
}
}
}
},
"hide": {
"desc": "Hide it"
},
"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",
"examples": [
400
]
},
"message": {
"type": "String",
"desc": "Message to display",
"examples": [
"Processing your request"
]
},
"spinnerSize": {
"type": "Number",
"desc": "Spinner size (in pixels)",
"examples": [
60
]
},
"spinnerColor": {
"type": "String",
"desc": "Color name for spinner from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"messageColor": {
"type": "String",
"desc": "Color name for text from the Quasar Color Palette",
"examples": [
"primary",
"teal-10"
],
"category": "style"
},
"backgroundColor": {
"type": "String",
"desc": "Color name for background from the Quasar Color Palette",
"examples": [
"primary",
"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"
]
}
}
}
}
}
}
}