@quidgest/ui 0.31.1 → 0.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +46 -0
- package/dist/json/api.json +1032 -243
- package/dist/manifest/components.json +1 -0
- package/dist/ui.css +859 -285
- package/dist/ui.esm.js +1584 -1360
- package/dist/ui.min.css +1 -1
- package/dist/ui.scss +949 -305
- package/lib/components/QAccordion/QAccordion.d.ts +1 -1
- package/lib/components/QAccordion/QAccordion.d.ts.map +1 -1
- package/lib/components/QAccordion/QAccordionItem.d.ts.map +1 -1
- package/lib/components/QAccordion/QAccordionItem.vue.js +5 -5
- package/lib/components/QAccordion/index.d.ts +6 -6
- package/lib/components/QAccordion/types.d.ts +2 -2
- package/lib/components/QAccordion/types.d.ts.map +1 -1
- package/lib/components/QAlert/QAlert.d.ts +1 -1
- package/lib/components/QAlert/QAlert.d.ts.map +1 -1
- package/lib/components/QAlert/QAlert.vue.js +78 -74
- package/lib/components/QAlert/index.d.ts +3 -3
- package/lib/components/QAlert/types.d.ts +20 -2
- package/lib/components/QAlert/types.d.ts.map +1 -1
- package/lib/components/QAvatar/QAvatar.d.ts +1 -1
- package/lib/components/QAvatar/index.d.ts +3 -3
- package/lib/components/QBadge/QBadge.d.ts +1 -1
- package/lib/components/QBadge/QBadge.d.ts.map +1 -1
- package/lib/components/QBadge/QBadge.vue.js +64 -55
- package/lib/components/QBadge/index.d.ts +3 -3
- package/lib/components/QBadge/types.d.ts +2 -2
- package/lib/components/QBadge/types.d.ts.map +1 -1
- package/lib/components/QBadgeIndicator/QBadgeIndicator.vue.js +2 -3
- package/lib/components/QBreadcrumbs/QBreadcrumb.d.ts +6 -6
- package/lib/components/QBreadcrumbs/QBreadcrumb.vue.js +3 -3
- package/lib/components/QBreadcrumbs/QBreadcrumbs.d.ts +1 -1
- package/lib/components/QBreadcrumbs/QBreadcrumbs.d.ts.map +1 -1
- package/lib/components/QBreadcrumbs/QBreadcrumbs.vue.js +31 -31
- package/lib/components/QBreadcrumbs/context.d.ts +2 -1
- package/lib/components/QBreadcrumbs/context.d.ts.map +1 -1
- package/lib/components/QBreadcrumbs/index.d.ts +9 -9
- package/lib/components/QBreadcrumbs/types.d.ts +2 -2
- package/lib/components/QBreadcrumbs/types.d.ts.map +1 -1
- package/lib/components/QButton/QButton.d.ts +2 -2
- package/lib/components/QButton/QButton.d.ts.map +1 -1
- package/lib/components/QButton/QButton.vue.js +53 -49
- package/lib/components/QButton/index.d.ts +6 -6
- package/lib/components/QButton/types.d.ts +2 -2
- package/lib/components/QButton/types.d.ts.map +1 -1
- package/lib/components/QCard/QCard.vue.js +9 -20
- package/lib/components/QCarousel/QCarousel.d.ts +4 -4
- package/lib/components/QCarousel/QCarousel.d.ts.map +1 -1
- package/lib/components/QCarousel/QCarousel.vue.js +10 -16
- package/lib/components/QCarousel/index.d.ts +14 -14
- package/lib/components/QCarousel/types.d.ts +2 -2
- package/lib/components/QCarousel/types.d.ts.map +1 -1
- package/lib/components/QCheckbox/QCheckbox.d.ts +3 -22
- package/lib/components/QCheckbox/QCheckbox.d.ts.map +1 -1
- package/lib/components/QCheckbox/QCheckbox.vue.js +98 -100
- package/lib/components/QCheckbox/constants.d.ts +9 -0
- package/lib/components/QCheckbox/constants.d.ts.map +1 -1
- package/lib/components/QCheckbox/constants.js +4 -4
- package/lib/components/QCheckbox/index.d.ts +10 -72
- package/lib/components/QCheckbox/index.d.ts.map +1 -1
- package/lib/components/QCheckbox/types.d.ts +2 -8
- package/lib/components/QCheckbox/types.d.ts.map +1 -1
- package/lib/components/QCollapsible/QCollapsible.d.ts +1 -1
- package/lib/components/QCollapsible/QCollapsible.d.ts.map +1 -1
- package/lib/components/QCollapsible/QCollapsible.vue.js +20 -27
- package/lib/components/QCollapsible/index.d.ts +6 -6
- package/lib/components/QCollapsible/types.d.ts +2 -2
- package/lib/components/QCollapsible/types.d.ts.map +1 -1
- package/lib/components/QColorPicker/QColorPicker.d.ts +4 -18
- package/lib/components/QColorPicker/QColorPicker.d.ts.map +1 -1
- package/lib/components/QColorPicker/QColorPicker.vue.js +52 -35
- package/lib/components/QColorPicker/constants.d.ts +4 -0
- package/lib/components/QColorPicker/constants.d.ts.map +1 -1
- package/lib/components/QColorPicker/index.d.ts +13 -57
- package/lib/components/QColorPicker/index.d.ts.map +1 -1
- package/lib/components/QColorPicker/types.d.ts +2 -2
- package/lib/components/QColorPicker/types.d.ts.map +1 -1
- package/lib/components/QCombobox/QCombobox.d.ts +355 -299
- package/lib/components/QCombobox/QCombobox.d.ts.map +1 -1
- package/lib/components/QCombobox/QCombobox.vue.js +236 -190
- package/lib/components/QCombobox/constants.d.ts +5 -0
- package/lib/components/QCombobox/constants.d.ts.map +1 -1
- package/lib/components/QCombobox/constants.js +1 -0
- package/lib/components/QCombobox/index.d.ts +265 -424
- package/lib/components/QCombobox/index.d.ts.map +1 -1
- package/lib/components/QCombobox/types.d.ts +2 -2
- package/lib/components/QCombobox/types.d.ts.map +1 -1
- package/lib/components/QDateTimePicker/QDateTimePicker.d.ts +106 -229
- package/lib/components/QDateTimePicker/QDateTimePicker.d.ts.map +1 -1
- package/lib/components/QDateTimePicker/QDateTimePicker.vue.js +829 -722
- package/lib/components/QDateTimePicker/constants.d.ts +6 -1
- package/lib/components/QDateTimePicker/constants.d.ts.map +1 -1
- package/lib/components/QDateTimePicker/constants.js +2 -1
- package/lib/components/QDateTimePicker/index.d.ts +73 -229
- package/lib/components/QDateTimePicker/index.d.ts.map +1 -1
- package/lib/components/QDateTimePicker/types.d.ts +2 -1
- package/lib/components/QDateTimePicker/types.d.ts.map +1 -1
- package/lib/components/QDialog/QDialog.d.ts +22 -10
- package/lib/components/QDialog/QDialog.d.ts.map +1 -1
- package/lib/components/QDialog/QDialog.vue.js +143 -108
- package/lib/components/QDialog/QDialogProvider.d.ts.map +1 -1
- package/lib/components/QDialog/QDialogProvider.vue.js +8 -3
- package/lib/components/QDialog/constants.d.ts +19 -1
- package/lib/components/QDialog/constants.d.ts.map +1 -1
- package/lib/components/QDialog/constants.js +16 -11
- package/lib/components/QDialog/index.d.ts +39 -23
- package/lib/components/QDialog/index.d.ts.map +1 -1
- package/lib/components/QDialog/types.d.ts +24 -13
- package/lib/components/QDialog/types.d.ts.map +1 -1
- package/lib/components/QDivider/QDivider.d.ts.map +1 -1
- package/lib/components/QDivider/QDivider.vue.js +23 -13
- package/lib/components/QDivider/types.d.ts +9 -0
- package/lib/components/QDivider/types.d.ts.map +1 -1
- package/lib/components/QDrawer/QDrawer.d.ts +71 -0
- package/lib/components/QDrawer/QDrawer.d.ts.map +1 -0
- package/lib/components/QDrawer/QDrawer.vue.js +458 -0
- package/lib/components/QDrawer/QDrawer2.vue.js +5 -0
- package/lib/components/QDrawer/constants.d.ts +22 -0
- package/lib/components/QDrawer/constants.d.ts.map +1 -0
- package/lib/components/QDrawer/constants.js +14 -0
- package/lib/components/QDrawer/index.d.ts +214 -0
- package/lib/components/QDrawer/index.d.ts.map +1 -0
- package/lib/components/QDrawer/index.js +6 -0
- package/lib/components/QDrawer/types.d.ts +221 -0
- package/lib/components/QDrawer/types.d.ts.map +1 -0
- package/lib/components/QDropdownMenu/QDropdownMenu.d.ts +1 -1
- package/lib/components/QDropdownMenu/QDropdownMenu.d.ts.map +1 -1
- package/lib/components/QDropdownMenu/QDropdownMenu.vue.js +59 -52
- package/lib/components/QDropdownMenu/QDropdownMenuContent.d.ts +118 -42
- package/lib/components/QDropdownMenu/QDropdownMenuContent.d.ts.map +1 -1
- package/lib/components/QDropdownMenu/QDropdownMenuContent.vue.js +213 -185
- package/lib/components/QDropdownMenu/ids.d.ts +6 -0
- package/lib/components/QDropdownMenu/ids.d.ts.map +1 -1
- package/lib/components/QDropdownMenu/ids.js +4 -1
- package/lib/components/QDropdownMenu/index.d.ts +6 -6
- package/lib/components/QDropdownMenu/types.d.ts +6 -4
- package/lib/components/QDropdownMenu/types.d.ts.map +1 -1
- package/lib/components/QField/QField.d.ts +18 -17
- package/lib/components/QField/QField.d.ts.map +1 -1
- package/lib/components/QField/QField.vue.js +65 -50
- package/lib/components/QField/constants.d.ts +10 -3
- package/lib/components/QField/constants.d.ts.map +1 -1
- package/lib/components/QField/constants.js +4 -2
- package/lib/components/QField/index.d.ts +12 -11
- package/lib/components/QField/index.d.ts.map +1 -1
- package/lib/components/QField/types.d.ts +6 -5
- package/lib/components/QField/types.d.ts.map +1 -1
- package/lib/components/QFileUpload/QFileUpload.d.ts +28 -54
- package/lib/components/QFileUpload/QFileUpload.d.ts.map +1 -1
- package/lib/components/QFileUpload/QFileUpload.vue.js +43 -39
- package/lib/components/QFileUpload/constants.d.ts +4 -0
- package/lib/components/QFileUpload/constants.d.ts.map +1 -1
- package/lib/components/QFileUpload/index.d.ts +25 -105
- package/lib/components/QFileUpload/index.d.ts.map +1 -1
- package/lib/components/QFileUpload/types.d.ts +2 -1
- package/lib/components/QFileUpload/types.d.ts.map +1 -1
- package/lib/components/QFocusWrap/QFocusWrap.d.ts +1 -0
- package/lib/components/QFocusWrap/QFocusWrap.d.ts.map +1 -1
- package/lib/components/QFocusWrap/QFocusWrap.vue.js +60 -41
- package/lib/components/QFocusWrap/index.d.ts +3 -0
- package/lib/components/QFocusWrap/index.d.ts.map +1 -1
- package/lib/components/QFocusWrap/stack.d.ts +15 -0
- package/lib/components/QFocusWrap/stack.d.ts.map +1 -0
- package/lib/components/QFocusWrap/stack.js +11 -0
- package/lib/components/QFocusWrap/types.d.ts +8 -0
- package/lib/components/QFocusWrap/types.d.ts.map +1 -1
- package/lib/components/QGauge/QGauge.d.ts.map +1 -1
- package/lib/components/QGauge/QGauge.vue.js +87 -86
- package/lib/components/QGrid/QRow.d.ts +1 -1
- package/lib/components/QGrid/index.d.ts +3 -3
- package/lib/components/QIcon/QSvgSymbol.d.ts +1 -1
- package/lib/components/QIcon/QSvgSymbol.d.ts.map +1 -1
- package/lib/components/QIcon/QSvgSymbol.vue.js +31 -31
- package/lib/components/QIcon/utils/svgSource.d.ts +2 -2
- package/lib/components/QIcon/utils/svgSource.d.ts.map +1 -1
- package/lib/components/QInputGroup/QInputGroup.d.ts +27 -24
- package/lib/components/QInputGroup/QInputGroup.d.ts.map +1 -1
- package/lib/components/QInputGroup/QInputGroup.vue.js +19 -11
- package/lib/components/QInputGroup/index.d.ts +14 -12
- package/lib/components/QInputGroup/index.d.ts.map +1 -1
- package/lib/components/QLabel/QLabel.vue.js +1 -2
- package/lib/components/QList/QList.d.ts +46 -17
- package/lib/components/QList/QList.d.ts.map +1 -1
- package/lib/components/QList/QList.vue.js +470 -195
- package/lib/components/QList/QListItem.d.ts +1 -1
- package/lib/components/QList/QListItem.d.ts.map +1 -1
- package/lib/components/QList/QListItem.vue.js +33 -32
- package/lib/components/QList/QListItemGroup.vue.js +1 -1
- package/lib/components/QList/constants.d.ts +26 -0
- package/lib/components/QList/constants.d.ts.map +1 -1
- package/lib/components/QList/context.d.ts +12 -1
- package/lib/components/QList/context.d.ts.map +1 -1
- package/lib/components/QList/context.js +2 -2
- package/lib/components/QList/index.d.ts +79 -22
- package/lib/components/QList/index.d.ts.map +1 -1
- package/lib/components/QList/types.d.ts +11 -9
- package/lib/components/QList/types.d.ts.map +1 -1
- package/lib/components/QMeter/QMeter.d.ts.map +1 -1
- package/lib/components/QMeter/QMeter.vue.js +27 -26
- package/lib/components/QObfuscation/QObfuscation.d.ts +8 -26
- package/lib/components/QObfuscation/QObfuscation.d.ts.map +1 -1
- package/lib/components/QObfuscation/QObfuscation.vue.js +137 -113
- package/lib/components/QObfuscation/constants.d.ts +4 -0
- package/lib/components/QObfuscation/constants.d.ts.map +1 -1
- package/lib/components/QObfuscation/index.d.ts +26 -81
- package/lib/components/QObfuscation/index.d.ts.map +1 -1
- package/lib/components/QObfuscation/types.d.ts +10 -1
- package/lib/components/QObfuscation/types.d.ts.map +1 -1
- package/lib/components/QOverflow/QOverflow.d.ts +7 -3
- package/lib/components/QOverflow/QOverflow.d.ts.map +1 -1
- package/lib/components/QOverflow/QOverflow.vue.js +131 -108
- package/lib/components/QOverflow/constants.d.ts +4 -1
- package/lib/components/QOverflow/constants.d.ts.map +1 -1
- package/lib/components/QOverflow/index.d.ts +3 -3
- package/lib/components/QOverflow/types.d.ts +7 -4
- package/lib/components/QOverflow/types.d.ts.map +1 -1
- package/lib/components/QOverlay/QOverlay.d.ts +14 -5
- package/lib/components/QOverlay/QOverlay.d.ts.map +1 -1
- package/lib/components/QOverlay/QOverlay.vue.js +183 -158
- package/lib/components/QOverlay/index.d.ts +105 -13
- package/lib/components/QOverlay/index.d.ts.map +1 -1
- package/lib/components/QOverlay/layers.d.ts +21 -0
- package/lib/components/QOverlay/layers.d.ts.map +1 -0
- package/lib/components/QOverlay/layers.js +11 -0
- package/lib/components/QOverlay/types.d.ts +0 -6
- package/lib/components/QOverlay/types.d.ts.map +1 -1
- package/lib/components/QPasswordField/QPasswordField.d.ts +52 -170
- package/lib/components/QPasswordField/QPasswordField.d.ts.map +1 -1
- package/lib/components/QPasswordField/QPasswordField.vue.js +8 -3
- package/lib/components/QPasswordField/QPasswordFieldMeterOverlay.vue.js +2 -3
- package/lib/components/QPasswordField/constants.d.ts +4 -0
- package/lib/components/QPasswordField/constants.d.ts.map +1 -1
- package/lib/components/QPasswordField/index.d.ts +29 -170
- package/lib/components/QPasswordField/index.d.ts.map +1 -1
- package/lib/components/QPasswordField/types.d.ts +2 -1
- package/lib/components/QPasswordField/types.d.ts.map +1 -1
- package/lib/components/QPhoneField/QPhoneField.d.ts +485 -622
- package/lib/components/QPhoneField/QPhoneField.d.ts.map +1 -1
- package/lib/components/QPhoneField/QPhoneField.vue.js +20 -13
- package/lib/components/QPhoneField/constants.d.ts +4 -0
- package/lib/components/QPhoneField/constants.d.ts.map +1 -1
- package/lib/components/QPhoneField/index.d.ts +257 -393
- package/lib/components/QPhoneField/index.d.ts.map +1 -1
- package/lib/components/QPhoneField/types.d.ts +5 -2
- package/lib/components/QPhoneField/types.d.ts.map +1 -1
- package/lib/components/QPopover/QPopover.d.ts +1 -1
- package/lib/components/QPopover/QPopover.d.ts.map +1 -1
- package/lib/components/QPopover/QPopover.vue.js +64 -42
- package/lib/components/QPopover/index.d.ts +3 -3
- package/lib/components/QPopover/types.d.ts +7 -2
- package/lib/components/QPopover/types.d.ts.map +1 -1
- package/lib/components/QProgress/QProgress.d.ts.map +1 -1
- package/lib/components/QProgress/QProgress.vue.js +47 -46
- package/lib/components/QPropertyList/QPropertyList.d.ts +1 -1
- package/lib/components/QPropertyList/QPropertyList.d.ts.map +1 -1
- package/lib/components/QPropertyList/QPropertyList.vue.js +3 -3
- package/lib/components/QPropertyList/QPropertyListGroup.d.ts +1 -1
- package/lib/components/QPropertyList/QPropertyListGroup.d.ts.map +1 -1
- package/lib/components/QPropertyList/QPropertyListRow.d.ts +1 -1
- package/lib/components/QPropertyList/QPropertyListRow.d.ts.map +1 -1
- package/lib/components/QPropertyList/QPropertyListRow.vue.js +59 -44
- package/lib/components/QPropertyList/index.d.ts +8 -8
- package/lib/components/QPropertyList/index.d.ts.map +1 -1
- package/lib/components/QPropertyList/types.d.ts +3 -3
- package/lib/components/QPropertyList/types.d.ts.map +1 -1
- package/lib/components/QRadioGroup/QRadioButton.d.ts.map +1 -1
- package/lib/components/QRadioGroup/QRadioButton.vue.js +5 -2
- package/lib/components/QRadioGroup/QRadioGroup.d.ts +1 -1
- package/lib/components/QRadioGroup/QRadioGroup.d.ts.map +1 -1
- package/lib/components/QRadioGroup/QRadioGroup.vue.js +19 -18
- package/lib/components/QRadioGroup/index.d.ts +1 -6
- package/lib/components/QRadioGroup/index.d.ts.map +1 -1
- package/lib/components/QRadioGroup/types.d.ts +0 -6
- package/lib/components/QRadioGroup/types.d.ts.map +1 -1
- package/lib/components/QSection/QSection.d.ts +3 -3
- package/lib/components/QSection/QSection.d.ts.map +1 -1
- package/lib/components/QSection/QSection.vue.js +52 -45
- package/lib/components/QSection/index.d.ts +4 -4
- package/lib/components/QSection/types.d.ts +10 -2
- package/lib/components/QSection/types.d.ts.map +1 -1
- package/lib/components/QSelect/QSelect.d.ts +306 -114
- package/lib/components/QSelect/QSelect.d.ts.map +1 -1
- package/lib/components/QSelect/QSelect.vue.js +274 -250
- package/lib/components/QSelect/constants.d.ts +4 -0
- package/lib/components/QSelect/constants.d.ts.map +1 -1
- package/lib/components/QSelect/index.d.ts +173 -144
- package/lib/components/QSelect/index.d.ts.map +1 -1
- package/lib/components/QSelect/types.d.ts +4 -2
- package/lib/components/QSelect/types.d.ts.map +1 -1
- package/lib/components/QSidebar/QSidebar.d.ts +9 -9
- package/lib/components/QSidebar/QSidebar.d.ts.map +1 -1
- package/lib/components/QSidebar/QSidebar.vue.js +2 -2
- package/lib/components/QSidebar/QSidebarAnchor.d.ts +1 -1
- package/lib/components/QSidebar/QSidebarAnchor.d.ts.map +1 -1
- package/lib/components/QSidebar/QSidebarAnchor.vue.js +4 -4
- package/lib/components/QSidebar/QSidebarItem.d.ts +7 -7
- package/lib/components/QSidebar/QSidebarItem.vue.js +3 -3
- package/lib/components/QSidebar/QSidebarPanel.d.ts +3 -3
- package/lib/components/QSidebar/QSidebarPanel.d.ts.map +1 -1
- package/lib/components/QSidebar/QSidebarPanel.vue.js +81 -140
- package/lib/components/QSidebar/constants.d.ts.map +1 -1
- package/lib/components/QSidebar/constants.js +4 -5
- package/lib/components/QSidebar/index.d.ts +24 -24
- package/lib/components/QSidebar/types.d.ts +7 -6
- package/lib/components/QSidebar/types.d.ts.map +1 -1
- package/lib/components/QSteps/QStepHeader.d.ts +2 -1
- package/lib/components/QSteps/QStepHeader.d.ts.map +1 -1
- package/lib/components/QSteps/QStepHeader.vue.js +3 -4
- package/lib/components/QSteps/QSteps.d.ts +8 -8
- package/lib/components/QSteps/QSteps.d.ts.map +1 -1
- package/lib/components/QSteps/QSteps.vue.js +9 -6
- package/lib/components/QSteps/QStepsNav.d.ts +2 -1
- package/lib/components/QSteps/QStepsNav.d.ts.map +1 -1
- package/lib/components/QSteps/index.d.ts +12 -12
- package/lib/components/QSteps/types.d.ts +2 -2
- package/lib/components/QSteps/types.d.ts.map +1 -1
- package/lib/components/QSwitch/QSwitch.d.ts +39 -26
- package/lib/components/QSwitch/QSwitch.d.ts.map +1 -1
- package/lib/components/QSwitch/QSwitch.vue.js +64 -58
- package/lib/components/QSwitch/constants.d.ts +20 -0
- package/lib/components/QSwitch/constants.d.ts.map +1 -0
- package/lib/components/QSwitch/constants.js +9 -0
- package/lib/components/QSwitch/index.d.ts +56 -18
- package/lib/components/QSwitch/index.d.ts.map +1 -1
- package/lib/components/QSwitch/types.d.ts +21 -3
- package/lib/components/QSwitch/types.d.ts.map +1 -1
- package/lib/components/QTabs/QTab.d.ts +12 -12
- package/lib/components/QTabs/QTab.vue.js +3 -3
- package/lib/components/QTabs/QTabs.d.ts +9 -9
- package/lib/components/QTabs/QTabs.d.ts.map +1 -1
- package/lib/components/QTabs/QTabs.vue.js +92 -80
- package/lib/components/QTabs/index.d.ts +16 -16
- package/lib/components/QTabs/types.d.ts +2 -2
- package/lib/components/QTabs/types.d.ts.map +1 -1
- package/lib/components/QTextArea/QTextArea.d.ts +1 -0
- package/lib/components/QTextArea/QTextArea.d.ts.map +1 -1
- package/lib/components/QTextArea/QTextArea.vue.js +6 -1
- package/lib/components/QTextArea/index.d.ts +1 -0
- package/lib/components/QTextArea/index.d.ts.map +1 -1
- package/lib/components/QTextField/QTextField.d.ts +30 -42
- package/lib/components/QTextField/QTextField.d.ts.map +1 -1
- package/lib/components/QTextField/QTextField.vue.js +7 -2
- package/lib/components/QTextField/constants.d.ts +4 -0
- package/lib/components/QTextField/constants.d.ts.map +1 -1
- package/lib/components/QTextField/index.d.ts +26 -69
- package/lib/components/QTextField/index.d.ts.map +1 -1
- package/lib/components/QTextField/types.d.ts +2 -1
- package/lib/components/QTextField/types.d.ts.map +1 -1
- package/lib/components/QToast/QToast.d.ts +1 -1
- package/lib/components/QToast/QToast.d.ts.map +1 -1
- package/lib/components/QToast/QToast.vue.js +148 -134
- package/lib/components/QToast/QToaster.d.ts +3 -1
- package/lib/components/QToast/QToaster.d.ts.map +1 -1
- package/lib/components/QToast/QToaster.vue.js +74 -46
- package/lib/components/QToast/index.d.ts +9 -7
- package/lib/components/QToast/index.d.ts.map +1 -1
- package/lib/components/QToast/types.d.ts +2 -2
- package/lib/components/QToast/types.d.ts.map +1 -1
- package/lib/components/QToggle/QToggle.d.ts.map +1 -1
- package/lib/components/QToggle/QToggle.vue.js +2 -0
- package/lib/components/QToggle/index.d.ts +3 -3
- package/lib/components/QToggleGroup/QToggleGroupItem.d.ts +8 -1
- package/lib/components/QToggleGroup/QToggleGroupItem.d.ts.map +1 -1
- package/lib/components/QToggleGroup/QToggleGroupItem.vue.js +67 -16
- package/lib/components/QToggleGroup/index.d.ts +24 -3
- package/lib/components/QToggleGroup/index.d.ts.map +1 -1
- package/lib/components/QTooltip/QTooltip.d.ts +1 -1
- package/lib/components/QTooltip/QTooltip.vue.js +1 -1
- package/lib/components/QTooltip/index.d.ts +3 -3
- package/lib/components/__internal__/QChevron/QChevron.d.ts +1 -1
- package/lib/components/__internal__/QChevron/QChevron.d.ts.map +1 -1
- package/lib/components/__internal__/QChevron/index.d.ts +3 -3
- package/lib/components/__internal__/QChevron/types.d.ts +2 -2
- package/lib/components/__internal__/QChevron/types.d.ts.map +1 -1
- package/lib/components/__internal__/QClearButton/QClearButton.d.ts +1 -1
- package/lib/components/__internal__/QClearButton/QClearButton.d.ts.map +1 -1
- package/lib/components/__internal__/QClearButton/index.d.ts +1 -1
- package/lib/components/__internal__/QClearButton/types.d.ts +2 -2
- package/lib/components/__internal__/QClearButton/types.d.ts.map +1 -1
- package/lib/components/__internal__/QHelpPopover/QHelpPopover.d.ts +7 -7
- package/lib/components/__internal__/QHelpPopover/QHelpPopover.d.ts.map +1 -1
- package/lib/components/__internal__/QHelpPopover/QHelpPopover.vue.js +3 -6
- package/lib/components/__internal__/QHelpPopover/index.d.ts +7 -7
- package/lib/components/__internal__/QHelpPopover/types.d.ts +2 -2
- package/lib/components/__internal__/QHelpPopover/types.d.ts.map +1 -1
- package/lib/components/__internal__/QListboxPanel/QListboxPanel.d.ts +34 -0
- package/lib/components/__internal__/QListboxPanel/QListboxPanel.d.ts.map +1 -0
- package/lib/components/__internal__/QListboxPanel/QListboxPanel.vue.js +76 -0
- package/lib/components/__internal__/QListboxPanel/QListboxPanel2.vue.js +5 -0
- package/lib/components/__internal__/QListboxPanel/constants.d.ts +17 -0
- package/lib/components/__internal__/QListboxPanel/constants.d.ts.map +1 -0
- package/lib/components/__internal__/QListboxPanel/constants.js +4 -0
- package/lib/components/__internal__/QListboxPanel/index.d.ts +52 -0
- package/lib/components/__internal__/QListboxPanel/index.d.ts.map +1 -0
- package/lib/components/__internal__/QListboxPanel/index.js +7 -0
- package/lib/components/__internal__/QListboxPanel/types.d.ts +50 -0
- package/lib/components/__internal__/QListboxPanel/types.d.ts.map +1 -0
- package/lib/components/__internal__/QListboxPanel/utils.d.ts +4 -0
- package/lib/components/__internal__/QListboxPanel/utils.d.ts.map +1 -0
- package/lib/components/__internal__/QListboxPanel/utils.js +6 -0
- package/lib/components/__internal__/QRequiredIndicator/QRequiredIndicator.vue.js +1 -1
- package/lib/components/__internal__/QResizeHandle/QResizeButtons.d.ts +16 -0
- package/lib/components/__internal__/QResizeHandle/QResizeButtons.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/QResizeButtons.vue.js +72 -0
- package/lib/components/__internal__/QResizeHandle/QResizeButtons2.vue.js +5 -0
- package/lib/components/__internal__/QResizeHandle/QResizeHandle.d.ts +15 -0
- package/lib/components/__internal__/QResizeHandle/QResizeHandle.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/QResizeHandle.vue.js +74 -0
- package/lib/components/__internal__/QResizeHandle/QResizeHandle2.vue.js +5 -0
- package/lib/components/__internal__/QResizeHandle/constants.d.ts +22 -0
- package/lib/components/__internal__/QResizeHandle/constants.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/constants.js +10 -0
- package/lib/components/__internal__/QResizeHandle/index.d.ts +28 -0
- package/lib/components/__internal__/QResizeHandle/index.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/index.js +7 -0
- package/lib/components/__internal__/QResizeHandle/types.d.ts +107 -0
- package/lib/components/__internal__/QResizeHandle/types.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/useEdgeResize.d.ts +42 -0
- package/lib/components/__internal__/QResizeHandle/useEdgeResize.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/useEdgeResize.js +36 -0
- package/lib/components/__internal__/QResizeHandle/useResizePane.d.ts +39 -0
- package/lib/components/__internal__/QResizeHandle/useResizePane.d.ts.map +1 -0
- package/lib/components/__internal__/QResizeHandle/useResizePane.js +22 -0
- package/lib/components/__internal__/QSafeTriangle/QSafeTriangle.d.ts +2 -2
- package/lib/components/__internal__/QSafeTriangle/QSafeTriangle.vue.js +1 -1
- package/lib/components/__internal__/QSafeTriangle/index.d.ts +2 -2
- package/lib/components/__internal__/QSeverityContent/QSeverityContent.d.ts +24 -0
- package/lib/components/__internal__/QSeverityContent/QSeverityContent.d.ts.map +1 -0
- package/lib/components/__internal__/QSeverityContent/QSeverityContent.vue.js +58 -0
- package/lib/components/__internal__/QSeverityContent/QSeverityContent2.vue.js +5 -0
- package/lib/components/__internal__/QSeverityContent/index.d.ts +31 -0
- package/lib/components/__internal__/QSeverityContent/index.d.ts.map +1 -0
- package/lib/components/__internal__/QSeverityContent/index.js +6 -0
- package/lib/components/__internal__/QSeverityContent/types.d.ts +67 -0
- package/lib/components/__internal__/QSeverityContent/types.d.ts.map +1 -0
- package/lib/components/index.d.ts +1 -0
- package/lib/components/index.d.ts.map +1 -1
- package/lib/components/index.js +72 -70
- package/lib/composables/useColor/index.d.ts +7 -3
- package/lib/composables/useColor/index.d.ts.map +1 -1
- package/lib/composables/useColor/index.js +40 -38
- package/lib/composables/useColor/types.d.ts +5 -4
- package/lib/composables/useColor/types.d.ts.map +1 -1
- package/lib/composables/useDialog/_internal.js +1 -1
- package/lib/composables/useDialog/types.d.ts +6 -2
- package/lib/composables/useDialog/types.d.ts.map +1 -1
- package/lib/composables/useScrollTabStop/index.d.ts +17 -0
- package/lib/composables/useScrollTabStop/index.d.ts.map +1 -0
- package/lib/composables/useScrollTabStop/index.js +45 -0
- package/lib/composables/useVirtualList/index.d.ts +73 -0
- package/lib/composables/useVirtualList/index.d.ts.map +1 -0
- package/lib/composables/useVirtualList/index.js +83 -0
- package/lib/index.d.ts +2 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/types/component.d.ts +12 -5
- package/lib/types/component.d.ts.map +1 -1
- package/lib/types/index.d.ts +1 -1
- package/lib/types/index.d.ts.map +1 -1
- package/lib/utils/boundedValue.d.ts +20 -0
- package/lib/utils/boundedValue.d.ts.map +1 -0
- package/lib/utils/boundedValue.js +9 -0
- package/lib/utils/color/blend.d.ts +13 -0
- package/lib/utils/color/blend.d.ts.map +1 -1
- package/lib/utils/color/blend.js +6 -3
- package/lib/utils/color/contrast.d.ts +19 -0
- package/lib/utils/color/contrast.d.ts.map +1 -1
- package/lib/utils/color/contrast.js +26 -11
- package/lib/utils/color/index.d.ts +1 -1
- package/lib/utils/color/index.d.ts.map +1 -1
- package/lib/utils/date.d.ts +18 -8
- package/lib/utils/date.d.ts.map +1 -1
- package/lib/utils/date.js +26 -14
- package/lib/utils/index.js +14 -13
- package/lib/utils/overlay.d.ts +6 -0
- package/lib/utils/overlay.d.ts.map +1 -1
- package/lib/utils/overlay.js +10 -10
- package/lib/utils/popupLabel.d.ts +15 -0
- package/lib/utils/popupLabel.d.ts.map +1 -0
- package/lib/utils/popupLabel.js +6 -0
- package/lib/utils/railWidth.d.ts +15 -0
- package/lib/utils/railWidth.d.ts.map +1 -0
- package/lib/utils/railWidth.js +4 -0
- package/lib/utils/safeTriangle.d.ts +4 -4
- package/lib/utils/safeTriangle.d.ts.map +1 -1
- package/lib/utils/slots.d.ts +11 -2
- package/lib/utils/slots.d.ts.map +1 -1
- package/lib/utils/slots.js +7 -4
- package/lib/utils/theme.d.ts +3 -3
- package/lib/utils/theme.d.ts.map +1 -1
- package/lib/utils/theme.js +31 -31
- package/package.json +1 -1
package/dist/json/api.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.
|
|
2
|
+
"version": "0.32.0",
|
|
3
3
|
"components": [
|
|
4
4
|
{
|
|
5
5
|
"name": "QAccordion",
|
|
@@ -76,8 +76,8 @@
|
|
|
76
76
|
{
|
|
77
77
|
"name": "icons",
|
|
78
78
|
"type": {
|
|
79
|
-
"kind": "
|
|
80
|
-
"
|
|
79
|
+
"kind": "unknown",
|
|
80
|
+
"raw": "QIcons<\"chevron\"> | undefined"
|
|
81
81
|
},
|
|
82
82
|
"description": "Icons for the sections. They reach every section through the defaults cascade,\nunless a section sets its own `icons`.\nPass every key, or omit the prop to keep the defaults.",
|
|
83
83
|
"default": "DEFAULT_ICONS",
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
},
|
|
179
179
|
{
|
|
180
180
|
"name": "QAlert",
|
|
181
|
-
"description": "Alerts show persistent feedback inside the page, such as a summary of form errors or a notice next to related content. They stay in the document flow until removed. For short-lived notifications that float over the page, use a toast instead. The colors `info`, `success`, `warning` and `danger` set a severity: a default icon, a prefix that screen readers announce before the message (for example \"Warning:\"), and the live region role. Warnings and errors use `role=\"alert\"`, which interrupts the user. Other alerts use `role=\"status\"`, which waits until the user is idle.",
|
|
181
|
+
"description": "Alerts show persistent feedback inside the page, such as a summary of form errors or a notice next to related content. They stay in the document flow until removed. For short-lived notifications that float over the page, use a toast instead. ## Accessibility - The colors `info`, `success`, `warning` and `danger` set a severity: a default icon, a prefix that screen readers announce before the message (for example \"Warning:\"), and the live region role. - Warnings and errors use `role=\"alert\"`, which interrupts the user. Other alerts use `role=\"status\"`, which waits until the user is idle.",
|
|
182
182
|
"meta": {
|
|
183
183
|
"props": [
|
|
184
184
|
{
|
|
@@ -248,6 +248,19 @@
|
|
|
248
248
|
"required": false,
|
|
249
249
|
"category": "Presentation"
|
|
250
250
|
},
|
|
251
|
+
{
|
|
252
|
+
"name": "actionsAlign",
|
|
253
|
+
"type": {
|
|
254
|
+
"kind": "enum",
|
|
255
|
+
"values": [
|
|
256
|
+
"start",
|
|
257
|
+
"end"
|
|
258
|
+
]
|
|
259
|
+
},
|
|
260
|
+
"description": "Which side the buttons in the `actions` slot pack to.\nLeave it unset to keep today's placement: a banner's message grows, so the\nactions sit at the end of that row, and under a title they sit at the start.\n`start` and `end` place them on that side in both layouts. `end` is the right\nin left-to-right text and the left in right-to-left. The dismiss button stays\nat the trailing edge.",
|
|
261
|
+
"required": false,
|
|
262
|
+
"category": "Presentation"
|
|
263
|
+
},
|
|
251
264
|
{
|
|
252
265
|
"name": "dismissible",
|
|
253
266
|
"type": {
|
|
@@ -275,8 +288,8 @@
|
|
|
275
288
|
{
|
|
276
289
|
"name": "icons",
|
|
277
290
|
"type": {
|
|
278
|
-
"kind": "
|
|
279
|
-
"
|
|
291
|
+
"kind": "unknown",
|
|
292
|
+
"raw": "QIcons<\"info\" | \"success\" | \"warning\" | \"danger\" | \"dismiss\"> | undefined"
|
|
280
293
|
},
|
|
281
294
|
"description": "Custom icon configurations: the severity icons and the dismiss icon.\nPass every key, or omit the prop to keep the defaults.",
|
|
282
295
|
"default": "DEFAULT_ICONS",
|
|
@@ -333,6 +346,11 @@
|
|
|
333
346
|
"description": "`tonal` (default), `bold` and `outlined`.",
|
|
334
347
|
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t<q-alert\n\t\t\t\t\tv-for=\"variant in variants\"\n\t\t\t\t\t:key=\"variant\"\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\t:variant=\"variant\" />\n\t\t\t</div>"
|
|
335
348
|
},
|
|
349
|
+
{
|
|
350
|
+
"title": "Outlined Warning Border",
|
|
351
|
+
"description": "Warning (and other light colors) darken the text for contrast on the page. The outlined border takes that same color, not the raw theme color.",
|
|
352
|
+
"code": "<QAlert color=\"warning\" variant=\"outlined\" />"
|
|
353
|
+
},
|
|
336
354
|
{
|
|
337
355
|
"title": "Custom Color",
|
|
338
356
|
"description": "Any CSS color works too. Colors other than the four severities have no default icon, no screen reader prefix, and use `role=\"status\"`. Pass an icon in the `icon` slot to show one. The slot also replaces the icon of a severity alert.",
|
|
@@ -345,8 +363,8 @@
|
|
|
345
363
|
},
|
|
346
364
|
{
|
|
347
365
|
"title": "Actions",
|
|
348
|
-
"description": "The `actions` slot holds buttons or links that act on the alert. In a banner they share the row with the message and wrap below it when space runs out.",
|
|
349
|
-
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t<q-alert v-bind=\"args\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Delete\" variant=\"bold\" color=\"danger\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert v-bind=\"args\" title=\"Delete record\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Delete\" variant=\"bold\" color=\"danger\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t</div>"
|
|
366
|
+
"description": "The `actions` slot holds buttons or links that act on the alert. In a banner they share the row with the message and wrap below it when space runs out. `actionsAlign=\"end\"` packs them to the end of the row. `actionsAlign=\"start\"` keeps a banner's actions next to the message. The buttons stay in the order they are written, and the dismiss button stays at the trailing edge.",
|
|
367
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t<q-alert v-bind=\"args\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Delete\" variant=\"bold\" color=\"danger\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert v-bind=\"args\" title=\"Delete record\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Delete\" variant=\"bold\" color=\"danger\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert v-bind=\"args\" text=\"Follow the message?\" actions-align=\"start\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Follow\" variant=\"bold\" color=\"warning\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert v-bind=\"args\" text=\"Keep this record?\" actions-align=\"end\" dismissible>\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Keep\" variant=\"bold\" color=\"warning\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\ttitle=\"Keep record\"\n\t\t\t\t\ttext=\"Keep this record?\"\n\t\t\t\t\tactions-align=\"end\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Keep\" variant=\"bold\" color=\"warning\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"outlined\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t</div>"
|
|
350
368
|
},
|
|
351
369
|
{
|
|
352
370
|
"title": "Actions On Bold",
|
|
@@ -454,7 +472,7 @@
|
|
|
454
472
|
{
|
|
455
473
|
"title": "With Image",
|
|
456
474
|
"description": "Displays an avatar with an image.",
|
|
457
|
-
"code": "<QAvatar src=\"
|
|
475
|
+
"code": "<QAvatar src=\"/avatar.svg\" alt=\"User Avatar\" />"
|
|
458
476
|
},
|
|
459
477
|
{
|
|
460
478
|
"title": "With Initials",
|
|
@@ -469,12 +487,12 @@
|
|
|
469
487
|
{
|
|
470
488
|
"title": "Custom Size",
|
|
471
489
|
"description": "Displays an avatar with a custom size.",
|
|
472
|
-
"code": "<QAvatar size=\"120px\" src=\"
|
|
490
|
+
"code": "<QAvatar size=\"120px\" src=\"/avatar.svg\" alt=\"User Avatar\" />"
|
|
473
491
|
},
|
|
474
492
|
{
|
|
475
493
|
"title": "Square Shape",
|
|
476
494
|
"description": "Displays an avatar with a square shape.",
|
|
477
|
-
"code": "<QAvatar shape=\"square\" initials=\"SQ\" src=\"
|
|
495
|
+
"code": "<QAvatar shape=\"square\" initials=\"SQ\" src=\"/avatar.svg\" alt=\"User Avatar\" />"
|
|
478
496
|
},
|
|
479
497
|
{
|
|
480
498
|
"title": "Custom Colors",
|
|
@@ -582,8 +600,8 @@
|
|
|
582
600
|
{
|
|
583
601
|
"name": "icons",
|
|
584
602
|
"type": {
|
|
585
|
-
"kind": "
|
|
586
|
-
"
|
|
603
|
+
"kind": "unknown",
|
|
604
|
+
"raw": "QIcons<\"remove\"> | undefined"
|
|
587
605
|
},
|
|
588
606
|
"description": "Custom icon configurations.",
|
|
589
607
|
"default": "DEFAULT_ICONS",
|
|
@@ -637,6 +655,11 @@
|
|
|
637
655
|
"description": "Displays an outlined badge with a transparent background.",
|
|
638
656
|
"code": "<q-badge variant=\"outlined\">\n\t\t\t\tBadge\n\t\t\t</q-badge>"
|
|
639
657
|
},
|
|
658
|
+
{
|
|
659
|
+
"title": "Outlined Warning Border",
|
|
660
|
+
"description": "Warning (and other light colors) darken the text for contrast on the page. The outlined border takes that same color, not the raw theme color.",
|
|
661
|
+
"code": "<q-badge\n\t\t\t\tvariant=\"outlined\"\n\t\t\t\tcolor=\"warning\">\n\t\t\t\tWarning\n\t\t\t</q-badge>"
|
|
662
|
+
},
|
|
640
663
|
{
|
|
641
664
|
"title": "Trailing Icon",
|
|
642
665
|
"description": "Displays an icon before the text.",
|
|
@@ -647,6 +670,11 @@
|
|
|
647
670
|
"description": "Displays an icon after the text.",
|
|
648
671
|
"code": "<q-badge v-bind=\"args\">\n\t\t\t\tLisbon\n\t\t\t\t<q-icon icon=\"map-marker\" />\n\t\t\t</q-badge>"
|
|
649
672
|
},
|
|
673
|
+
{
|
|
674
|
+
"title": "Icon Only",
|
|
675
|
+
"description": "A badge with only an icon, which centers in the badge: there is no text whose capitals it could center on. The remove button of a removable one centers on the icon.",
|
|
676
|
+
"code": "<div style=\"display: flex; gap: 0.25rem\">\n\t\t\t\t<q-badge v-bind=\"args\">\n\t\t\t\t\t<q-icon icon=\"check-circle\" />\n\t\t\t\t</q-badge>\n\t\t\t\t<q-badge v-bind=\"args\" removable>\n\t\t\t\t\t<q-icon icon=\"check-circle\" />\n\t\t\t\t</q-badge>\n\t\t\t</div>"
|
|
677
|
+
},
|
|
650
678
|
{
|
|
651
679
|
"title": "Colors",
|
|
652
680
|
"description": "Any color can be applied to the badge. Supports utility colors (for example `success` or `danger`) or css colors (`#033` or `rgba(255, 0, 0, 0.5)`)",
|
|
@@ -861,8 +889,8 @@
|
|
|
861
889
|
{
|
|
862
890
|
"name": "icons",
|
|
863
891
|
"type": {
|
|
864
|
-
"kind": "
|
|
865
|
-
"
|
|
892
|
+
"kind": "unknown",
|
|
893
|
+
"raw": "QIcons<\"check\" | \"description\" | \"expand\" | \"separator\" | \"collapsed\"> | undefined"
|
|
866
894
|
},
|
|
867
895
|
"description": "Custom icons for the default separator and the collapsed-items control.\nPass every key, or omit the prop to keep the defaults.",
|
|
868
896
|
"default": "DEFAULT_ICONS",
|
|
@@ -899,6 +927,11 @@
|
|
|
899
927
|
"description": "The full trail, with a leading icon on each crumb.",
|
|
900
928
|
"code": "<q-breadcrumbs v-bind=\"args\">\n\t\t\t\t<q-breadcrumb label=\"Home\" href=\"/\" :icon=\"{ icon: 'home' }\" />\n\t\t\t\t<q-breadcrumb label=\"Documents\" href=\"/documents\" :icon=\"{ icon: 'folder' }\" />\n\t\t\t\t<q-breadcrumb label=\"Quarterly Report\" :icon=\"{ icon: 'file-document' }\" />\n\t\t\t</q-breadcrumbs>"
|
|
901
929
|
},
|
|
930
|
+
{
|
|
931
|
+
"title": "Icon Size",
|
|
932
|
+
"description": "Icons of other sizes, set with the `size` of a crumb's `icon` and of `icons.separator`. They center on the capitals of the labels like icons of the default size.",
|
|
933
|
+
"code": "<q-breadcrumbs v-bind=\"args\">\n\t\t\t\t<q-breadcrumb label=\"Home\" href=\"/\" :icon=\"{ icon: 'home', size: 1.5 }\" />\n\t\t\t\t<q-breadcrumb label=\"Documents\" href=\"/documents\" :icon=\"{ icon: 'folder', size: 0.75 }\" />\n\t\t\t\t<q-breadcrumb label=\"Quarterly Report\" :icon=\"{ icon: 'file-document', size: 1.5 }\" />\n\t\t\t</q-breadcrumbs>"
|
|
934
|
+
},
|
|
902
935
|
{
|
|
903
936
|
"title": "Collapsed",
|
|
904
937
|
"description": "A long trail collapses its middle crumbs into an ellipsis control that opens a dropdown, keeping the first and current crumb visible. The control has an accessible name (`aria-label`) and the dropdown is keyboard operable: Tab skips the collapsed links and reaches the control, which opens a menu of them.",
|
|
@@ -969,8 +1002,8 @@
|
|
|
969
1002
|
{
|
|
970
1003
|
"name": "icons",
|
|
971
1004
|
"type": {
|
|
972
|
-
"kind": "
|
|
973
|
-
"
|
|
1005
|
+
"kind": "unknown",
|
|
1006
|
+
"raw": "QIcons<\"help\"> | undefined"
|
|
974
1007
|
},
|
|
975
1008
|
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
976
1009
|
"default": "DEFAULT_ICONS",
|
|
@@ -1205,10 +1238,15 @@
|
|
|
1205
1238
|
"description": "Use the primary button once per page to represent the preferred user action.",
|
|
1206
1239
|
"code": "<div style=\"display: flex; flex-direction: column; align-items: start; gap: .5rem\">\n\t\t\t\t<div\n\t\t\t\t\tv-for=\"variant in variants\"\n\t\t\t\t\t:key=\"variant\"\n\t\t\t\t\tstyle=\"display: flex; align-items: start; gap: .5rem\">\n\t\t\t\t\t<q-button\n\t\t\t\t\t\tv-for=\"color in colors\"\n\t\t\t\t\t\t:key=\"color\"\n\t\t\t\t\t\t:variant\n\t\t\t\t\t\t:color\n\t\t\t\t\t\t:label=\"color\"\n\t\t\t\t\t\tv-bind=args />\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
1207
1240
|
},
|
|
1241
|
+
{
|
|
1242
|
+
"title": "Outlined Warning Border",
|
|
1243
|
+
"description": "Warning (and other light utilities) darken the label for contrast on white. The outlined border uses that same adjusted color, not the raw theme token.",
|
|
1244
|
+
"code": "<QButton label=\"Warning\" color=\"warning\" variant=\"outlined\" />"
|
|
1245
|
+
},
|
|
1208
1246
|
{
|
|
1209
1247
|
"title": "Surface",
|
|
1210
|
-
"description": "On a colored banner, set `surface` to the banner's color. The label and the hover are then measured against the banner instead of the page, so they stay readable.",
|
|
1211
|
-
"code": "<div style=\"display: flex; gap: .5rem; padding: 1rem; border-radius: var(--q-border-radius); background-color: var(--q-theme-primary)\">\n\t\t\t\t<q-button\n\t\t\t\t\tv-for=\"variant in variants\"\n\t\t\t\t\t:key=\"variant\"\n\t\t\t\t\t:variant\n\t\t\t\t\
|
|
1248
|
+
"description": "On a colored banner, set `surface` to the banner's color. The label and the hover are then measured against the banner instead of the page, so they stay readable, in a theme color too: the danger row reads on the banner itself and on its tint.",
|
|
1249
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: .5rem; padding: 1rem; border-radius: var(--q-border-radius); background-color: var(--q-theme-primary)\">\n\t\t\t\t<div\n\t\t\t\t\tv-for=\"color in colors\"\n\t\t\t\t\t:key=\"color\"\n\t\t\t\t\tstyle=\"display: flex; flex-wrap: wrap; gap: .5rem\">\n\t\t\t\t\t<q-button\n\t\t\t\t\t\tv-for=\"variant in variants\"\n\t\t\t\t\t\t:key=\"variant\"\n\t\t\t\t\t\t:variant\n\t\t\t\t\t\t:color\n\t\t\t\t\t\tsurface=\"primary\"\n\t\t\t\t\t\t:label=\"variant\" />\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
1212
1250
|
},
|
|
1213
1251
|
{
|
|
1214
1252
|
"title": "Disabled",
|
|
@@ -1235,10 +1273,15 @@
|
|
|
1235
1273
|
"description": "Plays a ripple effect from the pointer position on click. Opt in with `effect=\"ripple\"` — the default is `'none'`.",
|
|
1236
1274
|
"code": "<div style=\"display: flex; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-button label=\"Ripple\" effect=\"ripple\" />\n\t\t\t\t<q-button label=\"None\" />\n\t\t\t</div>"
|
|
1237
1275
|
},
|
|
1276
|
+
{
|
|
1277
|
+
"title": "Minimum Width",
|
|
1278
|
+
"description": "A button is never narrower than its minimum height: icon-only buttons, a one-character label, and a width set from outside, as a component that places a button might set it.",
|
|
1279
|
+
"code": "<div style=\"display: flex; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-button size=\"small\" aria-label=\"Done\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t\t<q-button aria-label=\"Done\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t\t<q-button size=\"large\" aria-label=\"Done\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t\t<q-button variant=\"text\" label=\"1\" />\n\t\t\t\t<q-button aria-label=\"Done\" style=\"width: 1.5rem\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t</div>"
|
|
1280
|
+
},
|
|
1238
1281
|
{
|
|
1239
1282
|
"title": "Size",
|
|
1240
|
-
"description": "Local size overrides. Useful for slotting buttons within other components. Combines with the global density toolbar (product = global × size).",
|
|
1241
|
-
"code": "<div style=\"display: flex; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-button size=\"small\" label=\"Small\"
|
|
1283
|
+
"description": "Local size overrides. Useful for slotting buttons within other components. Combines with the global density toolbar (product = global × size). The icon scales with the label, and centers on its capitals in every size.",
|
|
1284
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-button size=\"small\" label=\"Small\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t\t<q-button size=\"medium\" label=\"Medium\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t\t<q-button size=\"large\" label=\"Large\"><q-icon icon=\"check-circle\" /></q-button>\n\t\t\t</div>"
|
|
1242
1285
|
}
|
|
1243
1286
|
]
|
|
1244
1287
|
},
|
|
@@ -1345,6 +1388,11 @@
|
|
|
1345
1388
|
"title": "Elevated",
|
|
1346
1389
|
"description": "Features a subtle shadow for an elevated visual effect.",
|
|
1347
1390
|
"code": "<QButtonGroup :elevated=\"true\" />"
|
|
1391
|
+
},
|
|
1392
|
+
{
|
|
1393
|
+
"title": "Wrapping",
|
|
1394
|
+
"description": "Wraps onto more rows when its container is too narrow for one. Each row starts at the group's left edge, and the rows overlap their borders as the buttons of a row do.",
|
|
1395
|
+
"code": "<div style=\"width: 12rem\">\n\t\t\t\t<q-button-group v-bind=\"args\">\n\t\t\t\t\t<q-button label=\"Copy\" />\n\t\t\t\t\t<q-button label=\"Cut\" />\n\t\t\t\t\t<q-button label=\"Paste\" />\n\t\t\t\t\t<q-button label=\"Delete\" />\n\t\t\t\t\t<q-button label=\"Select all\" />\n\t\t\t\t</q-button-group>\n\t\t\t</div>"
|
|
1348
1396
|
}
|
|
1349
1397
|
]
|
|
1350
1398
|
},
|
|
@@ -1561,13 +1609,13 @@
|
|
|
1561
1609
|
{
|
|
1562
1610
|
"title": "Custom Header",
|
|
1563
1611
|
"description": "Adds custom components to the card header.",
|
|
1564
|
-
"code": "<q-card v-bind=\"args\">\n\t\t\t\t<template #header.prepend>\n\t\t\t\t\t<img src=\"
|
|
1612
|
+
"code": "<q-card v-bind=\"args\">\n\t\t\t\t<template #header.prepend>\n\t\t\t\t\t<img src=\"/carousel/slide-4.jpg\"\n\t\t\t\t\t\theight=\"200\"\n\t\t\t\t\t\talt=\"Clickable Image\">\n\t\t\t\t</template>\n\t\t\t\tSome quick example text to build on the card title.\n\t\t\t</q-card>"
|
|
1565
1613
|
}
|
|
1566
1614
|
]
|
|
1567
1615
|
},
|
|
1568
1616
|
{
|
|
1569
1617
|
"name": "QCarousel",
|
|
1570
|
-
"description": "The `QCarousel` component displays a set of slides with optional controls, indicators, autoplay, touch navigation, and progress bar. Screen readers call it a carousel: name it with `aria-label` or `aria-labelledby`. The slide shown is its Tab stop, where the arrows, Home and End change the slide. While it cycles on its own, a button pauses it, and it waits while focus or the pointer is on it.",
|
|
1618
|
+
"description": "The `QCarousel` component displays a set of slides with optional controls, indicators, autoplay, touch navigation, and progress bar. ## Accessibility - Screen readers call it a carousel: name it with `aria-label` or `aria-labelledby`. - The slide shown is its Tab stop, where the arrows, Home and End change the slide. - While it cycles on its own, a button pauses it, and it waits while focus or the pointer is on it.",
|
|
1571
1619
|
"meta": {
|
|
1572
1620
|
"props": [
|
|
1573
1621
|
{
|
|
@@ -1710,8 +1758,8 @@
|
|
|
1710
1758
|
{
|
|
1711
1759
|
"name": "icons",
|
|
1712
1760
|
"type": {
|
|
1713
|
-
"kind": "
|
|
1714
|
-
"
|
|
1761
|
+
"kind": "unknown",
|
|
1762
|
+
"raw": "QIcons<\"back\" | \"forward\" | \"pause\" | \"play\"> | undefined"
|
|
1715
1763
|
},
|
|
1716
1764
|
"description": "Custom icon configurations.\nPass every key, or omit the prop to keep the defaults.",
|
|
1717
1765
|
"default": "DEFAULT_ICONS",
|
|
@@ -1902,7 +1950,7 @@
|
|
|
1902
1950
|
"kind": "object",
|
|
1903
1951
|
"fields": {}
|
|
1904
1952
|
},
|
|
1905
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
1953
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
1906
1954
|
"default": "DEFAULT_ICONS",
|
|
1907
1955
|
"required": false,
|
|
1908
1956
|
"category": "Configuration"
|
|
@@ -1913,7 +1961,8 @@
|
|
|
1913
1961
|
"kind": "object",
|
|
1914
1962
|
"fields": {}
|
|
1915
1963
|
},
|
|
1916
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
1964
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
1965
|
+
"default": "DEFAULT_TEXTS",
|
|
1917
1966
|
"required": false,
|
|
1918
1967
|
"category": "Configuration"
|
|
1919
1968
|
},
|
|
@@ -1996,17 +2045,6 @@
|
|
|
1996
2045
|
"required": false,
|
|
1997
2046
|
"category": "State"
|
|
1998
2047
|
},
|
|
1999
|
-
{
|
|
2000
|
-
"name": "hasFocusOutline",
|
|
2001
|
-
"type": {
|
|
2002
|
-
"kind": "primitive",
|
|
2003
|
-
"name": "boolean"
|
|
2004
|
-
},
|
|
2005
|
-
"description": "Indicates whether the control will have an outline when focused.",
|
|
2006
|
-
"default": "true",
|
|
2007
|
-
"required": false,
|
|
2008
|
-
"category": "Behavior"
|
|
2009
|
-
},
|
|
2010
2048
|
{
|
|
2011
2049
|
"name": "borderless",
|
|
2012
2050
|
"type": {
|
|
@@ -2047,6 +2085,10 @@
|
|
|
2047
2085
|
"name": "errors",
|
|
2048
2086
|
"description": ""
|
|
2049
2087
|
},
|
|
2088
|
+
{
|
|
2089
|
+
"name": "warnings",
|
|
2090
|
+
"description": ""
|
|
2091
|
+
},
|
|
2050
2092
|
{
|
|
2051
2093
|
"name": "extras",
|
|
2052
2094
|
"description": ""
|
|
@@ -2071,8 +2113,8 @@
|
|
|
2071
2113
|
},
|
|
2072
2114
|
{
|
|
2073
2115
|
"title": "Readonly",
|
|
2074
|
-
"description": "A read-only checkbox that conveys a non-interactive appearance. This can be used to display a static checked/unchecked state for reference.",
|
|
2075
|
-
"code": "<
|
|
2116
|
+
"description": "A read-only checkbox that conveys a non-interactive appearance. This can be used to display a static checked/unchecked state for reference. Shown in the light and the dark theme, where the checked box and its check stand out in each.",
|
|
2117
|
+
"code": "<QCheckbox label=\"Readonly\" :readonly=\"true\" />"
|
|
2076
2118
|
},
|
|
2077
2119
|
{
|
|
2078
2120
|
"title": "Invalid",
|
|
@@ -2097,7 +2139,7 @@
|
|
|
2097
2139
|
{
|
|
2098
2140
|
"title": "Icons",
|
|
2099
2141
|
"description": "A checkbox with custom icons for the checked and indeterminate states. This allows for a more personalized or context-specific design.",
|
|
2100
|
-
"code": "<QCheckbox :model-value=\"true\" label=\"Diferent icon\" :icons=\"{\n\t\t\thelp: { icon: 'help' },\n\t\t\terror: { icon: 'alert-circle' },\n\t\t\tchecked: { icon: 'skip-next' },\n\t\t\tindeterminate: { icon: 'skip-next' }\n\t\t}\" />"
|
|
2142
|
+
"code": "<QCheckbox :model-value=\"true\" label=\"Diferent icon\" :icons=\"{\n\t\t\thelp: { icon: 'help' },\n\t\t\terror: { icon: 'alert-circle' },\n\t\t\twarning: { icon: 'alert' },\n\t\t\tchecked: { icon: 'skip-next' },\n\t\t\tindeterminate: { icon: 'skip-next' }\n\t\t}\" />"
|
|
2101
2143
|
},
|
|
2102
2144
|
{
|
|
2103
2145
|
"title": "Indeterminate",
|
|
@@ -2114,6 +2156,11 @@
|
|
|
2114
2156
|
"description": "The `errors` slot says what is wrong while `invalid` is true: here until the box is checked. The message goes under the label, above the help and the extras, and takes no room while there is none.",
|
|
2115
2157
|
"code": "<q-checkbox\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model=\"accepted\"\n\t\t\t\t:invalid=\"!accepted\">\n\t\t\t\t<template #errors>Accept the terms to continue</template>\n\t\t\t\t<template #extras>\n\t\t\t\t\t<a href=\"#terms\">Read the terms and conditions</a>\n\t\t\t\t</template>\n\t\t\t</q-checkbox>"
|
|
2116
2158
|
},
|
|
2159
|
+
{
|
|
2160
|
+
"title": "Warning Message",
|
|
2161
|
+
"description": "The `warnings` slot points out something to check without making the value invalid. It goes under the error, above the help and the extras, and moves up to the error's place while there is no error. The box takes a warning border, and an invalid box the error's.",
|
|
2162
|
+
"code": "<q-checkbox\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model=\"accepted\"\n\t\t\t\t:invalid=\"!accepted\">\n\t\t\t\t<template #errors>Accept the terms to continue</template>\n\t\t\t\t<template #warnings>The terms changed on 1 November</template>\n\t\t\t\t<template #extras>\n\t\t\t\t\t<a href=\"#terms\">Read the terms and conditions</a>\n\t\t\t\t</template>\n\t\t\t</q-checkbox>"
|
|
2163
|
+
},
|
|
2117
2164
|
{
|
|
2118
2165
|
"title": "Borderless",
|
|
2119
2166
|
"description": "Displays borderless checkbox.",
|
|
@@ -2231,8 +2278,8 @@
|
|
|
2231
2278
|
{
|
|
2232
2279
|
"name": "icons",
|
|
2233
2280
|
"type": {
|
|
2234
|
-
"kind": "
|
|
2235
|
-
"
|
|
2281
|
+
"kind": "unknown",
|
|
2282
|
+
"raw": "QIcons<\"chevron\"> | undefined"
|
|
2236
2283
|
},
|
|
2237
2284
|
"description": "Custom icon configurations.",
|
|
2238
2285
|
"default": "DEFAULT_ICONS",
|
|
@@ -2335,6 +2382,11 @@
|
|
|
2335
2382
|
"title": "Custom Icon",
|
|
2336
2383
|
"description": "The collapsible with a custom chevron icon.",
|
|
2337
2384
|
"code": "<q-collapsible v-model=\"model\" v-bind=\"args\">\n\t\t\t\t<template #icon>\n\t\t\t\t\t<q-icon v-if=\"model\" icon=\"minus\" />\n\t\t\t\t\t<q-icon v-else icon=\"plus\" />\n\t\t\t\t</template>\n\t\t\t\t<q-text-field label=\"Text input\"/>\n\t\t\t</q-collapsible>"
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"title": "Long Title",
|
|
2388
|
+
"description": "A long title and subtitle wrap inside a narrow header, as at 320px, instead of being cut off.",
|
|
2389
|
+
"code": "<div style=\"width: 288px\">\n\t\t\t\t<q-collapsible v-bind=\"args\">\n\t\t\t\t\t<q-text-field label=\"Country\" />\n\t\t\t\t</q-collapsible>\n\t\t\t</div>"
|
|
2338
2390
|
}
|
|
2339
2391
|
]
|
|
2340
2392
|
},
|
|
@@ -2383,7 +2435,7 @@
|
|
|
2383
2435
|
"kind": "object",
|
|
2384
2436
|
"fields": {}
|
|
2385
2437
|
},
|
|
2386
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
2438
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the help and clear button icons.\nPass every key, or omit the prop to keep the defaults.",
|
|
2387
2439
|
"default": "DEFAULT_ICONS",
|
|
2388
2440
|
"required": false,
|
|
2389
2441
|
"category": "Configuration"
|
|
@@ -2394,7 +2446,7 @@
|
|
|
2394
2446
|
"kind": "object",
|
|
2395
2447
|
"fields": {}
|
|
2396
2448
|
},
|
|
2397
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
2449
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations.\nPass every key, or omit the prop to keep the defaults.",
|
|
2398
2450
|
"default": "DEFAULT_TEXTS",
|
|
2399
2451
|
"required": false,
|
|
2400
2452
|
"category": "Configuration"
|
|
@@ -2516,6 +2568,10 @@
|
|
|
2516
2568
|
"name": "errors",
|
|
2517
2569
|
"description": ""
|
|
2518
2570
|
},
|
|
2571
|
+
{
|
|
2572
|
+
"name": "warnings",
|
|
2573
|
+
"description": ""
|
|
2574
|
+
},
|
|
2519
2575
|
{
|
|
2520
2576
|
"name": "extras",
|
|
2521
2577
|
"description": ""
|
|
@@ -2586,7 +2642,7 @@
|
|
|
2586
2642
|
"kind": "object",
|
|
2587
2643
|
"fields": {}
|
|
2588
2644
|
},
|
|
2589
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
2645
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the help and clear button icons.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the icons of the text field, the clear button, and the list.\nPass every key, or omit the prop to keep the defaults.",
|
|
2590
2646
|
"default": "DEFAULT_ICONS",
|
|
2591
2647
|
"required": false,
|
|
2592
2648
|
"category": "Configuration"
|
|
@@ -2597,7 +2653,7 @@
|
|
|
2597
2653
|
"kind": "object",
|
|
2598
2654
|
"fields": {}
|
|
2599
2655
|
},
|
|
2600
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
2656
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the help and clear button labels.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the strings of the text field and the clear button.\nPass every key, or omit the prop to keep the defaults.",
|
|
2601
2657
|
"default": "DEFAULT_TEXTS",
|
|
2602
2658
|
"required": false,
|
|
2603
2659
|
"category": "Configuration"
|
|
@@ -2844,7 +2900,6 @@
|
|
|
2844
2900
|
"values": [
|
|
2845
2901
|
"wrap",
|
|
2846
2902
|
"fit-content",
|
|
2847
|
-
"truncate",
|
|
2848
2903
|
"wrap-on-focus",
|
|
2849
2904
|
"scroll-on-focus"
|
|
2850
2905
|
]
|
|
@@ -2961,6 +3016,10 @@
|
|
|
2961
3016
|
"name": "errors",
|
|
2962
3017
|
"description": ""
|
|
2963
3018
|
},
|
|
3019
|
+
{
|
|
3020
|
+
"name": "warnings",
|
|
3021
|
+
"description": ""
|
|
3022
|
+
},
|
|
2964
3023
|
{
|
|
2965
3024
|
"name": "extras",
|
|
2966
3025
|
"description": ""
|
|
@@ -3007,18 +3066,33 @@
|
|
|
3007
3066
|
},
|
|
3008
3067
|
{
|
|
3009
3068
|
"title": "Loading",
|
|
3010
|
-
"description": "
|
|
3069
|
+
"description": "Before the first options load, the open list shows a \"Loading\" row the size of the \"No data\" one, and a bar over its top edge once the load runs past a short delay. A status region announces it, since focus stays in the input.",
|
|
3011
3070
|
"code": "<QCombobox :items=\"[]\" :loading=\"true\" />"
|
|
3012
3071
|
},
|
|
3072
|
+
{
|
|
3073
|
+
"title": "Async Search",
|
|
3074
|
+
"description": "Options that load as the user types, as a lookup that searches on the server does. The options stay while each search runs, the list says it is busy, and a bar over its top edge shows once a search runs past a short delay, so typing does not make the list vanish and come back.",
|
|
3075
|
+
"code": "<q-combobox\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model:search=\"search\"\n\t\t\t\t:items=\"items\"\n\t\t\t\t:loading=\"loading\" />"
|
|
3076
|
+
},
|
|
3013
3077
|
{
|
|
3014
3078
|
"title": "No Match",
|
|
3015
3079
|
"description": "When nothing matches what was typed, the open list says so, and a status region announces it, since focus stays in the input.",
|
|
3016
3080
|
"code": "<QCombobox />"
|
|
3017
3081
|
},
|
|
3082
|
+
{
|
|
3083
|
+
"title": "Typed Text Not An Option",
|
|
3084
|
+
"description": "Typed text that matches no option stays in the field for the user to fix when focus leaves. The field turns invalid and says to choose an option (`texts.invalidValue`), and the model keeps its last value. Text that is the label of an option, in any case, picks it. Escape puts the label of the selected option back, which clears the error.",
|
|
3085
|
+
"code": "<QCombobox model-value=\"queen\" />"
|
|
3086
|
+
},
|
|
3018
3087
|
{
|
|
3019
3088
|
"title": "Overflow",
|
|
3020
|
-
"description": "Controls how long option labels overflow relative to the field width. Defaults to `wrap`. - `wrap`: the menu matches the field and labels wrap onto more lines. - `
|
|
3021
|
-
"code": "<div style=\"display: flex; flex-wrap: wrap; align-items: flex-start; gap: 1rem\">\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Wrap\" overflow=\"wrap\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"
|
|
3089
|
+
"description": "Controls how long option labels overflow relative to the field width. Defaults to `wrap`. - `wrap`: the menu matches the field and labels wrap onto more lines. - `fit-content`: the menu grows with the longest option, up to the width of the screen, where the labels wrap. - `wrap-on-focus`: the menu matches the field and labels end in an ellipsis until the option is highlighted, then that label wraps. Focus stays in the field. A cut-off label also shows its full text in a native `title` on hover. - `scroll-on-focus`: like `wrap-on-focus` until the option is highlighted, then that label scrolls to its end and back. With reduced motion, the highlighted label wraps instead.",
|
|
3090
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; align-items: flex-start; gap: 1rem\">\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Wrap\" overflow=\"wrap\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"fit-content\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Fit content\" overflow=\"fit-content\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap-on-focus\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Wrap on focus\" overflow=\"wrap-on-focus\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"scroll-on-focus\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Scroll on focus\" overflow=\"scroll-on-focus\" />\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
3091
|
+
},
|
|
3092
|
+
{
|
|
3093
|
+
"title": "Fit Content Long Options",
|
|
3094
|
+
"description": "With `fit-content`, the list grows with its longest option up to the width of the screen, where the labels wrap: on a narrow screen, it never runs past the edge or scrolls sideways.",
|
|
3095
|
+
"code": "<QCombobox overflow=\"fit-content\" :items=\"[\n\t\t\t{ key: 'short', label: 'Short' },\n\t\t\t{\n\t\t\t\tkey: 'spaced',\n\t\t\t\tlabel: 'An option whose label has more words than a phone screen fits on one line'\n\t\t\t},\n\t\t\t{ key: 'unspaced', label: 'an_option_label_without_spaces_wider_than_a_phone_screen' }\n\t\t]\" />"
|
|
3022
3096
|
},
|
|
3023
3097
|
{
|
|
3024
3098
|
"title": "Description In Items",
|
|
@@ -3034,12 +3108,17 @@
|
|
|
3034
3108
|
"title": "Typing",
|
|
3035
3109
|
"description": "Typing filters the list and highlights the first match, which Enter picks. Any character opens the list, Home and End move the caret while it is closed, and a press outside closes it, so it opens again with nothing highlighted.",
|
|
3036
3110
|
"code": "<QCombobox />"
|
|
3111
|
+
},
|
|
3112
|
+
{
|
|
3113
|
+
"title": "Many Options",
|
|
3114
|
+
"description": "With many options, the list renders only those in view and a few around them, so it opens as fast as a short one. The keyboard reaches any option: End highlights the last one, which renders so `aria-activedescendant` has an element to point at, and typing filters all of them. Opened again, the list scrolls to the selected option, wherever it is.",
|
|
3115
|
+
"code": "<QCombobox label=\"Option\" :items=\"Array.from({ length: MANY_OPTIONS }, (_, index) => ({\n\t\t\tkey: `option${index + 1}`,\n\t\t\tlabel: `Option ${index + 1}`\n\t\t}))\" />"
|
|
3037
3116
|
}
|
|
3038
3117
|
]
|
|
3039
3118
|
},
|
|
3040
3119
|
{
|
|
3041
3120
|
"name": "QDateTimePicker",
|
|
3042
|
-
"description": "A component that enables users to select dates and times in various formats.",
|
|
3121
|
+
"description": "A component that enables users to select dates and times in various formats. ## Accessibility - The field is a `combobox` that opens a `dialog`, which takes the field's name: its `label`, `aria-label` or `aria-labelledby`. Name the field, so the dialog has a name too. - The calendar is a `grid` with one Tab stop (selected day, else today). Arrows, Home/End, and PageUp/PageDown move within it; Enter commits, Escape closes. In range mode the grid is `aria-multiselectable`, and only the days chosen are `aria-selected`: the days a range previews while its end is picked are not. - Month and year pickers are separate views with their own controls. The month or year on display is `aria-current`.",
|
|
3043
3122
|
"meta": {
|
|
3044
3123
|
"props": [
|
|
3045
3124
|
{
|
|
@@ -3128,7 +3207,7 @@
|
|
|
3128
3207
|
"kind": "object",
|
|
3129
3208
|
"fields": {}
|
|
3130
3209
|
},
|
|
3131
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
3210
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the icons of the text fields and the clear button.\nPass every key, or omit the prop to keep the defaults.",
|
|
3132
3211
|
"default": "DEFAULT_ICONS",
|
|
3133
3212
|
"required": false,
|
|
3134
3213
|
"category": "Configuration"
|
|
@@ -3139,7 +3218,7 @@
|
|
|
3139
3218
|
"kind": "object",
|
|
3140
3219
|
"fields": {}
|
|
3141
3220
|
},
|
|
3142
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
3221
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the strings of the text fields and the clear button.\nPass every key, or omit the prop to keep the defaults.",
|
|
3143
3222
|
"default": "DEFAULT_TEXTS",
|
|
3144
3223
|
"required": false,
|
|
3145
3224
|
"category": "Configuration"
|
|
@@ -3291,6 +3370,10 @@
|
|
|
3291
3370
|
"name": "errors",
|
|
3292
3371
|
"description": ""
|
|
3293
3372
|
},
|
|
3373
|
+
{
|
|
3374
|
+
"name": "warnings",
|
|
3375
|
+
"description": ""
|
|
3376
|
+
},
|
|
3294
3377
|
{
|
|
3295
3378
|
"name": "extras",
|
|
3296
3379
|
"description": ""
|
|
@@ -3305,9 +3388,19 @@
|
|
|
3305
3388
|
},
|
|
3306
3389
|
{
|
|
3307
3390
|
"title": "Date Time With Seconds",
|
|
3308
|
-
"description": "DateTime picker with seconds display",
|
|
3391
|
+
"description": "DateTime picker with seconds display. Picking a day of the next month shows that month, with focus on the day picked.",
|
|
3309
3392
|
"code": "<QDateTimePicker format=\"dd/MM/yyyy HH:mm:ss\" label=\"Select Date and Time\" placeholder=\"Choose date and time\" />"
|
|
3310
3393
|
},
|
|
3394
|
+
{
|
|
3395
|
+
"title": "Six Week Calendar",
|
|
3396
|
+
"description": "Every month is six weeks, so a short month is as tall as a long one. Days of the month on display are heavier than the days of the months beside it, and those days stay readable.",
|
|
3397
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: 1rem;\">\n\t\t\t\t<q-date-time-picker v-bind=\"args\" label=\"February 2021\" :model-value=\"february\" />\n\t\t\t\t<q-date-time-picker v-bind=\"args\" label=\"March 2026\" :model-value=\"march\" />\n\t\t\t</div>"
|
|
3398
|
+
},
|
|
3399
|
+
{
|
|
3400
|
+
"title": "Narrow Menu",
|
|
3401
|
+
"description": "On a narrow screen, the menu is no wider than the screen allows, and its days shrink with it: each week stays on one row, under its weekdays, and the days stay square. Checked in loose density, where the menu is widest and a day is a 44px control on a wider screen.",
|
|
3402
|
+
"code": "<QDateTimePicker format=\"dd/MM/yyyy\" />"
|
|
3403
|
+
},
|
|
3311
3404
|
{
|
|
3312
3405
|
"title": "Date Time 12 Hour Format",
|
|
3313
3406
|
"description": "DateTime picker with 12-hour format (AM/PM)",
|
|
@@ -3318,6 +3411,11 @@
|
|
|
3318
3411
|
"description": "Time-only picker. Without a calendar, the menu is only as wide as the time inputs.",
|
|
3319
3412
|
"code": "<QDateTimePicker format=\"HH:mm\" label=\"Select Time\" placeholder=\"HH:mm\" model-value=\"14:00\" />"
|
|
3320
3413
|
},
|
|
3414
|
+
{
|
|
3415
|
+
"title": "Typing A Time",
|
|
3416
|
+
"description": "Typing a time in its fields. A first digit stays as typed, so a second one follows it, even after the window loses focus and gets it back, and the number is padded when focus leaves its field. A digit typed at the end of a full field starts a new number.",
|
|
3417
|
+
"code": "<QDateTimePicker format=\"HH:mm\" label=\"Select Time\" />"
|
|
3418
|
+
},
|
|
3321
3419
|
{
|
|
3322
3420
|
"title": "Time Only 12 Hour Format",
|
|
3323
3421
|
"description": "Time-only picker with 12-hour format (AM/PM)",
|
|
@@ -3343,9 +3441,14 @@
|
|
|
3343
3441
|
"description": "Range DateTime picker",
|
|
3344
3442
|
"code": "<QDateTimePicker label=\"Select a date range\" :range=\"true\" />"
|
|
3345
3443
|
},
|
|
3444
|
+
{
|
|
3445
|
+
"title": "Range Around Today",
|
|
3446
|
+
"description": "A range around today. The band's edges above and below are a shadow, so today keeps its own border, in the main color on every side, inside the range.",
|
|
3447
|
+
"code": "<QDateTimePicker label=\"Select a date range\" :range=\"true\" format=\"dd/MM/yyyy\" :model-value=\"[\n\t\t\tnew Date(now.getFullYear(), now.getMonth(), now.getDate() - 3),\n\t\t\tnew Date(now.getFullYear(), now.getMonth(), now.getDate() + 3)\n\t\t]\" />"
|
|
3448
|
+
},
|
|
3346
3449
|
{
|
|
3347
3450
|
"title": "Typed Text Not A Date",
|
|
3348
|
-
"description": "Text that is not a date stays in the field for the user to fix. The field turns invalid and says how to type one, with today as the example (`texts.invalidValue`), and the model keeps its last value. A date clears the error.",
|
|
3451
|
+
"description": "Text that is not a date stays in the field for the user to fix. The field turns invalid and says how to type one, with today as the example (`texts.invalidValue`), and the model keeps its last value. So does a date that does not exist, such as 31 February: it is not changed to one that does. A date clears the error.",
|
|
3349
3452
|
"code": "<q-date-time-picker v-bind=\"args\" v-model=\"args.modelValue\" />\n\t\t\t<q-button label=\"After\" style=\"margin-top: 1rem\" />"
|
|
3350
3453
|
},
|
|
3351
3454
|
{
|
|
@@ -3407,7 +3510,7 @@
|
|
|
3407
3510
|
},
|
|
3408
3511
|
{
|
|
3409
3512
|
"name": "QDialog",
|
|
3410
|
-
"description": "A floating, dismissible dialog window that provides feedback or requires user interaction.",
|
|
3513
|
+
"description": "A floating, dismissible dialog window that provides feedback or requires user interaction. ## Accessibility - Uses `role=\"dialog\"`. With `focusWrap` (default) it traps Tab and sets `aria-modal=\"true\"`; without it, Tab can leave and `aria-modal` is omitted so the page stays available to assistive technology. - Escape dismisses it (including when `persistent` blocks outside pointer / focus). Focus returns to the opener on close unless `closingFocus` overrides that. - Prefer a visible title over `aria-label` alone. The title is an `h2` by default; pass `headingLevel` for another level, or a value outside 1–6 for a non-heading.",
|
|
3411
3514
|
"meta": {
|
|
3412
3515
|
"props": [
|
|
3413
3516
|
{
|
|
@@ -3421,22 +3524,23 @@
|
|
|
3421
3524
|
"category": "Identification"
|
|
3422
3525
|
},
|
|
3423
3526
|
{
|
|
3424
|
-
"name": "
|
|
3527
|
+
"name": "title",
|
|
3425
3528
|
"type": {
|
|
3426
3529
|
"kind": "primitive",
|
|
3427
|
-
"name": "
|
|
3530
|
+
"name": "string"
|
|
3428
3531
|
},
|
|
3429
|
-
"description": "The
|
|
3532
|
+
"description": "The title of the dialog window.",
|
|
3430
3533
|
"required": false,
|
|
3431
3534
|
"category": "Content"
|
|
3432
3535
|
},
|
|
3433
3536
|
{
|
|
3434
|
-
"name": "
|
|
3537
|
+
"name": "headingLevel",
|
|
3435
3538
|
"type": {
|
|
3436
3539
|
"kind": "primitive",
|
|
3437
|
-
"name": "
|
|
3540
|
+
"name": "number"
|
|
3438
3541
|
},
|
|
3439
|
-
"description": "The title of the
|
|
3542
|
+
"description": "The heading level of the title. The title heads a window of its own, outside the heading\noutline of the page, so it is an `h2` by default: set this only for an app that wants another\nlevel. A value outside 1–6 renders the title in a plain `div`. Defaults to 2.",
|
|
3543
|
+
"default": "2",
|
|
3440
3544
|
"required": false,
|
|
3441
3545
|
"category": "Content"
|
|
3442
3546
|
},
|
|
@@ -3479,8 +3583,7 @@
|
|
|
3479
3583
|
"value": {}
|
|
3480
3584
|
}
|
|
3481
3585
|
},
|
|
3482
|
-
"description": "The buttons to interact with the dialog window. Pass an empty array to show no buttons.",
|
|
3483
|
-
"default": "DEFAULT_BUTTONS",
|
|
3586
|
+
"description": "The buttons to interact with the dialog window. Without it, the dialog shows one \"Ok\" button,\nlabeled from `texts.ok` with `icons.ok`. Pass an empty array to show no buttons.",
|
|
3484
3587
|
"required": false,
|
|
3485
3588
|
"category": "Content"
|
|
3486
3589
|
},
|
|
@@ -3660,10 +3763,10 @@
|
|
|
3660
3763
|
{
|
|
3661
3764
|
"name": "icons",
|
|
3662
3765
|
"type": {
|
|
3663
|
-
"kind": "
|
|
3664
|
-
"
|
|
3766
|
+
"kind": "unknown",
|
|
3767
|
+
"raw": "QIcons<\"warning\" | \"close\" | \"help\" | \"error\" | \"clear\" | \"ok\"> | undefined"
|
|
3665
3768
|
},
|
|
3666
|
-
"description": "Custom icon configurations. Includes the icons of the prompt input.\nPass every key, or omit the prop to keep the defaults.",
|
|
3769
|
+
"description": "Custom icon configurations. Includes the icons of the prompt input and `ok`, the icon of\nthe default button.\nPass every key, or omit the prop to keep the defaults.",
|
|
3667
3770
|
"default": "DEFAULT_ICONS",
|
|
3668
3771
|
"required": false,
|
|
3669
3772
|
"category": "Configuration"
|
|
@@ -3674,7 +3777,7 @@
|
|
|
3674
3777
|
"kind": "object",
|
|
3675
3778
|
"fields": {}
|
|
3676
3779
|
},
|
|
3677
|
-
"description": "Custom text configurations. Includes the strings of the prompt input
|
|
3780
|
+
"description": "Custom text configurations. Includes the strings of the prompt input, `ok`, the label of\nthe default button, and `prompt`, the name of a prompt field with no `input.label`.\nPass every key, or omit the prop to keep the defaults.",
|
|
3678
3781
|
"default": "DEFAULT_TEXTS",
|
|
3679
3782
|
"required": false,
|
|
3680
3783
|
"category": "Configuration"
|
|
@@ -3688,13 +3791,28 @@
|
|
|
3688
3791
|
"description": "",
|
|
3689
3792
|
"default": "undefined",
|
|
3690
3793
|
"required": false
|
|
3794
|
+
},
|
|
3795
|
+
{
|
|
3796
|
+
"name": "modelValue",
|
|
3797
|
+
"type": {
|
|
3798
|
+
"kind": "primitive",
|
|
3799
|
+
"name": "boolean"
|
|
3800
|
+
},
|
|
3801
|
+
"description": "",
|
|
3802
|
+
"default": "false",
|
|
3803
|
+
"required": false
|
|
3691
3804
|
}
|
|
3692
3805
|
],
|
|
3693
3806
|
"events": [
|
|
3694
3807
|
{
|
|
3695
3808
|
"name": "update:modelValue",
|
|
3696
3809
|
"description": "",
|
|
3697
|
-
"type": "[
|
|
3810
|
+
"type": "[value: boolean]"
|
|
3811
|
+
},
|
|
3812
|
+
{
|
|
3813
|
+
"name": "after-leave",
|
|
3814
|
+
"description": "",
|
|
3815
|
+
"type": "[]"
|
|
3698
3816
|
},
|
|
3699
3817
|
{
|
|
3700
3818
|
"name": "action",
|
|
@@ -3746,9 +3864,14 @@
|
|
|
3746
3864
|
},
|
|
3747
3865
|
{
|
|
3748
3866
|
"title": "With Title",
|
|
3749
|
-
"description": "Displays a header with a custom title.",
|
|
3867
|
+
"description": "Displays a header with a custom title. The title is a heading, an `h2` unless `headingLevel` picks another level, and names the dialog.",
|
|
3750
3868
|
"code": "<QDialog text=\"You clicked the button!\" title=\"What did you do?\" :dismissible=\"true\" />"
|
|
3751
3869
|
},
|
|
3870
|
+
{
|
|
3871
|
+
"title": "Prompt",
|
|
3872
|
+
"description": "A prompt: `input` adds a field to the dialog, with its `type` and a visible `label`. A `validator` runs when a button with an `action` is pressed, and, once its error shows, again as the value changes, so the error goes as soon as the value is valid.",
|
|
3873
|
+
"code": "<QDialog title=\"Share the report\" text=\"We will send a link to the report.\" :icon=\"null\" :input=\"{\n\t\t\ttype: 'email',\n\t\t\tlabel: 'Email',\n\t\t\tvalidator: (value: string) =>\n\t\t\t\t/^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$/.test(value) ? undefined : 'Enter an email address'\n\t\t}\" :buttons=\"[\n\t\t\t{ id: 'send', action: () => undefined, props: { label: 'Send', variant: 'bold' } }\n\t\t]\" />"
|
|
3874
|
+
},
|
|
3752
3875
|
{
|
|
3753
3876
|
"title": "Flush",
|
|
3754
3877
|
"description": "Edge-to-edge layout (no body inset or section dividers) — same chrome `QDialogProvider` uses for programmatic dialogs.",
|
|
@@ -3759,6 +3882,16 @@
|
|
|
3759
3882
|
"description": "Shows a custom icon instead of the default one.",
|
|
3760
3883
|
"code": "<QDialog text=\"You clicked the button?\" :icon=\"{\n\t\t\ticon: 'help-circle-outline'\n\t\t}\" />"
|
|
3761
3884
|
},
|
|
3885
|
+
{
|
|
3886
|
+
"title": "Non Modal",
|
|
3887
|
+
"description": "A dialog that does not wrap focus (`focusWrap: false`): it is not modal, and Tab can leave it for the page. Focus still moves into it when it opens, and back to the button that opened it when it closes.",
|
|
3888
|
+
"code": "<QDialog text=\"You clicked the button!\" :focus-wrap=\"false\" />"
|
|
3889
|
+
},
|
|
3890
|
+
{
|
|
3891
|
+
"title": "Nothing Focusable",
|
|
3892
|
+
"description": "A dialog with nothing to focus: no buttons, no close button and no field. Focus moves to the dialog itself, so the keyboard is inside it, and Escape closes it.",
|
|
3893
|
+
"code": "<QDialog title=\"Saving\" text=\"Your changes are being saved.\" :icon=\"null\" :buttons=\"[]\" />"
|
|
3894
|
+
},
|
|
3762
3895
|
{
|
|
3763
3896
|
"title": "Without Icon Or Buttons",
|
|
3764
3897
|
"description": "A message with no icon and no buttons: `icon` set to `null` and `buttons` to an empty array. The close button in the header dismisses it.",
|
|
@@ -3781,7 +3914,7 @@
|
|
|
3781
3914
|
},
|
|
3782
3915
|
{
|
|
3783
3916
|
"title": "Header Slot",
|
|
3784
|
-
"description": "For a fully custom dialog, the **header** slot replaces the header dialog content.",
|
|
3917
|
+
"description": "For a fully custom dialog, the **header** slot replaces the header dialog content. Without a `title`, the heading it renders names the dialog, or all of it when it renders none.",
|
|
3785
3918
|
"code": "<q-button label=\"Click me\" @click=\"modelValue = true\" />\n\t\t\t<q-dialog v-model=\"modelValue\" v-bind=\"args\">\n\t\t\t\t<template #header>\n\t\t\t\t\t<h2 style=\"font-size: 1.125rem; margin: 0;\">Custom header</h2>\n\t\t\t\t\t<p style=\"color: var(--q-text-color-secondary); margin-top: 0.375rem;\">Custom header content</p>\n\t\t\t\t</template>\n\t\t\t</q-dialog>"
|
|
3786
3919
|
},
|
|
3787
3920
|
{
|
|
@@ -3823,6 +3956,11 @@
|
|
|
3823
3956
|
"title": "Focus On Close",
|
|
3824
3957
|
"description": "When the dialog is closed, a specific element will be focused.",
|
|
3825
3958
|
"code": "<q-button label=\"Click me\" @click=\"modelValue = true\" />\n\t\t\t<br /><br />\n\t\t\t<q-button id=\"focus-btn\" label=\"Focus\" />\n\t\t\t<q-dialog v-model=\"modelValue\" v-bind=\"args\" />"
|
|
3959
|
+
},
|
|
3960
|
+
{
|
|
3961
|
+
"title": "Stacked",
|
|
3962
|
+
"description": "Two dialogs `useDialog` opens at once, such as a warning over a form. Closing the top one with Escape returns focus to the one under it, which is still open and modal. The top one fades out as it closes, like a dialog closed through `v-model`: the provider keeps its entry until its overlay has left.",
|
|
3963
|
+
"code": "<q-dialog-provider />\n\t\t\t<q-button label=\"Open both\" @click=\"openBoth\" />"
|
|
3826
3964
|
}
|
|
3827
3965
|
]
|
|
3828
3966
|
},
|
|
@@ -3926,6 +4064,16 @@
|
|
|
3926
4064
|
"default": "neutral",
|
|
3927
4065
|
"required": false,
|
|
3928
4066
|
"category": "Presentation"
|
|
4067
|
+
},
|
|
4068
|
+
{
|
|
4069
|
+
"name": "surface",
|
|
4070
|
+
"type": {
|
|
4071
|
+
"kind": "primitive",
|
|
4072
|
+
"name": "string"
|
|
4073
|
+
},
|
|
4074
|
+
"description": "The color the divider sits on, when it is not the theme background: a utility color\nlike 'primary', or a CSS color code. The label color is measured against it, so the\nlabel stays readable on a colored banner, and a neutral divider's label takes the\nsurface's own text color. Defaults to the theme background.",
|
|
4075
|
+
"required": false,
|
|
4076
|
+
"category": "Presentation"
|
|
3929
4077
|
}
|
|
3930
4078
|
],
|
|
3931
4079
|
"events": [],
|
|
@@ -3953,19 +4101,488 @@
|
|
|
3953
4101
|
"code": "<div>\n <p>Full-width option</p>\n <QDivider inset />\n <p>Inset option</p>\n <QDivider inset />\n </div>"
|
|
3954
4102
|
},
|
|
3955
4103
|
{
|
|
3956
|
-
"title": "Vertical",
|
|
3957
|
-
"description": "A vertical divider used to split side-by-side elements.",
|
|
3958
|
-
"code": "<div style=\"display: flex; height: 1rem;\">\n <div>Left</div>\n <QDivider direction=\"vertical\" />\n <div>Right</div>\n </div>"
|
|
4104
|
+
"title": "Vertical",
|
|
4105
|
+
"description": "A vertical divider used to split side-by-side elements.",
|
|
4106
|
+
"code": "<div style=\"display: flex; height: 1rem;\">\n <div>Left</div>\n <QDivider direction=\"vertical\" />\n <div>Right</div>\n </div>"
|
|
4107
|
+
},
|
|
4108
|
+
{
|
|
4109
|
+
"title": "Thicker",
|
|
4110
|
+
"description": "A horizontal divider with a bigger thickness.",
|
|
4111
|
+
"code": "<div>\n <p>Section above</p>\n <QDivider :thickness=\"5\" />\n <p>Section below</p>\n </div>"
|
|
4112
|
+
},
|
|
4113
|
+
{
|
|
4114
|
+
"title": "Colored",
|
|
4115
|
+
"description": "A horizontal divider with a primary color.",
|
|
4116
|
+
"code": "<div>\n <p>Section above</p>\n <QDivider color=\"primary\" />\n <p>Section below</p>\n </div>"
|
|
4117
|
+
},
|
|
4118
|
+
{
|
|
4119
|
+
"title": "Surface",
|
|
4120
|
+
"description": "On a colored banner, set `surface` to the banner's color. The label is then measured against the banner instead of the page, so it stays readable. Without a `color`, the label takes the banner's own text color.",
|
|
4121
|
+
"code": "<div style=\"padding: 1rem; border-radius: var(--q-border-radius); background-color: var(--q-theme-primary)\">\n <QDivider color=\"onPrimary\" surface=\"primary\">Or</QDivider>\n <QDivider color=\"danger\" surface=\"primary\">Danger</QDivider>\n <QDivider surface=\"primary\">Neutral</QDivider>\n </div>"
|
|
4122
|
+
}
|
|
4123
|
+
]
|
|
4124
|
+
},
|
|
4125
|
+
{
|
|
4126
|
+
"name": "QDrawer",
|
|
4127
|
+
"description": "A side surface that docks left or right — permanent in the layout or temporary as an overlay with scrim — for app navigation and contextual panels. ## Accessibility - Temporary mode puts `role=\"dialog\"` on the surface inside `QFocusWrap` (like `QOverlay`, including `closingFocus` / `returnFocusOnDeactivate`), with Escape / scrim dismiss, scroll lock, and focus return on close. With `focusWrap` (default) it traps Tab, sets `aria-modal`, and registers a modal layer for toasts; without it, focus still moves in on open and Tab can leave. - Permanent mode renders an `<aside>` landmark. Provide a visible `title` or a `label` / `texts.drawer` so the landmark has an accessible name. - The optional resize handle is a focusable `separator` named after the drawer (`aria-labelledby` / the same name as the surface). Arrow keys resize it (WCAG 2.1.1). Shrink/grow buttons are the single-pointer alternative to dragging (WCAG 2.5.7) — arrow keys alone do not satisfy 2.5.7. - Width / slide transitions follow `prefers-reduced-motion` (local duration override). - Prefer a visible title over `aria-label` alone when the header is shown. Pass `headingLevel` (1–6) when the title should be a heading; omit it for a non-heading. - Rail mode: `#rail` is the collapsed icon strip; the default slot is the expanded chrome. `railExpand` chooses the layout when open: `beside` keeps the strip next to a (often different) panel; `replace` hides the strip once the panel shows (app-style icons → labeled nav). With `expandOnHover`, hover or focus-within widens the drawer. Name the landmark with `label` while the title may be hidden when collapsed.",
|
|
4128
|
+
"meta": {
|
|
4129
|
+
"props": [
|
|
4130
|
+
{
|
|
4131
|
+
"name": "id",
|
|
4132
|
+
"type": {
|
|
4133
|
+
"kind": "primitive",
|
|
4134
|
+
"name": "string"
|
|
4135
|
+
},
|
|
4136
|
+
"description": "The component unique identifier.",
|
|
4137
|
+
"required": false,
|
|
4138
|
+
"category": "Identification"
|
|
4139
|
+
},
|
|
4140
|
+
{
|
|
4141
|
+
"name": "location",
|
|
4142
|
+
"type": {
|
|
4143
|
+
"kind": "enum",
|
|
4144
|
+
"values": [
|
|
4145
|
+
"left",
|
|
4146
|
+
"right"
|
|
4147
|
+
]
|
|
4148
|
+
},
|
|
4149
|
+
"description": "Side of the viewport or layout the drawer docks to.\nDefaults to `left`.",
|
|
4150
|
+
"default": "left",
|
|
4151
|
+
"required": false,
|
|
4152
|
+
"category": "Presentation"
|
|
4153
|
+
},
|
|
4154
|
+
{
|
|
4155
|
+
"name": "mode",
|
|
4156
|
+
"type": {
|
|
4157
|
+
"kind": "enum",
|
|
4158
|
+
"values": [
|
|
4159
|
+
"temporary",
|
|
4160
|
+
"permanent"
|
|
4161
|
+
]
|
|
4162
|
+
},
|
|
4163
|
+
"description": "Layout mode: in-flow (`permanent`) or overlay with scrim (`temporary`).\nDefaults to `temporary`.",
|
|
4164
|
+
"default": "temporary",
|
|
4165
|
+
"required": false,
|
|
4166
|
+
"category": "Behavior"
|
|
4167
|
+
},
|
|
4168
|
+
{
|
|
4169
|
+
"name": "rail",
|
|
4170
|
+
"type": {
|
|
4171
|
+
"kind": "primitive",
|
|
4172
|
+
"name": "boolean"
|
|
4173
|
+
},
|
|
4174
|
+
"description": "When true, uses the collapsed rail width instead of the expanded width.\nPass a `#rail` slot for the icon strip and put the expanded chrome in the\ndefault slot. How those two relate when open is `railExpand`. Defaults to\n`false`.",
|
|
4175
|
+
"default": "false",
|
|
4176
|
+
"required": false,
|
|
4177
|
+
"category": "Presentation"
|
|
4178
|
+
},
|
|
4179
|
+
{
|
|
4180
|
+
"name": "expandOnHover",
|
|
4181
|
+
"type": {
|
|
4182
|
+
"kind": "primitive",
|
|
4183
|
+
"name": "boolean"
|
|
4184
|
+
},
|
|
4185
|
+
"description": "When `rail` is true, expands to the full width on hover or focus-within\nand reveals the default-slot panel. Defaults to `false`.",
|
|
4186
|
+
"default": "false",
|
|
4187
|
+
"required": false,
|
|
4188
|
+
"category": "Behavior"
|
|
4189
|
+
},
|
|
4190
|
+
{
|
|
4191
|
+
"name": "railExpand",
|
|
4192
|
+
"type": {
|
|
4193
|
+
"kind": "enum",
|
|
4194
|
+
"values": [
|
|
4195
|
+
"replace",
|
|
4196
|
+
"beside"
|
|
4197
|
+
]
|
|
4198
|
+
},
|
|
4199
|
+
"description": "Layout of `#rail` vs the expanded panel when the rail is open.\n`beside` keeps the strip next to the panel; `replace` hides the strip\nonce the panel is shown (app-style icon rail → labeled nav). Only applies\nwith a `#rail` slot. Defaults to `beside`.",
|
|
4200
|
+
"default": "beside",
|
|
4201
|
+
"required": false,
|
|
4202
|
+
"category": "Presentation"
|
|
4203
|
+
},
|
|
4204
|
+
{
|
|
4205
|
+
"name": "width",
|
|
4206
|
+
"type": {
|
|
4207
|
+
"kind": "union",
|
|
4208
|
+
"types": [
|
|
4209
|
+
{
|
|
4210
|
+
"name": "string"
|
|
4211
|
+
},
|
|
4212
|
+
{
|
|
4213
|
+
"name": "number"
|
|
4214
|
+
}
|
|
4215
|
+
]
|
|
4216
|
+
},
|
|
4217
|
+
"description": "Expanded drawer width. A number is treated as CSS pixels (scaled by\n`--q-density-scale`); a string is used as a raw CSS length.\nDefaults to `280`.",
|
|
4218
|
+
"default": "DEFAULT_WIDTH",
|
|
4219
|
+
"required": false,
|
|
4220
|
+
"category": "Presentation"
|
|
4221
|
+
},
|
|
4222
|
+
{
|
|
4223
|
+
"name": "railWidth",
|
|
4224
|
+
"type": {
|
|
4225
|
+
"kind": "union",
|
|
4226
|
+
"types": [
|
|
4227
|
+
{
|
|
4228
|
+
"name": "string"
|
|
4229
|
+
},
|
|
4230
|
+
{
|
|
4231
|
+
"name": "number"
|
|
4232
|
+
}
|
|
4233
|
+
]
|
|
4234
|
+
},
|
|
4235
|
+
"description": "Rail (mini) width when `rail` is true. Same number/string rules as `width`.\nDefaults to `var(--q-rail-width, calc(var(--q-space-1) * 12.5))` — set\n`--q-rail-width` in app CSS to align this with the `QSidebar` anchor rail.",
|
|
4236
|
+
"default": "DEFAULT_RAIL_WIDTH",
|
|
4237
|
+
"required": false,
|
|
4238
|
+
"category": "Presentation"
|
|
4239
|
+
},
|
|
4240
|
+
{
|
|
4241
|
+
"name": "minWidth",
|
|
4242
|
+
"type": {
|
|
4243
|
+
"kind": "primitive",
|
|
4244
|
+
"name": "number"
|
|
4245
|
+
},
|
|
4246
|
+
"description": "Minimum width in CSS pixels while resizing. Only applies when `resizable`\nis true. Defaults to `50` (regular-density pixel equivalent of the shared\nrem rail width at a 16px root).",
|
|
4247
|
+
"default": "DEFAULT_RAIL_WIDTH_PX",
|
|
4248
|
+
"required": false,
|
|
4249
|
+
"category": "Presentation"
|
|
4250
|
+
},
|
|
4251
|
+
{
|
|
4252
|
+
"name": "maxWidth",
|
|
4253
|
+
"type": {
|
|
4254
|
+
"kind": "primitive",
|
|
4255
|
+
"name": "number"
|
|
4256
|
+
},
|
|
4257
|
+
"description": "Maximum width in CSS pixels while resizing. Only applies when `resizable`\nis true. Omit for no upper limit beyond the viewport.",
|
|
4258
|
+
"required": false,
|
|
4259
|
+
"category": "Presentation"
|
|
4260
|
+
},
|
|
4261
|
+
{
|
|
4262
|
+
"name": "resizable",
|
|
4263
|
+
"type": {
|
|
4264
|
+
"kind": "primitive",
|
|
4265
|
+
"name": "boolean"
|
|
4266
|
+
},
|
|
4267
|
+
"description": "Whether the user can resize the drawer by dragging (or arrow keys on) the\nedge handle. Ignored while `rail` is true. Defaults to `false`.",
|
|
4268
|
+
"default": "false",
|
|
4269
|
+
"required": false,
|
|
4270
|
+
"category": "Behavior"
|
|
4271
|
+
},
|
|
4272
|
+
{
|
|
4273
|
+
"name": "showGrip",
|
|
4274
|
+
"type": {
|
|
4275
|
+
"kind": "primitive",
|
|
4276
|
+
"name": "boolean"
|
|
4277
|
+
},
|
|
4278
|
+
"description": "Whether to show a visible grip on the resize handle. Only applies when\n`resizable` is true. Defaults to `true`.",
|
|
4279
|
+
"default": "true",
|
|
4280
|
+
"required": false,
|
|
4281
|
+
"category": "Presentation"
|
|
4282
|
+
},
|
|
4283
|
+
{
|
|
4284
|
+
"name": "title",
|
|
4285
|
+
"type": {
|
|
4286
|
+
"kind": "primitive",
|
|
4287
|
+
"name": "string"
|
|
4288
|
+
},
|
|
4289
|
+
"description": "Optional title shown in the header. Also names the drawer for assistive\ntechnology when no `label` is set and the header slot does not replace it.",
|
|
4290
|
+
"required": false,
|
|
4291
|
+
"category": "Content"
|
|
4292
|
+
},
|
|
4293
|
+
{
|
|
4294
|
+
"name": "headingLevel",
|
|
4295
|
+
"type": {
|
|
4296
|
+
"kind": "primitive",
|
|
4297
|
+
"name": "number"
|
|
4298
|
+
},
|
|
4299
|
+
"description": "Heading level for the title (`1`–`6` → `h1`–`h6`). Outside that range, or\nwhen omitted, the title renders as a `div` so the page outline does not\nchange until the app sets a level. No default.",
|
|
4300
|
+
"required": false,
|
|
4301
|
+
"category": "Accessibility"
|
|
4302
|
+
},
|
|
4303
|
+
{
|
|
4304
|
+
"name": "label",
|
|
4305
|
+
"type": {
|
|
4306
|
+
"kind": "primitive",
|
|
4307
|
+
"name": "string"
|
|
4308
|
+
},
|
|
4309
|
+
"description": "Accessible name when there is no rendered title element. Prefer a visible\n`title` when possible. Falls back to `texts.drawer` when omitted.",
|
|
4310
|
+
"required": false,
|
|
4311
|
+
"category": "Accessibility"
|
|
4312
|
+
},
|
|
4313
|
+
{
|
|
4314
|
+
"name": "dismissible",
|
|
4315
|
+
"type": {
|
|
4316
|
+
"kind": "primitive",
|
|
4317
|
+
"name": "boolean"
|
|
4318
|
+
},
|
|
4319
|
+
"description": "When true, shows a close button in the header area.\nDefaults to `false`.",
|
|
4320
|
+
"default": "false",
|
|
4321
|
+
"required": false,
|
|
4322
|
+
"category": "Behavior"
|
|
4323
|
+
},
|
|
4324
|
+
{
|
|
4325
|
+
"name": "backdropBlur",
|
|
4326
|
+
"type": {
|
|
4327
|
+
"kind": "primitive",
|
|
4328
|
+
"name": "boolean"
|
|
4329
|
+
},
|
|
4330
|
+
"description": "Temporary mode only: blurs the page behind the scrim.\nDefaults to `true`.",
|
|
4331
|
+
"default": "true",
|
|
4332
|
+
"required": false,
|
|
4333
|
+
"category": "Presentation"
|
|
4334
|
+
},
|
|
4335
|
+
{
|
|
4336
|
+
"name": "scrollLock",
|
|
4337
|
+
"type": {
|
|
4338
|
+
"kind": "primitive",
|
|
4339
|
+
"name": "boolean"
|
|
4340
|
+
},
|
|
4341
|
+
"description": "Temporary mode only: prevents scrolling the page while open.\nDefaults to `true`.",
|
|
4342
|
+
"default": "true",
|
|
4343
|
+
"required": false,
|
|
4344
|
+
"category": "Behavior"
|
|
4345
|
+
},
|
|
4346
|
+
{
|
|
4347
|
+
"name": "persistent",
|
|
4348
|
+
"type": {
|
|
4349
|
+
"kind": "primitive",
|
|
4350
|
+
"name": "boolean"
|
|
4351
|
+
},
|
|
4352
|
+
"description": "Temporary mode only: when true, outside pointer / focus does not close the\ndrawer. Escape still closes it so the dialog stays keyboard-dismissible.\nDefaults to `false`.",
|
|
4353
|
+
"default": "false",
|
|
4354
|
+
"required": false,
|
|
4355
|
+
"category": "Behavior"
|
|
4356
|
+
},
|
|
4357
|
+
{
|
|
4358
|
+
"name": "focusWrap",
|
|
4359
|
+
"type": {
|
|
4360
|
+
"kind": "primitive",
|
|
4361
|
+
"name": "boolean"
|
|
4362
|
+
},
|
|
4363
|
+
"description": "Temporary mode only: traps Tab focus inside the drawer while open.\nDefaults to `true`.",
|
|
4364
|
+
"default": "true",
|
|
4365
|
+
"required": false,
|
|
4366
|
+
"category": "Behavior"
|
|
4367
|
+
},
|
|
4368
|
+
{
|
|
4369
|
+
"name": "initialFocus",
|
|
4370
|
+
"type": {
|
|
4371
|
+
"kind": "union",
|
|
4372
|
+
"types": [
|
|
4373
|
+
{
|
|
4374
|
+
"name": "other",
|
|
4375
|
+
"value": "null"
|
|
4376
|
+
},
|
|
4377
|
+
{
|
|
4378
|
+
"name": "string"
|
|
4379
|
+
},
|
|
4380
|
+
{
|
|
4381
|
+
"name": "object",
|
|
4382
|
+
"value": {}
|
|
4383
|
+
}
|
|
4384
|
+
]
|
|
4385
|
+
},
|
|
4386
|
+
"description": "Element to focus when the focus wrap activates. Has priority over\n`focusWithinOnActivate`.",
|
|
4387
|
+
"required": false,
|
|
4388
|
+
"category": "Behavior"
|
|
4389
|
+
},
|
|
4390
|
+
{
|
|
4391
|
+
"name": "focusWithinOnActivate",
|
|
4392
|
+
"type": {
|
|
4393
|
+
"kind": "primitive",
|
|
4394
|
+
"name": "boolean"
|
|
4395
|
+
},
|
|
4396
|
+
"description": "Whether to focus the first focusable element when the focus wrap activates.\nDefaults to `true`.",
|
|
4397
|
+
"default": "true",
|
|
4398
|
+
"required": false,
|
|
4399
|
+
"category": "Behavior"
|
|
4400
|
+
},
|
|
4401
|
+
{
|
|
4402
|
+
"name": "closingFocus",
|
|
4403
|
+
"type": {
|
|
4404
|
+
"kind": "union",
|
|
4405
|
+
"types": [
|
|
4406
|
+
{
|
|
4407
|
+
"name": "string"
|
|
4408
|
+
},
|
|
4409
|
+
{
|
|
4410
|
+
"name": "object",
|
|
4411
|
+
"value": {}
|
|
4412
|
+
}
|
|
4413
|
+
]
|
|
4414
|
+
},
|
|
4415
|
+
"description": "Element to focus when the drawer closes. Has priority over\n`returnFocusOnDeactivate`.",
|
|
4416
|
+
"required": false,
|
|
4417
|
+
"category": "Behavior"
|
|
4418
|
+
},
|
|
4419
|
+
{
|
|
4420
|
+
"name": "returnFocusOnDeactivate",
|
|
4421
|
+
"type": {
|
|
4422
|
+
"kind": "primitive",
|
|
4423
|
+
"name": "boolean"
|
|
4424
|
+
},
|
|
4425
|
+
"description": "Whether to return focus to the element that opened the drawer when the\nfocus wrap deactivates. Defaults to `true`.",
|
|
4426
|
+
"default": "true",
|
|
4427
|
+
"required": false,
|
|
4428
|
+
"category": "Behavior"
|
|
4429
|
+
},
|
|
4430
|
+
{
|
|
4431
|
+
"name": "attach",
|
|
4432
|
+
"type": {
|
|
4433
|
+
"kind": "primitive",
|
|
4434
|
+
"name": "string"
|
|
4435
|
+
},
|
|
4436
|
+
"description": "DOM element the temporary drawer teleports to. Defaults to `body`.\nIgnored when `inline` is true or `mode` is `permanent`.",
|
|
4437
|
+
"default": "body",
|
|
4438
|
+
"required": false,
|
|
4439
|
+
"category": "Behavior"
|
|
4440
|
+
},
|
|
4441
|
+
{
|
|
4442
|
+
"name": "inline",
|
|
4443
|
+
"type": {
|
|
4444
|
+
"kind": "primitive",
|
|
4445
|
+
"name": "boolean"
|
|
4446
|
+
},
|
|
4447
|
+
"description": "Temporary mode only: disables teleport so `attach` is ignored.\nDefaults to `false`.",
|
|
4448
|
+
"default": "false",
|
|
4449
|
+
"required": false,
|
|
4450
|
+
"category": "Behavior"
|
|
4451
|
+
},
|
|
4452
|
+
{
|
|
4453
|
+
"name": "icons",
|
|
4454
|
+
"type": {
|
|
4455
|
+
"kind": "unknown",
|
|
4456
|
+
"raw": "QIcons<\"close\" | \"shrink\" | \"grow\"> | undefined"
|
|
4457
|
+
},
|
|
4458
|
+
"description": "Custom icon configurations. Pass every key, or omit the prop to keep the\ndefaults.",
|
|
4459
|
+
"default": "DEFAULT_ICONS",
|
|
4460
|
+
"required": false,
|
|
4461
|
+
"category": "Configuration"
|
|
4462
|
+
},
|
|
4463
|
+
{
|
|
4464
|
+
"name": "texts",
|
|
4465
|
+
"type": {
|
|
4466
|
+
"kind": "object",
|
|
4467
|
+
"fields": {}
|
|
4468
|
+
},
|
|
4469
|
+
"description": "Custom text configurations (close button, accessible name fallback, shrink /\ngrow). Pass every key, or omit the prop to keep the defaults.",
|
|
4470
|
+
"default": "DEFAULT_TEXTS",
|
|
4471
|
+
"required": false,
|
|
4472
|
+
"category": "Configuration"
|
|
4473
|
+
},
|
|
4474
|
+
{
|
|
4475
|
+
"name": "modelValue",
|
|
4476
|
+
"type": {
|
|
4477
|
+
"kind": "primitive",
|
|
4478
|
+
"name": "boolean"
|
|
4479
|
+
},
|
|
4480
|
+
"description": "",
|
|
4481
|
+
"default": "false",
|
|
4482
|
+
"required": false
|
|
4483
|
+
}
|
|
4484
|
+
],
|
|
4485
|
+
"events": [
|
|
4486
|
+
{
|
|
4487
|
+
"name": "update:modelValue",
|
|
4488
|
+
"description": "",
|
|
4489
|
+
"type": "[value: boolean]"
|
|
4490
|
+
},
|
|
4491
|
+
{
|
|
4492
|
+
"name": "resize:start",
|
|
4493
|
+
"description": "",
|
|
4494
|
+
"type": "[]"
|
|
4495
|
+
},
|
|
4496
|
+
{
|
|
4497
|
+
"name": "resize",
|
|
4498
|
+
"description": "",
|
|
4499
|
+
"type": "[width: number]"
|
|
4500
|
+
},
|
|
4501
|
+
{
|
|
4502
|
+
"name": "resize:end",
|
|
4503
|
+
"description": "",
|
|
4504
|
+
"type": "[finalWidth: number]"
|
|
4505
|
+
}
|
|
4506
|
+
],
|
|
4507
|
+
"slots": [
|
|
4508
|
+
{
|
|
4509
|
+
"name": "drawer",
|
|
4510
|
+
"description": ""
|
|
4511
|
+
},
|
|
4512
|
+
{
|
|
4513
|
+
"name": "rail",
|
|
4514
|
+
"description": ""
|
|
4515
|
+
},
|
|
4516
|
+
{
|
|
4517
|
+
"name": "header",
|
|
4518
|
+
"description": ""
|
|
4519
|
+
},
|
|
4520
|
+
{
|
|
4521
|
+
"name": "header.prepend",
|
|
4522
|
+
"description": ""
|
|
4523
|
+
},
|
|
4524
|
+
{
|
|
4525
|
+
"name": "header.append",
|
|
4526
|
+
"description": ""
|
|
4527
|
+
},
|
|
4528
|
+
{
|
|
4529
|
+
"name": "prepend",
|
|
4530
|
+
"description": ""
|
|
4531
|
+
},
|
|
4532
|
+
{
|
|
4533
|
+
"name": "default",
|
|
4534
|
+
"description": ""
|
|
4535
|
+
},
|
|
4536
|
+
{
|
|
4537
|
+
"name": "append",
|
|
4538
|
+
"description": ""
|
|
4539
|
+
},
|
|
4540
|
+
{
|
|
4541
|
+
"name": "footer",
|
|
4542
|
+
"description": ""
|
|
4543
|
+
}
|
|
4544
|
+
]
|
|
4545
|
+
},
|
|
4546
|
+
"examples": [
|
|
4547
|
+
{
|
|
4548
|
+
"title": "Default",
|
|
4549
|
+
"description": "Temporary drawer over page content with scrim. Escape or the scrim closes it.",
|
|
4550
|
+
"code": "<div>\n\t\t\t\t<q-button label=\"Open drawer\" @click=\"open = true\" />\n\t\t\t\t<p style=\"margin-top: 1rem;\">Page content stays interactive only after the drawer closes.</p>\n\t\t\t\t<q-drawer v-bind=\"args\" :model-value=\"open\" @update:model-value=\"onUpdate\">\n\t\t\t\t\t<p>Temporary overlay drawer. Press Escape or click the scrim to dismiss.</p>\n\t\t\t\t</q-drawer>\n\t\t\t</div>"
|
|
4551
|
+
},
|
|
4552
|
+
{
|
|
4553
|
+
"title": "Permanent Left",
|
|
4554
|
+
"description": "Permanent left rail in the document flow — typical app shell navigation chrome. Menu items are slotted; the library does not ship a menu model.",
|
|
4555
|
+
"code": "<div class=\"q-drawer-story-shell\">\n\t\t\t\t<q-drawer v-model=\"args.modelValue\" v-bind=\"args\">\n\t\t\t\t\t<q-list label=\"Navigation\">\n\t\t\t\t\t\t<q-list-item value=\"home\" label=\"Home\" />\n\t\t\t\t\t\t<q-list-item value=\"projects\" label=\"Projects\" />\n\t\t\t\t\t\t<q-list-item value=\"settings\" label=\"Settings\" />\n\t\t\t\t\t</q-list>\n\t\t\t\t</q-drawer>\n\t\t\t\t<main :style=\"mainStyle\">\n\t\t\t\t\t<p>Main application content. The permanent drawer stays in layout flow.</p>\n\t\t\t\t</main>\n\t\t\t</div>"
|
|
4556
|
+
},
|
|
4557
|
+
{
|
|
4558
|
+
"title": "Permanent Right",
|
|
4559
|
+
"description": "Permanent drawer docked on the right — contextual edit panel pattern.",
|
|
4560
|
+
"code": "<div class=\"q-drawer-story-shell\">\n\t\t\t\t<main :style=\"mainStyle\">\n\t\t\t\t\t<p>Dashboard canvas. The edit panel docks on the right.</p>\n\t\t\t\t</main>\n\t\t\t\t<q-drawer v-model=\"args.modelValue\" v-bind=\"args\">\n\t\t\t\t\t<p>Widget configuration form goes here.</p>\n\t\t\t\t\t<template #footer>\n\t\t\t\t\t\t<q-button label=\"Save\" variant=\"bold\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-drawer>\n\t\t\t</div>"
|
|
4561
|
+
},
|
|
4562
|
+
{
|
|
4563
|
+
"title": "Temporary Right",
|
|
4564
|
+
"description": "Temporary right-side overlay — dashboard edit mode that covers the canvas.",
|
|
4565
|
+
"code": "<div>\n\t\t\t\t<q-button label=\"Edit dashboard\" @click=\"open = true\" />\n\t\t\t\t<q-drawer v-bind=\"args\" :model-value=\"open\" @update:model-value=\"onUpdate\">\n\t\t\t\t\t<p>Temporary panel for editing. Scrim blocks the canvas until closed.</p>\n\t\t\t\t</q-drawer>\n\t\t\t</div>"
|
|
4566
|
+
},
|
|
4567
|
+
{
|
|
4568
|
+
"title": "Rail",
|
|
4569
|
+
"description": "`railExpand=\"beside\"`: icon strip stays; a separate panel opens next to it. Collapsed shows `#rail` only; hover or focus-within widens the drawer. Clicking a strip tool switches the panel title and lists beside it.",
|
|
4570
|
+
"code": "<div class=\"q-drawer-story-shell\">\n\t\t\t\t<q-drawer\n\t\t\t\t\tv-model=\"args.modelValue\"\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\t:title=\"panels[tool].title\">\n\t\t\t\t\t<template #rail>\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t:color=\"tool === 'search' ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\ttitle=\"Search\"\n\t\t\t\t\t\t\taria-label=\"Search\"\n\t\t\t\t\t\t\t:aria-pressed=\"tool === 'search'\"\n\t\t\t\t\t\t\t@click=\"selectTool('search')\">\n\t\t\t\t\t\t\t<q-icon icon=\"magnify\" />\n\t\t\t\t\t\t</q-button>\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t:color=\"tool === 'favorites' ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\ttitle=\"Favorites\"\n\t\t\t\t\t\t\taria-label=\"Favorites\"\n\t\t\t\t\t\t\t:aria-pressed=\"tool === 'favorites'\"\n\t\t\t\t\t\t\t@click=\"selectTool('favorites')\">\n\t\t\t\t\t\t\t<q-icon icon=\"star\" />\n\t\t\t\t\t\t</q-button>\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t:color=\"tool === 'help' ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\ttitle=\"Help\"\n\t\t\t\t\t\t\taria-label=\"Help\"\n\t\t\t\t\t\t\t:aria-pressed=\"tool === 'help'\"\n\t\t\t\t\t\t\t@click=\"selectTool('help')\">\n\t\t\t\t\t\t\t<q-icon icon=\"help-circle\" />\n\t\t\t\t\t\t</q-button>\n\t\t\t\t\t</template>\n\t\t\t\t\t<p style=\"margin: 0 0 var(--q-space-3); color: var(--q-text-color-secondary);\">\n\t\t\t\t\t\t{{ panels[tool].blurb }}\n\t\t\t\t\t</p>\n\t\t\t\t\t<div\n\t\t\t\t\t\tv-for=\"(group, index) in panels[tool].groups\"\n\t\t\t\t\t\t:key=\"group.label\"\n\t\t\t\t\t\t:style=\"index > 0 ? 'margin-top: var(--q-space-3);' : undefined\">\n\t\t\t\t\t\t<q-list :label=\"group.label\">\n\t\t\t\t\t\t\t<q-list-item\n\t\t\t\t\t\t\t\tv-for=\"item in group.items\"\n\t\t\t\t\t\t\t\t:key=\"item.value\"\n\t\t\t\t\t\t\t\t:value=\"item.value\"\n\t\t\t\t\t\t\t\t:label=\"item.label\" />\n\t\t\t\t\t\t</q-list>\n\t\t\t\t\t</div>\n\t\t\t\t\t<template #footer>\n\t\t\t\t\t\t<q-button :label=\"tool === 'help' ? 'Contact' : 'Manage'\" variant=\"text\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-drawer>\n\t\t\t\t<main :style=\"mainStyle\">\n\t\t\t\t\t<p>\n\t\t\t\t\t\tHover the strip to open the panel. Click Search, Favorites, or Help to\n\t\t\t\t\t\tswap what the expanded area shows — the strip tools drive the panel,\n\t\t\t\t\t\tthey are not the same items with labels.\n\t\t\t\t\t</p>\n\t\t\t\t\t<p style=\"color: var(--q-text-color-secondary);\">\n\t\t\t\t\t\tActive tool: {{ panels[tool].title }}\n\t\t\t\t\t</p>\n\t\t\t\t</main>\n\t\t\t</div>"
|
|
4571
|
+
},
|
|
4572
|
+
{
|
|
4573
|
+
"title": "Rail Nav",
|
|
4574
|
+
"description": "`railExpand=\"replace\"`: collapsed `#rail` is the same destinations as icons only; hover widens into a labeled nav (top level + one sub-level at most) and the strip yields. No group separators. Strip and panel stay in sync on click.",
|
|
4575
|
+
"code": "<div class=\"q-drawer-story-shell q-drawer-rail-nav-demo\">\n\t\t\t\t<!-- Explicit after v-bind so Controls cannot reset railExpand to beside. -->\n\t\t\t\t<q-drawer v-model=\"args.modelValue\" v-bind=\"args\" rail-expand=\"replace\">\n\t\t\t\t\t<template #rail>\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tv-for=\"item in items\"\n\t\t\t\t\t\t\t:key=\"item.id\"\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t:color=\"active === item.id || item.children?.some((c) => c.id === active) ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\t:title=\"item.label\"\n\t\t\t\t\t\t\t:aria-label=\"item.label\"\n\t\t\t\t\t\t\t:aria-pressed=\"active === item.id || item.children?.some((c) => c.id === active)\"\n\t\t\t\t\t\t\t@click=\"selectFromRail(item.id)\">\n\t\t\t\t\t\t\t<q-icon :icon=\"item.icon\" />\n\t\t\t\t\t\t</q-button>\n\t\t\t\t\t</template>\n\t\t\t\t\t<nav class=\"q-drawer-rail-nav\" :aria-label=\"args.label\">\n\t\t\t\t\t\t<template v-for=\"item in items\" :key=\"item.id\">\n\t\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\t\tclass=\"q-drawer-rail-nav__item\"\n\t\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t\t:color=\"active === item.id || item.children?.some((c) => c.id === active) ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\t\t:aria-pressed=\"active === item.id || item.children?.some((c) => c.id === active)\"\n\t\t\t\t\t\t\t\t:aria-expanded=\"item.children ? Boolean(expanded[item.id]) : undefined\"\n\t\t\t\t\t\t\t\t@click=\"selectFromPanel(item.id)\">\n\t\t\t\t\t\t\t\t<q-icon :icon=\"item.icon\" />\n\t\t\t\t\t\t\t\t<span class=\"q-drawer-rail-nav__item-label\">{{ item.label }}</span>\n\t\t\t\t\t\t\t\t<q-icon\n\t\t\t\t\t\t\t\t\tv-if=\"item.children\"\n\t\t\t\t\t\t\t\t\t:icon=\"expanded[item.id] ? 'chevron-up' : 'chevron-down'\" />\n\t\t\t\t\t\t\t</q-button>\n\t\t\t\t\t\t\t<div\n\t\t\t\t\t\t\t\tv-if=\"item.children && expanded[item.id]\"\n\t\t\t\t\t\t\t\tclass=\"q-drawer-rail-nav__children\">\n\t\t\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\t\t\tv-for=\"child in item.children\"\n\t\t\t\t\t\t\t\t\t:key=\"child.id\"\n\t\t\t\t\t\t\t\t\tclass=\"q-drawer-rail-nav__child\"\n\t\t\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\t\t\t:color=\"active === child.id ? 'primary' : 'neutral'\"\n\t\t\t\t\t\t\t\t\tborderless\n\t\t\t\t\t\t\t\t\t:aria-pressed=\"active === child.id\"\n\t\t\t\t\t\t\t\t\t@click=\"selectChild(child.id)\">\n\t\t\t\t\t\t\t\t\t<q-badge\n\t\t\t\t\t\t\t\t\t\tv-if=\"child.code\"\n\t\t\t\t\t\t\t\t\t\tvariant=\"tonal\"\n\t\t\t\t\t\t\t\t\t\tcolor=\"primary\"\n\t\t\t\t\t\t\t\t\t\tsize=\"small\"\n\t\t\t\t\t\t\t\t\t\tpill>\n\t\t\t\t\t\t\t\t\t\t{{ child.code }}\n\t\t\t\t\t\t\t\t\t</q-badge>\n\t\t\t\t\t\t\t\t\t<q-icon v-else-if=\"child.icon\" :icon=\"child.icon\" />\n\t\t\t\t\t\t\t\t\t<span class=\"q-drawer-rail-nav__item-label\">{{ child.label }}</span>\n\t\t\t\t\t\t\t\t</q-button>\n\t\t\t\t\t\t\t</div>\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</nav>\n\t\t\t\t</q-drawer>\n\t\t\t\t<main :style=\"mainStyle\">\n\t\t\t\t\t<p>\n\t\t\t\t\t\tSame destinations as the icon strip — labels plus one sub-level when a\n\t\t\t\t\t\tsection is open. No separators or deeper nesting.\n\t\t\t\t\t</p>\n\t\t\t\t\t<p style=\"color: var(--q-text-color-secondary);\">\n\t\t\t\t\t\tActive: {{ activeLabel }}\n\t\t\t\t\t</p>\n\t\t\t\t</main>\n\t\t\t</div>"
|
|
3959
4576
|
},
|
|
3960
4577
|
{
|
|
3961
|
-
"title": "
|
|
3962
|
-
"description": "
|
|
3963
|
-
"code": "<div>\n
|
|
4578
|
+
"title": "Resizable",
|
|
4579
|
+
"description": "Resizable permanent drawer. Drag the free edge, use ArrowLeft / ArrowRight on the handle (Home / End for min / max), or the Narrow / Widen buttons (WCAG 2.5.7).",
|
|
4580
|
+
"code": "<div class=\"q-drawer-story-shell\">\n\t\t\t\t<q-drawer v-model=\"args.modelValue\" v-bind=\"args\">\n\t\t\t\t\t<p>Drag the right edge, use arrow keys on the handle, or Narrow / Widen.</p>\n\t\t\t\t</q-drawer>\n\t\t\t\t<main :style=\"mainStyle\">\n\t\t\t\t\t<p>Main content.</p>\n\t\t\t\t</main>\n\t\t\t</div>"
|
|
3964
4581
|
},
|
|
3965
4582
|
{
|
|
3966
|
-
"title": "
|
|
3967
|
-
"description": "
|
|
3968
|
-
"code": "<div>\n
|
|
4583
|
+
"title": "Persistent",
|
|
4584
|
+
"description": "Persistent temporary drawer: Escape closes, outside pointer does not.",
|
|
4585
|
+
"code": "<div>\n\t\t\t\t<!-- Keep the opener mounted so focus can return to it. -->\n\t\t\t\t<q-button label=\"Open drawer\" @click=\"open = true\" />\n\t\t\t\t<p style=\"margin-top: 1rem;\">Outside content. A click here must not dismiss the drawer.</p>\n\t\t\t\t<q-drawer v-bind=\"args\" :model-value=\"open\" @update:model-value=\"onUpdate\">\n\t\t\t\t\t<p>Click outside — the drawer stays open. Press Escape or the close button.</p>\n\t\t\t\t</q-drawer>\n\t\t\t</div>"
|
|
3969
4586
|
}
|
|
3970
4587
|
]
|
|
3971
4588
|
},
|
|
@@ -3998,7 +4615,7 @@
|
|
|
3998
4615
|
}
|
|
3999
4616
|
]
|
|
4000
4617
|
},
|
|
4001
|
-
"description": "The DOM element used to activate the dropdown menu, such as a button. It takes the states\nof a menu button (`aria-haspopup`, `aria-expanded` and, while the menu is open,\n`aria-controls`), and its `id` names the menu.",
|
|
4618
|
+
"description": "The DOM element used to activate the dropdown menu, such as a button. It takes the states\nof a menu button (`aria-haspopup`, `aria-expanded` and, while the menu is open,\n`aria-controls`), and its `id` names the menu. An activator without an `id` gets one\nwhile it opens the menu.",
|
|
4002
4619
|
"required": false,
|
|
4003
4620
|
"category": "Identification"
|
|
4004
4621
|
},
|
|
@@ -4031,7 +4648,7 @@
|
|
|
4031
4648
|
"value": {}
|
|
4032
4649
|
}
|
|
4033
4650
|
},
|
|
4034
|
-
"description": "The list of available items for selection.",
|
|
4651
|
+
"description": "The list of available items for selection. An item's `extraInfo`, such as a shortcut,\nshows at its end and describes it, unless the `item.append` slot replaces it.",
|
|
4035
4652
|
"required": false,
|
|
4036
4653
|
"category": "Content"
|
|
4037
4654
|
},
|
|
@@ -4132,8 +4749,8 @@
|
|
|
4132
4749
|
{
|
|
4133
4750
|
"name": "icons",
|
|
4134
4751
|
"type": {
|
|
4135
|
-
"kind": "
|
|
4136
|
-
"
|
|
4752
|
+
"kind": "unknown",
|
|
4753
|
+
"raw": "QIcons<\"check\" | \"description\" | \"expand\"> | undefined"
|
|
4137
4754
|
},
|
|
4138
4755
|
"description": "Custom icon configurations. Includes the icons of the list.\nPass every key, or omit the prop to keep the defaults.",
|
|
4139
4756
|
"required": false,
|
|
@@ -4219,7 +4836,7 @@
|
|
|
4219
4836
|
{
|
|
4220
4837
|
"title": "Custom Activator",
|
|
4221
4838
|
"description": "Example of a custom activator other than a button.",
|
|
4222
|
-
"code": "<q-button ref=\"activator\" variant=\"ghost\" pill size=\"small\">\n\t\t\t\t<q-avatar alt=\"User Avatar\" src=\"
|
|
4839
|
+
"code": "<q-button ref=\"activator\" variant=\"ghost\" pill size=\"small\">\n\t\t\t\t<q-avatar alt=\"User Avatar\" src=\"/avatar.svg\" />\n\t\t\t</q-button>\n\t\t\t<q-dropdown-menu v-bind=\"args\" :activator=\"activatorRef?.$el\">\n\t\t\t\t<template #prepend>\n\t\t\t\t\t<div style=\"padding: .75rem .75rem .1rem .75rem; min-width: 12rem;\">\n\t\t\t\t\t\t<p style=\"margin: 0\">User Avatar</p>\n\t\t\t\t\t\t<span style=\"color: var(--q-theme-primary); font-size: .85rem;\">Administrator</span>\n\t\t\t\t\t</div>\n\t\t\t\t\t<q-divider />\n\t\t\t\t</template>\n\t\t\t</q-dropdown-menu>"
|
|
4223
4840
|
}
|
|
4224
4841
|
]
|
|
4225
4842
|
},
|
|
@@ -4312,10 +4929,10 @@
|
|
|
4312
4929
|
{
|
|
4313
4930
|
"name": "icons",
|
|
4314
4931
|
"type": {
|
|
4315
|
-
"kind": "
|
|
4316
|
-
"
|
|
4932
|
+
"kind": "unknown",
|
|
4933
|
+
"raw": "QIcons<\"warning\" | \"help\" | \"error\"> | undefined"
|
|
4317
4934
|
},
|
|
4318
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
4935
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4319
4936
|
"default": "DEFAULT_ICONS",
|
|
4320
4937
|
"required": false,
|
|
4321
4938
|
"category": "Configuration"
|
|
@@ -4326,7 +4943,7 @@
|
|
|
4326
4943
|
"kind": "object",
|
|
4327
4944
|
"fields": {}
|
|
4328
4945
|
},
|
|
4329
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
4946
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4330
4947
|
"default": "DEFAULT_TEXTS",
|
|
4331
4948
|
"required": false,
|
|
4332
4949
|
"category": "Configuration"
|
|
@@ -4411,6 +5028,10 @@
|
|
|
4411
5028
|
"name": "errors",
|
|
4412
5029
|
"description": ""
|
|
4413
5030
|
},
|
|
5031
|
+
{
|
|
5032
|
+
"name": "warnings",
|
|
5033
|
+
"description": ""
|
|
5034
|
+
},
|
|
4414
5035
|
{
|
|
4415
5036
|
"name": "extras",
|
|
4416
5037
|
"description": ""
|
|
@@ -4421,7 +5042,7 @@
|
|
|
4421
5042
|
},
|
|
4422
5043
|
{
|
|
4423
5044
|
"name": "QFileUpload",
|
|
4424
|
-
"description": "An image input field with drag and drop area for uploading files.",
|
|
5045
|
+
"description": "An image input field with drag and drop area for uploading files. ## Accessibility - The native file input is hidden. The Choose button is the keyboard path; it carries the field label and describes required / invalid state in text because a button cannot take `aria-required` or `aria-invalid`. - Drag and drop is an extra pointer path, not the only one (WCAG 2.5.7). Focus stays in the field after a file is chosen or the native dialog closes.",
|
|
4425
5046
|
"meta": {
|
|
4426
5047
|
"props": [
|
|
4427
5048
|
{
|
|
@@ -4510,7 +5131,7 @@
|
|
|
4510
5131
|
"kind": "object",
|
|
4511
5132
|
"fields": {}
|
|
4512
5133
|
},
|
|
4513
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
5134
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
4514
5135
|
"default": "DEFAULT_ICONS",
|
|
4515
5136
|
"required": false,
|
|
4516
5137
|
"category": "Configuration"
|
|
@@ -4521,7 +5142,7 @@
|
|
|
4521
5142
|
"kind": "object",
|
|
4522
5143
|
"fields": {}
|
|
4523
5144
|
},
|
|
4524
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
5145
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations.",
|
|
4525
5146
|
"default": "DEFAULT_TEXTS",
|
|
4526
5147
|
"required": false,
|
|
4527
5148
|
"category": "Configuration"
|
|
@@ -4617,6 +5238,10 @@
|
|
|
4617
5238
|
"name": "errors",
|
|
4618
5239
|
"description": ""
|
|
4619
5240
|
},
|
|
5241
|
+
{
|
|
5242
|
+
"name": "warnings",
|
|
5243
|
+
"description": ""
|
|
5244
|
+
},
|
|
4620
5245
|
{
|
|
4621
5246
|
"name": "extras",
|
|
4622
5247
|
"description": ""
|
|
@@ -4668,7 +5293,7 @@
|
|
|
4668
5293
|
},
|
|
4669
5294
|
{
|
|
4670
5295
|
"name": "QFocusWrap",
|
|
4671
|
-
"description": "
|
|
5296
|
+
"description": "Traps or hosts keyboard focus inside its contents while active. ## Accessibility - With `wrap` (default), Tab cycles inside. Without it, focus still moves in on activate and back on deactivate, but Tab can leave — the non-modal dialog pattern. - Use `initialFocus` / `focusWithinOnActivate` for entry, and `closingFocus` / `returnFocusOnDeactivate` for exit. Dialog builds on this.",
|
|
4672
5297
|
"meta": {
|
|
4673
5298
|
"props": [
|
|
4674
5299
|
{
|
|
@@ -4692,6 +5317,17 @@
|
|
|
4692
5317
|
"required": false,
|
|
4693
5318
|
"category": "Behavior"
|
|
4694
5319
|
},
|
|
5320
|
+
{
|
|
5321
|
+
"name": "wrap",
|
|
5322
|
+
"type": {
|
|
5323
|
+
"kind": "primitive",
|
|
5324
|
+
"name": "boolean"
|
|
5325
|
+
},
|
|
5326
|
+
"description": "Whether Tab wraps around inside the contents while active. Without it, the focus wrap still\nmoves focus in when it activates and back when it deactivates, but Tab can leave it, as in\na non-modal dialog. Defaults to true.",
|
|
5327
|
+
"default": "true",
|
|
5328
|
+
"required": false,
|
|
5329
|
+
"category": "Behavior"
|
|
5330
|
+
},
|
|
4695
5331
|
{
|
|
4696
5332
|
"name": "initialFocus",
|
|
4697
5333
|
"type": {
|
|
@@ -5143,10 +5779,10 @@
|
|
|
5143
5779
|
{
|
|
5144
5780
|
"name": "icons",
|
|
5145
5781
|
"type": {
|
|
5146
|
-
"kind": "
|
|
5147
|
-
"
|
|
5782
|
+
"kind": "unknown",
|
|
5783
|
+
"raw": "QIcons<\"warning\" | \"help\" | \"error\"> | undefined"
|
|
5148
5784
|
},
|
|
5149
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
5785
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
5150
5786
|
"required": false,
|
|
5151
5787
|
"category": "Configuration"
|
|
5152
5788
|
},
|
|
@@ -5156,7 +5792,7 @@
|
|
|
5156
5792
|
"kind": "object",
|
|
5157
5793
|
"fields": {}
|
|
5158
5794
|
},
|
|
5159
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
5795
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
5160
5796
|
"required": false,
|
|
5161
5797
|
"category": "Configuration"
|
|
5162
5798
|
},
|
|
@@ -5326,6 +5962,10 @@
|
|
|
5326
5962
|
"name": "errors",
|
|
5327
5963
|
"description": ""
|
|
5328
5964
|
},
|
|
5965
|
+
{
|
|
5966
|
+
"name": "warnings",
|
|
5967
|
+
"description": ""
|
|
5968
|
+
},
|
|
5329
5969
|
{
|
|
5330
5970
|
"name": "extras",
|
|
5331
5971
|
"description": ""
|
|
@@ -5554,7 +6194,7 @@
|
|
|
5554
6194
|
},
|
|
5555
6195
|
{
|
|
5556
6196
|
"name": "QList",
|
|
5557
|
-
"description": "A list of items, allowing the user to select one or more of them.",
|
|
6197
|
+
"description": "A list of items, allowing the user to select one or more of them. ## Accessibility - Default role is `listbox` with `option` items. Pass `role=\"menu\"` (as DropdownMenu does) for action items (`menuitem`); a menu never selects a value and always uses the `list` layout. - Provide `label` (or an accessible name from the owner) so the listbox / menu is named. - In `grid` layout, arrows follow the tile grid; menus stay a vertical list.",
|
|
5558
6198
|
"meta": {
|
|
5559
6199
|
"props": [
|
|
5560
6200
|
{
|
|
@@ -5591,16 +6231,6 @@
|
|
|
5591
6231
|
"required": false,
|
|
5592
6232
|
"category": "Presentation"
|
|
5593
6233
|
},
|
|
5594
|
-
{
|
|
5595
|
-
"name": "modelValue",
|
|
5596
|
-
"type": {
|
|
5597
|
-
"kind": "unknown",
|
|
5598
|
-
"raw": "any"
|
|
5599
|
-
},
|
|
5600
|
-
"description": "The value of the selected item.",
|
|
5601
|
-
"required": false,
|
|
5602
|
-
"category": "Content"
|
|
5603
|
-
},
|
|
5604
6234
|
{
|
|
5605
6235
|
"name": "highlighted",
|
|
5606
6236
|
"type": {
|
|
@@ -5724,20 +6354,29 @@
|
|
|
5724
6354
|
{
|
|
5725
6355
|
"name": "icons",
|
|
5726
6356
|
"type": {
|
|
5727
|
-
"kind": "
|
|
5728
|
-
"
|
|
6357
|
+
"kind": "unknown",
|
|
6358
|
+
"raw": "QIcons<\"check\" | \"description\"> | undefined"
|
|
5729
6359
|
},
|
|
5730
6360
|
"description": "Custom icon configurations, used by every item. Includes the check mark and description icons.\nPass every key, or omit the prop to keep the defaults.",
|
|
5731
6361
|
"default": "DEFAULT_ICONS",
|
|
5732
6362
|
"required": false,
|
|
5733
6363
|
"category": "Configuration"
|
|
6364
|
+
},
|
|
6365
|
+
{
|
|
6366
|
+
"name": "modelValue",
|
|
6367
|
+
"type": {
|
|
6368
|
+
"kind": "unknown",
|
|
6369
|
+
"raw": "any"
|
|
6370
|
+
},
|
|
6371
|
+
"description": "",
|
|
6372
|
+
"required": false
|
|
5734
6373
|
}
|
|
5735
6374
|
],
|
|
5736
6375
|
"events": [
|
|
5737
6376
|
{
|
|
5738
6377
|
"name": "update:modelValue",
|
|
5739
6378
|
"description": "",
|
|
5740
|
-
"type": "[
|
|
6379
|
+
"type": "[value: any]"
|
|
5741
6380
|
},
|
|
5742
6381
|
{
|
|
5743
6382
|
"name": "click",
|
|
@@ -6003,7 +6642,7 @@
|
|
|
6003
6642
|
},
|
|
6004
6643
|
{
|
|
6005
6644
|
"name": "QObfuscation",
|
|
6006
|
-
"description": "Permission-based data obfuscation for consulta / sensitive fields. - No permission: plain \"Restricted\" (or bullets) — no action. - Can reveal: a padlock toggles the value. When revealed, either: - place scoped-slot `qObfuscationHideAction` on the field's `label.append` (QObfuscation then hides its own label/padlock), or - omit it and QObfuscation keeps its label with the hide padlock. - Set `loading` while fetching on reveal (before the value becomes visible).",
|
|
6645
|
+
"description": "Permission-based data obfuscation for consulta / sensitive fields. - No permission: plain \"Restricted\" (or bullets) — no action. - Can reveal: a padlock toggles the value. When revealed, either: - place scoped-slot `qObfuscationHideAction` on the field's `label.append` (QObfuscation then hides its own label/padlock), or - omit it and QObfuscation keeps its label with the hide padlock. - Set `hideable: false` to reveal for good: no hide control, and the value stays shown until the app sets `revealed` back to false. - Set `loading` while fetching on reveal (before the value becomes visible).",
|
|
6007
6646
|
"meta": {
|
|
6008
6647
|
"props": [
|
|
6009
6648
|
{
|
|
@@ -6094,7 +6733,7 @@
|
|
|
6094
6733
|
"kind": "object",
|
|
6095
6734
|
"fields": {}
|
|
6096
6735
|
},
|
|
6097
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
6736
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
6098
6737
|
"default": "DEFAULT_ICONS",
|
|
6099
6738
|
"required": false,
|
|
6100
6739
|
"category": "Configuration"
|
|
@@ -6105,7 +6744,7 @@
|
|
|
6105
6744
|
"kind": "object",
|
|
6106
6745
|
"fields": {}
|
|
6107
6746
|
},
|
|
6108
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
6747
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations.",
|
|
6109
6748
|
"default": "DEFAULT_TEXTS",
|
|
6110
6749
|
"required": false,
|
|
6111
6750
|
"category": "Configuration"
|
|
@@ -6170,6 +6809,17 @@
|
|
|
6170
6809
|
"required": false,
|
|
6171
6810
|
"category": "Behavior"
|
|
6172
6811
|
},
|
|
6812
|
+
{
|
|
6813
|
+
"name": "hideable",
|
|
6814
|
+
"type": {
|
|
6815
|
+
"kind": "primitive",
|
|
6816
|
+
"name": "boolean"
|
|
6817
|
+
},
|
|
6818
|
+
"description": "When false, a revealed value stays revealed: no hide button shows, `QObfuscationHideAction`\nrenders none, and the slot's `toggle` does not hide it. The app can still hide it by setting\n`revealed` to false. Has no effect unless `revealable`.",
|
|
6819
|
+
"default": "true",
|
|
6820
|
+
"required": false,
|
|
6821
|
+
"category": "Behavior"
|
|
6822
|
+
},
|
|
6173
6823
|
{
|
|
6174
6824
|
"name": "loading",
|
|
6175
6825
|
"type": {
|
|
@@ -6259,6 +6909,10 @@
|
|
|
6259
6909
|
"name": "errors",
|
|
6260
6910
|
"description": ""
|
|
6261
6911
|
},
|
|
6912
|
+
{
|
|
6913
|
+
"name": "warnings",
|
|
6914
|
+
"description": ""
|
|
6915
|
+
},
|
|
6262
6916
|
{
|
|
6263
6917
|
"name": "extras",
|
|
6264
6918
|
"description": ""
|
|
@@ -6286,6 +6940,11 @@
|
|
|
6286
6940
|
"description": "Allow reveal — value shown with an open padlock on the slotted field label.",
|
|
6287
6941
|
"code": "<q-obfuscation\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model:revealed=\"revealed\"\n\t\t\t\tv-slot=\"{ qObfuscationHideAction }\">\n\t\t\t\t<q-text-field :label=\"args.label\" v-model=\"value\">\n\t\t\t\t\t<template #label.append>\n\t\t\t\t\t\t<component :is=\"qObfuscationHideAction\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-text-field>\n\t\t\t</q-obfuscation>"
|
|
6288
6942
|
},
|
|
6943
|
+
{
|
|
6944
|
+
"title": "Reveal Only",
|
|
6945
|
+
"description": "Reveal only — `hideable: false` shows no hide button once the value is revealed. The field still places `qObfuscationHideAction`, which then draws no button but leaves the field's label as the only one. Focus moves to the field, since the button that had it is gone. Only the app can mask the value again, by setting `revealed` to false: \"Mask again\" does that, and restores the value.",
|
|
6946
|
+
"code": "<div style=\"display: flex; flex-direction: column; align-items: flex-start; gap: 1rem;\">\n\t\t\t\t<q-obfuscation\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\tv-model:revealed=\"revealed\"\n\t\t\t\t\tv-slot=\"{ qObfuscationHideAction }\">\n\t\t\t\t\t<q-text-field v-model=\"value\" :label=\"args.label\">\n\t\t\t\t\t\t<template #label.append>\n\t\t\t\t\t\t\t<component :is=\"qObfuscationHideAction\" />\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</q-text-field>\n\t\t\t\t</q-obfuscation>\n\t\t\t\t<q-button\n\t\t\t\t\tlabel=\"Mask again\"\n\t\t\t\t\t@click=\"reset\" />\n\t\t\t</div>"
|
|
6947
|
+
},
|
|
6289
6948
|
{
|
|
6290
6949
|
"title": "Revealable Text Field",
|
|
6291
6950
|
"description": "Editable text field gated behind the padlock control.",
|
|
@@ -6466,8 +7125,8 @@
|
|
|
6466
7125
|
{
|
|
6467
7126
|
"name": "icons",
|
|
6468
7127
|
"type": {
|
|
6469
|
-
"kind": "
|
|
6470
|
-
"
|
|
7128
|
+
"kind": "unknown",
|
|
7129
|
+
"raw": "QIcons<\"back\" | \"forward\" | \"up\" | \"down\"> | undefined"
|
|
6471
7130
|
},
|
|
6472
7131
|
"description": "Custom icon configurations for navigation controls.\n\nIcons are chosen from physical `direction` (left/right or up/down), not document\n`dir` / writing mode. Logical start/end and RTL-aware chevrons are a follow-up.",
|
|
6473
7132
|
"default": "DEFAULT_ICONS",
|
|
@@ -6480,7 +7139,7 @@
|
|
|
6480
7139
|
"kind": "object",
|
|
6481
7140
|
"fields": {}
|
|
6482
7141
|
},
|
|
6483
|
-
"description": "Custom accessible strings for navigation controls.\n\nOptional `regionLabel` opts into a named landmark (`role=\"region\"` + `aria-label`)
|
|
7142
|
+
"description": "Custom accessible strings for navigation controls.\n\nOptional `regionLabel` opts into a named landmark (`role=\"region\"` + `aria-label`) and\nnames the scroll area while it is a Tab stop. Set it when the content takes no focus, such\nas text or images: the scroll area is then a Tab stop while it overflows, so the keyboard can\nscroll it, and without a name it says nothing to a screen reader. Omit it (the default) when\nthe content takes focus (tabs, buttons), which avoids N generic landmarks and an invalid\nunnamed `region`.",
|
|
6484
7143
|
"default": "DEFAULT_TEXTS",
|
|
6485
7144
|
"required": false,
|
|
6486
7145
|
"category": "Configuration"
|
|
@@ -6538,16 +7197,26 @@
|
|
|
6538
7197
|
"description": "Custom previous and next controls via slots.",
|
|
6539
7198
|
"code": "<div :style=\"horizontalHostStyle\">\n\t\t\t\t<q-overflow v-bind=\"args\">\n\t\t\t\t\t<template #prev=\"{ disabled, onClick }\">\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\tlabel=\"Back\"\n\t\t\t\t\t\t\t:disabled=\"disabled\"\n\t\t\t\t\t\t\t@click=\"onClick\" />\n\t\t\t\t\t</template>\n\n\t\t\t\t\t<div :style=\"horizontalStripStyle\">\n\t\t\t\t\t\t<div\n\t\t\t\t\t\t\tv-for=\"item in demoItems\"\n\t\t\t\t\t\t\t:key=\"item\"\n\t\t\t\t\t\t\t:style=\"horizontalItemStyle\">\n\t\t\t\t\t\t\t{{ item }}\n\t\t\t\t\t\t</div>\n\t\t\t\t\t</div>\n\n\t\t\t\t\t<template #next=\"{ disabled, onClick }\">\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tvariant=\"ghost\"\n\t\t\t\t\t\t\tlabel=\"Next\"\n\t\t\t\t\t\t\t:disabled=\"disabled\"\n\t\t\t\t\t\t\t@click=\"onClick\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-overflow>\n\t\t\t</div>"
|
|
6540
7199
|
},
|
|
7200
|
+
{
|
|
7201
|
+
"title": "Region Label",
|
|
7202
|
+
"description": "A strip of content that takes no focus, such as text or images, is a Tab stop while it overflows, so the keyboard can scroll it. Name it with `texts.regionLabel`: the strip becomes a named region, and the scroll area a group with the same name, which screen readers read when it takes focus. Without a name, it is a Tab stop that says nothing.",
|
|
7203
|
+
"code": "<QOverflow :texts=\"{ back: 'Previous', forward: 'Next', regionLabel: 'Recent files' }\" />"
|
|
7204
|
+
},
|
|
6541
7205
|
{
|
|
6542
7206
|
"title": "Without Overflow",
|
|
6543
7207
|
"description": "When content fits the viewport, navigation arrows are omitted.",
|
|
6544
7208
|
"code": "<div :style=\"horizontalHostStyle\">\n\t\t\t\t<q-overflow v-bind=\"args\">\n\t\t\t\t\t<div :style=\"horizontalStripStyle\">\n\t\t\t\t\t\t<div :style=\"horizontalItemStyle\">Fits</div>\n\t\t\t\t\t\t<div :style=\"horizontalItemStyle\">Here</div>\n\t\t\t\t\t</div>\n\t\t\t\t</q-overflow>\n\t\t\t</div>"
|
|
7209
|
+
},
|
|
7210
|
+
{
|
|
7211
|
+
"title": "Focusable Items",
|
|
7212
|
+
"description": "Items that take focus, such as buttons: Tab goes from item to item, and each one scrolls into view as it takes focus, clear of the edge fade. The viewport is then no Tab stop of its own, since the items already scroll it. Without items that take focus, the viewport is a Tab stop while it overflows, so the keyboard can scroll it (see **Default**).",
|
|
7213
|
+
"code": "<div :style=\"horizontalHostStyle\">\n\t\t\t\t<q-overflow v-bind=\"args\">\n\t\t\t\t\t<div :style=\"[horizontalStripStyle, 'gap: 0.5rem; padding: 0.25rem']\">\n\t\t\t\t\t\t<q-button\n\t\t\t\t\t\t\tv-for=\"item in demoItems\"\n\t\t\t\t\t\t\t:key=\"item\"\n\t\t\t\t\t\t\t:label=\"item\" />\n\t\t\t\t\t</div>\n\t\t\t\t</q-overflow>\n\t\t\t</div>"
|
|
6545
7214
|
}
|
|
6546
7215
|
]
|
|
6547
7216
|
},
|
|
6548
7217
|
{
|
|
6549
7218
|
"name": "QOverlay",
|
|
6550
|
-
"description": "A generic overlay for creating floating elements.",
|
|
7219
|
+
"description": "A generic overlay for creating floating elements. ## Accessibility - With an underlay (modal-style overlay), the content gets `role=\"dialog\"`. Pair that with `focusWrap` when Tab should stay inside; without the trap, Tab can leave (same split as Dialog). Prefer Dialog when you need the full dialog chrome. - Escape still dismisses a `persistent` overlay so it stays keyboard-closable. `scrollLock` blocks page scroll while open. - Anchored overlays (menus, popovers) omit the dialog role: the owner supplies the popup semantics (`listbox`, `menu`, and so on).",
|
|
6551
7220
|
"meta": {
|
|
6552
7221
|
"props": [
|
|
6553
7222
|
{
|
|
@@ -6560,16 +7229,6 @@
|
|
|
6560
7229
|
"required": false,
|
|
6561
7230
|
"category": "Identification"
|
|
6562
7231
|
},
|
|
6563
|
-
{
|
|
6564
|
-
"name": "modelValue",
|
|
6565
|
-
"type": {
|
|
6566
|
-
"kind": "primitive",
|
|
6567
|
-
"name": "boolean"
|
|
6568
|
-
},
|
|
6569
|
-
"description": "The value of the selected item.",
|
|
6570
|
-
"required": false,
|
|
6571
|
-
"category": "Content"
|
|
6572
|
-
},
|
|
6573
7232
|
{
|
|
6574
7233
|
"name": "anchor",
|
|
6575
7234
|
"type": {
|
|
@@ -6895,13 +7554,28 @@
|
|
|
6895
7554
|
"default": "true",
|
|
6896
7555
|
"required": false,
|
|
6897
7556
|
"category": "Behavior"
|
|
7557
|
+
},
|
|
7558
|
+
{
|
|
7559
|
+
"name": "modelValue",
|
|
7560
|
+
"type": {
|
|
7561
|
+
"kind": "primitive",
|
|
7562
|
+
"name": "boolean"
|
|
7563
|
+
},
|
|
7564
|
+
"description": "",
|
|
7565
|
+
"default": "false",
|
|
7566
|
+
"required": false
|
|
6898
7567
|
}
|
|
6899
7568
|
],
|
|
6900
7569
|
"events": [
|
|
6901
7570
|
{
|
|
6902
7571
|
"name": "update:modelValue",
|
|
6903
7572
|
"description": "",
|
|
6904
|
-
"type": "[
|
|
7573
|
+
"type": "[value: boolean]"
|
|
7574
|
+
},
|
|
7575
|
+
{
|
|
7576
|
+
"name": "after-leave",
|
|
7577
|
+
"description": "",
|
|
7578
|
+
"type": "[]"
|
|
6905
7579
|
},
|
|
6906
7580
|
{
|
|
6907
7581
|
"name": "enter",
|
|
@@ -6960,7 +7634,7 @@
|
|
|
6960
7634
|
"kind": "object",
|
|
6961
7635
|
"fields": {}
|
|
6962
7636
|
},
|
|
6963
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
7637
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the help and clear button icons.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the icons of the clear button and the help button.\nPass every key, or omit the prop to keep the defaults.",
|
|
6964
7638
|
"default": "DEFAULT_ICONS",
|
|
6965
7639
|
"required": false,
|
|
6966
7640
|
"category": "Configuration"
|
|
@@ -7224,6 +7898,10 @@
|
|
|
7224
7898
|
"name": "errors",
|
|
7225
7899
|
"description": ""
|
|
7226
7900
|
},
|
|
7901
|
+
{
|
|
7902
|
+
"name": "warnings",
|
|
7903
|
+
"description": ""
|
|
7904
|
+
},
|
|
7227
7905
|
{
|
|
7228
7906
|
"name": "extras",
|
|
7229
7907
|
"description": ""
|
|
@@ -7369,7 +8047,7 @@
|
|
|
7369
8047
|
"kind": "object",
|
|
7370
8048
|
"fields": {}
|
|
7371
8049
|
},
|
|
7372
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
8050
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the icons of the country selector and the clear button.\nPass every key, or omit the prop to keep the defaults.",
|
|
7373
8051
|
"default": "DEFAULT_ICONS",
|
|
7374
8052
|
"required": false,
|
|
7375
8053
|
"category": "Configuration"
|
|
@@ -7380,7 +8058,7 @@
|
|
|
7380
8058
|
"kind": "object",
|
|
7381
8059
|
"fields": {}
|
|
7382
8060
|
},
|
|
7383
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
8061
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the texts of the country selector and the clear button.\nPass every key, or omit the prop to keep the defaults.",
|
|
7384
8062
|
"default": "DEFAULT_TEXTS",
|
|
7385
8063
|
"required": false,
|
|
7386
8064
|
"category": "Configuration"
|
|
@@ -8320,9 +8998,13 @@
|
|
|
8320
8998
|
"name": "errors",
|
|
8321
8999
|
"description": "The app's error message, shown under the field while `invalid` is true, in place of the\nfield's own message from `autoValidate`."
|
|
8322
9000
|
},
|
|
9001
|
+
{
|
|
9002
|
+
"name": "warnings",
|
|
9003
|
+
"description": "A warning about the value, shown under the field, after the error, whenever it renders."
|
|
9004
|
+
},
|
|
8323
9005
|
{
|
|
8324
9006
|
"name": "extras",
|
|
8325
|
-
"description": "Other content under the field, after the error and the help."
|
|
9007
|
+
"description": "Other content under the field, after the error, the warning and the help."
|
|
8326
9008
|
}
|
|
8327
9009
|
]
|
|
8328
9010
|
},
|
|
@@ -8403,7 +9085,7 @@
|
|
|
8403
9085
|
}
|
|
8404
9086
|
]
|
|
8405
9087
|
},
|
|
8406
|
-
"description": "The DOM element the popover should be anchored to.",
|
|
9088
|
+
"description": "The DOM element the popover should be anchored to. It takes the states of a button that\nopens a dialog (`aria-haspopup`, `aria-expanded` and, while the popover is open,\n`aria-controls`), and names a popover that has no title and no `aria-label` or\n`aria-labelledby` of its own: an anchor with no `id` gets one while it is the anchor.",
|
|
8407
9089
|
"required": true,
|
|
8408
9090
|
"category": "Identification"
|
|
8409
9091
|
},
|
|
@@ -8433,7 +9115,7 @@
|
|
|
8433
9115
|
"kind": "primitive",
|
|
8434
9116
|
"name": "number"
|
|
8435
9117
|
},
|
|
8436
|
-
"description": "The heading level of the title of the
|
|
9118
|
+
"description": "The heading level of the title. The title heads a window of its own, outside the heading\noutline of the page, so it is an `h2` by default: set this only for an app that wants another\nlevel. A value outside 1–6 renders the title in a plain `div`. Defaults to 2.",
|
|
8437
9119
|
"default": "2",
|
|
8438
9120
|
"required": false,
|
|
8439
9121
|
"category": "Content"
|
|
@@ -8554,7 +9236,7 @@
|
|
|
8554
9236
|
"examples": [
|
|
8555
9237
|
{
|
|
8556
9238
|
"title": "Default",
|
|
8557
|
-
"description": "Displays the popover to the right of the element.",
|
|
9239
|
+
"description": "Displays the popover to the right of the element. With no title, the button that opens it names it, and says it opens a dialog, whether it is open, and which one.",
|
|
8558
9240
|
"code": "<q-button ref=\"anchor\" label=\"Click me\" />\n <q-popover v-bind=\"args\" :anchor=\"anchor?.$el\" />"
|
|
8559
9241
|
},
|
|
8560
9242
|
{
|
|
@@ -8798,6 +9480,16 @@
|
|
|
8798
9480
|
"description": "Animated solid fill — sheen sweeps across the bar (no stripes required).",
|
|
8799
9481
|
"code": "<q-progress v-bind=\"args\" />"
|
|
8800
9482
|
},
|
|
9483
|
+
{
|
|
9484
|
+
"title": "Animated At Any Value",
|
|
9485
|
+
"description": "The sheen is the same size and moves at the same speed whatever the value: it sweeps along the track, and the fill shows the part that crosses it. On a short fill it passes quickly, on a long one it stays longer.",
|
|
9486
|
+
"code": "<div style=\"display: grid; gap: 1rem; width: 20rem\">\n\t\t\t\t<q-progress v-bind=\"args\" label=\"Short\" :model-value=\"20\" />\n\t\t\t\t<q-progress v-bind=\"args\" label=\"Long\" :model-value=\"80\" />\n\t\t\t</div>"
|
|
9487
|
+
},
|
|
9488
|
+
{
|
|
9489
|
+
"title": "Animated Value Change",
|
|
9490
|
+
"description": "A value that changes moves the fill over a short transition, and the sheen stays half the track at every frame of it, whether the bar advances or starts again from a lower value.",
|
|
9491
|
+
"code": "<div style=\"display: grid; gap: 1rem; width: 20rem\">\n\t\t\t\t<q-progress v-bind=\"args\" label=\"Upload\" :model-value=\"value\" />\n\t\t\t\t<div style=\"display: flex; gap: 0.5rem\">\n\t\t\t\t\t<q-button label=\"Advance\" @click=\"value = 80\" />\n\t\t\t\t\t<q-button label=\"Restart\" @click=\"value = 10\" />\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
9492
|
+
},
|
|
8801
9493
|
{
|
|
8802
9494
|
"title": "Animated Striped",
|
|
8803
9495
|
"description": "Displays an animated, striped progress bar.",
|
|
@@ -8915,8 +9607,8 @@
|
|
|
8915
9607
|
{
|
|
8916
9608
|
"name": "icons",
|
|
8917
9609
|
"type": {
|
|
8918
|
-
"kind": "
|
|
8919
|
-
"
|
|
9610
|
+
"kind": "unknown",
|
|
9611
|
+
"raw": "QIcons<\"close\" | \"open\"> | undefined"
|
|
8920
9612
|
},
|
|
8921
9613
|
"description": "Custom icon configurations.",
|
|
8922
9614
|
"default": "DEFAULT_ICONS",
|
|
@@ -9005,10 +9697,10 @@
|
|
|
9005
9697
|
{
|
|
9006
9698
|
"name": "icons",
|
|
9007
9699
|
"type": {
|
|
9008
|
-
"kind": "
|
|
9009
|
-
"
|
|
9700
|
+
"kind": "unknown",
|
|
9701
|
+
"raw": "QIcons<\"warning\" | \"help\" | \"error\"> | undefined"
|
|
9010
9702
|
},
|
|
9011
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
9703
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9012
9704
|
"required": false,
|
|
9013
9705
|
"category": "Configuration"
|
|
9014
9706
|
},
|
|
@@ -9018,7 +9710,7 @@
|
|
|
9018
9710
|
"kind": "object",
|
|
9019
9711
|
"fields": {}
|
|
9020
9712
|
},
|
|
9021
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
9713
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9022
9714
|
"required": false,
|
|
9023
9715
|
"category": "Configuration"
|
|
9024
9716
|
},
|
|
@@ -9172,17 +9864,6 @@
|
|
|
9172
9864
|
"required": false,
|
|
9173
9865
|
"category": "Behavior"
|
|
9174
9866
|
},
|
|
9175
|
-
{
|
|
9176
|
-
"name": "hasFocusOutline",
|
|
9177
|
-
"type": {
|
|
9178
|
-
"kind": "primitive",
|
|
9179
|
-
"name": "boolean"
|
|
9180
|
-
},
|
|
9181
|
-
"description": "Indicates whether the control will have an outline when focused.",
|
|
9182
|
-
"default": "true",
|
|
9183
|
-
"required": false,
|
|
9184
|
-
"category": "Behavior"
|
|
9185
|
-
},
|
|
9186
9867
|
{
|
|
9187
9868
|
"name": "modelValue",
|
|
9188
9869
|
"type": {
|
|
@@ -9209,6 +9890,10 @@
|
|
|
9209
9890
|
"name": "errors",
|
|
9210
9891
|
"description": ""
|
|
9211
9892
|
},
|
|
9893
|
+
{
|
|
9894
|
+
"name": "warnings",
|
|
9895
|
+
"description": ""
|
|
9896
|
+
},
|
|
9212
9897
|
{
|
|
9213
9898
|
"name": "extras",
|
|
9214
9899
|
"description": ""
|
|
@@ -9233,8 +9918,8 @@
|
|
|
9233
9918
|
},
|
|
9234
9919
|
{
|
|
9235
9920
|
"title": "Readonly",
|
|
9236
|
-
"description": "A read-only radio button group that displays a fixed selection.",
|
|
9237
|
-
"code": "<
|
|
9921
|
+
"description": "A read-only radio button group that displays a fixed selection. Shown in the light and the dark theme, where its circles stand out in each.",
|
|
9922
|
+
"code": "<QRadioGroup model-value=\"blue\" label=\"Read-only selection\" :readonly=\"true\" :'on-update:model-value'=\"fn()\" />"
|
|
9238
9923
|
},
|
|
9239
9924
|
{
|
|
9240
9925
|
"title": "Disabled",
|
|
@@ -9248,8 +9933,8 @@
|
|
|
9248
9933
|
},
|
|
9249
9934
|
{
|
|
9250
9935
|
"title": "Colors",
|
|
9251
|
-
"description": "A demonstration of radio buttons with different color themes.",
|
|
9252
|
-
"code": "<
|
|
9936
|
+
"description": "A demonstration of radio buttons with different color themes, in the light and the dark theme. A custom color is drawn as given in both, so it is the app's to pick one that stands out from the page in each.",
|
|
9937
|
+
"code": "<QRadioGroup model-value=\"primary\" label=\"Theme Colors\" />"
|
|
9253
9938
|
},
|
|
9254
9939
|
{
|
|
9255
9940
|
"title": "Size",
|
|
@@ -9268,9 +9953,14 @@
|
|
|
9268
9953
|
},
|
|
9269
9954
|
{
|
|
9270
9955
|
"title": "Invalid",
|
|
9271
|
-
"description": "A radio button group with an invalid state.",
|
|
9956
|
+
"description": "A radio button group with an invalid state. Each button takes a danger border, the checked one too.",
|
|
9272
9957
|
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Option 1\" value=\"option1\" />\n\t\t\t\t<q-radio-button label=\"Option 2\" value=\"option2\" />\n\t\t\t\t<q-radio-button label=\"Option 3\" value=\"option3\" />\n\t\t\t</q-radio-group>"
|
|
9273
9958
|
},
|
|
9959
|
+
{
|
|
9960
|
+
"title": "Warning Message",
|
|
9961
|
+
"description": "The `warnings` slot points out something to check without making the choice invalid. Each button takes a warning border, the checked one too.",
|
|
9962
|
+
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Option 1\" value=\"option1\" />\n\t\t\t\t<q-radio-button label=\"Option 2\" value=\"option2\" />\n\t\t\t\t<q-radio-button label=\"Option 3\" value=\"option3\" />\n\t\t\t\t<template #warnings>Option 2 takes a week longer this month</template>\n\t\t\t</q-radio-group>"
|
|
9963
|
+
},
|
|
9274
9964
|
{
|
|
9275
9965
|
"title": "Help",
|
|
9276
9966
|
"description": "Help shown in a popover.",
|
|
@@ -9374,6 +10064,16 @@
|
|
|
9374
10064
|
"required": false,
|
|
9375
10065
|
"category": "Content"
|
|
9376
10066
|
},
|
|
10067
|
+
{
|
|
10068
|
+
"name": "headingLevel",
|
|
10069
|
+
"type": {
|
|
10070
|
+
"kind": "primitive",
|
|
10071
|
+
"name": "number"
|
|
10072
|
+
},
|
|
10073
|
+
"description": "The heading level of the title, so screen reader users can find the section by its\nheading. Choose the level that fits the page's heading outline. Not set by default, so the\ntitle stays a plain `div`, as does a value outside 1–6.",
|
|
10074
|
+
"required": false,
|
|
10075
|
+
"category": "Content"
|
|
10076
|
+
},
|
|
9377
10077
|
{
|
|
9378
10078
|
"name": "help",
|
|
9379
10079
|
"type": {
|
|
@@ -9439,8 +10139,8 @@
|
|
|
9439
10139
|
{
|
|
9440
10140
|
"name": "icons",
|
|
9441
10141
|
"type": {
|
|
9442
|
-
"kind": "
|
|
9443
|
-
"
|
|
10142
|
+
"kind": "unknown",
|
|
10143
|
+
"raw": "QIcons<\"help\"> | undefined"
|
|
9444
10144
|
},
|
|
9445
10145
|
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9446
10146
|
"default": "DEFAULT_ICONS",
|
|
@@ -9483,7 +10183,7 @@
|
|
|
9483
10183
|
},
|
|
9484
10184
|
{
|
|
9485
10185
|
"title": "Popover",
|
|
9486
|
-
"description": "Help shown in a popover on the title
|
|
10186
|
+
"description": "Help shown in a popover on the title, which is a heading at `headingLevel`.",
|
|
9487
10187
|
"code": "<q-section v-bind=\"args\">\n\t\t\t\t<span>Example of a group box</span>\n\t\t\t</q-section>"
|
|
9488
10188
|
},
|
|
9489
10189
|
{
|
|
@@ -9619,7 +10319,7 @@
|
|
|
9619
10319
|
"kind": "object",
|
|
9620
10320
|
"fields": {}
|
|
9621
10321
|
},
|
|
9622
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
10322
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the icons of the badges and the list.\nPass every key, or omit the prop to keep the defaults.",
|
|
9623
10323
|
"default": "DEFAULT_ICONS",
|
|
9624
10324
|
"required": false,
|
|
9625
10325
|
"category": "Configuration"
|
|
@@ -9630,7 +10330,7 @@
|
|
|
9630
10330
|
"kind": "object",
|
|
9631
10331
|
"fields": {}
|
|
9632
10332
|
},
|
|
9633
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
10333
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the badges' remove label and the clear button strings.\nPass every key, or omit the prop to keep the defaults.",
|
|
9634
10334
|
"default": "DEFAULT_TEXTS",
|
|
9635
10335
|
"required": false,
|
|
9636
10336
|
"category": "Configuration"
|
|
@@ -9758,7 +10458,7 @@
|
|
|
9758
10458
|
"kind": "primitive",
|
|
9759
10459
|
"name": "boolean"
|
|
9760
10460
|
},
|
|
9761
|
-
"description": "Whether pressing Tab while an option is focused selects it before focus moves away.",
|
|
10461
|
+
"description": "Whether pressing Tab while an option is focused selects it before focus moves away.\nA multiple select never does: each option there is picked on its own, and Tab only\nleaves the list.",
|
|
9762
10462
|
"default": "true",
|
|
9763
10463
|
"required": false,
|
|
9764
10464
|
"category": "Behavior"
|
|
@@ -9780,7 +10480,6 @@
|
|
|
9780
10480
|
"values": [
|
|
9781
10481
|
"wrap",
|
|
9782
10482
|
"fit-content",
|
|
9783
|
-
"truncate",
|
|
9784
10483
|
"wrap-on-focus",
|
|
9785
10484
|
"scroll-on-focus"
|
|
9786
10485
|
]
|
|
@@ -9911,6 +10610,10 @@
|
|
|
9911
10610
|
"name": "errors",
|
|
9912
10611
|
"description": ""
|
|
9913
10612
|
},
|
|
10613
|
+
{
|
|
10614
|
+
"name": "warnings",
|
|
10615
|
+
"description": ""
|
|
10616
|
+
},
|
|
9914
10617
|
{
|
|
9915
10618
|
"name": "extras",
|
|
9916
10619
|
"description": ""
|
|
@@ -9962,7 +10665,7 @@
|
|
|
9962
10665
|
},
|
|
9963
10666
|
{
|
|
9964
10667
|
"title": "Loading",
|
|
9965
|
-
"description": "
|
|
10668
|
+
"description": "Before the first options load, the open list shows a \"Loading\" row the size of the \"No data\" one, and a bar over its top edge once the load runs past a short delay. A status region announces it, since focus never reaches them. Options that load again stay while they load.",
|
|
9966
10669
|
"code": "<QSelect :items=\"[]\" :loading=\"true\" />"
|
|
9967
10670
|
},
|
|
9968
10671
|
{
|
|
@@ -9972,8 +10675,13 @@
|
|
|
9972
10675
|
},
|
|
9973
10676
|
{
|
|
9974
10677
|
"title": "Overflow",
|
|
9975
|
-
"description": "Controls how long option labels overflow relative to the field width. Defaults to `wrap`. - `wrap`: the menu matches the field and labels wrap onto more lines. - `
|
|
9976
|
-
"code": "<div style=\"display: flex; flex-wrap: wrap; align-items: flex-start; gap: 1rem\">\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Wrap\" overflow=\"wrap\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"
|
|
10678
|
+
"description": "Controls how long option labels overflow relative to the field width. Defaults to `wrap`. - `wrap`: the menu matches the field and labels wrap onto more lines. - `fit-content`: the menu grows with the longest option, up to the width of the screen, where the labels wrap. - `wrap-on-focus`: the menu matches the field and labels end in an ellipsis until the option is focused, then that label wraps. A cut-off label also shows its full text in a native `title` on hover. - `scroll-on-focus`: like `wrap-on-focus` until the option is focused, then that label scrolls to its end and back. With reduced motion, the focused label wraps instead.",
|
|
10679
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; align-items: flex-start; gap: 1rem\">\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Wrap\" overflow=\"wrap\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"fit-content\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Fit content\" overflow=\"fit-content\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"wrap-on-focus\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Wrap on focus\" overflow=\"wrap-on-focus\" />\n\t\t\t\t</div>\n\t\t\t\t<div style=\"width: 12rem\" data-overflow=\"scroll-on-focus\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Scroll on focus\" overflow=\"scroll-on-focus\" />\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
10680
|
+
},
|
|
10681
|
+
{
|
|
10682
|
+
"title": "Fit Content Long Options",
|
|
10683
|
+
"description": "With `fit-content`, the list grows with its longest option up to the width of the screen, where the labels wrap: on a narrow screen, it never runs past the edge or scrolls sideways.",
|
|
10684
|
+
"code": "<QSelect overflow=\"fit-content\" :items=\"[\n\t\t\t{ key: 'short', label: 'Short' },\n\t\t\t{\n\t\t\t\tkey: 'spaced',\n\t\t\t\tlabel: 'An option whose label has more words than a phone screen fits on one line'\n\t\t\t},\n\t\t\t{ key: 'unspaced', label: 'an_option_label_without_spaces_wider_than_a_phone_screen' }\n\t\t]\" />"
|
|
9977
10685
|
},
|
|
9978
10686
|
{
|
|
9979
10687
|
"title": "Description In Items",
|
|
@@ -10022,19 +10730,29 @@
|
|
|
10022
10730
|
},
|
|
10023
10731
|
{
|
|
10024
10732
|
"title": "Readonly Counter",
|
|
10025
|
-
"description": "A read-only select keeps every value in reach: its \"+N\" counter is a button, for the keyboard too, that opens a popover listing them all. Escape closes it and returns to the counter.",
|
|
10733
|
+
"description": "A read-only select keeps every value in reach: its \"+N\" counter is a button, for the keyboard too, that opens a popover listing them all. Escape closes it and returns to the counter. The count keeps room for the counter as a button, which is wider than a plain badge.",
|
|
10026
10734
|
"code": "<QSelect :readonly=\"true\" />"
|
|
10027
10735
|
},
|
|
10028
10736
|
{
|
|
10029
10737
|
"title": "Keyboard",
|
|
10030
10738
|
"description": "The select by keyboard: Arrow Down, Enter or Space opens it on the selected option (or the first), the arrows, Home, End and typing move through the options, Enter picks one, and Escape closes the list. Focus goes back to the select either way. Tab picks the focused option and goes on to what follows the select; Shift+Tab goes back to the select without picking anything. The text shows the picked option, and typing, Backspace or a paste leaves it as it is.",
|
|
10031
|
-
"code": "<div style=\"display: flex; gap: 0.5rem; align-items: center\">\n\t\t\t\t<q-button label=\"Before\" />\n\t\t\t\t<q-select v-bind=\"args\" aria-label=\"Format\" style=\"width: 12rem\" />\n\t\t\t\t<q-button label=\"After\" />\n\t\t\t</div>"
|
|
10739
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; gap: 0.5rem; align-items: center\">\n\t\t\t\t<q-button label=\"Before\" />\n\t\t\t\t<q-select v-bind=\"args\" aria-label=\"Format\" style=\"width: 12rem\" />\n\t\t\t\t<q-button label=\"After\" />\n\t\t\t</div>"
|
|
10740
|
+
},
|
|
10741
|
+
{
|
|
10742
|
+
"title": "Many Options",
|
|
10743
|
+
"description": "With many options, the list renders only those in view and a few around them, so it opens as fast as a short one. Each option says its place among all of them, and the keyboard reaches any of them: End goes to the last one, which renders as it takes focus.",
|
|
10744
|
+
"code": "<QSelect :items=\"manyOptions\" />"
|
|
10745
|
+
},
|
|
10746
|
+
{
|
|
10747
|
+
"title": "Many Options Fit Content",
|
|
10748
|
+
"description": "A list as wide as its widest option (`overflow: 'fit-content'`) with many options renders only those in view, and measures the widest label and description rather than render every option: the list is as wide from the start as the options far down that need it most, which show on one line when reached.",
|
|
10749
|
+
"code": "<QSelect overflow=\"fit-content\" :items=\"Array.from({ length: MANY_OPTIONS }, (_, index) => {\n\t\t\t// The widest label and the widest description, far down the list, with names to type\n\t\t\tif (index === MANY_OPTIONS - 2000) {\n\t\t\t\treturn {\n\t\t\t\t\tkey: index + 1,\n\t\t\t\t\tlabel: 'Zone with a much longer name than every other option'\n\t\t\t\t}\n\t\t\t}\n\t\t\tif (index === MANY_OPTIONS - 1000) {\n\t\t\t\treturn {\n\t\t\t\t\tkey: index + 1,\n\t\t\t\t\tlabel: 'Zones',\n\t\t\t\t\tdescription:\n\t\t\t\t\t\t'A description wider than every name in the list, with its icon before it, by far'\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn { key: index + 1, label: `Option ${index + 1}` }\n\t\t})\" />"
|
|
10032
10750
|
}
|
|
10033
10751
|
]
|
|
10034
10752
|
},
|
|
10035
10753
|
{
|
|
10036
10754
|
"name": "QSidebar",
|
|
10037
|
-
"description": "A flexible sidebar
|
|
10755
|
+
"description": "A flexible sidebar with anchors and optional panels — including resizable ones. ## Accessibility - An open panel is a named `region` (`aria-labelledby` from the title or the anchor toggle). A resizable panel needs that name: its resize handle is a Tab stop that takes it. - The optional resize handle is a focusable `separator`: arrow keys resize it (WCAG 2.1.1). Shrink/grow buttons are the single-pointer alternative to dragging (WCAG 2.5.7) — arrow keys alone do not satisfy 2.5.7. - Pass `headingLevel` (1–6) when the panel title should be a heading; omit it for a non-heading.",
|
|
10038
10756
|
"meta": {
|
|
10039
10757
|
"props": [
|
|
10040
10758
|
{
|
|
@@ -10053,7 +10771,7 @@
|
|
|
10053
10771
|
"kind": "primitive",
|
|
10054
10772
|
"name": "number"
|
|
10055
10773
|
},
|
|
10056
|
-
"description": "Width of the anchor section in pixels at regular density. Scaled by\n`--q-density-scale` when applied. Omit to use
|
|
10774
|
+
"description": "Width of the anchor section in pixels at regular density. Scaled by\n`--q-density-scale` when applied. Omit to use\n`var(--q-rail-width, calc(var(--q-space-1) * 12.5))` — set `--q-rail-width`\nin app CSS to align this with `QDrawer`'s default `railWidth`.",
|
|
10057
10775
|
"required": false,
|
|
10058
10776
|
"category": "Presentation"
|
|
10059
10777
|
},
|
|
@@ -10084,8 +10802,8 @@
|
|
|
10084
10802
|
{
|
|
10085
10803
|
"name": "icons",
|
|
10086
10804
|
"type": {
|
|
10087
|
-
"kind": "
|
|
10088
|
-
"
|
|
10805
|
+
"kind": "unknown",
|
|
10806
|
+
"raw": "QIcons<\"shrink\" | \"grow\"> | undefined"
|
|
10089
10807
|
},
|
|
10090
10808
|
"description": "Icons of the buttons that narrow and widen a resizable panel, which the sidebar\ncascades to its items unless an item sets its own `icons`.\nPass every key, or omit the prop to keep the defaults.",
|
|
10091
10809
|
"default": "DEFAULT_ICONS",
|
|
@@ -10120,9 +10838,9 @@
|
|
|
10120
10838
|
"type": "[value: string | undefined]"
|
|
10121
10839
|
},
|
|
10122
10840
|
{
|
|
10123
|
-
"name": "
|
|
10841
|
+
"name": "resize:start",
|
|
10124
10842
|
"description": "",
|
|
10125
|
-
"type": "[
|
|
10843
|
+
"type": "[]"
|
|
10126
10844
|
},
|
|
10127
10845
|
{
|
|
10128
10846
|
"name": "resize",
|
|
@@ -10130,14 +10848,14 @@
|
|
|
10130
10848
|
"type": "[width: number]"
|
|
10131
10849
|
},
|
|
10132
10850
|
{
|
|
10133
|
-
"name": "resize:
|
|
10851
|
+
"name": "resize:end",
|
|
10134
10852
|
"description": "",
|
|
10135
|
-
"type": "[]"
|
|
10853
|
+
"type": "[finalWidth: number]"
|
|
10136
10854
|
},
|
|
10137
10855
|
{
|
|
10138
|
-
"name": "
|
|
10856
|
+
"name": "click:item",
|
|
10139
10857
|
"description": "",
|
|
10140
|
-
"type": "[
|
|
10858
|
+
"type": "[id: string]"
|
|
10141
10859
|
}
|
|
10142
10860
|
],
|
|
10143
10861
|
"slots": [
|
|
@@ -10408,8 +11126,8 @@
|
|
|
10408
11126
|
{
|
|
10409
11127
|
"name": "icons",
|
|
10410
11128
|
"type": {
|
|
10411
|
-
"kind": "
|
|
10412
|
-
"
|
|
11129
|
+
"kind": "unknown",
|
|
11130
|
+
"raw": "QIcons<\"back\" | \"forward\" | \"previous\" | \"next\" | \"up\" | \"down\" | \"completed\" | \"current\"> | undefined"
|
|
10413
11131
|
},
|
|
10414
11132
|
"description": "Custom icons for the previous/next navigation buttons, the\n`completed`/`current` status badges, and the overflow scroll arrows.\nPass every key, or omit the prop to keep the defaults.",
|
|
10415
11133
|
"default": "DEFAULT_ICONS",
|
|
@@ -10635,10 +11353,11 @@
|
|
|
10635
11353
|
{
|
|
10636
11354
|
"name": "icons",
|
|
10637
11355
|
"type": {
|
|
10638
|
-
"kind": "
|
|
10639
|
-
"
|
|
11356
|
+
"kind": "unknown",
|
|
11357
|
+
"raw": "QIcons<\"warning\" | \"help\" | \"error\"> | undefined"
|
|
10640
11358
|
},
|
|
10641
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
11359
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nIcon overrides. Includes the field's help, error and warning icons.\nPass every key, or omit the prop to keep the defaults.",
|
|
11360
|
+
"default": "DEFAULT_ICONS",
|
|
10642
11361
|
"required": false,
|
|
10643
11362
|
"category": "Configuration"
|
|
10644
11363
|
},
|
|
@@ -10648,7 +11367,8 @@
|
|
|
10648
11367
|
"kind": "object",
|
|
10649
11368
|
"fields": {}
|
|
10650
11369
|
},
|
|
10651
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
11370
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nText overrides. Includes the state labels, `on` and `off`, shown when the switch has no\n`trueLabel` or `falseLabel`, and the field's help, error and warning texts.\nPass every key, or omit the prop to keep the defaults.",
|
|
11371
|
+
"default": "DEFAULT_TEXTS",
|
|
10652
11372
|
"required": false,
|
|
10653
11373
|
"category": "Configuration"
|
|
10654
11374
|
},
|
|
@@ -10658,8 +11378,7 @@
|
|
|
10658
11378
|
"kind": "primitive",
|
|
10659
11379
|
"name": "string"
|
|
10660
11380
|
},
|
|
10661
|
-
"description": "Label displayed when switch is
|
|
10662
|
-
"default": "On",
|
|
11381
|
+
"description": "Label displayed when the switch is on, with `showStateLabels`. Defaults to `texts.on`;\nan empty string shows none.",
|
|
10663
11382
|
"required": false,
|
|
10664
11383
|
"category": "Content"
|
|
10665
11384
|
},
|
|
@@ -10669,8 +11388,7 @@
|
|
|
10669
11388
|
"kind": "primitive",
|
|
10670
11389
|
"name": "string"
|
|
10671
11390
|
},
|
|
10672
|
-
"description": "Label displayed when switch is
|
|
10673
|
-
"default": "Off",
|
|
11391
|
+
"description": "Label displayed when the switch is off, with `showStateLabels`. Defaults to `texts.off`;\nan empty string shows none.",
|
|
10674
11392
|
"required": false,
|
|
10675
11393
|
"category": "Content"
|
|
10676
11394
|
},
|
|
@@ -10769,6 +11487,10 @@
|
|
|
10769
11487
|
{
|
|
10770
11488
|
"name": "errors",
|
|
10771
11489
|
"description": ""
|
|
11490
|
+
},
|
|
11491
|
+
{
|
|
11492
|
+
"name": "warnings",
|
|
11493
|
+
"description": ""
|
|
10772
11494
|
}
|
|
10773
11495
|
]
|
|
10774
11496
|
},
|
|
@@ -10780,7 +11502,7 @@
|
|
|
10780
11502
|
},
|
|
10781
11503
|
{
|
|
10782
11504
|
"title": "With State Labels",
|
|
10783
|
-
"description": "Displays the switch with state-specific labels (`trueLabel`
|
|
11505
|
+
"description": "Displays the switch with state-specific labels, off and on, in the light and the dark theme. They come from `texts.on` and `texts.off` (\"On\" and \"Off\") unless the switch sets `trueLabel` and `falseLabel`. The thumb takes the color that goes on its track, so it stands out from the track in each, and the label on it takes the track's color.",
|
|
10784
11506
|
"code": "<QSwitch :show-state-labels=\"true\" />"
|
|
10785
11507
|
},
|
|
10786
11508
|
{
|
|
@@ -10805,8 +11527,13 @@
|
|
|
10805
11527
|
},
|
|
10806
11528
|
{
|
|
10807
11529
|
"title": "Invalid",
|
|
10808
|
-
"description": "An invalid switch. The help says what to fix, since the danger outline shows it only in color.",
|
|
10809
|
-
"code": "<
|
|
11530
|
+
"description": "An invalid switch, on or off. The help says what to fix, since the danger outline shows it only in color.",
|
|
11531
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; gap: 2rem\">\n\t\t\t\t<q-switch v-bind=\"args\" />\n\t\t\t\t<q-switch v-bind=\"args\" model-value />\n\t\t\t</div>"
|
|
11532
|
+
},
|
|
11533
|
+
{
|
|
11534
|
+
"title": "Warning Message",
|
|
11535
|
+
"description": "The `warnings` slot points out something to check without making the value invalid. The switch takes a warning outline, on or off.",
|
|
11536
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; gap: 2rem\">\n\t\t\t\t<q-switch v-bind=\"args\">\n\t\t\t\t\t<template #warnings>Notifications can arrive late this week</template>\n\t\t\t\t</q-switch>\n\t\t\t\t<q-switch v-bind=\"args\" model-value>\n\t\t\t\t\t<template #warnings>Notifications can arrive late this week</template>\n\t\t\t\t</q-switch>\n\t\t\t</div>"
|
|
10810
11537
|
},
|
|
10811
11538
|
{
|
|
10812
11539
|
"title": "Size",
|
|
@@ -10815,12 +11542,12 @@
|
|
|
10815
11542
|
},
|
|
10816
11543
|
{
|
|
10817
11544
|
"title": "Custom Color",
|
|
10818
|
-
"description": "Switch with a custom checked color instead of the default theme color.",
|
|
11545
|
+
"description": "Switch with a custom checked color instead of the default theme color, in the light and the dark theme. The track takes the custom color as given in both, and the thumb the color that goes on it.",
|
|
10819
11546
|
"code": "<QSwitch :model-value=\"true\" checked-color=\"rgb(0, 200, 83)\" />"
|
|
10820
11547
|
},
|
|
10821
11548
|
{
|
|
10822
11549
|
"title": "Custom Switch",
|
|
10823
|
-
"description": "A themed switch using
|
|
11550
|
+
"description": "A themed switch using its own state labels (`trueLabel` and `falseLabel`, with emoji) and a custom color, ideal for toggling between light and dark modes.",
|
|
10824
11551
|
"code": "<QSwitch :model-value=\"true\" :show-state-labels=\"true\" label=\"Theme\" true-label=\"🌙 Dark\" false-label=\"☀️ Light\" checked-color=\"#333\" />"
|
|
10825
11552
|
},
|
|
10826
11553
|
{
|
|
@@ -10837,7 +11564,7 @@
|
|
|
10837
11564
|
},
|
|
10838
11565
|
{
|
|
10839
11566
|
"name": "QTabs",
|
|
10840
|
-
"description": "Displays a set of tabbed panels. Only one panel is visible at a time.",
|
|
11567
|
+
"description": "Displays a set of tabbed panels. Only one panel is visible at a time. Name the tab strip with `aria-label` or `aria-labelledby` on `QTabs`, when the page has more than one strip or the tabs alone do not say what they switch: both go to the tablist.",
|
|
10841
11568
|
"meta": {
|
|
10842
11569
|
"props": [
|
|
10843
11570
|
{
|
|
@@ -10907,8 +11634,8 @@
|
|
|
10907
11634
|
{
|
|
10908
11635
|
"name": "icons",
|
|
10909
11636
|
"type": {
|
|
10910
|
-
"kind": "
|
|
10911
|
-
"
|
|
11637
|
+
"kind": "unknown",
|
|
11638
|
+
"raw": "QIcons<\"back\" | \"forward\" | \"up\" | \"down\"> | undefined"
|
|
10912
11639
|
},
|
|
10913
11640
|
"description": "Icons for the tab strip. Includes the overflow navigation chevrons.\nPass every key, or omit the prop to keep the defaults.",
|
|
10914
11641
|
"default": "DEFAULT_ICONS",
|
|
@@ -10961,6 +11688,11 @@
|
|
|
10961
11688
|
"description": "Subtext help at the top of a panel. The tab button stays the label.",
|
|
10962
11689
|
"code": "<q-tabs v-bind=\"args\">\n\t\t\t\t<q-tab title=\"Details\" value=\"details\" help=\"Shown for this tab\">\n\t\t\t\t\tContent for the details tab.\n\t\t\t\t</q-tab>\n\t\t\t\t<q-tab title=\"History\" value=\"history\">\n\t\t\t\t\tContent for the history tab.\n\t\t\t\t</q-tab>\n\t\t\t\t<q-tab title=\"Settings\" value=\"settings\">\n\t\t\t\t\tContent for the settings tab.\n\t\t\t\t</q-tab>\n\t\t\t</q-tabs>"
|
|
10963
11690
|
},
|
|
11691
|
+
{
|
|
11692
|
+
"title": "Named",
|
|
11693
|
+
"description": "Tabs named by the heading above them: `aria-labelledby` on `QTabs` names the tablist, so a screen reader says which tabs these are.",
|
|
11694
|
+
"code": "<h3 id=\"account-tabs-title\">Account</h3>\n\t\t\t<q-tabs v-bind=\"args\" aria-labelledby=\"account-tabs-title\">\n\t\t\t\t<q-tab title=\"Profile\" value=\"profile\">\n\t\t\t\t\tContent for the profile tab.\n\t\t\t\t</q-tab>\n\t\t\t\t<q-tab title=\"Security\" value=\"security\">\n\t\t\t\t\tContent for the security tab.\n\t\t\t\t</q-tab>\n\t\t\t</q-tabs>"
|
|
11695
|
+
},
|
|
10964
11696
|
{
|
|
10965
11697
|
"title": "Vertical",
|
|
10966
11698
|
"description": "Vertical tab list beside the panels.",
|
|
@@ -11106,10 +11838,10 @@
|
|
|
11106
11838
|
{
|
|
11107
11839
|
"name": "icons",
|
|
11108
11840
|
"type": {
|
|
11109
|
-
"kind": "
|
|
11110
|
-
"
|
|
11841
|
+
"kind": "unknown",
|
|
11842
|
+
"raw": "QIcons<\"warning\" | \"help\" | \"error\"> | undefined"
|
|
11111
11843
|
},
|
|
11112
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
11844
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
11113
11845
|
"required": false,
|
|
11114
11846
|
"category": "Configuration"
|
|
11115
11847
|
},
|
|
@@ -11119,7 +11851,7 @@
|
|
|
11119
11851
|
"kind": "object",
|
|
11120
11852
|
"fields": {}
|
|
11121
11853
|
},
|
|
11122
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
11854
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.",
|
|
11123
11855
|
"required": false,
|
|
11124
11856
|
"category": "Configuration"
|
|
11125
11857
|
},
|
|
@@ -11291,6 +12023,10 @@
|
|
|
11291
12023
|
"name": "errors",
|
|
11292
12024
|
"description": ""
|
|
11293
12025
|
},
|
|
12026
|
+
{
|
|
12027
|
+
"name": "warnings",
|
|
12028
|
+
"description": ""
|
|
12029
|
+
},
|
|
11294
12030
|
{
|
|
11295
12031
|
"name": "extras",
|
|
11296
12032
|
"description": ""
|
|
@@ -11446,7 +12182,7 @@
|
|
|
11446
12182
|
"kind": "object",
|
|
11447
12183
|
"fields": {}
|
|
11448
12184
|
},
|
|
11449
|
-
"description": "Icon overrides. Includes the help popover icon, `help`,
|
|
12185
|
+
"description": "Icon overrides. Includes the help popover icon, `help`, the error icon, `error`, and the\nwarning icon, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations. Includes the help and clear button icons.\nPass every key, or omit the prop to keep the defaults.",
|
|
11450
12186
|
"default": "DEFAULT_ICONS",
|
|
11451
12187
|
"required": false,
|
|
11452
12188
|
"category": "Configuration"
|
|
@@ -11457,7 +12193,7 @@
|
|
|
11457
12193
|
"kind": "object",
|
|
11458
12194
|
"fields": {}
|
|
11459
12195
|
},
|
|
11460
|
-
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the
|
|
12196
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`, and the texts read\nbefore an error message, `error`, and before a warning, `warning`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations. Includes the help and clear button labels.\nPass every key, or omit the prop to keep the defaults.",
|
|
11461
12197
|
"default": "DEFAULT_TEXTS",
|
|
11462
12198
|
"required": false,
|
|
11463
12199
|
"category": "Configuration"
|
|
@@ -11594,6 +12330,10 @@
|
|
|
11594
12330
|
"name": "errors",
|
|
11595
12331
|
"description": ""
|
|
11596
12332
|
},
|
|
12333
|
+
{
|
|
12334
|
+
"name": "warnings",
|
|
12335
|
+
"description": ""
|
|
12336
|
+
},
|
|
11597
12337
|
{
|
|
11598
12338
|
"name": "extras",
|
|
11599
12339
|
"description": ""
|
|
@@ -11656,6 +12396,16 @@
|
|
|
11656
12396
|
"description": "The `errors` slot says what is wrong while `invalid` is true. The message shows under the field after an error icon, describes the input, and screen readers announce it as it appears, after the text \"Error:\" (`texts.error`). The slot is ignored while `invalid` is false, so it can hold the message all along.",
|
|
11657
12397
|
"code": "<q-text-field\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model=\"value\"\n\t\t\t\t:invalid=\"invalid\">\n\t\t\t\t<template #errors>Use at least 3 characters</template>\n\t\t\t</q-text-field>"
|
|
11658
12398
|
},
|
|
12399
|
+
{
|
|
12400
|
+
"title": "Warning Message",
|
|
12401
|
+
"description": "The `warnings` slot points out something the user may want to check, without blocking: the value stays valid. The warning shows whenever the slot renders something, so render it conditionally. It shows under the field after a warning icon, with a warning border, and describes the input. Screen readers announce it as it appears, after the text \"Warning:\" (`texts.warning`). With an error too, both show, the error first, and the border is the error's.",
|
|
12402
|
+
"code": "<q-text-field\n\t\t\t\tv-bind=\"args\"\n\t\t\t\tv-model=\"value\"\n\t\t\t\t:invalid=\"invalid\">\n\t\t\t\t<template #errors>Use at least 3 characters</template>\n\t\t\t\t<template\n\t\t\t\t\tv-if=\"uppercase\"\n\t\t\t\t\t#warnings>\n\t\t\t\t\tUsernames are usually all lowercase\n\t\t\t\t</template>\n\t\t\t</q-text-field>"
|
|
12403
|
+
},
|
|
12404
|
+
{
|
|
12405
|
+
"title": "Message Icon Size",
|
|
12406
|
+
"description": "Error and warning icons of another size, set with the `size` of `icons.error` and `icons.warning`. They center on the capitals of their messages like icons of the default size.",
|
|
12407
|
+
"code": "<q-text-field v-bind=\"args\">\n\t\t\t\t<template #errors>Use at least 3 characters</template>\n\t\t\t\t<template #warnings>Usernames are usually all lowercase</template>\n\t\t\t</q-text-field>"
|
|
12408
|
+
},
|
|
11659
12409
|
{
|
|
11660
12410
|
"title": "Clearable",
|
|
11661
12411
|
"description": "Adds a clear button to the field, allowing the user to clear the value. The button leaves with the value, so focus goes back to the input, to type a new one.",
|
|
@@ -11755,7 +12505,7 @@
|
|
|
11755
12505
|
},
|
|
11756
12506
|
{
|
|
11757
12507
|
"name": "QToast",
|
|
11758
|
-
"description": "Toasts are commonly used to display quick feedback messages to the user, without removing focus from the main page. Show toasts with `useToast` and a `QToaster
|
|
12508
|
+
"description": "Toasts are commonly used to display quick feedback messages to the user, without removing focus from the main page. Show toasts with `useToast` and a `QToaster`. ## Accessibility - A `QToaster` announces each toast to screen readers. A toast used on its own takes `role=\"alert\"` for warnings and errors and `role=\"status\"` otherwise, but many screen readers skip a `status` toast that appears together with its message.",
|
|
11759
12509
|
"meta": {
|
|
11760
12510
|
"props": [
|
|
11761
12511
|
{
|
|
@@ -11879,8 +12629,8 @@
|
|
|
11879
12629
|
{
|
|
11880
12630
|
"name": "icons",
|
|
11881
12631
|
"type": {
|
|
11882
|
-
"kind": "
|
|
11883
|
-
"
|
|
12632
|
+
"kind": "unknown",
|
|
12633
|
+
"raw": "QIcons<\"info\" | \"success\" | \"warning\" | \"danger\" | \"close\"> | undefined"
|
|
11884
12634
|
},
|
|
11885
12635
|
"description": "Custom icon configurations: the severity icons and the dismiss icon.\nPass every key, or omit the prop to keep the defaults.",
|
|
11886
12636
|
"default": "DEFAULT_ICONS",
|
|
@@ -11958,7 +12708,7 @@
|
|
|
11958
12708
|
{
|
|
11959
12709
|
"title": "Elevation",
|
|
11960
12710
|
"description": "Supports different elevation levels. Defaults to medium.",
|
|
11961
|
-
"code": "<div style=\"display: flex; gap: 0.5rem;\">\n\t\t\t\t<q-toast\n\t\t\t\t\tv-for=\"(_, idx) in elevations\"\n\t\t\t\t\t:key=\"elevations[idx]\"\n\t\t\t\t\t:elevation=\"elevations[idx]\"\n\t\t\t\t\t:text=\"texts[idx]\"\n\t\t\t\t\tv-bind=\"args\" />\n\t\t\t</div>"
|
|
12711
|
+
"code": "<div style=\"display: flex; flex-wrap: wrap; gap: 0.5rem;\">\n\t\t\t\t<q-toast\n\t\t\t\t\tv-for=\"(_, idx) in elevations\"\n\t\t\t\t\t:key=\"elevations[idx]\"\n\t\t\t\t\t:elevation=\"elevations[idx]\"\n\t\t\t\t\t:text=\"texts[idx]\"\n\t\t\t\t\tv-bind=\"args\" />\n\t\t\t</div>"
|
|
11962
12712
|
},
|
|
11963
12713
|
{
|
|
11964
12714
|
"title": "Colors",
|
|
@@ -11982,13 +12732,28 @@
|
|
|
11982
12732
|
},
|
|
11983
12733
|
{
|
|
11984
12734
|
"title": "Outlined",
|
|
11985
|
-
"description": "Displays an outlined toast
|
|
12735
|
+
"description": "Displays an outlined toast: a border in its color, on an opaque background.",
|
|
11986
12736
|
"code": "<QToast color=\"danger\" variant=\"outlined\" elevation=\"none\" text=\"An unexpected error occured!\" />"
|
|
11987
12737
|
},
|
|
12738
|
+
{
|
|
12739
|
+
"title": "Outlined Warning Border",
|
|
12740
|
+
"description": "Warning (and other light colors) darken the text for contrast. The outlined border takes that same color, not the raw theme color.",
|
|
12741
|
+
"code": "<QToast color=\"warning\" variant=\"outlined\" elevation=\"none\" text=\"Your session expires in five minutes.\" />"
|
|
12742
|
+
},
|
|
12743
|
+
{
|
|
12744
|
+
"title": "Long Word",
|
|
12745
|
+
"description": "A long word, such as a file path or a link, wraps inside the toast instead of widening it.",
|
|
12746
|
+
"code": "<QToast color=\"info\" text=\"Saved as QuarterlySalesFiguresAndForecastByRegionFinalVersion2026.pdf\" />"
|
|
12747
|
+
},
|
|
12748
|
+
{
|
|
12749
|
+
"title": "Wrapped Text",
|
|
12750
|
+
"description": "A text that wraps onto more lines. The icon and the dismiss button stay on its first line, and the rest of the text runs below them.",
|
|
12751
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem; width: 320px\">\n\t\t\t\t<q-toast v-bind=\"args\" />\n\t\t\t\t<q-toast v-bind=\"args\" text=\"Your report is ready.\" />\n\t\t\t</div>"
|
|
12752
|
+
},
|
|
11988
12753
|
{
|
|
11989
12754
|
"title": "Custom Body",
|
|
11990
12755
|
"description": "The default slot of the toast allows for greater customization of its contents.",
|
|
11991
|
-
"code": "<q-toast v-bind=\"args\">\n\t\t\t\t<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t\t<q-skeleton-loader type=\"icon\" :width=\"40\" :height=\"40\" />\n\t\t\t\t\t<q-skeleton-loader type=\"text\"
|
|
12756
|
+
"code": "<q-toast v-bind=\"args\">\n\t\t\t\t<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t\t<q-skeleton-loader type=\"icon\" :width=\"40\" :height=\"40\" />\n\t\t\t\t\t<q-skeleton-loader type=\"text\" width=\"min(31.25rem, 100%)\" />\n\t\t\t\t\t<q-skeleton-loader type=\"text\" width=\"min(27rem, 100%)\" />\n\t\t\t\t</div>\n\t\t\t</q-toast>"
|
|
11992
12757
|
},
|
|
11993
12758
|
{
|
|
11994
12759
|
"title": "Header Slots",
|
|
@@ -12049,8 +12814,8 @@
|
|
|
12049
12814
|
{
|
|
12050
12815
|
"name": "icons",
|
|
12051
12816
|
"type": {
|
|
12052
|
-
"kind": "
|
|
12053
|
-
"
|
|
12817
|
+
"kind": "unknown",
|
|
12818
|
+
"raw": "QIcons<\"help\"> | undefined"
|
|
12054
12819
|
},
|
|
12055
12820
|
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
12056
12821
|
"required": false,
|
|
@@ -12244,14 +13009,9 @@
|
|
|
12244
13009
|
"description": "",
|
|
12245
13010
|
"code": "<q-toggle v-bind=\"args\" aria-label=\"Underline\">\n\t\t <q-icon icon=\"format-underline\" />\n\t\t</q-toggle>"
|
|
12246
13011
|
},
|
|
12247
|
-
{
|
|
12248
|
-
"title": "Colors",
|
|
12249
|
-
"description": "A pressed toggle uses its own `color`: a tonal fill and a label that clears 4.5:1 on it.",
|
|
12250
|
-
"code": "<div style=\"display: flex; gap: 0.5rem;\">\n\t\t <q-toggle\n\t\t v-for=\"color in colors\"\n\t\t :key=\"color\"\n\t\t :model-value=\"true\"\n\t\t :color=\"color\"\n\t\t :aria-label=\"'Underline in ' + color\">\n\t\t <q-icon icon=\"format-underline\" />\n\t\t </q-toggle>\n\t\t</div>"
|
|
12251
|
-
},
|
|
12252
13012
|
{
|
|
12253
13013
|
"title": "Borderless Colors",
|
|
12254
|
-
"description": "A pressed borderless toggle
|
|
13014
|
+
"description": "A pressed borderless toggle fills solid in its own color too, with the text that goes on that color.",
|
|
12255
13015
|
"code": "<div style=\"display: flex; gap: 0.5rem;\">\n\t\t <q-toggle\n\t\t v-for=\"color in colors\"\n\t\t :key=\"color\"\n\t\t :model-value=\"true\"\n\t\t :color=\"color\"\n\t\t borderless\n\t\t :aria-label=\"'Underline in ' + color\">\n\t\t <q-icon icon=\"format-underline\" />\n\t\t </q-toggle>\n\t\t <q-toggle borderless aria-label=\"Bold\">\n\t\t <q-icon icon=\"format-bold\" />\n\t\t </q-toggle>\n\t\t</div>"
|
|
12256
13016
|
}
|
|
12257
13017
|
]
|
|
@@ -12669,6 +13429,11 @@
|
|
|
12669
13429
|
"title": "HTML Support",
|
|
12670
13430
|
"description": "Enables HTML support for the tooltip text.",
|
|
12671
13431
|
"code": "<QTooltip text=\"This is a tooltip. Did you know that the contents of tooltips can be formatted?<br><br>HTML is fully supported, so text formatting options such as <b>bold</b>, <i>italic</i>, or even<br>newlines can be used.\" />"
|
|
13432
|
+
},
|
|
13433
|
+
{
|
|
13434
|
+
"title": "Click Trigger",
|
|
13435
|
+
"description": "A tooltip that opens on a click of its anchor (`trigger: 'click'`), as a toggletip. From the keyboard too, focus stays on the anchor, which the tooltip describes: the tooltip itself takes no focus, so Tab goes on to what follows the anchor and closes it, and Escape closes it.",
|
|
13436
|
+
"code": "<q-button id=\"click-trigger-anchor\" label=\"Info\" />\n\t\t\t<q-tooltip anchor=\"#click-trigger-anchor\" trigger=\"click\" text=\"More about this\" />\n\t\t\t<q-button label=\"Next\" />"
|
|
12672
13437
|
}
|
|
12673
13438
|
]
|
|
12674
13439
|
}
|
|
@@ -12696,7 +13461,7 @@
|
|
|
12696
13461
|
"name": "QDialogItem",
|
|
12697
13462
|
"kind": "type",
|
|
12698
13463
|
"description": "Public view of a dialog managed by {@link useDialog}. `id` is set when the dialog registers during setup. Prefer `await addDialog(...)` to obtain the id rather than reading it from this list before the promise resolves.",
|
|
12699
|
-
"signature": "type QDialogItem = {\n id?: string;\n props: QDialogProps;\n options?: QDialogOptions;\n handlers?: QDialogHandlers;\n};"
|
|
13464
|
+
"signature": "type QDialogItem = {\n id?: string;\n props: QDialogProps & {\n modelValue?: boolean;\n };\n options?: QDialogOptions;\n handlers?: QDialogHandlers;\n};"
|
|
12700
13465
|
},
|
|
12701
13466
|
{
|
|
12702
13467
|
"name": "QThemeDefinition",
|
|
@@ -13347,7 +14112,7 @@
|
|
|
13347
14112
|
"name": "completePartialDateInput",
|
|
13348
14113
|
"kind": "function",
|
|
13349
14114
|
"description": "Completes trailing partial numeric segments with zero defaults. Partial digits are right-padded; missing suffix segments use zero-filled defaults.",
|
|
13350
|
-
"signature": "completePartialDateInput(dateStr: string, format: string, labels?:
|
|
14115
|
+
"signature": "completePartialDateInput(dateStr: string, format: string, labels?: QDateParserLabels | undefined): string | null",
|
|
13351
14116
|
"parameters": [
|
|
13352
14117
|
{
|
|
13353
14118
|
"name": "dateStr",
|
|
@@ -13363,7 +14128,7 @@
|
|
|
13363
14128
|
},
|
|
13364
14129
|
{
|
|
13365
14130
|
"name": "labels",
|
|
13366
|
-
"type": "
|
|
14131
|
+
"type": "QDateParserLabels | undefined",
|
|
13367
14132
|
"description": "Optional localized text resolvers, to read the date before a missing offset.",
|
|
13368
14133
|
"optional": true
|
|
13369
14134
|
}
|
|
@@ -13391,23 +14156,11 @@
|
|
|
13391
14156
|
"description": "Mask string."
|
|
13392
14157
|
}
|
|
13393
14158
|
},
|
|
13394
|
-
{
|
|
13395
|
-
"name": "DateFormatterLabels",
|
|
13396
|
-
"kind": "type",
|
|
13397
|
-
"description": "Formats a date according to a format string.",
|
|
13398
|
-
"signature": "type DateFormatterLabels = {\n getMonthName?: (month: number, short: boolean) => string;\n getWeekdayName?: (weekday: number, short: boolean) => string;\n};"
|
|
13399
|
-
},
|
|
13400
|
-
{
|
|
13401
|
-
"name": "DateParserLabels",
|
|
13402
|
-
"kind": "type",
|
|
13403
|
-
"description": "Optional parsing label resolvers used by `parseDate`. English names are always read too.",
|
|
13404
|
-
"signature": "type DateParserLabels = {\n getMonthName?: (month: number, short: boolean) => string;\n getWeekdayName?: (weekday: number, short: boolean) => string;\n getMonthIndex?: (monthName: string, short: boolean) => number | null;\n getWeekdayIndex?: (weekdayName: string, short: boolean) => number | null;\n};"
|
|
13405
|
-
},
|
|
13406
14159
|
{
|
|
13407
14160
|
"name": "formatDate",
|
|
13408
14161
|
"kind": "function",
|
|
13409
14162
|
"description": "Formats a date according to a format string. Supports numeric and textual date/time tokens and quoted literals.",
|
|
13410
|
-
"signature": "formatDate(date: Date, format: string, labels?:
|
|
14163
|
+
"signature": "formatDate(date: Date, format: string, labels?: QDateFormatterLabels | undefined): string",
|
|
13411
14164
|
"parameters": [
|
|
13412
14165
|
{
|
|
13413
14166
|
"name": "date",
|
|
@@ -13423,7 +14176,7 @@
|
|
|
13423
14176
|
},
|
|
13424
14177
|
{
|
|
13425
14178
|
"name": "labels",
|
|
13426
|
-
"type": "
|
|
14179
|
+
"type": "QDateFormatterLabels | undefined",
|
|
13427
14180
|
"description": "Optional localized text resolvers for month/weekday names.",
|
|
13428
14181
|
"optional": true
|
|
13429
14182
|
}
|
|
@@ -13751,11 +14504,35 @@
|
|
|
13751
14504
|
"description": "Left-zero-padded string value."
|
|
13752
14505
|
}
|
|
13753
14506
|
},
|
|
14507
|
+
{
|
|
14508
|
+
"name": "padNumericSegments",
|
|
14509
|
+
"kind": "function",
|
|
14510
|
+
"description": "Pads fully-typed numeric segments to their width for the provided format, such as `5/4/2026 9:05` to `05/04/2026 09:05` in `dd/MM/yyyy HH:mm`. Unlike {@link clampNumericSegments}, it never changes a value: a date or time that does not exist, such as `31/02/2026`, stays as it is, for a parser to reject.",
|
|
14511
|
+
"signature": "padNumericSegments(value: string, format: string): string",
|
|
14512
|
+
"parameters": [
|
|
14513
|
+
{
|
|
14514
|
+
"name": "value",
|
|
14515
|
+
"type": "string",
|
|
14516
|
+
"description": "Masked user input.",
|
|
14517
|
+
"optional": false
|
|
14518
|
+
},
|
|
14519
|
+
{
|
|
14520
|
+
"name": "format",
|
|
14521
|
+
"type": "string",
|
|
14522
|
+
"description": "Date/time format pattern.",
|
|
14523
|
+
"optional": false
|
|
14524
|
+
}
|
|
14525
|
+
],
|
|
14526
|
+
"returns": {
|
|
14527
|
+
"type": "string",
|
|
14528
|
+
"description": "Input with its numeric segments padded."
|
|
14529
|
+
}
|
|
14530
|
+
},
|
|
13754
14531
|
{
|
|
13755
14532
|
"name": "parseDate",
|
|
13756
14533
|
"kind": "function",
|
|
13757
14534
|
"description": "Parses a date string according to a format string. Supports quoted literals, milliseconds, meridiem, and textual month/weekday tokens. A weekday name the date does not fall on makes the input invalid, unless `options.ignoreWeekday` is set.",
|
|
13758
|
-
"signature": "parseDate(dateStr: string, format: string, labels?:
|
|
14535
|
+
"signature": "parseDate(dateStr: string, format: string, labels?: QDateParserLabels | undefined, options?: { ignoreWeekday?: boolean; } | undefined): Date | null",
|
|
13759
14536
|
"parameters": [
|
|
13760
14537
|
{
|
|
13761
14538
|
"name": "dateStr",
|
|
@@ -13771,7 +14548,7 @@
|
|
|
13771
14548
|
},
|
|
13772
14549
|
{
|
|
13773
14550
|
"name": "labels",
|
|
13774
|
-
"type": "
|
|
14551
|
+
"type": "QDateParserLabels | undefined",
|
|
13775
14552
|
"description": "Optional localized text resolvers for month/weekday parsing.",
|
|
13776
14553
|
"optional": true
|
|
13777
14554
|
},
|
|
@@ -13791,7 +14568,7 @@
|
|
|
13791
14568
|
"name": "parseDateWithCompletion",
|
|
13792
14569
|
"kind": "function",
|
|
13793
14570
|
"description": "Parses a date string, completing trailing partial numeric segments when needed.",
|
|
13794
|
-
"signature": "parseDateWithCompletion(dateStr: string, format: string, labels?:
|
|
14571
|
+
"signature": "parseDateWithCompletion(dateStr: string, format: string, labels?: QDateParserLabels | undefined, options?: { ignoreWeekday?: boolean; } | undefined): Date | null",
|
|
13795
14572
|
"parameters": [
|
|
13796
14573
|
{
|
|
13797
14574
|
"name": "dateStr",
|
|
@@ -13807,7 +14584,7 @@
|
|
|
13807
14584
|
},
|
|
13808
14585
|
{
|
|
13809
14586
|
"name": "labels",
|
|
13810
|
-
"type": "
|
|
14587
|
+
"type": "QDateParserLabels | undefined",
|
|
13811
14588
|
"description": "Optional localized text resolvers for month/weekday parsing.",
|
|
13812
14589
|
"optional": true
|
|
13813
14590
|
},
|
|
@@ -13841,6 +14618,18 @@
|
|
|
13841
14618
|
"description": "Parsed `Date` instance or `null` when the string is not ISO-shaped or invalid."
|
|
13842
14619
|
}
|
|
13843
14620
|
},
|
|
14621
|
+
{
|
|
14622
|
+
"name": "QDateFormatterLabels",
|
|
14623
|
+
"kind": "type",
|
|
14624
|
+
"description": "Formats a date according to a format string.",
|
|
14625
|
+
"signature": "type QDateFormatterLabels = {\n getMonthName?: (month: number, short: boolean) => string;\n getWeekdayName?: (weekday: number, short: boolean) => string;\n};"
|
|
14626
|
+
},
|
|
14627
|
+
{
|
|
14628
|
+
"name": "QDateParserLabels",
|
|
14629
|
+
"kind": "type",
|
|
14630
|
+
"description": "Optional parsing label resolvers used by `parseDate`. English names are always read too.",
|
|
14631
|
+
"signature": "type QDateParserLabels = {\n getMonthName?: (month: number, short: boolean) => string;\n getWeekdayName?: (weekday: number, short: boolean) => string;\n getMonthIndex?: (monthName: string, short: boolean) => number | null;\n getWeekdayIndex?: (weekdayName: string, short: boolean) => number | null;\n};"
|
|
14632
|
+
},
|
|
13844
14633
|
{
|
|
13845
14634
|
"name": "uses12HourFormat",
|
|
13846
14635
|
"kind": "function",
|
|
@@ -13945,7 +14734,7 @@
|
|
|
13945
14734
|
{
|
|
13946
14735
|
"name": "hasSlotContent",
|
|
13947
14736
|
"kind": "function",
|
|
13948
|
-
"description": "Whether a slot renders anything: a node that is not a comment, looking inside fragments. A slot can be passed and still render nothing, such as a template whose only element has a false `v-if`, which Vue renders as a comment. `$slots.name` is set all the same, so a wrapper shown on it would render empty. By default this is exactly the rule Vue uses to show a slot's fallback content (`ensureValidVNode`), so a check and a fallback never disagree. Only `ignoreBlankText`
|
|
14737
|
+
"description": "Whether a slot renders anything: a node that is not a comment, looking inside fragments. A slot can be passed and still render nothing, such as a template whose only element has a false `v-if`, which Vue renders as a comment. `$slots.name` is set all the same, so a wrapper shown on it would render empty. By default this is exactly the rule Vue uses to show a slot's fallback content (`ensureValidVNode`), so a check and a fallback never disagree. Only `ignoreBlankText` and `textOnly` depart from it. Call it while rendering, in the template or a function the template calls, never in a `computed`: the slots object is not reactive, so a computed keeps its first answer.",
|
|
13949
14738
|
"signature": "hasSlotContent(slot: ((props: never) => unknown) | undefined, options?: QHasSlotContentOptions): boolean",
|
|
13950
14739
|
"parameters": [
|
|
13951
14740
|
{
|
|
@@ -13957,7 +14746,7 @@
|
|
|
13957
14746
|
{
|
|
13958
14747
|
"name": "options",
|
|
13959
14748
|
"type": "QHasSlotContentOptions",
|
|
13960
|
-
"description": "The props to pass to a scoped slot, and whether
|
|
14749
|
+
"description": "The props to pass to a scoped slot, whether blank text counts, and whether only text does.",
|
|
13961
14750
|
"optional": true
|
|
13962
14751
|
}
|
|
13963
14752
|
],
|
|
@@ -13970,7 +14759,7 @@
|
|
|
13970
14759
|
"name": "QHasSlotContentOptions",
|
|
13971
14760
|
"kind": "type",
|
|
13972
14761
|
"description": "Options for {@link hasSlotContent}.",
|
|
13973
|
-
"signature": "type QHasSlotContentOptions = {\n props?: Record<string, unknown>;\n ignoreBlankText?: boolean;\n};"
|
|
14762
|
+
"signature": "type QHasSlotContentOptions = {\n props?: Record<string, unknown>;\n ignoreBlankText?: boolean;\n textOnly?: boolean;\n};"
|
|
13974
14763
|
}
|
|
13975
14764
|
]
|
|
13976
14765
|
}
|