quasar 2.18.7 → 2.19.0

package/dist/api/QSelect.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/select"},"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"},"virtual-scroll-horizontal":{"type":"Boolean","desc":"Make virtual list work in horizontal mode","category":"behavior"},"virtual-scroll-slice-size":{"type":["Number","String","null"],"desc":"Minimum number of items to render in the virtual list","default":"10","examples":["60","'60'"],"category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-before":{"type":["Number","String"],"desc":"Ratio of number of items in visible zone to render before it","default":"1","category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-after":{"type":["Number","String"],"desc":"Ratio of number of items in visible zone to render after it","default":"1","category":"virtual-scroll","required":false},"virtual-scroll-item-size":{"type":["Number","String"],"desc":"Default size in pixels (height if vertical, width if horizontal) of an item; This value is used for rendering the initial list; Try to use a value close to the minimum size of an item","default":"24","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-start":{"type":["Number","String"],"desc":"Size in pixels (height if vertical, width if horizontal) of the sticky part (if using one) at the start of the list; A correct value will improve scroll precision","default":"0","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-end":{"type":["Number","String"],"desc":"Size in pixels (height if vertical, width if horizontal) of the sticky part (if using one) at the end of the list; A correct value will improve scroll precision","default":"0","category":"virtual-scroll","required":false},"table-colspan":{"type":["Number","String"],"desc":"The number of columns in the table (you need this if you use table-layout: fixed)","category":"virtual-scroll|content"},"model-value":{"desc":"Model of the component; Must be 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":"Any","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"},"multiple":{"type":"Boolean","desc":"Allow multiple selection; Model must be Array","category":"model|selection"},"display-value":{"type":["Number","String"],"desc":"Override default selection string, if not using 'selected' slot/scoped slot and if not using 'use-chips' prop","examples":["'Options: x, y, z'"],"category":"selection"},"display-value-html":{"type":"Boolean","desc":"Force render the selected option(s) as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'selected' or 'selected-item' slots!","category":"selection"},"options":{"type":"Array","desc":"Array of objects with available options that the user can select from. For best performance freeze the list of options. Canonical form of each object is with 'label' (String), 'value' (Any) and optional 'disable' (Boolean) props (can be customized with options-value/option-label/option-disable props).","default":"[]","examples":["[ 'Tesla', 'iPhone' ]","[ { label: 'Tesla', value: 'car' }, { label: 'iPhone', value: 'phone' } ]"],"category":"options","required":false},"option-value":{"type":["Function","String"],"desc":"Property of option which holds the 'value'; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'value'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"Any","desc":"Value of the current option","examples":["'car'","34"]},"examples":["'modelNumber'","item => (item === null ? null : item.modelNumber)"],"category":"options","required":false},"option-label":{"type":["Function","String"],"desc":"Property of option which holds the 'label'; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'label'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"String","desc":"Label of the current option","examples":["'Tesla'","'iPhone'"]},"examples":["'itemName'","item => (item === null ? 'Null value' : item.itemName)"],"category":"options","required":false},"option-disable":{"type":["Function","String"],"desc":"Property of option which tells it's disabled; The value of the property must be a Boolean; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'disable'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"Boolean","desc":"If true, the current option will be disabled"},"examples":["item => (item === null ? true : item.cannotSelect)","# option-disable=\"cannotSelect\""],"category":"options","required":false},"hide-selected":{"type":"Boolean","desc":"Hides selection; Use the underlying input tag to hold the label (instead of showing it to the right of the input) of the selected option; Only works for non 'multiple' Selects","category":"selection"},"hide-dropdown-icon":{"type":"Boolean","desc":"Hides dropdown icon","category":"content|behavior"},"dropdown-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"max-values":{"type":["Number","String"],"desc":"Allow a maximum number of selections that the user can do","category":"selection"},"options-dense":{"type":"Boolean","desc":"Dense mode for options list; occupies less space","category":"options"},"options-dark":{"type":["Boolean","null"],"default":"null","desc":"Options menu will be colored with a dark color","category":"options","required":false},"options-selected-class":{"type":"String","desc":"CSS class name for options that are active/selected; Set it to an empty string to stop applying the default (which is text-* where * is the 'color' prop value)","examples":["'text-orange'"],"category":"options"},"options-html":{"type":"Boolean","desc":"Force render the options as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'option' slot!","category":"options"},"options-cover":{"type":"Boolean","desc":"Expanded menu will cover the component (will not work along with 'use-input' prop for obvious reasons)","category":"options"},"menu-shrink":{"type":"Boolean","desc":"Allow the options list to be narrower than the field (only in menu mode)","category":"options"},"menu-anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the options list relative to the field (only in menu mode)","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"category":"position"},"menu-self":{"type":"String","desc":"Two values setting the options list's own position relative to its target (only in menu mode)","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"category":"position"},"menu-offset":{"type":"Array","desc":"An array of two numbers to offset the options list horizontally and vertically in pixels (only in menu mode)","examples":["[ 8, 8 ]","[ 5, 10 ]"],"category":"position"},"popup-content-class":{"type":"String","desc":"Class definitions to be attributed to the popup content","examples":["'my-special-class'"],"category":"style"},"popup-content-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the popup content","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"popup-no-route-dismiss":{"type":"Boolean","desc":"Changing route app won't dismiss the popup (menu or dialog)","category":"behavior","addedIn":"v2.15"},"use-chips":{"type":"Boolean","desc":"Use QChip to show what is currently selected","category":"selection"},"use-input":{"type":"Boolean","desc":"Use an input tag where users can type","category":"content"},"maxlength":{"type":["String","Number"],"desc":"Specify a max length for the inner input tag (if 'use-input' is enabled)","category":"content"},"fill-input":{"type":"Boolean","desc":"Fills the input with current value; Useful along with 'hide-selected'; Does NOT work along with 'multiple' selection","category":"behavior"},"new-value-mode":{"type":"String","desc":"Enables creation of new values and defines behavior when a new value is added: 'add' means it adds the value (even if possible duplicate), 'add-unique' adds only unique values, and 'toggle' adds or removes the value (based on if it exists or not already); When using this prop then listening for @new-value becomes optional (only to override the behavior defined by 'new-value-mode')","values":["'add'","'add-unique'","'toggle'"],"category":"behavior"},"map-options":{"type":"Boolean","desc":"Try to map labels of model from 'options' Array; has a small performance penalty; If you are using emit-value you will probably need to use map-options to display the label text in the select field rather than the value;  Refer to the 'Affecting model' section above","category":"options"},"disable-tab-selection":{"type":"Boolean","desc":"Prevents the tab key from confirming the currently hovered option","category":"options","addedIn":"v2.17"},"emit-value":{"type":"Boolean","desc":"Update model with the value of the selected option instead of the whole option","category":"model"},"input-debounce":{"type":["Number","String"],"desc":"Debounce the input model update with an amount of milliseconds (also affects the 'filter' event, if used)","default":"500","category":"content","required":false},"input-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the underlying input tag","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 input tag","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general","default":"0","required":false},"autocomplete":{"type":"String","desc":"Autocomplete attribute for field","examples":["'country'"],"category":"behavior"},"transition-show":{"type":"String","desc":"Transition when showing the menu/dialog; One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"behavior","default":"'fade'","required":false},"transition-hide":{"type":"String","desc":"Transition when hiding the menu/dialog; One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"behavior","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration when hiding the menu/dialog (in milliseconds, without unit)","default":"300","category":"behavior","required":false},"behavior":{"type":"String","desc":"Overrides the default dynamic mode of showing as menu on desktop and dialog on mobiles","values":["'default'","'menu'","'dialog'"],"default":"'default'","category":"behavior","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; Suggestion: spinners"},"selected":{"desc":"Override default selection slot; Suggestion: QChip"},"before-options":{"desc":"Template slot for the elements that should be rendered before the list of options"},"after-options":{"desc":"Template slot for the elements that should be rendered after the list of options"},"no-option":{"desc":"What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>","scope":{"inputValue":{"type":"String","desc":"Input textfield value, if any (not QSelect model)","examples":["'typed something'"]}}},"selected-item":{"desc":"Override default selection slot; Suggestion: QChip","scope":{"index":{"type":"Number","desc":"Selection index"},"opt":{"type":"Any","desc":"Selected option -- its value is taken from model"},"selected":{"type":"Boolean","desc":"Always true -- passed down as prop to QItem (when using QItem)"},"html":{"type":"Boolean","desc":"Is the content HTML?"},"removeAtIndex":{"type":"Function","desc":"Remove selected option located at specific index","params":{"index":{"type":"Number","required":true,"desc":"Index at which to remove selection"}},"returns":null},"toggleOption":{"type":"Function","desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"}},"returns":null},"tabindex":{"type":"Number","desc":"Tabindex HTML attribute value associated with respective option","values":["0","-1"]}}},"option":{"desc":"Customize how options are rendered; Suggestion: QItem","scope":{"index":{"type":"Number","desc":"Option index"},"opt":{"type":"Any","desc":"Option -- its value is taken from 'options' prop"},"html":{"type":"Boolean","desc":"Is the content HTML?"},"label":{"type":"String","desc":"Label of the option"},"selected":{"type":"Boolean","desc":"Is option selected?"},"focused":{"type":"Boolean","desc":"Is option focused?"},"toggleOption":{"type":"Function","desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"}},"returns":null},"setOptionIndex":{"type":"Function","desc":"Sets option from menu as 'focused'","params":{"index":{"type":"Number","required":true,"desc":"Index of option from menu"}},"returns":null},"itemProps":{"type":"Object","desc":"Computed properties passed down to QItem"}}}},"events":{"virtual-scroll":{"desc":"Emitted when the virtual scroll occurs","params":{"details":{"type":"Object","desc":"Object of properties on the new scroll position","definition":{"index":{"type":"Number","required":true,"desc":"Index of the list item that was scrolled into view (0 based)"},"from":{"type":"Number","required":true,"desc":"The index of the first list item that is rendered (0 based)"},"to":{"type":"Number","required":true,"desc":"The index of the last list item that is rendered (0 based)"},"direction":{"type":"String","required":true,"desc":"Direction of change","values":["'increase'","'decrease'"]},"ref":{"type":"Component","required":true,"desc":"Vue reference to the QSelect","tsType":"QSelect"}}}}},"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"}}},"input-value":{"desc":"Emitted when the value in the text input changes","params":{"value":{"type":"String","desc":"New text value"}}},"remove":{"desc":"Emitted when an option is removed from selection","params":{"details":{"type":"Object","desc":"Removal details","definition":{"index":{"type":"Number","required":true,"desc":"Model index at which removal took place"},"value":{"type":"Any","required":true,"desc":"The actual value that was removed"}}}}},"add":{"desc":"Emitted when an option is added to the selection","params":{"details":{"type":"Object","desc":"Addition details","definition":{"index":{"type":"Number","required":true,"desc":"Model index at which addition took place"},"value":{"type":"Any","required":true,"desc":"The actual value that was added"}}}}},"new-value":{"desc":"Enables creation of new values; Emitted when a new value has been created; You can override 'new-value-mode' property with it","params":{"inputValue":{"type":"String","desc":"What the user typed","examples":["'phone'"]},"doneFn":{"type":"Function","desc":"Adds (optional) value to the model; Do not forget to call it after you validate the newly created value; Call it with no parameters if nothing should be added","params":{"item":{"type":"Any","required":false,"desc":"Item to add"},"mode":{"type":"String","required":false,"desc":"Override 'new-value-mode' (prop) behavior should you wish to","values":["'add'","'add-unique'","'toggle'"],"default":"'add'"}},"returns":null}}},"filter":{"desc":"Emitted when user wants to filter a value","params":{"inputValue":{"type":"String","desc":"What the user typed","examples":["'phone'"]},"doneFn":{"type":"Function","desc":"Supply a function which makes the necessary updates","params":{"callbackFn":{"type":"Function","required":true,"desc":"Callback to call to make the actual updates","params":null,"returns":null},"afterFn":{"type":"Function","required":false,"desc":"Callback to call at the end after the update has been fully processed by QSelect","params":{"ref":{"type":"Component","tsType":"QSelect","required":true,"desc":"Vue reference to the QSelect which triggered the filtering"}},"returns":null}},"returns":null},"abortFn":{"type":"Function","desc":"Call this function if something went wrong","params":null,"returns":null}}},"filter-abort":{"desc":"Emitted when a filtering was aborted; Probably a new one was requested?"},"popup-show":{"desc":"Emitted when the select options menu or dialog is shown.","params":{"evt":{"type":"Event","desc":"JS event object"}}},"popup-hide":{"desc":"Emitted when the select options menu or dialog is hidden.","params":{"evt":{"type":"Event","desc":"JS event object"}}}},"methods":{"scrollTo":{"desc":"Scroll the virtual scroll list to the item with the specified index (0 based)","params":{"index":{"type":["Number","String"],"desc":"The index of the list item (0 based)","required":true},"edge":{"type":"String","desc":"The edge to align to if the item is not visible already (by default it aligns to end if scrolling towards the end and to start otherwise); If the '-force' version is used then it always aligns","values":["'start'","'center'","'end'","'start-force'","'center-force'","'end-force'"]}},"returns":null},"reset":{"desc":"Resets the virtual scroll computations; Needed for custom edge-cases","params":null,"returns":null},"refresh":{"desc":"Refreshes the virtual scroll list; Use it after appending items","params":{"index":{"type":["String","Number"],"desc":"The index of the list item to scroll to after refresh (0 based); If it's not specified the scroll position is not changed; Use a negative value to keep scroll position","examples":["5"]}},"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},"showPopup":{"desc":"Focus and open popup","params":null,"returns":null},"hidePopup":{"desc":"Hide popup","params":null,"returns":null},"removeAtIndex":{"desc":"Remove selected option located at specific index","params":{"index":{"type":"Number","required":true,"desc":"Index at which to remove selection"}},"returns":null},"add":{"desc":"Adds option to model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"},"unique":{"type":"Boolean","desc":"Option must be unique"}},"returns":null},"toggleOption":{"desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"},"keepOpen":{"type":"Boolean","desc":"Don't close the menu and do not clear the filter"}},"returns":null},"getOptionIndex":{"desc":"Gets current focused option index from menu; It's -1 if no option is focused","params":null,"returns":{"type":"Number","desc":"Index of option from menu; It's -1 if no option is focused"},"addedIn":"v2.5.4"},"setOptionIndex":{"desc":"Sets option from menu as 'focused'; -1 to focus none","params":{"index":{"type":"Number","required":true,"desc":"Index of option from menu; -1 to focus none"}},"returns":null},"moveOptionSelection":{"desc":"Move selected option from menu by index offset","params":{"offset":{"type":"Number","desc":"Number of options to move up or down","default":"1","required":false},"skipInputValue":{"type":"Boolean","desc":"Don't set input-value on navigation"}},"returns":null},"filter":{"desc":"Filter options","params":{"value":{"type":"String","required":true,"desc":"String to filter with","examples":["'car'"]}},"returns":null},"updateMenuPosition":{"desc":"Recomputes menu position","params":null,"returns":null},"updateInputValue":{"desc":"If 'use-input' is specified, this updates the value that it holds","params":{"value":{"type":"String","required":true,"desc":"String to set the input value to","examples":["'hotel'"]},"noFilter":{"type":"Boolean","desc":"Set to true if you don't want the filter (if any) to be also triggered"}},"returns":null},"isOptionSelected":{"desc":"Tells if an option is selected","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Boolean","desc":"Option is selected or not"}},"getEmittingOptionValue":{"desc":"Get the model value that would be emitted by QSelect when selecting a said option; Also takes into consideration if 'emit-value' is set","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Emitting model value of said option"}},"getOptionValue":{"desc":"Get the model value of an option; Takes into consideration 'option-value' (if used), but does not looks for 'emit-value', like getEmittingOptionValue() does","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Model value of said option"}},"getOptionLabel":{"desc":"Get the label of an option; Takes into consideration the 'option-label' prop (if used)","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Label of said option"}},"isOptionDisabled":{"desc":"Tells if an option is disabled; Takes into consideration 'option-disable' prop (if used)","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Boolean","desc":"Option is disabled or not"}}},"computedProps":{"hasError":{"type":"Boolean","desc":"Whether the component is in error state"}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/select"},"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"},"virtual-scroll-horizontal":{"type":"Boolean","desc":"Make virtual list work in horizontal mode","category":"behavior"},"virtual-scroll-slice-size":{"type":["Number","String","null"],"desc":"Minimum number of items to render in the virtual list","default":"10","examples":["60","'60'"],"category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-before":{"type":["Number","String"],"desc":"Ratio of number of items in visible zone to render before it","default":"1","category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-after":{"type":["Number","String"],"desc":"Ratio of number of items in visible zone to render after it","default":"1","category":"virtual-scroll","required":false},"virtual-scroll-item-size":{"type":["Number","String"],"desc":"Default size in pixels (height if vertical, width if horizontal) of an item; This value is used for rendering the initial list; Try to use a value close to the minimum size of an item","default":"24","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-start":{"type":["Number","String"],"desc":"Size in pixels (height if vertical, width if horizontal) of the sticky part (if using one) at the start of the list; A correct value will improve scroll precision","default":"0","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-end":{"type":["Number","String"],"desc":"Size in pixels (height if vertical, width if horizontal) of the sticky part (if using one) at the end of the list; A correct value will improve scroll precision","default":"0","category":"virtual-scroll","required":false},"table-colspan":{"type":["Number","String"],"desc":"The number of columns in the table (you need this if you use table-layout: fixed)","category":"virtual-scroll|content"},"model-value":{"desc":"Model of the component; Must be 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":"Any","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"},"multiple":{"type":"Boolean","desc":"Allow multiple selection; Model must be Array","category":"model|selection"},"display-value":{"type":["Number","String"],"desc":"Override default selection string, if not using 'selected' slot/scoped slot and if not using 'use-chips' prop","examples":["'Options: x, y, z'"],"category":"selection"},"display-value-html":{"type":"Boolean","desc":"Force render the selected option(s) as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'selected' or 'selected-item' slots!","category":"selection"},"options":{"type":"Array","desc":"Array of objects with available options that the user can select from. For best performance freeze the list of options. Canonical form of each object is with 'label' (String), 'value' (Any) and optional 'disable' (Boolean) props (can be customized with options-value/option-label/option-disable props).","default":"[]","examples":["['Tesla', 'iPhone']","[{ label: 'Tesla', value: 'car' }, { label: 'iPhone', value: 'phone' }]"],"category":"options","required":false},"option-value":{"type":["Function","String"],"desc":"Property of option which holds the 'value'; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'value'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"Any","desc":"Value of the current option","examples":["'car'","34"]},"examples":["'modelNumber'","item => (item === null ? null : item.modelNumber)"],"category":"options","required":false},"option-label":{"type":["Function","String"],"desc":"Property of option which holds the 'label'; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'label'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"String","desc":"Label of the current option","examples":["'Tesla'","'iPhone'"]},"examples":["'itemName'","item => (item === null ? 'Null value' : item.itemName)"],"category":"options","required":false},"option-disable":{"type":["Function","String"],"desc":"Property of option which tells it's disabled; The value of the property must be a Boolean; If using a function then for best performance, reference it from your scope and do not define it inline","default":"'disable'","params":{"option":{"type":["String","Object"],"desc":"The current option being processed","examples":["'Tesla'","'iPhone'","{ label: 'Tesla', value: 'car', cannotSelect: true }"]}},"returns":{"type":"Boolean","desc":"If true, the current option will be disabled"},"examples":["item => (item === null ? true : item.cannotSelect)","# option-disable=\"cannotSelect\""],"category":"options","required":false},"hide-selected":{"type":"Boolean","desc":"Hides selection; Use the underlying input tag to hold the label (instead of showing it to the right of the input) of the selected option; Only works for non 'multiple' Selects","category":"selection"},"hide-dropdown-icon":{"type":"Boolean","desc":"Hides dropdown icon","category":"content|behavior"},"dropdown-icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"max-values":{"type":["Number","String"],"desc":"Allow a maximum number of selections that the user can do","category":"selection"},"options-dense":{"type":"Boolean","desc":"Dense mode for options list; occupies less space","category":"options"},"options-dark":{"type":["Boolean","null"],"default":"null","desc":"Options menu will be colored with a dark color","category":"options","required":false},"options-selected-class":{"type":"String","desc":"CSS class name for options that are active/selected; Set it to an empty string to stop applying the default (which is text-* where * is the 'color' prop value)","examples":["'text-orange'"],"category":"options"},"options-html":{"type":"Boolean","desc":"Force render the options as HTML; This can lead to XSS attacks so make sure that you sanitize the content; Does NOT apply when using 'option' slot!","category":"options"},"options-cover":{"type":"Boolean","desc":"Expanded menu will cover the component (will not work along with 'use-input' prop for obvious reasons)","category":"options"},"menu-shrink":{"type":"Boolean","desc":"Allow the options list to be narrower than the field (only in menu mode)","category":"options"},"menu-anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the options list relative to the field (only in menu mode)","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"category":"position"},"menu-self":{"type":"String","desc":"Two values setting the options list's own position relative to its target (only in menu mode)","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"category":"position"},"menu-offset":{"type":"Array","desc":"An array of two numbers to offset the options list horizontally and vertically in pixels (only in menu mode)","examples":["[8, 8]","[5, 10]"],"category":"position"},"popup-content-class":{"type":"String","desc":"Class definitions to be attributed to the popup content","examples":["'my-special-class'"],"category":"style"},"popup-content-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the popup content","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"popup-no-route-dismiss":{"type":"Boolean","desc":"Changing route app won't dismiss the popup (menu or dialog)","category":"behavior","addedIn":"v2.15"},"use-chips":{"type":"Boolean","desc":"Use QChip to show what is currently selected","category":"selection"},"use-input":{"type":"Boolean","desc":"Use an input tag where users can type","category":"content"},"maxlength":{"type":["String","Number"],"desc":"Specify a max length for the inner input tag (if 'use-input' is enabled)","category":"content"},"fill-input":{"type":"Boolean","desc":"Fills the input with current value; Useful along with 'hide-selected'; Does NOT work along with 'multiple' selection","category":"behavior"},"new-value-mode":{"type":"String","desc":"Enables creation of new values and defines behavior when a new value is added: 'add' means it adds the value (even if possible duplicate), 'add-unique' adds only unique values, and 'toggle' adds or removes the value (based on if it exists or not already); When using this prop then listening for @new-value becomes optional (only to override the behavior defined by 'new-value-mode')","values":["'add'","'add-unique'","'toggle'"],"category":"behavior"},"map-options":{"type":"Boolean","desc":"Try to map labels of model from 'options' Array; has a small performance penalty; If you are using emit-value you will probably need to use map-options to display the label text in the select field rather than the value;  Refer to the 'Affecting model' section above","category":"options"},"disable-tab-selection":{"type":"Boolean","desc":"Prevents the tab key from confirming the currently hovered option","category":"options","addedIn":"v2.17"},"emit-value":{"type":"Boolean","desc":"Update model with the value of the selected option instead of the whole option","category":"model"},"input-debounce":{"type":["Number","String"],"desc":"Debounce the input model update with an amount of milliseconds (also affects the 'filter' event, if used)","default":"500","category":"content","required":false},"input-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the underlying input tag","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 input tag","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"tabindex":{"type":["Number","String"],"desc":"Tabindex HTML attribute value","examples":["100","'0'"],"category":"general","default":"0","required":false},"autocomplete":{"type":"String","desc":"Autocomplete attribute for field","examples":["'country'"],"category":"behavior"},"transition-show":{"type":"String","desc":"Transition when showing the menu/dialog; One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"behavior","default":"'fade'","required":false},"transition-hide":{"type":"String","desc":"Transition when hiding the menu/dialog; One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"behavior","default":"'fade'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration when hiding the menu/dialog (in milliseconds, without unit)","default":"300","category":"behavior","required":false},"behavior":{"type":"String","desc":"Overrides the default dynamic mode of showing as menu on desktop and dialog on mobiles","values":["'default'","'menu'","'dialog'"],"default":"'default'","category":"behavior","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; Suggestion: spinners"},"selected":{"desc":"Override default selection slot; Suggestion: QChip"},"before-options":{"desc":"Template slot for the elements that should be rendered before the list of options"},"after-options":{"desc":"Template slot for the elements that should be rendered after the list of options"},"no-option":{"desc":"What should the menu display after filtering options and none are left to be displayed; Suggestion: <div>","scope":{"inputValue":{"type":"String","desc":"Input textfield value, if any (not QSelect model)","examples":["'typed something'"]}}},"selected-item":{"desc":"Override default selection slot; Suggestion: QChip","scope":{"index":{"type":"Number","desc":"Selection index"},"opt":{"type":"Any","desc":"Selected option -- its value is taken from model"},"selected":{"type":"Boolean","desc":"Always true -- passed down as prop to QItem (when using QItem)"},"html":{"type":"Boolean","desc":"Is the content HTML?"},"removeAtIndex":{"type":"Function","desc":"Remove selected option located at specific index","params":{"index":{"type":"Number","required":true,"desc":"Index at which to remove selection"}},"returns":null},"toggleOption":{"type":"Function","desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"}},"returns":null},"tabindex":{"type":"Number","desc":"Tabindex HTML attribute value associated with respective option","values":["0","-1"]}}},"option":{"desc":"Customize how options are rendered; Suggestion: QItem","scope":{"index":{"type":"Number","desc":"Option index"},"opt":{"type":"Any","desc":"Option -- its value is taken from 'options' prop"},"html":{"type":"Boolean","desc":"Is the content HTML?"},"label":{"type":"String","desc":"Label of the option"},"selected":{"type":"Boolean","desc":"Is option selected?"},"focused":{"type":"Boolean","desc":"Is option focused?"},"toggleOption":{"type":"Function","desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"}},"returns":null},"setOptionIndex":{"type":"Function","desc":"Sets option from menu as 'focused'","params":{"index":{"type":"Number","required":true,"desc":"Index of option from menu"}},"returns":null},"itemProps":{"type":"Object","desc":"Computed properties passed down to QItem"}}}},"events":{"virtual-scroll":{"desc":"Emitted when the virtual scroll occurs","params":{"details":{"type":"Object","desc":"Object of properties on the new scroll position","definition":{"index":{"type":"Number","required":true,"desc":"Index of the list item that was scrolled into view (0 based)"},"from":{"type":"Number","required":true,"desc":"The index of the first list item that is rendered (0 based)"},"to":{"type":"Number","required":true,"desc":"The index of the last list item that is rendered (0 based)"},"direction":{"type":"String","required":true,"desc":"Direction of change","values":["'increase'","'decrease'"]},"ref":{"type":"Component","required":true,"desc":"Vue reference to the QSelect","tsType":"QSelect"}}}}},"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"}}},"input-value":{"desc":"Emitted when the value in the text input changes","params":{"value":{"type":"String","desc":"New text value"}}},"remove":{"desc":"Emitted when an option is removed from selection","params":{"details":{"type":"Object","desc":"Removal details","definition":{"index":{"type":"Number","required":true,"desc":"Model index at which removal took place"},"value":{"type":"Any","required":true,"desc":"The actual value that was removed"}}}}},"add":{"desc":"Emitted when an option is added to the selection","params":{"details":{"type":"Object","desc":"Addition details","definition":{"index":{"type":"Number","required":true,"desc":"Model index at which addition took place"},"value":{"type":"Any","required":true,"desc":"The actual value that was added"}}}}},"new-value":{"desc":"Enables creation of new values; Emitted when a new value has been created; You can override 'new-value-mode' property with it","params":{"inputValue":{"type":"String","desc":"What the user typed","examples":["'phone'"]},"doneFn":{"type":"Function","desc":"Adds (optional) value to the model; Do not forget to call it after you validate the newly created value; Call it with no parameters if nothing should be added","params":{"item":{"type":"Any","required":false,"desc":"Item to add"},"mode":{"type":"String","required":false,"desc":"Override 'new-value-mode' (prop) behavior should you wish to","values":["'add'","'add-unique'","'toggle'"],"default":"'add'"}},"returns":null}}},"filter":{"desc":"Emitted when user wants to filter a value","params":{"inputValue":{"type":"String","desc":"What the user typed","examples":["'phone'"]},"doneFn":{"type":"Function","desc":"Supply a function which makes the necessary updates","params":{"callbackFn":{"type":"Function","required":true,"desc":"Callback to call to make the actual updates","params":null,"returns":null},"afterFn":{"type":"Function","required":false,"desc":"Callback to call at the end after the update has been fully processed by QSelect","params":{"ref":{"type":"Component","tsType":"QSelect","required":true,"desc":"Vue reference to the QSelect which triggered the filtering"}},"returns":null}},"returns":null},"abortFn":{"type":"Function","desc":"Call this function if something went wrong","params":null,"returns":null}}},"filter-abort":{"desc":"Emitted when a filtering was aborted; Probably a new one was requested?"},"popup-show":{"desc":"Emitted when the select options menu or dialog is shown.","params":{"evt":{"type":"Event","desc":"JS event object"}}},"popup-hide":{"desc":"Emitted when the select options menu or dialog is hidden.","params":{"evt":{"type":"Event","desc":"JS event object"}}}},"methods":{"scrollTo":{"desc":"Scroll the virtual scroll list to the item with the specified index (0 based)","params":{"index":{"type":["Number","String"],"desc":"The index of the list item (0 based)","required":true},"edge":{"type":"String","desc":"The edge to align to if the item is not visible already (by default it aligns to end if scrolling towards the end and to start otherwise); If the '-force' version is used then it always aligns","values":["'start'","'center'","'end'","'start-force'","'center-force'","'end-force'"]}},"returns":null},"reset":{"desc":"Resets the virtual scroll computations; Needed for custom edge-cases","params":null,"returns":null},"refresh":{"desc":"Refreshes the virtual scroll list; Use it after appending items","params":{"index":{"type":["String","Number"],"desc":"The index of the list item to scroll to after refresh (0 based); If it's not specified the scroll position is not changed; Use a negative value to keep scroll position","examples":["5"]}},"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},"showPopup":{"desc":"Focus and open popup","params":null,"returns":null},"hidePopup":{"desc":"Hide popup","params":null,"returns":null},"removeAtIndex":{"desc":"Remove selected option located at specific index","params":{"index":{"type":"Number","required":true,"desc":"Index at which to remove selection"}},"returns":null},"add":{"desc":"Adds option to model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"},"unique":{"type":"Boolean","desc":"Option must be unique"}},"returns":null},"toggleOption":{"desc":"Add/remove option from model","params":{"opt":{"type":"Any","required":true,"desc":"Option to add to model"},"keepOpen":{"type":"Boolean","desc":"Don't close the menu and do not clear the filter"}},"returns":null},"getOptionIndex":{"desc":"Gets current focused option index from menu; It's -1 if no option is focused","params":null,"returns":{"type":"Number","desc":"Index of option from menu; It's -1 if no option is focused"},"addedIn":"v2.5.4"},"setOptionIndex":{"desc":"Sets option from menu as 'focused'; -1 to focus none","params":{"index":{"type":"Number","required":true,"desc":"Index of option from menu; -1 to focus none"}},"returns":null},"moveOptionSelection":{"desc":"Move selected option from menu by index offset","params":{"offset":{"type":"Number","desc":"Number of options to move up or down","default":"1","required":false},"skipInputValue":{"type":"Boolean","desc":"Don't set input-value on navigation"}},"returns":null},"filter":{"desc":"Filter options","params":{"value":{"type":"String","required":true,"desc":"String to filter with","examples":["'car'"]}},"returns":null},"updateMenuPosition":{"desc":"Recomputes menu position","params":null,"returns":null},"updateInputValue":{"desc":"If 'use-input' is specified, this updates the value that it holds","params":{"value":{"type":"String","required":true,"desc":"String to set the input value to","examples":["'hotel'"]},"noFilter":{"type":"Boolean","desc":"Set to true if you don't want the filter (if any) to be also triggered"}},"returns":null},"isOptionSelected":{"desc":"Tells if an option is selected","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Boolean","desc":"Option is selected or not"}},"getEmittingOptionValue":{"desc":"Get the model value that would be emitted by QSelect when selecting a said option; Also takes into consideration if 'emit-value' is set","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Emitting model value of said option"}},"getOptionValue":{"desc":"Get the model value of an option; Takes into consideration 'option-value' (if used), but does not looks for 'emit-value', like getEmittingOptionValue() does","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Model value of said option"}},"getOptionLabel":{"desc":"Get the label of an option; Takes into consideration the 'option-label' prop (if used)","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Any","desc":"Label of said option"}},"isOptionDisabled":{"desc":"Tells if an option is disabled; Takes into consideration 'option-disable' prop (if used)","params":{"opt":{"type":"Any","required":true,"desc":"Option entry"}},"returns":{"type":"Boolean","desc":"Option is disabled or not"}}},"computedProps":{"hasError":{"type":"Boolean","desc":"Whether the component is in error state"}}}

