quasar 2.15.3 → 2.16.0

package/dist/api/QTable.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/table"},"props":{"fullscreen":{"type":"Boolean","sync":true,"desc":"Fullscreen mode","examples":["# v-model:fullscreen=\"isFullscreen\""],"category":"behavior","syncable":true},"no-route-fullscreen-exit":{"type":"Boolean","desc":"Changing route app won't exit fullscreen","category":"behavior"},"rows":{"type":"Array","desc":"Rows of data to display","required":true,"examples":["# :rows=\"myData\""],"category":"general"},"row-key":{"type":["String","Function"],"desc":"Property of each row that defines the unique key of each row (the result must be a primitive, not Object, Array, etc); The value of property must be string or a function taking a row and returning the desired (nested) key in the row; If supplying a function then for best performance, reference it from your scope and do not define it inline","default":"'id'","params":{"row":{"type":"Object","desc":"The current row being processed","examples":["{ name: 'Lorem Ipsum', price: 19 }"]}},"returns":{"type":"Any","desc":"Current row's key","examples":["'34f39dda-6206-4071-a9df-4393aabe49ac'","34"]},"examples":["'name'","row => row.name"],"category":"general","required":false},"virtual-scroll":{"type":"Boolean","desc":"Display data using QVirtualScroll (for non-grid mode only)","category":"virtual-scroll"},"virtual-scroll-target":{"type":["Element","String"],"desc":"CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one","examples":[".scroll-target-class","#scroll-target-id","$refs.scrollTarget","document.body"],"category":"behavior"},"virtual-scroll-slice-size":{"type":["Number","String"],"desc":"Minimum number of rows to render in the virtual list","default":"30","category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-before":{"type":["Number","String"],"desc":"Ratio of number of rows 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 rows 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 of a row; This value is used for rendering the initial table; Try to use a value close to the minimum size of a row; Default value: 48 (24 if dense)","default":"# 48/24","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-start":{"type":["Number","String"],"desc":"Size in pixels of the sticky header (if using one); A correct value will improve scroll precision; Will be also used for non-virtual-scroll tables for fixing top alignment when using scrollTo method","default":"0","category":"virtual-scroll|behavior","required":false},"virtual-scroll-sticky-size-end":{"type":["Number","String"],"desc":"Size in pixels of the sticky footer part (if using one); 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"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","default":"'grey-8'","required":false},"icon-first-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to first page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-prev-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to previous page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-next-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to next page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-last-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to last page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"grid":{"type":"Boolean","desc":"Display data as a grid instead of the default table","category":"behavior"},"grid-header":{"type":"Boolean","desc":"Display header for grid-mode also","category":"behavior|content"},"dense":{"type":"Boolean","desc":"Dense mode; Connect with $q.screen for responsive behavior","category":"style"},"columns":{"type":"Array","desc":"The column definitions (Array of Objects)","examples":["# :columns=\"tableColumns\""],"category":"column","definition":{"name":{"type":"String","required":true,"desc":"Unique id, identifies column, (used by pagination.sortBy, 'body-cell-[name]' slot, ...)","examples":["'desc'"]},"label":{"type":"String","required":true,"desc":"Label for header","examples":["'Dessert (100g serving)'"]},"field":{"type":["String","Function"],"required":true,"desc":"Row Object property to determine value for this column or function which maps to the required property","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Lorem Ipsum', prices: { active: 19, old: 25, list: 29 } }"]}},"returns":{"type":"Any","desc":"Value for this column","examples":["'19'","19"]},"examples":["'name'","row => row.prices.active"]},"required":{"type":"Boolean","desc":"If we use visible-columns, this col will always be visible"},"align":{"type":"String","desc":"Horizontal alignment of cells in this column","values":["'left'","'right'","'center'"],"default":"'right'","required":false},"sortable":{"type":"Boolean","desc":"Tell QTable you want this column sortable","default":"false","required":false},"sort":{"type":"Function","desc":"Compare function if you have some custom data or want a specific way to compare two rows; rows with null/undefined values will get sorted without triggering this method (use 'rawSort' instead if you want to handle those values too)","examples":["(a, b, _rowA, _rowB) => parseInt(a, 10) - parseInt(b, 10)"],"params":{"a":{"type":"Any","required":true,"desc":"Value of the first comparison term","examples":["123","'abc'"]},"b":{"type":"Any","required":true,"desc":"Value of the second comparison term","examples":["123","'abc'"]},"rowA":{"type":"Object","required":true,"desc":"Full Row object in which is contained the first term","examples":["{ name: 'Potassium', value: 'K' }"]},"rowB":{"type":"Object","required":true,"desc":"Full Row object in which is contained the second term","examples":["{ name: 'Fluorine', value: 'F' }"]}},"returns":{"type":"Number","desc":"Comparison result of term 'a' with term 'b'. Less than 0 when 'a' should come first; greater than 0 if 'b' should come first; equal to 0 if their position must not be changed with respect to each other","examples":["-1","0","1"]}},"rawSort":{"type":"Function","desc":"Compare function if you have some custom data or want a specific way to compare two rows; includes rows with null/undefined values (use 'sort' instead if you don't want that)","examples":["(a, b, _rowA, _rowB) => parseInt(a, 10) - parseInt(b, 10)"],"params":{"a":{"type":"Any","required":true,"desc":"Value of the first comparison term","examples":["123","'abc'"]},"b":{"type":"Any","required":true,"desc":"Value of the second comparison term","examples":["123","'abc'"]},"rowA":{"type":"Object","required":true,"desc":"Full Row object in which is contained the first term","examples":["{ name: 'Potassium', value: 'K' }"]},"rowB":{"type":"Object","required":true,"desc":"Full Row object in which is contained the second term","examples":["{ name: 'Fluorine', value: 'F' }"]}},"returns":{"type":"Number","desc":"Comparison result of term 'a' with term 'b'. Less than 0 when 'a' should come first; greater than 0 if 'b' should come first; equal to 0 if their position must not be changed with respect to each other","examples":["-1","0","1"]},"addedIn":"v2.13.0"},"sortOrder":{"type":"String","desc":"Set column sort order: 'ad' (ascending-descending) or 'da' (descending-ascending); Overrides the 'column-sort-order' prop","values":["'ad'","'da'"],"default":"'ad'","required":false},"format":{"type":"Function","desc":"Function you can apply to format your data","examples":["(val, _row) => `${ val }%`","val => val ? /* Unicode checkmark checked */ '☑' : /* Unicode checkmark unchecked */ '☐'"],"params":{"val":{"type":"Any","required":true,"desc":"Value of the cell","examples":["123","'abc'"]},"row":{"type":"Object","required":true,"desc":"Full Row object in which the cell is contained","examples":["{ name: 'Potassium', value: 'K' }"]}},"returns":{"type":"Any","desc":"The resulting formatted value","examples":["'20%'"]}},"style":{"type":["String","Function"],"desc":"Style to apply on normal cells of the column","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Frozen Yogurt', calories: 159 }"]}},"returns":{"type":"String"},"examples":["'width: 500px'","row => (row.calories % 2 === 0 ? 'width: 10px' : 'font-size: 2em; font-weight: bold')"]},"classes":{"type":["String","Function"],"desc":"Classes to add on normal cells of the column","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Frozen Yogurt', calories: 159 }"]}},"returns":{"type":"String"},"examples":["'my-special-class bg-primary'","row => (row.calories % 2 === 0 ? 'bg-green text-white' : 'bg-yellow')"]},"headerStyle":{"type":"String","desc":"Style to apply on header cells of the column","examples":["'width: 500px'"]},"headerClasses":{"type":"String","desc":"Classes to add on header cells of the column","examples":["'my-special-class'"]}}},"visible-columns":{"type":"Array","desc":"Array of Strings defining column names ('name' property of each column from 'columns' prop definitions); Columns marked as 'required' are not affected by this property","examples":["[ 'desc', 'carbs', 'protein' ]","# :visible-columns=\"myCols\""],"category":"column"},"loading":{"type":"Boolean","desc":"Put Table into 'loading' state; Notify the user something is happening behind the scenes","category":"behavior|content"},"title":{"type":"String","desc":"Table title","examples":["'Device list'"],"category":"content"},"hide-header":{"type":"Boolean","desc":"Hide table header layer","category":"content"},"hide-bottom":{"type":"Boolean","desc":"Hide table bottom layer regardless of what it has to display","category":"content"},"hide-selected-banner":{"type":"Boolean","desc":"Hide the selected rows banner (if any)","category":"content"},"hide-no-data":{"type":"Boolean","desc":"Hide the default no data bottom layer","category":"content"},"hide-pagination":{"type":"Boolean","desc":"Hide the pagination controls at the bottom","category":"content"},"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"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style"},"separator":{"type":"String","desc":"Use a separator/border between rows, columns or all cells","default":"'horizontal'","values":["'horizontal'","'vertical'","'cell'","'none'"],"category":"content","required":false},"wrap-cells":{"type":"Boolean","desc":"Wrap text within table cells","category":"content"},"binary-state-sort":{"type":"Boolean","desc":"Skip the third state (unsorted) when user toggles column sort direction","category":"sorting"},"column-sort-order":{"type":"String","desc":"Set column sort order: 'ad' (ascending-descending) or 'da' (descending-ascending); It gets applied to all columns unless a column has its own sortOrder specified in the 'columns' definition prop","values":["'ad'","'da'"],"default":"'ad'","category":"sorting","required":false},"no-data-label":{"type":"String","desc":"Override default text to display when no data is available","examples":["'No devices available'"],"category":"content"},"no-results-label":{"type":"String","desc":"Override default text to display when user filters the table and no matched results are found","examples":["'No matched records'"],"category":"content"},"loading-label":{"type":"String","desc":"Override default text to display when table is in loading state (see 'loading' prop)","examples":["'Loading devices...'"],"category":"content"},"selected-rows-label":{"type":"Function","desc":"Text to display when user selected at least one row; For best performance, reference it from your scope and do not define it inline","params":{"numberOfRows":{"type":"Number","desc":"Number of rows available"}},"returns":{"type":"String","desc":"Label to display","examples":["'5 rows are selected'"]},"examples":["(numberOfRows) => `Selected: ${ numberOfRows } entries`"],"category":"selection"},"rows-per-page-label":{"type":"String","desc":"Text to override default rows per page label at bottom of table","examples":["'Records per page:'"],"category":"pagination"},"pagination-label":{"type":"Function","desc":"Text to override default pagination label at bottom of table (unless 'pagination' scoped slot is used); For best performance, reference it from your scope and do not define it inline","params":{"firstRowIndex":{"type":"Number","desc":"Index of first displayed row"},"endRowIndex":{"type":"Number","desc":"Index of last displayed row"},"totalRowsNumber":{"type":"Number","desc":"Number of total rows available in data"}},"returns":{"type":"String","desc":"Label to display","examples":["'1-10 of 132'"]},"examples":["(start, end, total) => `${ start }-${ end } of ${ total }`"],"category":"pagination"},"table-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to native HTML <table> element's wrapper (which is a DIV)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"table-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to native HTML <table> element's wrapper (which is a DIV)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"table-header-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to header of native HTML <table> (which is a TR)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"table-header-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to header of native HTML <table> (which is a TR)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"card-container-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to the cards container (when in grid mode)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"card-container-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the cards container (when in grid mode)","examples":["'my-special-class'","'justify-center'","{ 'my-special-class': true }"],"category":"style"},"card-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to the card (when in grid mode) or container card (when not in grid mode)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"card-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the card (when in grid mode) or container card (when not in grid mode)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"title-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the title (if using 'title' prop)","examples":["'my-special-class'","'text-h1'","{ 'text-h1': true }"],"category":"style"},"filter":{"type":["String","Object"],"desc":"String/Object to filter table with; When using an Object it requires 'filter-method' to also be specified since it will be a custom filtering","examples":["'car'"],"category":"filter"},"filter-method":{"type":"Function","desc":"The actual filtering mechanism; For best performance, reference it from your scope and do not define it inline","params":{"rows":{"type":"Array","desc":"Array of rows"},"terms":{"type":["String","Object"],"desc":"Terms to filter with (is essentially the 'filter' prop value)"},"cols":{"type":"Array","desc":"Column definitions"},"getCellValue":{"type":"Function","desc":"Optional function to get a cell value","params":{"col":{"type":"Object","required":true,"desc":"Column name from column definitions"},"row":{"type":"Object","required":true,"desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}},"returns":{"type":"Array","desc":"Filtered rows"},"default":"# see source code","examples":["# see source code"],"category":"filter","required":false},"pagination":{"type":"Object","desc":"Pagination object; You can also use the 'v-model:pagination' for synching; When not synching it simply initializes the pagination on first render","definition":{"sortBy":{"type":["String","null"],"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","desc":"For server-side fetching only. How many total database rows are there to be added to the table. If set, causes the QTable to emit @request when data is required."}},"syncable":true,"examples":["# :pagination=\"myInitialPagination\"","# v-model:pagination=\"myPagination\""],"category":"pagination"},"rows-per-page-options":{"type":"Array","desc":"Options for user to pick (Numbers); Number 0 means 'Show all rows in one page'","default":"[ 3, 5, 7, 10, 15, 20, 25, 50, 0 ]","examples":["[ 10, 20 ]"],"category":"pagination","required":false},"selection":{"type":"String","desc":"Selection type","default":"'none'","values":["'single'","'multiple'","'none'"],"category":"selection","required":false},"selected":{"type":"Array","desc":"Keeps the user selection array","default":"[]","syncable":true,"examples":["# v-model:selected=\"selection\""],"category":"selection","required":false},"expanded":{"type":"Array","desc":"Keeps the array with expanded rows keys","default":"[]","syncable":true,"examples":["# v-model:expanded=\"expanded\""],"category":"expansion","required":false},"sort-method":{"type":"Function","desc":"The actual sort mechanism. Function (rows, sortBy, descending) => sorted rows; For best performance, reference it from your scope and do not define it inline","params":{"rows":{"type":"Array","desc":"Array with rows"},"sortBy":{"type":"String","desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"}},"returns":{"type":"Array","desc":"Sorted rows"},"default":"# see source code","examples":["# see source code"],"category":"sorting","required":false}},"slots":{"loading":{"desc":"Override default effect when table is in loading state; Suggestion: QInnerLoading"},"item":{"desc":"Slot to use for defining an item when in 'grid' mode; Suggestion: QCard","scope":{"key":{"type":"Any","desc":"Row/Item's key"},"row":{"type":"Object","desc":"Row/Item object"},"rowIndex":{"type":"Number","desc":"Row/Item's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row/Item's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row/item selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row/item expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body":{"desc":"Slot to define how a body row looks like; Suggestion: QTr + Td","scope":{"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"__trClass":{"type":"String","desc":"Internal prop passed down to QTr (if used)"}}},"body-cell":{"desc":"Slot to define how all body cells look like; Suggestion: QTd","scope":{"col":{"type":"Object","desc":"Column definition for column associated with table cell"},"value":{"type":"Any","desc":"Parsed/Formatted value of table cell"},"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body-cell-[name]":{"desc":"Slot to define how a specific column cell looks like; replace '[name]' with column name (from columns definition object)","scope":{"col":{"type":"Object","desc":"Column definition for column associated with table cell"},"value":{"type":"Any","desc":"Parsed/Formatted value of table cell"},"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header":{"desc":"Slot to define how header looks like; Suggestion: QTr + QTh","scope":{"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"__trClass":{"type":"String","desc":"Internal prop passed down to QTr (if used)"},"header":{"type":"Boolean","desc":"Internal prop passed down to QTh (if used); Always 'true'"}}},"header-cell":{"desc":"Slot to define how each header cell looks like; Suggestion: QTh","scope":{"col":{"type":"Object","desc":"Column definition associated to header cell"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header-cell-[name]":{"desc":"Slot to define how a specific header cell looks like; replace '[name]' with column name (from columns definition object)","scope":{"col":{"type":"Object","desc":"Column definition associated to header cell"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body-selection":{"desc":"Slot to define how body selection column looks like; Suggestion: QCheckbox","scope":{"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header-selection":{"desc":"Slot to define how header selection column looks like (available only for multiple selection mode); Suggestion: QCheckbox","scope":{"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"top-row":{"desc":"Slot to define how top extra row looks like","scope":{"cols":{"type":"Object","desc":"Column definitions"}}},"bottom-row":{"desc":"Slot to define how bottom extra row looks like","scope":{"cols":{"type":"Object","desc":"Column definitions"}}},"top":{"desc":"Slot to define how table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"bottom":{"desc":"Slot to define how table bottom looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"pagination":{"desc":"Slot to override default pagination label and buttons","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-left":{"desc":"Slot to define how left part of the table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-right":{"desc":"Slot to define how right part of the table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-selection":{"desc":"Slot to define how top table section looks like when user has selected at least one row","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"no-data":{"desc":"Slot to define how the bottom will look like when is nothing to display","scope":{"message":{"type":"String","desc":"The suggested message","examples":["'No data available'"]},"icon":{"type":"String","desc":"The suggested icon name (following Quasar convention)","examples":["'warning'"]}}}},"events":{"fullscreen":{"desc":"Emitted when fullscreen state changes","params":{"value":{"type":"Boolean","desc":"Fullscreen state (showing/hidden)"}}},"row-click":{"desc":"Emitted when user clicks/taps on a row; Is not emitted when using body/row/item scoped slots","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has clicked/tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"row-dblclick":{"desc":"Emitted when user quickly double clicks/taps on a row; Is not emitted when using body/row/item scoped slots; Please check JS dblclick event support before using","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has double clicked/tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"row-contextmenu":{"desc":"Emitted when user right clicks/long taps on a row; Is not emitted when using body/row/item scoped slots","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has right clicked/long tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"request":{"desc":"Emitted when a server request is triggered","params":{"requestProp":{"type":"Object","desc":"Props of the request","definition":{"pagination":{"type":"Object","required":true,"desc":"Pagination object","definition":{"sortBy":{"type":"String","required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"filter":{"type":["String","Object"],"desc":"String/Object to filter table with (the 'filter' prop)"},"getCellValue":{"type":"Function","required":true,"desc":"Function to get a cell value","params":{"col":{"type":"Object","required":true,"desc":"Column name from column definitions"},"row":{"type":"Object","required":true,"desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}}}}},"selection":{"desc":"Emitted when user selects/unselects row(s)","params":{"details":{"type":"Object","desc":"Selection details","definition":{"rows":{"type":"Array","required":true,"desc":"Array of row objects that were selected/unselected"},"keys":{"type":"Array","required":true,"desc":"Array of the keys of rows that were selected/unselected"},"added":{"type":"Boolean","required":true,"desc":"Were the rows added to selection (true) or removed from selection (false)"},"evt":{"type":"Event","desc":"JS event object","required":true}}}}},"update:pagination":{"desc":"Used by Vue on 'v-model:pagination' for updating its value","params":{"newPagination":{"type":"Object","desc":"The updated pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","required":false,"desc":"For server-side fetching only. How many total database rows are there to be added to the table."}}}}},"update:selected":{"desc":"Used by Vue on 'v-model:selected' prop for updating its value","params":{"newSelected":{"type":"Array","desc":"The updated selected array","examples":["[ { name: 'Frozen Yogurt', calories: 159, fat: 6 } ]"]}}},"update:expanded":{"desc":"Used by Vue on 'v-model:expanded' prop for updating its value","params":{"newExpanded":{"type":"Array","desc":"The updated expanded array","examples":["[ 'row-a', 'row-b' ]"]}}},"virtual-scroll":{"desc":"Emitted when the virtual scroll occurs, if using virtual scroll","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 underlying QVirtualScroll instance"}}}}}},"methods":{"toggleFullscreen":{"desc":"Toggles fullscreen mode","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"requestServerInteraction":{"desc":"Trigger a server request (emits 'request' event)","params":{"props":{"type":"Object","required":false,"desc":"Request details","definition":{"pagination":{"type":"Object","required":false,"desc":"Optional pagination object","definition":{"sortBy":{"type":"String","desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","desc":"For server-side fetching only. How many total database rows are there to be added to the table."}}},"filter":{"type":"Function","desc":"Filtering method (the 'filter-method' prop)","params":{"rows":{"type":"Array","required":true,"desc":"Array of rows"},"terms":{"type":["String","Object"],"required":true,"desc":"Terms to filter with (is essentially the 'filter' prop value)"},"cols":{"type":"Array","desc":"Optional column definitions"},"getCellValue":{"type":"Function","desc":"Optional function to get a cell value","params":{"col":{"type":"Object","desc":"Column name from column definitions"},"row":{"type":"Object","desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}},"returns":{"type":"Array","desc":"Filtered rows"}}}}},"returns":null},"setPagination":{"desc":"Unless using an external pagination Object (through 'v-model:pagination' prop), you can use this method and force the internal pagination to change","params":{"pagination":{"type":"Object","required":true,"desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"}}},"forceServerRequest":{"type":"Boolean","desc":"Also force a server request"}},"returns":null},"firstPage":{"desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"desc":"Navigates to last page","params":null,"returns":null},"isRowSelected":{"desc":"Determine if a row has been selected by user","params":{"key":{"type":"Any","required":true,"desc":"Row key value","examples":["'calories'"]}},"returns":{"type":"Boolean","desc":"Is row selected or not?"}},"clearSelection":{"desc":"Clears user selection (emits 'update:selected' with empty array)","params":null,"returns":null},"isRowExpanded":{"desc":"Determine if a row is expanded or not","params":{"key":{"type":"Any","required":true,"desc":"Row key value","examples":["'calories'"]}},"returns":{"type":"Boolean","desc":"Is row expanded or not?"}},"setExpanded":{"desc":"Sets the expanded rows keys array; Especially useful if not using an external 'expanded' state otherwise just emits 'update:expanded' with the value","params":{"expanded":{"type":"Array","required":true,"desc":"Array containing keys of the expanded rows","examples":["[ 'row-a', 'row-b' ]"]}},"returns":null},"sort":{"desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"resetVirtualScroll":{"desc":"Resets the virtual scroll (if using it) computations; Needed for custom edge-cases","params":null,"returns":null},"scrollTo":{"desc":"Scroll the table to the row with the specified index in page (0 based)","params":{"index":{"type":["Number","String"],"required":true,"desc":"The index of the row in page (0 based)"},"edge":{"type":"String","desc":"Only for virtual scroll - the edge to align to if the row is not visible already; If the '-force' version is used then it always aligns; Default value: end (if scrolling towards the end) / start (if scrolling towards the start)","values":["'start'","'center'","'end'","'start-force'","'center-force'","'end-force'"],"default":"# end/start","required":false}},"returns":null}},"computedProps":{"filteredSortedRows":{"desc":"The filtered and sorted rows (same as the rows prop if using server-side fetching)","type":"Array","examples":["[ { name: 'Ice Cream Sandwich', calories: 237, fat: 9.0, carbs: 37, protein: 4.3, sodium: 129, calcium: 8, iron: 1 }, ... ]"]},"computedRows":{"desc":"Paginated, filtered, and sorted rows (same as the rows prop if using server-side fetching)","type":"Array","examples":["[ { name: 'Ice Cream Sandwich', calories: 237, fat: 9.0, carbs: 37, protein: 4.3, sodium: 129, calcium: 8, iron: 1 }, ... ]"]},"computedRowsNumber":{"type":"Number","desc":"The number of computed rows"}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/table"},"props":{"fullscreen":{"type":"Boolean","sync":true,"desc":"Fullscreen mode","examples":["# v-model:fullscreen=\"isFullscreen\""],"category":"behavior","syncable":true},"no-route-fullscreen-exit":{"type":"Boolean","desc":"Changing route app won't exit fullscreen","category":"behavior"},"rows":{"type":"Array","desc":"Rows of data to display","required":true,"examples":["# :rows=\"myData\""],"category":"general"},"row-key":{"type":["String","Function"],"desc":"Property of each row that defines the unique key of each row (the result must be a primitive, not Object, Array, etc); The value of property must be string or a function taking a row and returning the desired (nested) key in the row; If supplying a function then for best performance, reference it from your scope and do not define it inline","default":"'id'","params":{"row":{"type":"Object","desc":"The current row being processed","examples":["{ name: 'Lorem Ipsum', price: 19 }"]}},"returns":{"type":"Any","desc":"Current row's key","examples":["'34f39dda-6206-4071-a9df-4393aabe49ac'","34"]},"examples":["'name'","row => row.name"],"category":"general","required":false},"virtual-scroll":{"type":"Boolean","desc":"Display data using QVirtualScroll (for non-grid mode only)","category":"virtual-scroll"},"virtual-scroll-target":{"type":["Element","String"],"desc":"CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one","examples":[".scroll-target-class","#scroll-target-id","$refs.scrollTarget","document.body"],"category":"behavior"},"virtual-scroll-slice-size":{"type":["Number","String","null"],"desc":"Minimum number of rows to render in the virtual list","default":"30","category":"virtual-scroll","required":false},"virtual-scroll-slice-ratio-before":{"type":["Number","String"],"desc":"Ratio of number of rows 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 rows 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 of a row; This value is used for rendering the initial table; Try to use a value close to the minimum size of a row; Default value: 48 (24 if dense)","default":"# 48/24","category":"virtual-scroll","required":false},"virtual-scroll-sticky-size-start":{"type":["Number","String"],"desc":"Size in pixels of the sticky header (if using one); A correct value will improve scroll precision; Will be also used for non-virtual-scroll tables for fixing top alignment when using scrollTo method","default":"0","category":"virtual-scroll|behavior","required":false},"virtual-scroll-sticky-size-end":{"type":["Number","String"],"desc":"Size in pixels of the sticky footer part (if using one); 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"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","default":"'grey-8'","required":false},"icon-first-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to first page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-prev-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to previous page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-next-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to next page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"icon-last-page":{"type":"String","desc":"Icon name following Quasar convention for stepping to last page; Make sure you have the icon library installed unless you are using 'img:' prefix","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"grid":{"type":"Boolean","desc":"Display data as a grid instead of the default table","category":"behavior"},"grid-header":{"type":"Boolean","desc":"Display header for grid-mode also","category":"behavior|content"},"dense":{"type":"Boolean","desc":"Dense mode; Connect with $q.screen for responsive behavior","category":"style"},"columns":{"type":"Array","desc":"The column definitions (Array of Objects)","examples":["# :columns=\"tableColumns\""],"category":"column","definition":{"name":{"type":"String","required":true,"desc":"Unique id, identifies column, (used by pagination.sortBy, 'body-cell-[name]' slot, ...)","examples":["'desc'"]},"label":{"type":"String","required":true,"desc":"Label for header","examples":["'Dessert (100g serving)'"]},"field":{"type":["String","Function"],"required":true,"desc":"Row Object property to determine value for this column or function which maps to the required property","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Lorem Ipsum', prices: { active: 19, old: 25, list: 29 } }"]}},"returns":{"type":"Any","desc":"Value for this column","examples":["'19'","19"]},"examples":["'name'","row => row.prices.active"]},"required":{"type":"Boolean","desc":"If we use visible-columns, this col will always be visible"},"align":{"type":"String","desc":"Horizontal alignment of cells in this column","values":["'left'","'right'","'center'"],"default":"'right'","required":false},"sortable":{"type":"Boolean","desc":"Tell QTable you want this column sortable","default":"false","required":false},"sort":{"type":"Function","desc":"Compare function if you have some custom data or want a specific way to compare two rows; rows with null/undefined values will get sorted without triggering this method (use 'rawSort' instead if you want to handle those values too)","examples":["(a, b, _rowA, _rowB) => parseInt(a, 10) - parseInt(b, 10)"],"params":{"a":{"type":"Any","required":true,"desc":"Value of the first comparison term","examples":["123","'abc'"]},"b":{"type":"Any","required":true,"desc":"Value of the second comparison term","examples":["123","'abc'"]},"rowA":{"type":"Object","required":true,"desc":"Full Row object in which is contained the first term","examples":["{ name: 'Potassium', value: 'K' }"]},"rowB":{"type":"Object","required":true,"desc":"Full Row object in which is contained the second term","examples":["{ name: 'Fluorine', value: 'F' }"]}},"returns":{"type":"Number","desc":"Comparison result of term 'a' with term 'b'. Less than 0 when 'a' should come first; greater than 0 if 'b' should come first; equal to 0 if their position must not be changed with respect to each other","examples":["-1","0","1"]}},"rawSort":{"type":"Function","desc":"Compare function if you have some custom data or want a specific way to compare two rows; includes rows with null/undefined values (use 'sort' instead if you don't want that)","examples":["(a, b, _rowA, _rowB) => parseInt(a, 10) - parseInt(b, 10)"],"params":{"a":{"type":"Any","required":true,"desc":"Value of the first comparison term","examples":["123","'abc'"]},"b":{"type":"Any","required":true,"desc":"Value of the second comparison term","examples":["123","'abc'"]},"rowA":{"type":"Object","required":true,"desc":"Full Row object in which is contained the first term","examples":["{ name: 'Potassium', value: 'K' }"]},"rowB":{"type":"Object","required":true,"desc":"Full Row object in which is contained the second term","examples":["{ name: 'Fluorine', value: 'F' }"]}},"returns":{"type":"Number","desc":"Comparison result of term 'a' with term 'b'. Less than 0 when 'a' should come first; greater than 0 if 'b' should come first; equal to 0 if their position must not be changed with respect to each other","examples":["-1","0","1"]},"addedIn":"v2.13"},"sortOrder":{"type":"String","desc":"Set column sort order: 'ad' (ascending-descending) or 'da' (descending-ascending); Overrides the 'column-sort-order' prop","values":["'ad'","'da'"],"default":"'ad'","required":false},"format":{"type":"Function","desc":"Function you can apply to format your data","examples":["(val, _row) => `${ val }%`","val => val ? /* Unicode checkmark checked */ '☑' : /* Unicode checkmark unchecked */ '☐'"],"params":{"val":{"type":"Any","required":true,"desc":"Value of the cell","examples":["123","'abc'"]},"row":{"type":"Object","required":true,"desc":"Full Row object in which the cell is contained","examples":["{ name: 'Potassium', value: 'K' }"]}},"returns":{"type":"Any","desc":"The resulting formatted value","examples":["'20%'"]}},"style":{"type":["String","Function"],"desc":"Style to apply on normal cells of the column","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Frozen Yogurt', calories: 159 }"]}},"returns":{"type":"String"},"examples":["'width: 500px'","row => (row.calories % 2 === 0 ? 'width: 10px' : 'font-size: 2em; font-weight: bold')"]},"classes":{"type":["String","Function"],"desc":"Classes to add on normal cells of the column","params":{"row":{"type":"Object","required":true,"desc":"The current row being processed","examples":["{ name: 'Frozen Yogurt', calories: 159 }"]}},"returns":{"type":"String"},"examples":["'my-special-class bg-primary'","row => (row.calories % 2 === 0 ? 'bg-green text-white' : 'bg-yellow')"]},"headerStyle":{"type":"String","desc":"Style to apply on header cells of the column","examples":["'width: 500px'"]},"headerClasses":{"type":"String","desc":"Classes to add on header cells of the column","examples":["'my-special-class'"]}}},"visible-columns":{"type":"Array","desc":"Array of Strings defining column names ('name' property of each column from 'columns' prop definitions); Columns marked as 'required' are not affected by this property","examples":["[ 'desc', 'carbs', 'protein' ]","# :visible-columns=\"myCols\""],"category":"column"},"loading":{"type":"Boolean","desc":"Put Table into 'loading' state; Notify the user something is happening behind the scenes","category":"behavior|content"},"title":{"type":"String","desc":"Table title","examples":["'Device list'"],"category":"content"},"hide-header":{"type":"Boolean","desc":"Hide table header layer","category":"content"},"hide-bottom":{"type":"Boolean","desc":"Hide table bottom layer regardless of what it has to display","category":"content"},"hide-selected-banner":{"type":"Boolean","desc":"Hide the selected rows banner (if any)","category":"content"},"hide-no-data":{"type":"Boolean","desc":"Hide the default no data bottom layer","category":"content"},"hide-pagination":{"type":"Boolean","desc":"Hide the pagination controls at the bottom","category":"content"},"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"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style"},"separator":{"type":"String","desc":"Use a separator/border between rows, columns or all cells","default":"'horizontal'","values":["'horizontal'","'vertical'","'cell'","'none'"],"category":"content","required":false},"wrap-cells":{"type":"Boolean","desc":"Wrap text within table cells","category":"content"},"binary-state-sort":{"type":"Boolean","desc":"Skip the third state (unsorted) when user toggles column sort direction","category":"sorting"},"column-sort-order":{"type":"String","desc":"Set column sort order: 'ad' (ascending-descending) or 'da' (descending-ascending); It gets applied to all columns unless a column has its own sortOrder specified in the 'columns' definition prop","values":["'ad'","'da'"],"default":"'ad'","category":"sorting","required":false},"no-data-label":{"type":"String","desc":"Override default text to display when no data is available","examples":["'No devices available'"],"category":"content"},"no-results-label":{"type":"String","desc":"Override default text to display when user filters the table and no matched results are found","examples":["'No matched records'"],"category":"content"},"loading-label":{"type":"String","desc":"Override default text to display when table is in loading state (see 'loading' prop)","examples":["'Loading devices...'"],"category":"content"},"selected-rows-label":{"type":"Function","desc":"Text to display when user selected at least one row; For best performance, reference it from your scope and do not define it inline","params":{"numberOfRows":{"type":"Number","desc":"Number of rows available"}},"returns":{"type":"String","desc":"Label to display","examples":["'5 rows are selected'"]},"examples":["(numberOfRows) => `Selected: ${ numberOfRows } entries`"],"category":"selection"},"rows-per-page-label":{"type":"String","desc":"Text to override default rows per page label at bottom of table","examples":["'Records per page:'"],"category":"pagination"},"pagination-label":{"type":"Function","desc":"Text to override default pagination label at bottom of table (unless 'pagination' scoped slot is used); For best performance, reference it from your scope and do not define it inline","params":{"firstRowIndex":{"type":"Number","desc":"Index of first displayed row"},"endRowIndex":{"type":"Number","desc":"Index of last displayed row"},"totalRowsNumber":{"type":"Number","desc":"Number of total rows available in data"}},"returns":{"type":"String","desc":"Label to display","examples":["'1-10 of 132'"]},"examples":["(start, end, total) => `${ start }-${ end } of ${ total }`"],"category":"pagination"},"table-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to native HTML <table> element's wrapper (which is a DIV)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"table-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to native HTML <table> element's wrapper (which is a DIV)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"table-header-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to header of native HTML <table> (which is a TR)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"table-header-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to header of native HTML <table> (which is a TR)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"card-container-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to the cards container (when in grid mode)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"card-container-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the cards container (when in grid mode)","examples":["'my-special-class'","'justify-center'","{ 'my-special-class': true }"],"category":"style"},"card-style":{"type":["String","Array","Object"],"tsType":"VueStyleProp","desc":"CSS style to apply to the card (when in grid mode) or container card (when not in grid mode)","examples":["'background-color: #ff0000'","{ backgroundColor: '#ff0000' }"],"category":"style"},"card-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the card (when in grid mode) or container card (when not in grid mode)","examples":["'my-special-class'","{ 'my-special-class': true }"],"category":"style"},"title-class":{"type":["String","Array","Object"],"tsType":"VueClassProp","desc":"CSS classes to apply to the title (if using 'title' prop)","examples":["'my-special-class'","'text-h1'","{ 'text-h1': true }"],"category":"style"},"filter":{"type":["String","Object"],"desc":"String/Object to filter table with; When using an Object it requires 'filter-method' to also be specified since it will be a custom filtering","examples":["'car'"],"category":"filter"},"filter-method":{"type":"Function","desc":"The actual filtering mechanism; For best performance, reference it from your scope and do not define it inline","params":{"rows":{"type":"Array","desc":"Array of rows"},"terms":{"type":["String","Object"],"desc":"Terms to filter with (is essentially the 'filter' prop value)"},"cols":{"type":"Array","desc":"Column definitions"},"getCellValue":{"type":"Function","desc":"Optional function to get a cell value","params":{"col":{"type":"Object","required":true,"desc":"Column name from column definitions"},"row":{"type":"Object","required":true,"desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}},"returns":{"type":"Array","desc":"Filtered rows"},"examples":["# see source code"],"category":"filter"},"pagination":{"type":"Object","desc":"Pagination object; You can also use the 'v-model:pagination' for synching; When not synching it simply initializes the pagination on first render","definition":{"sortBy":{"type":["String","null"],"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","desc":"For server-side fetching only. How many total database rows are there to be added to the table. If set, causes the QTable to emit @request when data is required."}},"syncable":true,"examples":["# :pagination=\"myInitialPagination\"","# v-model:pagination=\"myPagination\""],"category":"pagination"},"rows-per-page-options":{"type":"Array","desc":"Options for user to pick (Numbers); Number 0 means 'Show all rows in one page'","default":"[ 5, 7, 10, 15, 20, 25, 50, 0 ]","examples":["[ 10, 20 ]"],"category":"pagination","required":false},"selection":{"type":"String","desc":"Selection type","default":"'none'","values":["'single'","'multiple'","'none'"],"category":"selection","required":false},"selected":{"type":"Array","desc":"Keeps the user selection array","default":"[]","syncable":true,"examples":["# v-model:selected=\"selection\""],"category":"selection","required":false},"expanded":{"type":"Array","desc":"Keeps the array with expanded rows keys","syncable":true,"examples":["# v-model:expanded=\"expanded\""],"category":"expansion"},"sort-method":{"type":"Function","desc":"The actual sort mechanism. Function (rows, sortBy, descending) => sorted rows; For best performance, reference it from your scope and do not define it inline","params":{"rows":{"type":"Array","desc":"Array with rows"},"sortBy":{"type":"String","desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"}},"returns":{"type":"Array","desc":"Sorted rows"},"examples":["# see source code"],"category":"sorting"}},"slots":{"loading":{"desc":"Override default effect when table is in loading state; Suggestion: QInnerLoading"},"item":{"desc":"Slot to use for defining an item when in 'grid' mode; Suggestion: QCard","scope":{"key":{"type":"Any","desc":"Row/Item's key"},"row":{"type":"Object","desc":"Row/Item object"},"rowIndex":{"type":"Number","desc":"Row/Item's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row/Item's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row/item selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row/item expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body":{"desc":"Slot to define how a body row looks like; Suggestion: QTr + Td","scope":{"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"__trClass":{"type":"String","desc":"Internal prop passed down to QTr (if used)"}}},"body-cell":{"desc":"Slot to define how all body cells look like; Suggestion: QTd","scope":{"col":{"type":"Object","desc":"Column definition for column associated with table cell"},"value":{"type":"Any","desc":"Parsed/Formatted value of table cell"},"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body-cell-[name]":{"desc":"Slot to define how a specific column cell looks like; replace '[name]' with column name (from columns definition object)","scope":{"col":{"type":"Object","desc":"Column definition for column associated with table cell"},"value":{"type":"Any","desc":"Parsed/Formatted value of table cell"},"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header":{"desc":"Slot to define how header looks like; Suggestion: QTr + QTh","scope":{"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"},"__trClass":{"type":"String","desc":"Internal prop passed down to QTr (if used)"},"header":{"type":"Boolean","desc":"Internal prop passed down to QTh (if used); Always 'true'"}}},"header-cell":{"desc":"Slot to define how each header cell looks like; Suggestion: QTh","scope":{"col":{"type":"Object","desc":"Column definition associated to header cell"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header-cell-[name]":{"desc":"Slot to define how a specific header cell looks like; replace '[name]' with column name (from columns definition object)","scope":{"col":{"type":"Object","desc":"Column definition associated to header cell"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"body-selection":{"desc":"Slot to define how body selection column looks like; Suggestion: QCheckbox","scope":{"key":{"type":"Any","desc":"Row's key"},"row":{"type":"Object","desc":"Row object"},"rowIndex":{"type":"Number","desc":"Row's index (0 based) in the filtered and sorted table"},"pageIndex":{"type":"Number","desc":"Row's index (0 based) in the current page of the filtered and sorted table"},"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"header-selection":{"desc":"Slot to define how header selection column looks like (available only for multiple selection mode); Suggestion: QCheckbox","scope":{"cols":{"type":"Object","desc":"Column definitions"},"colsMap":{"type":"Object","desc":"Column mapping (key is column name, value is column object)"},"sort":{"type":"Function","desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"selected":{"type":"Boolean","desc":"(Only if using selection) Is row selected? Can directly be assigned new Boolean value which changes selection state","reactive":true},"expand":{"type":"Boolean","desc":"Is row expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"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},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style"}}},"top-row":{"desc":"Slot to define how top extra row looks like","scope":{"cols":{"type":"Object","desc":"Column definitions"}}},"bottom-row":{"desc":"Slot to define how bottom extra row looks like","scope":{"cols":{"type":"Object","desc":"Column definitions"}}},"top":{"desc":"Slot to define how table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"bottom":{"desc":"Slot to define how table bottom looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"pagination":{"desc":"Slot to override default pagination label and buttons","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-left":{"desc":"Slot to define how left part of the table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-right":{"desc":"Slot to define how right part of the table top looks like","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"top-selection":{"desc":"Slot to define how top table section looks like when user has selected at least one row","scope":{"pagination":{"type":"Object","desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"pagesNumber":{"type":"Number","desc":"Number of pages available"},"isFirstPage":{"type":"Boolean","desc":"Are we on first page?"},"isLastPage":{"type":"Boolean","desc":"Are we on last page?"},"firstPage":{"type":"Function","desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"type":"Function","desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"type":"Function","desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"type":"Function","desc":"Navigates to last page","params":null,"returns":null},"inFullscreen":{"type":"Boolean","desc":"Is table in fullscreen mode?"},"toggleFullscreen":{"type":"Function","desc":"Toggles fullscreen mode","params":null,"returns":null}}},"no-data":{"desc":"Slot to define how the bottom will look like when is nothing to display","scope":{"message":{"type":"String","desc":"The suggested message","examples":["'No data available'"]},"icon":{"type":"String","desc":"The suggested icon name (following Quasar convention)","examples":["'warning'"]}}}},"events":{"fullscreen":{"desc":"Emitted when fullscreen state changes","params":{"value":{"type":"Boolean","desc":"Fullscreen state (showing/hidden)"}}},"update:fullscreen":{"desc":"Used by Vue on 'v-model:fullscreen' prop for updating its value","params":{"value":{"type":"Boolean","desc":"Fullscreen state (showing/hidden)"}}},"row-click":{"desc":"Emitted when user clicks/taps on a row; Is not emitted when using body/row/item scoped slots","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has clicked/tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"row-dblclick":{"desc":"Emitted when user quickly double clicks/taps on a row; Is not emitted when using body/row/item scoped slots; Please check JS dblclick event support before using","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has double clicked/tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"row-contextmenu":{"desc":"Emitted when user right clicks/long taps on a row; Is not emitted when using body/row/item scoped slots","params":{"evt":{"type":"Event","desc":"JS event object"},"row":{"type":"Object","desc":"The row upon which user has right clicked/long tapped"},"index":{"type":"Number","desc":"Index of the row in the current page"}}},"request":{"desc":"Emitted when a server request is triggered","params":{"requestProp":{"type":"Object","desc":"Props of the request","definition":{"pagination":{"type":"Object","required":true,"desc":"Pagination object","definition":{"sortBy":{"type":"String","required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"}}},"filter":{"type":["String","Object"],"desc":"String/Object to filter table with (the 'filter' prop)"},"getCellValue":{"type":"Function","required":true,"desc":"Function to get a cell value","params":{"col":{"type":"Object","required":true,"desc":"Column name from column definitions"},"row":{"type":"Object","required":true,"desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}}}}},"selection":{"desc":"Emitted when user selects/unselects row(s)","params":{"details":{"type":"Object","desc":"Selection details","definition":{"rows":{"type":"Array","required":true,"desc":"Array of row objects that were selected/unselected"},"keys":{"type":"Array","required":true,"desc":"Array of the keys of rows that were selected/unselected"},"added":{"type":"Boolean","required":true,"desc":"Were the rows added to selection (true) or removed from selection (false)"},"evt":{"type":"Event","desc":"JS event object","required":true}}}}},"update:pagination":{"desc":"Used by Vue on 'v-model:pagination' for updating its value","params":{"newPagination":{"type":"Object","desc":"The updated pagination object","definition":{"sortBy":{"type":["String","null"],"required":true,"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","required":true,"desc":"Is sorting in descending order?"},"page":{"type":"Number","required":true,"desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","required":true,"desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","required":false,"desc":"For server-side fetching only. How many total database rows are there to be added to the table."}}}}},"update:selected":{"desc":"Used by Vue on 'v-model:selected' prop for updating its value","params":{"newSelected":{"type":"Array","desc":"The updated selected array","examples":["[ { name: 'Frozen Yogurt', calories: 159, fat: 6 } ]"]}}},"update:expanded":{"desc":"Used by Vue on 'v-model:expanded' prop for updating its value","params":{"newExpanded":{"type":"Array","desc":"The updated expanded array","examples":["[ 'row-a', 'row-b' ]"]}}},"virtual-scroll":{"desc":"Emitted when the virtual scroll occurs, if using virtual scroll","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 underlying QVirtualScroll instance"}}}}}},"methods":{"toggleFullscreen":{"desc":"Toggles fullscreen mode","params":null,"returns":null},"setFullscreen":{"desc":"Enter the fullscreen view","params":null,"returns":null},"exitFullscreen":{"desc":"Leave the fullscreen view","params":null,"returns":null},"requestServerInteraction":{"desc":"Trigger a server request (emits 'request' event)","params":{"props":{"type":"Object","required":false,"desc":"Request details","definition":{"pagination":{"type":"Object","required":false,"desc":"Optional pagination object","definition":{"sortBy":{"type":"String","desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"},"rowsNumber":{"type":"Number","desc":"For server-side fetching only. How many total database rows are there to be added to the table."}}},"filter":{"type":"Function","desc":"Filtering method (the 'filter-method' prop)","params":{"rows":{"type":"Array","required":true,"desc":"Array of rows"},"terms":{"type":["String","Object"],"required":true,"desc":"Terms to filter with (is essentially the 'filter' prop value)"},"cols":{"type":"Array","desc":"Optional column definitions"},"getCellValue":{"type":"Function","desc":"Optional function to get a cell value","params":{"col":{"type":"Object","desc":"Column name from column definitions"},"row":{"type":"Object","desc":"The row object"}},"returns":{"type":"Any","desc":"Parsed/Processed cell value","examples":["'Ice Cream Sandwich'"]}}},"returns":{"type":"Array","desc":"Filtered rows"}}}}},"returns":null},"setPagination":{"desc":"Unless using an external pagination Object (through 'v-model:pagination' prop), you can use this method and force the internal pagination to change","params":{"pagination":{"type":"Object","required":true,"desc":"Pagination object","definition":{"sortBy":{"type":["String","null"],"desc":"Column name (from column definition)","examples":["'calories'"]},"descending":{"type":"Boolean","desc":"Is sorting in descending order?"},"page":{"type":"Number","desc":"Page number (1-based)"},"rowsPerPage":{"type":"Number","desc":"How many rows per page? 0 means Infinite"}}},"forceServerRequest":{"type":"Boolean","desc":"Also force a server request"}},"returns":null},"firstPage":{"desc":"Navigates to first page","params":null,"returns":null},"prevPage":{"desc":"Navigates to previous page, if available","params":null,"returns":null},"nextPage":{"desc":"Navigates to next page, if available","params":null,"returns":null},"lastPage":{"desc":"Navigates to last page","params":null,"returns":null},"isRowSelected":{"desc":"Determine if a row has been selected by user","params":{"key":{"type":"Any","required":true,"desc":"Row key value","examples":["'calories'"]}},"returns":{"type":"Boolean","desc":"Is row selected or not?"}},"clearSelection":{"desc":"Clears user selection (emits 'update:selected' with empty array)","params":null,"returns":null},"isRowExpanded":{"desc":"Determine if a row is expanded or not","params":{"key":{"type":"Any","required":true,"desc":"Row key value","examples":["'calories'"]}},"returns":{"type":"Boolean","desc":"Is row expanded or not?"}},"setExpanded":{"desc":"Sets the expanded rows keys array; Especially useful if not using an external 'expanded' state otherwise just emits 'update:expanded' with the value","params":{"expanded":{"type":"Array","required":true,"desc":"Array containing keys of the expanded rows","examples":["[ 'row-a', 'row-b' ]"]}},"returns":null},"sort":{"desc":"Trigger a table sort","params":{"col":{"type":["String","Object"],"required":true,"desc":"Column name or column definition object","examples":["'calories'"]}},"returns":null},"resetVirtualScroll":{"desc":"Resets the virtual scroll (if using it) computations; Needed for custom edge-cases","params":null,"returns":null},"scrollTo":{"desc":"Scroll the table to the row with the specified index in page (0 based)","params":{"index":{"type":["Number","String"],"required":true,"desc":"The index of the row in page (0 based)"},"edge":{"type":"String","desc":"Only for virtual scroll - the edge to align to if the row is not visible already; If the '-force' version is used then it always aligns; Default value: end (if scrolling towards the end) / start (if scrolling towards the start)","values":["'start'","'center'","'end'","'start-force'","'center-force'","'end-force'"],"default":"# end/start","required":false}},"returns":null}},"computedProps":{"filteredSortedRows":{"desc":"The filtered and sorted rows (same as the rows prop if using server-side fetching)","type":"Array","examples":["[ { name: 'Ice Cream Sandwich', calories: 237, fat: 9.0, carbs: 37, protein: 4.3, sodium: 129, calcium: 8, iron: 1 }, ... ]"]},"computedRows":{"desc":"Paginated, filtered, and sorted rows (same as the rows prop if using server-side fetching)","type":"Array","examples":["[ { name: 'Ice Cream Sandwich', calories: 237, fat: 9.0, carbs: 37, protein: 4.3, sodium: 129, calcium: 8, iron: 1 }, ... ]"]},"computedRowsNumber":{"type":"Number","desc":"The number of computed rows"}}}

