quasar 2.18.7 → 2.19.0

package/dist/api/QBtnToggle.json

@@ -1 +1 @@
-{"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"}}}
+{"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"}}}

package/dist/api/QCarousel.json

@@ -1 +1 @@
-{"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\""],"required":true,"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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'"],"default":"'flat'","category":"style","required":false},"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","examples":["true","false","2500"],"category":"behavior"},"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:fullscreen":{"desc":"Used by Vue on 'v-model:fullscreen' prop for updating its value","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","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"next":{"desc":"Go to next panel","params":null,"returns":null},"previous":{"desc":"Go to previous panel","params":null,"returns":null},"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'"]}},"returns":null}}}
+{"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\""],"required":true,"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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'"],"default":"'flat'","category":"style","required":false},"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","examples":["true","false","2500"],"category":"behavior"},"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:fullscreen":{"desc":"Used by Vue on 'v-model:fullscreen' prop for updating its value","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","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"next":{"desc":"Go to next panel","params":null,"returns":null},"previous":{"desc":"Go to previous panel","params":null,"returns":null},"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'"]}},"returns":null}}}

package/dist/api/QCarouselControl.json

@@ -1 +1 @@
-{"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"}}}
+{"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"}}}

package/dist/api/QChatMessage.json

@@ -1 +1 @@
-{"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":["[ 'How are you?' ]","[ '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"}}}
+{"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":["['How are you?']","['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"}}}

package/dist/api/QCheckbox.json

@@ -1 +1 @@
-{"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"],"default":"null","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":"model","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 -> ...","values":["'tf'","'ft'"],"category":"behavior"},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["100","'0'"],"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)","params":null,"returns":null}}}
+{"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"],"default":"null","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":"model","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 -> ...","values":["'tf'","'ft'"],"category":"behavior"},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["100","'0'"],"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)","params":null,"returns":null}}}

package/dist/api/QColor.json

@@ -1 +1 @@
-{"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":["'#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":["[ '#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","null"],"default":"null","desc":"Notify the component that the background is a dark color","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":["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}}}}}
+{"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":["'#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":["['#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","null"],"default":"null","desc":"Notify the component that the background is a dark color","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":["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}}}}}

package/dist/api/QDate.json

@@ -1 +1 @@
-{"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":["{ 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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","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"},"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":["[ '2018/11/05', '2018/11/06', '2018/11/09', '2018/11/23' ]","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'","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":["[ '2018/11/05', '2018/11/12', '2018/11/19', '2018/11/26' ]","date => (date[ 9 ] % 3 === 0)","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":["1","# 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","params":null,"returns":null},"setView":{"desc":"Change current view","params":{"view":{"type":"String","required":true,"desc":"QDate view name","values":["'Calendar'","'Months'","'Years'"]}},"returns":null},"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?"}},"returns":null},"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"}},"returns":null},"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"}}}},"returns":null}}}
+{"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":["{ 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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","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"},"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":["['2018/11/05', '2018/11/06', '2018/11/09', '2018/11/23']","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'","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":["['2018/11/05', '2018/11/12', '2018/11/19', '2018/11/26']","date => (date[ 9 ] % 3 === 0)","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":["1","# 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","params":null,"returns":null},"setView":{"desc":"Change current view","params":{"view":{"type":"String","required":true,"desc":"QDate view name","values":["'Calendar'","'Months'","'Years'"]}},"returns":null},"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?"}},"returns":null},"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"}},"returns":null},"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"}}}},"returns":null}}}

package/dist/api/QEditor.json