package/dist/api/QSlider.json

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

package/dist/api/QSplitter.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/splitter"},"props":{"model-value":{"desc":"Model of the component defining the size of first panel (or second if using reverse) in the unit specified (for '%' it's the split ratio percent - 0.0 < x < 100.0; for 'px' it's the size in px); Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":"Number","examples":["# v-model=\"ratio\""]},"reverse":{"type":"Boolean","desc":"Apply the model size to the second panel (by default it applies to the first)","category":"model"},"unit":{"type":"String","desc":"CSS unit for the model","default":"'%'","values":["'%'","'px'"],"category":"model","required":false},"emit-immediately":{"type":"Boolean","desc":"Emit model while user is panning on the separator","category":"model"},"horizontal":{"type":"Boolean","desc":"Allows the splitter to split its two panels horizontally, instead of vertically","category":"content"},"limits":{"type":"Array","desc":"An array of two values representing the minimum and maximum split size of the two panels; When 'px' unit is set then you can use Infinity as the second value to make it unbound on the other side; Default value: for '%' unit it is [10, 90], while for 'px' unit it is [50, Infinity]","default":"# [10, 90]/[50, Infinity]","examples":["[ 30, 70 ]","[ 0, Infinity ]"],"category":"content|model","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"before-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the 'before' panel","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"after-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the 'after' panel","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"separator-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the splitter separator","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"separator-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the splitter separator","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Applies a default lighter color on the separator; To be used when background is darker; Avoid using when you are overriding through separator-class or separator-style props","category":"style","required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component; Suggestion: QTooltip, QMenu"},"before":{"desc":"Content of the panel on left/top"},"after":{"desc":"Content of the panel on right/bottom"},"separator":{"desc":"Content to be placed inside the separator; By default it is centered"}},"events":{"update:model-value":{"desc":"Emitted when component's model value changes; Is also used by v-model","params":{"value":{"type":"Number","desc":"New model value (0.0 < x < 100.0) defining the ratio between panels"}}}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/splitter"},"props":{"model-value":{"desc":"Model of the component defining the size of first panel (or second if using reverse) in the unit specified (for '%' it's the split ratio percent - 0.0 < x < 100.0; for 'px' it's the size in px); Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":"Number","examples":["# v-model=\"ratio\""]},"reverse":{"type":"Boolean","desc":"Apply the model size to the second panel (by default it applies to the first)","category":"model"},"unit":{"type":"String","desc":"CSS unit for the model","default":"'%'","values":["'%'","'px'"],"category":"model","required":false},"emit-immediately":{"type":"Boolean","desc":"Emit model while user is panning on the separator","category":"model"},"horizontal":{"type":"Boolean","desc":"Allows the splitter to split its two panels horizontally, instead of vertically","category":"content"},"limits":{"type":"Array","desc":"An array of two values representing the minimum and maximum split size of the two panels; When 'px' unit is set then you can use Infinity as the second value to make it unbound on the other side; Default value: for '%' unit it is [10, 90], while for 'px' unit it is [50, Infinity]","default":"# [10, 90]/[50, Infinity]","examples":["[30, 70]","[0, Infinity]"],"category":"content|model","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"before-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the 'before' panel","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"after-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the 'after' panel","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"separator-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"Class definitions to be attributed to the splitter separator","examples":["'bg-deep-orange'","{ 'my-special-class': true }"],"category":"style"},"separator-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"Style definitions to be attributed to the splitter separator","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Applies a default lighter color on the separator; To be used when background is darker; Avoid using when you are overriding through separator-class or separator-style props","category":"style","required":false}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component; Suggestion: QTooltip, QMenu"},"before":{"desc":"Content of the panel on left/top"},"after":{"desc":"Content of the panel on right/bottom"},"separator":{"desc":"Content to be placed inside the separator; By default it is centered"}},"events":{"update:model-value":{"desc":"Emitted when component's model value changes; Is also used by v-model","params":{"value":{"type":"Number","desc":"New model value (0.0 < x < 100.0) defining the ratio between panels"}}}}}