package/dist/api/QTimeline.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/timeline"},"props":{"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"side":{"type":"String","desc":"Side to place the timeline entries in dense and comfortable layout; For loose layout it gets overridden by QTimelineEntry side prop","default":"'right'","values":["'left'","'right'"],"category":"behavior","required":false},"layout":{"type":"String","desc":"Layout of the timeline. Dense keeps content and labels on one side. Comfortable keeps content on one side and labels on the opposite side. Loose puts content on both sides.","default":"'dense'","values":["'dense'","'comfortable'","'loose'"],"category":"behavior","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":"Used for content of component"}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/timeline"},"props":{"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","default":"'primary'","required":false},"side":{"type":"String","desc":"Side to place the timeline entries in dense and comfortable layout; For loose layout it gets overridden by QTimelineEntry side prop","default":"'right'","values":["'left'","'right'"],"category":"behavior","required":false},"layout":{"type":"String","desc":"Layout of the timeline. Dense keeps content and labels on one side. Comfortable keeps content on one side and labels on the opposite side. Loose puts content on both sides.","default":"'dense'","values":["'dense'","'comfortable'","'loose'"],"category":"behavior","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":"Used for content of component"}}}

package/dist/api/QToggle.json

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

package/dist/api/QTooltip.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/tooltip"},"props":{"transition-show":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'jump-down'","required":false},"transition-hide":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'jump-up'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","required":false},"model-value":{"type":"Boolean","desc":"Model of the component defining shown/hidden state; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive","category":"model"},"max-height":{"type":["String","null"],"desc":"The maximum height of the Tooltip; Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"content","default":"null","required":false},"max-width":{"type":["String","null"],"desc":"The maximum width of the Tooltip; Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"content","default":"null","required":false},"anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the Tooltip relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'bottom middle'","category":"position","required":false},"self":{"type":"String","desc":"Two values setting the Tooltip's own position relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'top middle'","category":"position","required":false},"offset":{"type":"Array","desc":"An array of two numbers to offset the Tooltip horizontally and vertically in pixels","default":"[ 14, 14 ]","examples":["[ 8, 8 ]","[ 5, 10 ]"],"category":"position","required":false},"scroll-target":{"type":["Element","String"],"desc":"CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one","examples":[".scroll-target-class","#scroll-target-id","$refs.scrollTarget","document.body"],"category":"behavior"},"target":{"type":["Boolean","String"],"desc":"Configure a target element to trigger Tooltip toggle; 'true' means it enables the parent DOM element, 'false' means it disables attaching events to any DOM elements; By using a String (CSS selector) it attaches the events to the specified DOM element (if it exists)","default":"true","examples":["# :target=\"false\"","# target=\".my-parent\""],"category":"behavior","required":false},"no-parent-event":{"type":"Boolean","desc":"Skips attaching events to the target DOM element (that trigger the element to get shown)","category":"behavior"},"delay":{"type":"Number","desc":"Configure Tooltip to appear with delay","default":"0","category":"behavior","required":false},"hide-delay":{"type":"Number","desc":"Configure Tooltip to disappear with delay","default":"0","category":"behavior","required":false},"persistent":{"type":"Boolean","desc":"Prevents Tooltip from auto-closing when app's route changes","category":"behavior"}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}},"events":{"update:model-value":{"desc":"Emitted when showing/hidden state changes; Is also used by v-model","params":{"value":{"type":"Boolean","desc":"New state (showing/hidden)"}}},"show":{"desc":"Emitted after component has triggered show()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-show":{"desc":"Emitted when component triggers show() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"hide":{"desc":"Emitted after component has triggered hide()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-hide":{"desc":"Emitted when component triggers hide() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"show":{"desc":"Triggers component to show","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"hide":{"desc":"Triggers component to hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"toggle":{"desc":"Triggers component to toggle between show/hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"updatePosition":{"desc":"There are some custom scenarios for which Quasar cannot automatically reposition the tooltip without significant performance drawbacks so the optimal solution is for you to call this method when you need it","params":null,"returns":null}},"computedProps":{"contentEl":{"type":"Element","desc":"The DOM Element of the rendered content","addedIn":"v2.10.1"}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/tooltip"},"props":{"transition-show":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'jump-down'","required":false},"transition-hide":{"type":"String","desc":"One of Quasar's embedded transitions","examples":["'fade'","'slide-down'"],"category":"transition","default":"'jump-up'","required":false},"transition-duration":{"type":["String","Number"],"desc":"Transition duration (in milliseconds, without unit)","default":"300","category":"transition","required":false},"target":{"type":["Boolean","String","Element"],"desc":"Configure a target element to trigger component toggle; 'true' means it enables the parent DOM element, 'false' means it disables attaching events to any DOM elements; By using a String (CSS selector) or a DOM element it attaches the events to the specified DOM element (if it exists)","default":"true","examples":["false",".my-parent","#target-id","$refs.target"],"category":"behavior","required":false},"no-parent-event":{"type":"Boolean","desc":"Skips attaching events to the target DOM element (that trigger the element to get shown)","category":"behavior"},"model-value":{"type":["Boolean","null"],"desc":"Model of the component defining shown/hidden state; Either use this property (along with a listener for 'update:model-value' event) OR use v-model directive","default":"null","category":"model","examples":["# v-model=\"state\""],"required":false},"max-height":{"type":["String","null"],"desc":"The maximum height of the Tooltip; Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"content","default":"null","required":false},"max-width":{"type":["String","null"],"desc":"The maximum width of the Tooltip; Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"content","default":"null","required":false},"anchor":{"type":"String","desc":"Two values setting the starting position or anchor point of the Tooltip relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'bottom middle'","category":"position","required":false},"self":{"type":"String","desc":"Two values setting the Tooltip's own position relative to its target","values":["'top left'","'top middle'","'top right'","'top start'","'top end'","'center left'","'center middle'","'center right'","'center start'","'center end'","'bottom left'","'bottom middle'","'bottom right'","'bottom start'","'bottom end'"],"default":"'top middle'","category":"position","required":false},"offset":{"type":"Array","desc":"An array of two numbers to offset the Tooltip horizontally and vertically in pixels","default":"[ 14, 14 ]","examples":["[ 8, 8 ]","[ 5, 10 ]"],"category":"position","required":false},"scroll-target":{"type":["Element","String"],"desc":"CSS selector or DOM element to be used as a custom scroll container instead of the auto detected one","examples":[".scroll-target-class","#scroll-target-id","$refs.scrollTarget","document.body"],"category":"behavior"},"delay":{"type":"Number","desc":"Configure Tooltip to appear with delay","default":"0","category":"behavior","required":false},"hide-delay":{"type":"Number","desc":"Configure Tooltip to disappear with delay","default":"0","category":"behavior","required":false},"persistent":{"type":"Boolean","desc":"Prevents Tooltip from auto-closing when app's route changes","category":"behavior"}},"slots":{"default":{"desc":"Default slot in the devland unslotted content of the component"}},"events":{"update:model-value":{"desc":"Emitted when showing/hidden state changes; Is also used by v-model","params":{"value":{"type":"Boolean","desc":"New state (showing/hidden)"}}},"show":{"desc":"Emitted after component has triggered show()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-show":{"desc":"Emitted when component triggers show() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"hide":{"desc":"Emitted after component has triggered hide()","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}},"before-hide":{"desc":"Emitted when component triggers hide() but before it finishes doing it","params":{"evt":{"type":"Event","desc":"JS event object","required":true}}}},"methods":{"show":{"desc":"Triggers component to show","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"hide":{"desc":"Triggers component to hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"toggle":{"desc":"Triggers component to toggle between show/hide","params":{"evt":{"type":"Event","desc":"JS event object","required":false}},"returns":null},"updatePosition":{"desc":"There are some custom scenarios for which Quasar cannot automatically reposition the tooltip without significant performance drawbacks so the optimal solution is for you to call this method when you need it","params":null,"returns":null}},"computedProps":{"contentEl":{"type":"Element","desc":"The DOM Element of the rendered content","addedIn":"v2.10.1"}}}

package/dist/api/QTree.json

@@ -1 +1 @@
-{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/tree"},"props":{"nodes":{"type":"Array","tsType":"QTreeNode","desc":"The array of nodes that designates the tree structure","required":true,"examples":["[ {}, {} ]"],"category":"content"},"node-key":{"type":"String","desc":"The property name of each node object that holds a unique node id","required":true,"examples":["'key'","'id'"],"category":"content"},"label-key":{"type":"String","desc":"The property name of each node object that holds the label of the node","default":"'label'","examples":["'name'","'description'"],"category":"content","required":false},"children-key":{"type":"String","desc":"The property name of each node object that holds the list of children of the node","default":"'children'","examples":["'roles'","'relatives'"],"category":"content","required":false},"no-connectors":{"type":"Boolean","desc":"Do not display the connector lines between nodes","category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-color":{"type":"String","tsType":"NamedColor","desc":"Color name for controls (like checkboxes) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"selected-color":{"type":"String","tsType":"NamedColor","desc":"Color name for selected nodes (from the Quasar Color Palette)","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style","addedIn":"v2.2.4"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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"},"tick-strategy":{"type":"String","desc":"The type of strategy to use for the selection of the nodes","default":"'none'","values":["'none'","'strict'","'leaf'","'leaf-filtered'"],"category":"behavior","required":false},"ticked":{"type":"Array","desc":"Keys of nodes that are ticked","sync":true,"examples":["# v-model:ticked=\"tickedKeys\""],"category":"state","syncable":true},"expanded":{"type":"Array","desc":"Keys of nodes that are expanded","sync":true,"examples":["# v-model:expanded=\"expandedKeys\""],"category":"state","syncable":true},"selected":{"type":"Any","desc":"Key of node currently selected","sync":true,"examples":["# v-model:selected=\"selectedKey\""],"category":"state","syncable":true},"no-selection-unset":{"type":"Boolean","desc":"Do not allow un-selection when clicking currently selected node","category":"behavior","addedIn":"v2.4.10"},"default-expand-all":{"type":"Boolean","desc":"Allow the tree to have all its branches expanded, when first rendered","category":"behavior"},"accordion":{"type":"Boolean","desc":"Allows the tree to be set in accordion mode","category":"behavior"},"no-transition":{"type":"Boolean","desc":"Turn off transition effects when expanding/collapsing nodes; Also enhances perf by a lot as a side-effect; Recommended for big trees","category":"behavior","addedIn":"v2.9.2"},"filter":{"type":"String","desc":"The text value to be used for filtering nodes","examples":["'car'"],"category":"filter"},"filter-method":{"type":"Function","desc":"The function to use to filter the tree nodes; For best performance, reference it from your scope and do not define it inline","default":"# see source code","params":{"node":{"type":"Object","desc":"Node currently being filtered"},"filter":{"type":"String","desc":"Filter text to match against"}},"returns":{"type":"Boolean","desc":"Matches or not"},"category":"filter","required":false},"duration":{"type":"Number","desc":"Toggle animation duration (in milliseconds)","default":"300","category":"style","required":false},"no-nodes-label":{"type":"String","desc":"Override default such label for when no nodes are available","examples":["'No nodes to show!'"],"category":"content"},"no-results-label":{"type":"String","desc":"Override default such label for when no nodes are available due to filtering","examples":["'No results'"],"category":"content"}},"slots":{"default-header":{"desc":"Slot to use for defining the header of a node","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"header-[name]":{"desc":"Header template slot for describing node header; Used by nodes which have their 'header' prop set to '[name]', where '[name]' can be any string","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"default-body":{"desc":"Slot to use for defining the body of a node","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"body-[name]":{"desc":"Body template slot for describing node body; Used by nodes which have their 'body' prop set to '[name]', where '[name]' can be any string","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}}},"events":{"update:expanded":{"desc":"Triggered when nodes are expanded or collapsed; Used by Vue on 'v-model:update' to update its value","params":{"expanded":{"type":"Array","desc":"The expanded node keys","examples":["[ 'Node 1', 'Node 2' ]"]}}},"lazy-load":{"desc":"Emitted when the lazy loading of nodes is finished","params":{"details":{"type":"Object","desc":"Lazy loading details","definition":{"node":{"type":"Object","required":true,"desc":"The node to which the new nodes (the children) will be appended"},"key":{"type":"String","required":true,"desc":"The key of the node getting the newly loaded child nodes","examples":["'New Node'"]},"done":{"type":"Function","required":true,"desc":"The callback to be carried out when the loading is successful","params":{"children":{"type":"Array","desc":"Array of nodes","default":"[]","required":false}},"returns":null},"fail":{"type":"Function","required":true,"desc":"The callback to be carried out should the loading fails","params":null,"returns":null}}}}},"update:ticked":{"desc":"Emitted when nodes are ticked/unticked via the checkbox; Used by Vue on 'v-model:ticked' to update its value","params":{"target":{"type":"Array","desc":"The ticked node keys","examples":["[ 'Node 1', 'Node 2' ]"]}}},"update:selected":{"desc":"Emitted when selected node changes; Used by Vue on 'v-model:selected' to update its value","params":{"target":{"type":"Any","desc":"The selected node key","examples":["'Node 1'"]}}},"after-show":{"desc":"Emitted when component show animation is finished"},"after-hide":{"desc":"Emitted when component hide animation is finished"}},"methods":{"getNodeByKey":{"desc":"Get the node with the given key","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Object","desc":"Requested node"}},"getTickedNodes":{"desc":"Get array of nodes that are ticked","params":null,"returns":{"type":"Array","desc":"Ticked node objects"}},"getExpandedNodes":{"desc":"Get array of nodes that are expanded","params":null,"returns":{"type":"Array","desc":"Expanded node objects"}},"isExpanded":{"desc":"Determine if a node is expanded","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Boolean","desc":"Is specified node expanded?"}},"expandAll":{"desc":"Use to expand all branches of the tree","params":null,"returns":null},"collapseAll":{"desc":"Use to collapse all branches of the tree","params":null,"returns":null},"setExpanded":{"desc":"Expands the tree at the point of the node with the key given","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]},"state":{"type":"Boolean","required":true,"desc":"Set to 'true' to expand the branch of the tree, otherwise 'false' collapses it"}},"returns":null},"isTicked":{"desc":"Method to check if a node's checkbox is selected or not","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Boolean","desc":"Is specified node ticked?"}},"setTicked":{"desc":"Method to set a node's checkbox programmatically","params":{"keys":{"type":"Array","required":true,"desc":"The keys of nodes to tick/untick","examples":["[ 'Node 1', 'Node 2' ]"]},"state":{"type":"Boolean","required":true,"desc":"Set to 'true' to tick the checkbox of nodes, otherwise 'false' unticks them"}},"returns":null}}}
+{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/tree"},"props":{"nodes":{"type":"Array","tsType":"QTreeNode","desc":"The array of nodes that designates the tree structure","required":true,"examples":["[ {}, {} ]"],"category":"content"},"node-key":{"type":"String","desc":"The property name of each node object that holds a unique node id","required":true,"examples":["'key'","'id'"],"category":"content"},"label-key":{"type":"String","desc":"The property name of each node object that holds the label of the node","default":"'label'","examples":["'name'","'description'"],"category":"content","required":false},"children-key":{"type":"String","desc":"The property name of each node object that holds the list of children of the node","default":"'children'","examples":["'roles'","'relatives'"],"category":"content","required":false},"no-connectors":{"type":"Boolean","desc":"Do not display the connector lines between nodes","category":"style"},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"control-color":{"type":"String","tsType":"NamedColor","desc":"Color name for controls (like checkboxes) from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"text-color":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"selected-color":{"type":"String","tsType":"NamedColor","desc":"Color name for selected nodes (from the Quasar Color Palette)","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"dense":{"type":"Boolean","desc":"Dense mode; occupies less space","category":"style","addedIn":"v2.2.4"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"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"},"tick-strategy":{"type":"String","desc":"The type of strategy to use for the selection of the nodes","default":"'none'","values":["'none'","'strict'","'leaf'","'leaf-filtered'"],"category":"behavior","required":false},"ticked":{"type":"Array","desc":"Keys of nodes that are ticked","sync":true,"examples":["# v-model:ticked=\"tickedKeys\""],"category":"state","syncable":true},"expanded":{"type":"Array","desc":"Keys of nodes that are expanded","sync":true,"examples":["# v-model:expanded=\"expandedKeys\""],"category":"state","syncable":true},"selected":{"type":"Any","desc":"Key of node currently selected","sync":true,"examples":["# v-model:selected=\"selectedKey\""],"category":"state","syncable":true},"no-selection-unset":{"type":"Boolean","desc":"Do not allow un-selection when clicking currently selected node","category":"behavior","addedIn":"v2.4.10"},"default-expand-all":{"type":"Boolean","desc":"Allow the tree to have all its branches expanded, when first rendered","category":"behavior"},"accordion":{"type":"Boolean","desc":"Allows the tree to be set in accordion mode","category":"behavior"},"no-transition":{"type":"Boolean","desc":"Turn off transition effects when expanding/collapsing nodes; Also enhances perf by a lot as a side-effect; Recommended for big trees","category":"behavior","addedIn":"v2.9.2"},"filter":{"type":"String","desc":"The text value to be used for filtering nodes","examples":["'car'"],"category":"filter"},"filter-method":{"type":"Function","desc":"The function to use to filter the tree nodes; For best performance, reference it from your scope and do not define it inline","params":{"node":{"type":"Object","desc":"Node currently being filtered"},"filter":{"type":"String","desc":"Filter text to match against"}},"returns":{"type":"Boolean","desc":"Matches or not"},"examples":["(node, filter) => node.label.toLowerCase().indexOf(filter.toLowerCase()) !== -1"],"category":"filter"},"duration":{"type":"Number","desc":"Toggle animation duration (in milliseconds)","default":"300","category":"style","required":false},"no-nodes-label":{"type":"String","desc":"Override default such label for when no nodes are available","examples":["'No nodes to show!'"],"category":"content"},"no-results-label":{"type":"String","desc":"Override default such label for when no nodes are available due to filtering","examples":["'No results'"],"category":"content"}},"slots":{"default-header":{"desc":"Slot to use for defining the header of a node","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"header-[name]":{"desc":"Header template slot for describing node header; Used by nodes which have their 'header' prop set to '[name]', where '[name]' can be any string","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"default-body":{"desc":"Slot to use for defining the body of a node","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}},"body-[name]":{"desc":"Body template slot for describing node body; Used by nodes which have their 'body' prop set to '[name]', where '[name]' can be any string","scope":{"expanded":{"type":"Boolean","desc":"Is node expanded? Can directly be assigned new Boolean value which changes expanded state","reactive":true},"ticked":{"type":"Boolean","desc":"Is node ticked? Can directly be assigned new Boolean value which changes ticked state","reactive":true},"tree":{"type":"Component","tsType":"QTree","desc":"QTree instance"},"node":{"type":"Object","desc":"Node object"},"key":{"type":"Any","desc":"Node's key"},"color":{"type":"String","desc":"QTree instance 'color' supplied prop value","examples":["'primary'"]},"dark":{"type":"Boolean","desc":"QTree instance 'dark' supplied prop value"}}}},"events":{"update:expanded":{"desc":"Triggered when nodes are expanded or collapsed; Used by Vue on 'v-model:update' to update its value","params":{"expanded":{"type":"Array","desc":"The expanded node keys","examples":["[ 'Node 1', 'Node 2' ]"]}}},"lazy-load":{"desc":"Emitted when the lazy loading of nodes is finished","params":{"details":{"type":"Object","desc":"Lazy loading details","definition":{"node":{"type":"Object","required":true,"desc":"The node to which the new nodes (the children) will be appended"},"key":{"type":"String","required":true,"desc":"The key of the node getting the newly loaded child nodes","examples":["'New Node'"]},"done":{"type":"Function","required":true,"desc":"The callback to be carried out when the loading is successful","params":{"children":{"type":"Array","desc":"Array of nodes","default":"[]","required":false}},"returns":null},"fail":{"type":"Function","required":true,"desc":"The callback to be carried out should the loading fails","params":null,"returns":null}}}}},"update:ticked":{"desc":"Emitted when nodes are ticked/unticked via the checkbox; Used by Vue on 'v-model:ticked' to update its value","params":{"target":{"type":"Array","desc":"The ticked node keys","examples":["[ 'Node 1', 'Node 2' ]"]}}},"update:selected":{"desc":"Emitted when selected node changes; Used by Vue on 'v-model:selected' to update its value","params":{"target":{"type":"Any","desc":"The selected node key","examples":["'Node 1'"]}}},"after-show":{"desc":"Emitted when component show animation is finished"},"after-hide":{"desc":"Emitted when component hide animation is finished"}},"methods":{"getNodeByKey":{"desc":"Get the node with the given key","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Object","desc":"Requested node"}},"getTickedNodes":{"desc":"Get array of nodes that are ticked","params":null,"returns":{"type":"Array","desc":"Ticked node objects"}},"getExpandedNodes":{"desc":"Get array of nodes that are expanded","params":null,"returns":{"type":"Array","desc":"Expanded node objects"}},"isExpanded":{"desc":"Determine if a node is expanded","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Boolean","desc":"Is specified node expanded?"}},"expandAll":{"desc":"Use to expand all branches of the tree","params":null,"returns":null},"collapseAll":{"desc":"Use to collapse all branches of the tree","params":null,"returns":null},"setExpanded":{"desc":"Expands the tree at the point of the node with the key given","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]},"state":{"type":"Boolean","required":true,"desc":"Set to 'true' to expand the branch of the tree, otherwise 'false' collapses it"}},"returns":null},"isTicked":{"desc":"Method to check if a node's checkbox is selected or not","params":{"key":{"type":"Any","required":true,"desc":"The key of a node","examples":["'Node 1'"]}},"returns":{"type":"Boolean","desc":"Is specified node ticked?"}},"setTicked":{"desc":"Method to set a node's checkbox programmatically","params":{"keys":{"type":"Array","required":true,"desc":"The keys of nodes to tick/untick","examples":["[ 'Node 1', 'Node 2' ]"]},"state":{"type":"Boolean","required":true,"desc":"Set to 'true' to tick the checkbox of nodes, otherwise 'false' unticks them"}},"returns":null}}}