@@ -1 +1 @@
-{"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["{ 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":["true","() => !checkIfUserIsActive()"]},"type":{"type":["String","null"],"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":["{ 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'"],"default":"'div'","category":"behavior","required":false},"content-style":{"type":"Object","tsType":"VueStyleObjectProp","desc":"Object with CSS properties and values for styling the container of QEditor","examples":["{ backgroundColor: '#C0C0C0' }"],"category":"style"},"content-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes for the input area","examples":["'my-special-class'","{ 'my-special-class': true }"],"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:fullscreen":{"desc":"Used by Vue on 'v-model:fullscreen' prop for updating its value","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","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"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}},"returns":null},"refreshToolbar":{"desc":"Hide the link editor if visible and force the instance to re-render","params":null,"returns":null},"focus":{"desc":"Focus on the contentEditable at saved cursor position","params":null,"returns":null},"getContentEl":{"desc":"Retrieve the content of the Editor","params":null,"returns":{"type":"Element","desc":"Provides the pure HTML within the editable area"}}},"computedProps":{"caret":{"type":"Object","tsType":"QEditorCaret","desc":"The current caret state"}}}
+{"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["{ 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":["true","() => !checkIfUserIsActive()"]},"type":{"type":["String","null"],"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":["{ 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'"],"default":"'div'","category":"behavior","required":false},"content-style":{"type":"Object","tsType":"VueStyleObjectProp","desc":"Object with CSS properties and values for styling the container of QEditor","examples":["{ backgroundColor: '#C0C0C0' }"],"category":"style"},"content-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes for the input area","examples":["'my-special-class'","{ 'my-special-class': true }"],"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:fullscreen":{"desc":"Used by Vue on 'v-model:fullscreen' prop for updating its value","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","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"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}},"returns":null},"refreshToolbar":{"desc":"Hide the link editor if visible and force the instance to re-render","params":null,"returns":null},"focus":{"desc":"Focus on the contentEditable at saved cursor position","params":null,"returns":null},"getContentEl":{"desc":"Retrieve the content of the Editor","params":null,"returns":{"type":"Element","desc":"Provides the pure HTML within the editable area"}}},"computedProps":{"caret":{"type":"Object","tsType":"QEditorCaret","desc":"The current caret state"}}}

package/dist/api/QField.json

@@ -1 +1 @@
-{"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","null"],"default":"null","desc":"Does field have validation errors?","category":"validation","required":false},"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":"validation"},"no-error-icon":{"type":"Boolean","desc":"Hide error icon when there is an error","category":"validation"},"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":["[ val => val.length <= 3 || 'Please use maximum 3 characters' ]","[ 'fulltime' ]","[ (val, rules) => rules.email(val) || 'Please enter a valid email address' ]"],"category":"validation"},"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":"validation"},"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","default":"false","values":["true","false","'ondemand'"],"category":"validation","required":false},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["true","'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"},"maxlength":{"type":["String","Number"],"desc":"Specify a max length of model","category":"model"},"tag":{"type":"String","desc":"HTML tag to use","category":"content","default":"'label'","examples":["'div'","'label'"],"addedIn":"v2.13.1","required":false}},"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}}}},"events":{"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"}}},"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"}}}},"methods":{"resetValidation":{"desc":"Reset validation status","params":null,"returns":null},"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","params":null,"returns":null},"blur":{"desc":"Blur component (lose focus)","params":null,"returns":null}},"computedProps":{"hasError":{"type":"Boolean","desc":"Whether the component is in error state"}}}
+{"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","null"],"default":"null","desc":"Does field have validation errors?","category":"validation","required":false},"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":"validation"},"no-error-icon":{"type":"Boolean","desc":"Hide error icon when there is an error","category":"validation"},"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":["[val => val.length <= 3 || 'Please use maximum 3 characters']","['fulltime']","[(val, rules) => rules.email(val) || 'Please enter a valid email address']"],"category":"validation"},"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":"validation"},"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","default":"false","values":["true","false","'ondemand'"],"category":"validation","required":false},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["true","'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"},"maxlength":{"type":["String","Number"],"desc":"Specify a max length of model","category":"model"},"tag":{"type":"String","desc":"HTML tag to use","category":"content","default":"'label'","examples":["'div'","'label'"],"addedIn":"v2.13.1","required":false}},"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}}}},"events":{"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"}}},"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"}}}},"methods":{"resetValidation":{"desc":"Reset validation status","params":null,"returns":null},"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","params":null,"returns":null},"blur":{"desc":"Blur component (lose focus)","params":null,"returns":null}},"computedProps":{"hasError":{"type":"Boolean","desc":"Whether the component is in error state"}}}

package/dist/api/QFile.json