package/dist/api/QStepper.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/stepper"},"props":{"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":"Put Stepper in vertical mode (instead of horizontal by default)","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":"# slide-right/slide-down","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":"# slide-left/slide-up","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},"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"},"alternative-labels":{"type":"Boolean","desc":"Use alternative labels - stacks the icon on top of the label (applies only to horizontal stepper)","category":"header"},"header-nav":{"type":"Boolean","desc":"Allow navigation through the header","category":"behavior"},"contracted":{"type":"Boolean","desc":"Hide header labels on narrow windows","category":"header|behavior"},"inactive-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":"header"},"inactive-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"done-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"done-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"active-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"active-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"error-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"error-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"header-class":{"type":"String","desc":"Class definitions to be attributed to the header","examples":["'my-special-class'"],"category":"style"}},"slots":{"default":{"desc":"Suggestion: QStep"},"navigation":{"desc":"Slot specific for the global navigation; Suggestion: QStepperNavigation"},"message":{"desc":"Slot specific for putting a message on top of each step (if horizontal stepper) or above steps (if vertical); Suggestion: QBanner, div.q-pa-lg"}},"events":{"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":{"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/stepper"},"props":{"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":"Put Stepper in vertical mode (instead of horizontal by default)","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":"# slide-right/slide-down","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":"# slide-left/slide-up","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},"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"},"alternative-labels":{"type":"Boolean","desc":"Use alternative labels - stacks the icon on top of the label (applies only to horizontal stepper)","category":"header"},"header-nav":{"type":"Boolean","desc":"Allow navigation through the header","category":"behavior"},"contracted":{"type":"Boolean","desc":"Hide header labels on narrow windows","category":"header|behavior"},"inactive-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":"header"},"inactive-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"done-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"done-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"active-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"active-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"error-icon":{"type":"String","desc":"Icon name following Quasar convention; If 'none' (String) is used as value, then it will defer to prefix or the regular icon for this state; 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":"header"},"error-color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"header"},"header-class":{"type":"String","desc":"Class definitions to be attributed to the header","examples":["'my-special-class'"],"category":"style"}},"slots":{"default":{"desc":"Suggestion: QStep"},"navigation":{"desc":"Slot specific for the global navigation; Suggestion: QStepperNavigation"},"message":{"desc":"Slot specific for putting a message on top of each step (if horizontal stepper) or above steps (if vertical); Suggestion: QBanner, div.q-pa-lg"}},"events":{"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":{"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/QTabPanels.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/tab-panels"},"props":{"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":"# slide-right/slide-down","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":"# slide-left/slide-up","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}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}},"events":{"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":{"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/tab-panels"},"props":{"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":"# slide-right/slide-down","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":"# slide-left/slide-up","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}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}},"events":{"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":{"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}}}