@@ -1 +1 @@
-{"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'"],"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":"Array","tsType":"File","desc":"Candidate files to be added to queue"}},"returns":{"type":"Array","tsType":"File","desc":"Filtered files to be added to queue"},"examples":["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","null"],"default":"null","desc":"Does field have validation errors?","category":"validation","required":false},"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":"validation"},"no-error-icon":{"type":"Boolean","desc":"Hide error icon when there is an error","category":"validation"},"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":["[ val => val.length <= 3 || 'Please use maximum 3 characters' ]","[ 'fulltime' ]","[ (val, rules) => rules.email(val) || 'Please enter a valid email address' ]"],"category":"validation"},"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":"validation"},"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","default":"false","values":["true","false","'ondemand'"],"category":"validation","required":false},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["true","'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":["(totalSize, filesNumber, maxFiles) => `${ filesNumber }${ maxFiles !== void 0 ? ' / ' + maxFiles : '' } (${ totalSize })`"],"category":"behavior"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general","default":"0","required":false},"input-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the underlying selection container","examples":["'my-special-class'","{ 'my-special-class': true }"],"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'","{ 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":"Array","tsType":"File","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"}}},"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}}},"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"}}},"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"}}}},"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"}},"returns":null},"addFiles":{"desc":"Add files programmatically","params":{"files":{"type":["Array","FileList"],"tsType":"QUseFileAddInput","desc":"Array of files (instances of File) or FileList","required":true}},"returns":null},"resetValidation":{"desc":"Reset validation status","params":null,"returns":null},"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","params":null,"returns":null},"blur":{"desc":"Blur component (lose focus)","params":null,"returns":null},"removeAtIndex":{"desc":"Remove file located at specific index in the model","params":{"index":{"type":"Number","desc":"Index at which to remove selection","required":true}},"returns":null},"removeFile":{"desc":"Remove specified file from the model","params":{"file":{"type":"File","desc":"File to remove (instance of File)","required":true}},"returns":null},"getNativeElement":{"desc":"DEPRECATED; Access 'nativeEl' directly; Gets the native input DOM Element","params":null,"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"}}}
+{"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'"],"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":"Array","tsType":"File","desc":"Candidate files to be added to queue"}},"returns":{"type":"Array","tsType":"File","desc":"Filtered files to be added to queue"},"examples":["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","null"],"default":"null","desc":"Does field have validation errors?","category":"validation","required":false},"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":"validation"},"no-error-icon":{"type":"Boolean","desc":"Hide error icon when there is an error","category":"validation"},"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":["[val => val.length <= 3 || 'Please use maximum 3 characters']","['fulltime']","[(val, rules) => rules.email(val) || 'Please enter a valid email address']"],"category":"validation"},"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":"validation"},"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","default":"false","values":["true","false","'ondemand'"],"category":"validation","required":false},"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","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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":["true","'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":["(totalSize, filesNumber, maxFiles) => `${ filesNumber }${ maxFiles !== void 0 ? ' / ' + maxFiles : '' } (${ totalSize })`"],"category":"behavior"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general","default":"0","required":false},"input-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the underlying selection container","examples":["'my-special-class'","{ 'my-special-class': true }"],"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'","{ 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":"Array","tsType":"File","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"}}},"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}}},"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"}}},"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"}}}},"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"}},"returns":null},"addFiles":{"desc":"Add files programmatically","params":{"files":{"type":["Array","FileList"],"tsType":"QUseFileAddInput","desc":"Array of files (instances of File) or FileList","required":true}},"returns":null},"resetValidation":{"desc":"Reset validation status","params":null,"returns":null},"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","params":null,"returns":null},"blur":{"desc":"Blur component (lose focus)","params":null,"returns":null},"removeAtIndex":{"desc":"Remove file located at specific index in the model","params":{"index":{"type":"Number","desc":"Index at which to remove selection","required":true}},"returns":null},"removeFile":{"desc":"Remove specified file from the model","params":{"file":{"type":"File","desc":"File to remove (instance of File)","required":true}},"returns":null},"getNativeElement":{"desc":"DEPRECATED; Access 'nativeEl' directly; Gets the native input DOM Element","params":null,"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"}}}