@quidgest/ui 0.27.1 → 0.29.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 +101 -8
- package/README.md +19 -0
- package/dist/json/api.json +2787 -366
- package/dist/manifest/components.json +1 -2
- package/dist/ui.css +641 -203
- package/dist/ui.esm.js +1631 -1608
- package/dist/ui.js +1314 -1292
- package/dist/ui.min.css +1 -1
- package/dist/ui.min.js +1314 -1292
- package/dist/ui.scss +483 -152
- package/esm/components/QAccordion/QAccordion.d.ts +8 -4
- package/esm/components/QAccordion/QAccordion.d.ts.map +1 -1
- package/esm/components/QAccordion/QAccordion.vue.js +38 -30
- package/esm/components/QAccordion/QAccordionItem.d.ts +4 -1
- package/esm/components/QAccordion/QAccordionItem.d.ts.map +1 -1
- package/esm/components/QAccordion/QAccordionItem.vue.js +37 -6
- package/esm/components/QAccordion/constants.d.ts +9 -0
- package/esm/components/QAccordion/constants.d.ts.map +1 -0
- package/esm/components/QAccordion/constants.js +5 -0
- package/esm/components/QAccordion/index.d.ts +38 -14
- package/esm/components/QAccordion/index.d.ts.map +1 -1
- package/esm/components/QAccordion/types.d.ts +17 -0
- package/esm/components/QAccordion/types.d.ts.map +1 -1
- package/esm/components/QAlert/QAlert.d.ts +68 -0
- package/esm/components/QAlert/QAlert.d.ts.map +1 -0
- package/esm/components/QAlert/QAlert.vue.js +113 -0
- package/esm/components/QAlert/QAlert2.vue.js +5 -0
- package/esm/components/QAlert/constants.d.ts +25 -0
- package/esm/components/QAlert/constants.d.ts.map +1 -0
- package/esm/components/QAlert/constants.js +11 -0
- package/esm/components/QAlert/index.d.ts +56 -0
- package/esm/components/QAlert/index.d.ts.map +1 -0
- package/esm/components/QAlert/index.js +6 -0
- package/esm/components/QAlert/types.d.ts +85 -0
- package/esm/components/QAlert/types.d.ts.map +1 -0
- package/esm/components/QAvatar/QAvatar.d.ts +1 -1
- package/esm/components/QAvatar/QAvatar.d.ts.map +1 -1
- package/esm/components/QAvatar/QAvatar.vue.js +19 -12
- package/esm/components/QAvatar/index.d.ts +3 -3
- package/esm/components/QAvatar/types.d.ts +3 -2
- package/esm/components/QAvatar/types.d.ts.map +1 -1
- package/esm/components/QBadge/QBadge.d.ts +1 -1
- package/esm/components/QBadge/QBadge.d.ts.map +1 -1
- package/esm/components/QBadge/QBadge.vue.js +41 -42
- package/esm/components/QBadge/constants.d.ts +1 -1
- package/esm/components/QBadge/constants.js +1 -1
- package/esm/components/QBadge/index.d.ts +3 -3
- package/esm/components/QBadgeIndicator/QBadgeIndicator.d.ts.map +1 -1
- package/esm/components/QBadgeIndicator/QBadgeIndicator.vue.js +14 -10
- package/esm/components/QBreadcrumbs/QBreadcrumb.d.ts +17 -4
- package/esm/components/QBreadcrumbs/QBreadcrumb.d.ts.map +1 -1
- package/esm/components/QBreadcrumbs/QBreadcrumb.vue.js +12 -7
- package/esm/components/QBreadcrumbs/QBreadcrumbs.d.ts.map +1 -1
- package/esm/components/QBreadcrumbs/QBreadcrumbs.vue.js +26 -32
- package/esm/components/QBreadcrumbs/constants.d.ts +11 -2
- package/esm/components/QBreadcrumbs/constants.d.ts.map +1 -1
- package/esm/components/QBreadcrumbs/constants.js +5 -3
- package/esm/components/QBreadcrumbs/context.d.ts +5 -5
- package/esm/components/QBreadcrumbs/context.d.ts.map +1 -1
- package/esm/components/QBreadcrumbs/index.d.ts +17 -4
- package/esm/components/QBreadcrumbs/index.d.ts.map +1 -1
- package/esm/components/QBreadcrumbs/types.d.ts +2 -0
- package/esm/components/QBreadcrumbs/types.d.ts.map +1 -1
- package/esm/components/QButton/QButton.d.ts +12 -4
- package/esm/components/QButton/QButton.d.ts.map +1 -1
- package/esm/components/QButton/QButton.vue.js +118 -66
- package/esm/components/QButton/constants.d.ts +11 -0
- package/esm/components/QButton/constants.d.ts.map +1 -0
- package/esm/components/QButton/constants.js +5 -0
- package/esm/components/QButton/index.d.ts +15 -4
- package/esm/components/QButton/index.d.ts.map +1 -1
- package/esm/components/QButton/types.d.ts +52 -0
- package/esm/components/QButton/types.d.ts.map +1 -1
- package/esm/components/QButtonGroup/QButtonGroup.vue.js +18 -18
- package/esm/components/QCard/QCard.d.ts.map +1 -1
- package/esm/components/QCard/QCard.vue.js +51 -48
- package/esm/components/QCarousel/QCarousel.d.ts +1 -1
- package/esm/components/QCarousel/QCarousel.d.ts.map +1 -1
- package/esm/components/QCarousel/QCarousel.vue.js +105 -101
- package/esm/components/QCarousel/constants.d.ts +3 -2
- package/esm/components/QCarousel/constants.d.ts.map +1 -1
- package/esm/components/QCarousel/constants.js +4 -3
- package/esm/components/QCarousel/index.d.ts +3 -3
- package/esm/components/QCheckbox/QCheckbox.d.ts +18 -6
- package/esm/components/QCheckbox/QCheckbox.d.ts.map +1 -1
- package/esm/components/QCheckbox/QCheckbox.vue.js +112 -94
- package/esm/components/QCheckbox/constants.d.ts +3 -0
- package/esm/components/QCheckbox/constants.d.ts.map +1 -1
- package/esm/components/QCheckbox/constants.js +4 -2
- package/esm/components/QCheckbox/index.d.ts +57 -47
- package/esm/components/QCheckbox/index.d.ts.map +1 -1
- package/esm/components/QCheckbox/index.js +2 -3
- package/esm/components/QCheckbox/types.d.ts +10 -7
- package/esm/components/QCheckbox/types.d.ts.map +1 -1
- package/esm/components/QCollapsible/QCollapsible.d.ts +1 -1
- package/esm/components/QCollapsible/QCollapsible.vue.js +23 -23
- package/esm/components/QCollapsible/index.d.ts +3 -3
- package/esm/components/QColorPicker/QColorPicker.d.ts +19 -2
- package/esm/components/QColorPicker/QColorPicker.d.ts.map +1 -1
- package/esm/components/QColorPicker/QColorPicker.vue.js +42 -32
- package/esm/components/QColorPicker/constants.d.ts +10 -0
- package/esm/components/QColorPicker/constants.d.ts.map +1 -1
- package/esm/components/QColorPicker/constants.js +6 -2
- package/esm/components/QColorPicker/index.d.ts +63 -6
- package/esm/components/QColorPicker/index.d.ts.map +1 -1
- package/esm/components/QColorPicker/types.d.ts +11 -3
- package/esm/components/QColorPicker/types.d.ts.map +1 -1
- package/esm/components/QCombobox/QCombobox.d.ts +677 -256
- package/esm/components/QCombobox/QCombobox.d.ts.map +1 -1
- package/esm/components/QCombobox/QCombobox.vue.js +134 -114
- package/esm/components/QCombobox/constants.d.ts +10 -0
- package/esm/components/QCombobox/constants.d.ts.map +1 -1
- package/esm/components/QCombobox/constants.js +13 -5
- package/esm/components/QCombobox/index.d.ts +900 -636
- package/esm/components/QCombobox/index.d.ts.map +1 -1
- package/esm/components/QCombobox/types.d.ts +12 -2
- package/esm/components/QCombobox/types.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/QDateTimePicker.d.ts +568 -49
- package/esm/components/QDateTimePicker/QDateTimePicker.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/QDateTimePicker.vue.js +284 -279
- package/esm/components/QDateTimePicker/constants.d.ts +4 -0
- package/esm/components/QDateTimePicker/constants.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/constants.js +12 -6
- package/esm/components/QDateTimePicker/index.d.ts +492 -32
- package/esm/components/QDateTimePicker/index.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/types.d.ts +4 -2
- package/esm/components/QDateTimePicker/types.d.ts.map +1 -1
- package/esm/components/QDialog/QDialog.d.ts +2 -2
- package/esm/components/QDialog/QDialog.d.ts.map +1 -1
- package/esm/components/QDialog/QDialog.vue.js +29 -25
- package/esm/components/QDialog/QDialogProvider.d.ts.map +1 -1
- package/esm/components/QDialog/constants.d.ts +8 -0
- package/esm/components/QDialog/constants.d.ts.map +1 -1
- package/esm/components/QDialog/constants.js +9 -4
- package/esm/components/QDialog/index.d.ts +9 -9
- package/esm/components/QDialog/types.d.ts +7 -5
- package/esm/components/QDialog/types.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/QDropdownMenu.d.ts +1 -1
- package/esm/components/QDropdownMenu/QDropdownMenu.vue.js +0 -1
- package/esm/components/QDropdownMenu/QDropdownMenuContent.d.ts +29 -15
- package/esm/components/QDropdownMenu/QDropdownMenuContent.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/QDropdownMenuContent.vue.js +127 -112
- package/esm/components/QDropdownMenu/constants.d.ts +6 -0
- package/esm/components/QDropdownMenu/constants.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/constants.js +6 -2
- package/esm/components/QDropdownMenu/index.d.ts +3 -6
- package/esm/components/QDropdownMenu/index.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/types.d.ts +9 -7
- package/esm/components/QDropdownMenu/types.d.ts.map +1 -1
- package/esm/components/QField/QField.d.ts +228 -3
- package/esm/components/QField/QField.d.ts.map +1 -1
- package/esm/components/QField/QField.vue.js +99 -36
- package/esm/components/QField/constants.d.ts +11 -0
- package/esm/components/QField/constants.d.ts.map +1 -0
- package/esm/components/QField/constants.js +5 -0
- package/esm/components/QField/index.d.ts +129 -5
- package/esm/components/QField/index.d.ts.map +1 -1
- package/esm/components/QField/types.d.ts +37 -1
- package/esm/components/QField/types.d.ts.map +1 -1
- package/esm/components/QFileUpload/QFileUpload.d.ts +35 -3
- package/esm/components/QFileUpload/QFileUpload.d.ts.map +1 -1
- package/esm/components/QFileUpload/QFileUpload.vue.js +107 -85
- package/esm/components/QFileUpload/constants.d.ts +4 -0
- package/esm/components/QFileUpload/constants.d.ts.map +1 -1
- package/esm/components/QFileUpload/constants.js +6 -3
- package/esm/components/QFileUpload/index.d.ts +108 -9
- package/esm/components/QFileUpload/index.d.ts.map +1 -1
- package/esm/components/QFocusWrap/QFocusWrap.d.ts.map +1 -1
- package/esm/components/QFocusWrap/QFocusWrap.vue.js +38 -51
- package/esm/components/QIcon/QIconFont.d.ts +1 -3
- package/esm/components/QIcon/QIconFont.d.ts.map +1 -1
- package/esm/components/QIcon/QIconFont.vue.js +2 -2
- package/esm/components/QIcon/QIconSvg.d.ts +1 -3
- package/esm/components/QIcon/QIconSvg.d.ts.map +1 -1
- package/esm/components/QIcon/QIconSvg.vue.js +1 -1
- package/esm/components/QIcon/QSvgSymbol.d.ts +3 -2
- package/esm/components/QIcon/QSvgSymbol.d.ts.map +1 -1
- package/esm/components/QIcon/QSvgSymbol.vue.js +37 -28
- package/esm/components/QIcon/index.d.ts +2 -6
- package/esm/components/QIcon/index.d.ts.map +1 -1
- package/esm/components/QIcon/index.js +6 -6
- package/esm/components/QIcon/types.d.ts +7 -3
- package/esm/components/QIcon/types.d.ts.map +1 -1
- package/esm/components/QInputGroup/QInputGroup.d.ts +263 -12
- package/esm/components/QInputGroup/QInputGroup.d.ts.map +1 -1
- package/esm/components/QInputGroup/QInputGroup.vue.js +76 -35
- package/esm/components/QInputGroup/index.d.ts +138 -9
- package/esm/components/QInputGroup/index.d.ts.map +1 -1
- package/esm/components/QInputGroup/types.d.ts +15 -1
- package/esm/components/QInputGroup/types.d.ts.map +1 -1
- package/esm/components/QLabel/QLabel.d.ts.map +1 -1
- package/esm/components/QLabel/QLabel.vue.js +1 -0
- package/esm/components/QList/QList.d.ts +18 -10
- package/esm/components/QList/QList.d.ts.map +1 -1
- package/esm/components/QList/QList.vue.js +131 -125
- package/esm/components/QList/QListItem.d.ts +6 -2
- package/esm/components/QList/QListItem.d.ts.map +1 -1
- package/esm/components/QList/QListItem.vue.js +54 -41
- package/esm/components/QList/groupListItems.d.ts +25 -0
- package/esm/components/QList/groupListItems.d.ts.map +1 -0
- package/esm/components/QList/groupListItems.js +18 -0
- package/esm/components/QList/index.d.ts +14 -6
- package/esm/components/QList/index.d.ts.map +1 -1
- package/esm/components/QList/types.d.ts +23 -0
- package/esm/components/QList/types.d.ts.map +1 -1
- package/esm/components/QObfuscation/QObfuscation.d.ts +28 -3
- package/esm/components/QObfuscation/QObfuscation.d.ts.map +1 -1
- package/esm/components/QObfuscation/QObfuscation.vue.js +119 -89
- package/esm/components/QObfuscation/constants.d.ts +4 -0
- package/esm/components/QObfuscation/constants.d.ts.map +1 -1
- package/esm/components/QObfuscation/constants.js +6 -3
- package/esm/components/QObfuscation/index.d.ts +83 -9
- package/esm/components/QObfuscation/index.d.ts.map +1 -1
- package/esm/components/QOverflow/QOverflow.d.ts +6 -1
- package/esm/components/QOverflow/QOverflow.d.ts.map +1 -1
- package/esm/components/QOverflow/QOverflow.vue.js +94 -99
- package/esm/components/QOverflow/constants.d.ts +6 -3
- package/esm/components/QOverflow/constants.d.ts.map +1 -1
- package/esm/components/QOverflow/constants.js +2 -2
- package/esm/components/QOverflow/index.d.ts +3 -3
- package/esm/components/QOverlay/QOverlay.d.ts +2 -2
- package/esm/components/QOverlay/QOverlay.d.ts.map +1 -1
- package/esm/components/QOverlay/QOverlay.vue.js +125 -117
- package/esm/components/QOverlay/index.d.ts +6 -6
- package/esm/components/QOverlay/types.d.ts +9 -2
- package/esm/components/QOverlay/types.d.ts.map +1 -1
- package/esm/components/QPasswordField/QPasswordField.d.ts +412 -25
- package/esm/components/QPasswordField/QPasswordField.d.ts.map +1 -1
- package/esm/components/QPasswordField/QPasswordField.vue.js +51 -35
- package/esm/components/QPasswordField/QPasswordFieldMeterOverlay.vue.js +1 -0
- package/esm/components/QPasswordField/constants.d.ts +8 -0
- package/esm/components/QPasswordField/constants.d.ts.map +1 -1
- package/esm/components/QPasswordField/constants.js +8 -3
- package/esm/components/QPasswordField/index.d.ts +274 -15
- package/esm/components/QPasswordField/index.d.ts.map +1 -1
- package/esm/components/QPasswordField/types.d.ts +14 -2
- package/esm/components/QPasswordField/types.d.ts.map +1 -1
- package/esm/components/QPhoneField/QPhoneField.d.ts +1768 -132
- package/esm/components/QPhoneField/QPhoneField.d.ts.map +1 -1
- package/esm/components/QPhoneField/QPhoneField.vue.js +194 -168
- package/esm/components/QPhoneField/constants.d.ts +24 -0
- package/esm/components/QPhoneField/constants.d.ts.map +1 -1
- package/esm/components/QPhoneField/constants.js +14 -3
- package/esm/components/QPhoneField/index.d.ts +987 -68
- package/esm/components/QPhoneField/index.d.ts.map +1 -1
- package/esm/components/QPhoneField/types.d.ts +10 -2
- package/esm/components/QPhoneField/types.d.ts.map +1 -1
- package/esm/components/QPopover/QPopover.d.ts +1 -1
- package/esm/components/QPopover/index.d.ts +3 -3
- package/esm/components/QPropertyList/QPropertyList.d.ts.map +1 -1
- package/esm/components/QPropertyList/QPropertyList.vue.js +63 -59
- package/esm/components/QPropertyList/QPropertyListGroup.vue.js +5 -6
- package/esm/components/QPropertyList/QPropertyListPanel.vue.js +0 -1
- package/esm/components/QPropertyList/QPropertyListRow.d.ts +1 -1
- package/esm/components/QPropertyList/QPropertyListRow.vue.js +2 -2
- package/esm/components/QPropertyList/index.d.ts +2 -4
- package/esm/components/QPropertyList/index.d.ts.map +1 -1
- package/esm/components/QPropertyList/types.d.ts +0 -12
- package/esm/components/QPropertyList/types.d.ts.map +1 -1
- package/esm/components/QRadioGroup/QRadioButton.d.ts +1 -1
- package/esm/components/QRadioGroup/QRadioButton.d.ts.map +1 -1
- package/esm/components/QRadioGroup/QRadioButton.vue.js +49 -45
- package/esm/components/QRadioGroup/QRadioGroup.d.ts.map +1 -1
- package/esm/components/QRadioGroup/QRadioGroup.vue.js +56 -41
- package/esm/components/QRadioGroup/index.d.ts +3 -3
- package/esm/components/QRadioGroup/types.d.ts +5 -4
- package/esm/components/QRadioGroup/types.d.ts.map +1 -1
- package/esm/components/QRemoveScrollBar/QRemoveScrollBar.d.ts.map +1 -1
- package/esm/components/QRemoveScrollBar/QRemoveScrollBar.vue.js +7 -7
- package/esm/components/QRemoveScrollBar/utils/gap.d.ts +0 -6
- package/esm/components/QRemoveScrollBar/utils/gap.d.ts.map +1 -1
- package/esm/components/QRemoveScrollBar/utils/gap.js +12 -18
- package/esm/components/QRemoveScrollBar/utils/stylesheet.d.ts +11 -0
- package/esm/components/QRemoveScrollBar/utils/stylesheet.d.ts.map +1 -1
- package/esm/components/QRemoveScrollBar/utils/stylesheet.js +5 -5
- package/esm/components/QSection/QSection.d.ts +11 -3
- package/esm/components/QSection/QSection.d.ts.map +1 -1
- package/esm/components/QSection/QSection.vue.js +76 -21
- package/esm/components/QSection/constants.d.ts +11 -0
- package/esm/components/QSection/constants.d.ts.map +1 -0
- package/esm/components/QSection/constants.js +5 -0
- package/esm/components/QSection/index.d.ts +12 -1
- package/esm/components/QSection/index.d.ts.map +1 -1
- package/esm/components/QSection/types.d.ts +39 -0
- package/esm/components/QSection/types.d.ts.map +1 -1
- package/esm/components/QSelect/QSelect.d.ts +477 -36
- package/esm/components/QSelect/QSelect.d.ts.map +1 -1
- package/esm/components/QSelect/QSelect.vue.js +273 -212
- package/esm/components/QSelect/constants.d.ts +14 -1
- package/esm/components/QSelect/constants.d.ts.map +1 -1
- package/esm/components/QSelect/constants.js +14 -8
- package/esm/components/QSelect/index.d.ts +332 -28
- package/esm/components/QSelect/index.d.ts.map +1 -1
- package/esm/components/QSelect/types.d.ts +12 -2
- package/esm/components/QSelect/types.d.ts.map +1 -1
- package/esm/components/QSidebar/QSidebar.d.ts.map +1 -1
- package/esm/components/QSidebar/QSidebar.vue.js +68 -68
- package/esm/components/QSidebar/QSidebarAnchor.vue.js +1 -1
- package/esm/components/QSidebar/QSidebarItem.d.ts +32 -2
- package/esm/components/QSidebar/QSidebarItem.d.ts.map +1 -1
- package/esm/components/QSidebar/QSidebarItem.vue.js +1 -1
- package/esm/components/QSidebar/QSidebarPanel.d.ts.map +1 -1
- package/esm/components/QSidebar/QSidebarPanel.vue.js +5 -5
- package/esm/components/QSidebar/context.d.ts +3 -3
- package/esm/components/QSidebar/context.d.ts.map +1 -1
- package/esm/components/QSidebar/index.d.ts +16 -1
- package/esm/components/QSidebar/index.d.ts.map +1 -1
- package/esm/components/QSpinnerLoader/index.js +3 -3
- package/esm/components/QSteps/QStepHeader.d.ts.map +1 -1
- package/esm/components/QSteps/QStepHeader.vue.js +1 -0
- package/esm/components/QSteps/QSteps.d.ts +4 -4
- package/esm/components/QSteps/QSteps.d.ts.map +1 -1
- package/esm/components/QSteps/QSteps.vue.js +152 -130
- package/esm/components/QSteps/QStepsNav.vue.js +6 -6
- package/esm/components/QSteps/constants.d.ts +16 -1
- package/esm/components/QSteps/constants.d.ts.map +1 -1
- package/esm/components/QSteps/constants.js +6 -3
- package/esm/components/QSteps/index.d.ts +2 -2
- package/esm/components/QSteps/types.d.ts +13 -4
- package/esm/components/QSteps/types.d.ts.map +1 -1
- package/esm/components/QSwitch/QSwitch.d.ts +195 -0
- package/esm/components/QSwitch/QSwitch.d.ts.map +1 -1
- package/esm/components/QSwitch/QSwitch.vue.js +96 -56
- package/esm/components/QSwitch/index.d.ts +197 -2
- package/esm/components/QSwitch/index.d.ts.map +1 -1
- package/esm/components/QSwitch/types.d.ts +2 -1
- package/esm/components/QSwitch/types.d.ts.map +1 -1
- package/esm/components/QTabs/QTab.d.ts +35 -12
- package/esm/components/QTabs/QTab.d.ts.map +1 -1
- package/esm/components/QTabs/QTab.vue.js +77 -67
- package/esm/components/QTabs/QTabs.d.ts +7 -4
- package/esm/components/QTabs/QTabs.d.ts.map +1 -1
- package/esm/components/QTabs/QTabs.vue.js +94 -81
- package/esm/components/QTabs/constants.d.ts +24 -2
- package/esm/components/QTabs/constants.d.ts.map +1 -1
- package/esm/components/QTabs/constants.js +9 -0
- package/esm/components/QTabs/context.d.ts +3 -3
- package/esm/components/QTabs/context.d.ts.map +1 -1
- package/esm/components/QTabs/index.d.ts +34 -15
- package/esm/components/QTabs/index.d.ts.map +1 -1
- package/esm/components/QTabs/types.d.ts +26 -2
- package/esm/components/QTabs/types.d.ts.map +1 -1
- package/esm/components/QTextArea/QTextArea.d.ts +1 -1
- package/esm/components/QTextArea/QTextArea.d.ts.map +1 -1
- package/esm/components/QTextArea/QTextArea.vue.js +62 -47
- package/esm/components/QTextArea/index.d.ts +6 -6
- package/esm/components/QTextField/QTextField.d.ts +277 -11
- package/esm/components/QTextField/QTextField.d.ts.map +1 -1
- package/esm/components/QTextField/QTextField.vue.js +70 -55
- package/esm/components/QTextField/constants.d.ts +9 -0
- package/esm/components/QTextField/constants.d.ts.map +1 -1
- package/esm/components/QTextField/constants.js +10 -3
- package/esm/components/QTextField/index.d.ts +192 -11
- package/esm/components/QTextField/index.d.ts.map +1 -1
- package/esm/components/QTextField/index.js +4 -4
- package/esm/components/QTextField/types.d.ts +10 -2
- package/esm/components/QTextField/types.d.ts.map +1 -1
- package/esm/components/QToast/QToast.d.ts +4 -2
- package/esm/components/QToast/QToast.d.ts.map +1 -1
- package/esm/components/QToast/QToast.vue.js +157 -104
- package/esm/components/QToast/QToaster.d.ts +1 -1
- package/esm/components/QToast/QToaster.d.ts.map +1 -1
- package/esm/components/QToast/QToaster.vue.js +59 -29
- package/esm/components/QToast/constants.d.ts +18 -0
- package/esm/components/QToast/constants.d.ts.map +1 -1
- package/esm/components/QToast/constants.js +9 -2
- package/esm/components/QToast/context.d.ts +24 -0
- package/esm/components/QToast/context.d.ts.map +1 -0
- package/esm/components/QToast/context.js +4 -0
- package/esm/components/QToast/index.d.ts +12 -7
- package/esm/components/QToast/index.d.ts.map +1 -1
- package/esm/components/QToast/types.d.ts +26 -6
- package/esm/components/QToast/types.d.ts.map +1 -1
- package/esm/components/QToggle/QToggle.d.ts +2 -2
- package/esm/components/QToggle/QToggle.d.ts.map +1 -1
- package/esm/components/QToggle/QToggle.vue.js +13 -0
- package/esm/components/QToggle/index.d.ts +16 -1
- package/esm/components/QToggle/index.d.ts.map +1 -1
- package/esm/components/QToggleGroup/QToggleGroup.d.ts +3 -3
- package/esm/components/QToggleGroup/QToggleGroup.d.ts.map +1 -1
- package/esm/components/QToggleGroup/QToggleGroup.vue.js +34 -31
- package/esm/components/QToggleGroup/QToggleGroupItem.d.ts +2 -2
- package/esm/components/QToggleGroup/QToggleGroupItem.d.ts.map +1 -1
- package/esm/components/QToggleGroup/QToggleGroupItem.vue.js +20 -7
- package/esm/components/QToggleGroup/index.d.ts +9 -9
- package/esm/components/QToggleGroup/types.d.ts +8 -1
- package/esm/components/QToggleGroup/types.d.ts.map +1 -1
- package/esm/components/QTooltip/QTooltip.d.ts +1 -1
- package/esm/components/QTooltip/QTooltip.d.ts.map +1 -1
- package/esm/components/QTooltip/QTooltip.vue.js +1 -1
- package/esm/components/QTooltip/index.d.ts +3 -3
- package/esm/components/__internal__/QChevron/QChevron.vue.js +5 -5
- package/esm/components/__internal__/QClearButton/QClearButton.d.ts +1 -1
- package/esm/components/__internal__/QClearButton/QClearButton.vue.js +4 -4
- package/esm/components/__internal__/QClearButton/index.d.ts +1 -1
- package/esm/components/__internal__/QClearButton/index.d.ts.map +1 -1
- package/esm/components/__internal__/QHelpPopover/QHelpPopover.d.ts +99 -0
- package/esm/components/__internal__/QHelpPopover/QHelpPopover.d.ts.map +1 -0
- package/esm/components/__internal__/QHelpPopover/QHelpPopover.vue.js +60 -0
- package/esm/components/__internal__/QHelpPopover/QHelpPopover2.vue.js +5 -0
- package/esm/components/__internal__/QHelpPopover/constants.d.ts +9 -0
- package/esm/components/__internal__/QHelpPopover/constants.d.ts.map +1 -0
- package/esm/components/__internal__/QHelpPopover/constants.js +4 -0
- package/esm/components/__internal__/QHelpPopover/index.d.ts +98 -0
- package/esm/components/__internal__/QHelpPopover/index.d.ts.map +1 -0
- package/esm/components/__internal__/QHelpPopover/index.js +6 -0
- package/esm/components/__internal__/QHelpPopover/resolveHelp.d.ts +50 -0
- package/esm/components/__internal__/QHelpPopover/resolveHelp.d.ts.map +1 -0
- package/esm/components/__internal__/QHelpPopover/resolveHelp.js +27 -0
- package/esm/components/__internal__/QHelpPopover/types.d.ts +32 -0
- package/esm/components/__internal__/QHelpPopover/types.d.ts.map +1 -0
- package/esm/components/__internal__/QSafeTriangle/QSafeTriangle.d.ts +2 -2
- package/esm/components/__internal__/QSafeTriangle/index.d.ts +2 -2
- package/esm/components/index.d.ts +1 -0
- package/esm/components/index.d.ts.map +1 -1
- package/esm/components/index.js +132 -131
- package/esm/composables/defaults.d.ts +10 -0
- package/esm/composables/defaults.d.ts.map +1 -1
- package/esm/composables/defaults.js +8 -5
- package/esm/composables/useColor/index.d.ts +31 -21
- package/esm/composables/useColor/index.d.ts.map +1 -1
- package/esm/composables/useColor/index.js +58 -49
- package/esm/composables/useColor/types.d.ts +19 -6
- package/esm/composables/useColor/types.d.ts.map +1 -1
- package/esm/composables/useDialog/_internal.js +8 -11
- package/esm/composables/useDialog/index.js +1 -2
- package/esm/composables/useDialog/types.d.ts +3 -3
- package/esm/composables/useDialog/types.d.ts.map +1 -1
- package/esm/composables/useDropZone/index.d.ts +1 -11
- package/esm/composables/useDropZone/index.d.ts.map +1 -1
- package/esm/composables/useDropZone/index.js +23 -26
- package/esm/composables/useGroup/index.d.ts.map +1 -1
- package/esm/composables/useGroup/index.js +15 -15
- package/esm/composables/useOverlayScope/index.d.ts +29 -0
- package/esm/composables/useOverlayScope/index.d.ts.map +1 -0
- package/esm/composables/useOverlayScope/index.js +23 -0
- package/esm/composables/useTextareaAutosize/index.d.ts +3 -1
- package/esm/composables/useTextareaAutosize/index.d.ts.map +1 -1
- package/esm/composables/useTextareaAutosize/index.js +6 -6
- package/esm/composables/useToast/_internal.js +23 -23
- package/esm/composables/useToast/index.js +1 -2
- package/esm/composables/useToast/types.d.ts +3 -3
- package/esm/composables/useToast/types.d.ts.map +1 -1
- package/esm/framework.js +14 -12
- package/esm/index.d.ts +2 -3
- package/esm/index.d.ts.map +1 -1
- package/esm/symbols/overlayScope.d.ts +4 -0
- package/esm/symbols/overlayScope.d.ts.map +1 -0
- package/esm/symbols/overlayScope.js +4 -0
- package/esm/types/component.d.ts +31 -0
- package/esm/types/component.d.ts.map +1 -1
- package/esm/types/index.d.ts +1 -1
- package/esm/types/index.d.ts.map +1 -1
- package/esm/utils/color/merge.d.ts.map +1 -1
- package/esm/utils/color/parse.d.ts.map +1 -1
- package/esm/utils/color/parse.js +3 -10
- package/esm/utils/date.d.ts +35 -13
- package/esm/utils/date.d.ts.map +1 -1
- package/esm/utils/date.js +313 -253
- package/esm/utils/focus.d.ts +35 -0
- package/esm/utils/focus.d.ts.map +1 -0
- package/esm/utils/focus.js +27 -0
- package/esm/utils/mask.d.ts +1 -0
- package/esm/utils/mask.d.ts.map +1 -1
- package/esm/utils/mask.js +42 -100
- package/esm/utils/overlay.d.ts +13 -1
- package/esm/utils/overlay.d.ts.map +1 -1
- package/esm/utils/overlay.js +57 -43
- package/esm/utils/safeTriangle.d.ts.map +1 -1
- package/esm/utils/safeTriangle.js +2 -2
- package/esm/utils/setupPropsProxy.d.ts +3 -1
- package/esm/utils/setupPropsProxy.d.ts.map +1 -1
- package/esm/utils/setupPropsProxy.js +2 -2
- package/esm/utils/severity.d.ts +40 -0
- package/esm/utils/severity.d.ts.map +1 -0
- package/esm/utils/severity.js +25 -0
- package/esm/utils/theme.js +12 -12
- package/package.json +9 -6
- package/esm/components/QCheckbox/QCheckboxLabel.d.ts +0 -18
- package/esm/components/QCheckbox/QCheckboxLabel.d.ts.map +0 -1
- package/esm/components/QCheckbox/QCheckboxLabel.vue.js +0 -32
- package/esm/components/QCheckbox/QCheckboxLabel2.vue.js +0 -5
package/dist/json/api.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.
|
|
2
|
+
"version": "0.29.0",
|
|
3
3
|
"components": [
|
|
4
4
|
{
|
|
5
5
|
"name": "QAccordion",
|
|
@@ -104,13 +104,35 @@
|
|
|
104
104
|
"description": "If true, allows multiple collapsible sections to be expanded simultaneously.",
|
|
105
105
|
"required": false,
|
|
106
106
|
"category": "Behavior"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "icons",
|
|
110
|
+
"type": {
|
|
111
|
+
"kind": "object",
|
|
112
|
+
"fields": {}
|
|
113
|
+
},
|
|
114
|
+
"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.",
|
|
115
|
+
"default": "DEFAULT_ICONS",
|
|
116
|
+
"required": false,
|
|
117
|
+
"category": "Configuration"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "texts",
|
|
121
|
+
"type": {
|
|
122
|
+
"kind": "object",
|
|
123
|
+
"fields": {}
|
|
124
|
+
},
|
|
125
|
+
"description": "Accessible strings for the sections. They reach every section through the defaults cascade,\nunless a section sets its own `texts`.\nPass every key, or omit the prop to keep the defaults.",
|
|
126
|
+
"default": "DEFAULT_TEXTS",
|
|
127
|
+
"required": false,
|
|
128
|
+
"category": "Configuration"
|
|
107
129
|
}
|
|
108
130
|
],
|
|
109
131
|
"events": [
|
|
110
132
|
{
|
|
111
133
|
"name": "update:modelValue",
|
|
112
134
|
"description": "",
|
|
113
|
-
"type": "[value: Primitive | Primitive[]]"
|
|
135
|
+
"type": "[value: Primitive | Primitive[] | undefined]"
|
|
114
136
|
}
|
|
115
137
|
],
|
|
116
138
|
"slots": [
|
|
@@ -143,6 +165,195 @@
|
|
|
143
165
|
}
|
|
144
166
|
]
|
|
145
167
|
},
|
|
168
|
+
{
|
|
169
|
+
"name": "QAlert",
|
|
170
|
+
"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.",
|
|
171
|
+
"meta": {
|
|
172
|
+
"props": [
|
|
173
|
+
{
|
|
174
|
+
"name": "id",
|
|
175
|
+
"type": {
|
|
176
|
+
"kind": "primitive",
|
|
177
|
+
"name": "string"
|
|
178
|
+
},
|
|
179
|
+
"description": "The component unique identifier.",
|
|
180
|
+
"required": false,
|
|
181
|
+
"category": "Identification"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"name": "title",
|
|
185
|
+
"type": {
|
|
186
|
+
"kind": "primitive",
|
|
187
|
+
"name": "string"
|
|
188
|
+
},
|
|
189
|
+
"description": "The title of the alert, shown above the message.\nWithout a title, the alert is a single-row banner.",
|
|
190
|
+
"required": false,
|
|
191
|
+
"category": "Content"
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "headingLevel",
|
|
195
|
+
"type": {
|
|
196
|
+
"kind": "primitive",
|
|
197
|
+
"name": "number"
|
|
198
|
+
},
|
|
199
|
+
"description": "The heading level of the title, so screen reader users can find the alert by its\nheading. Choose the level that fits the page's heading outline. A value outside\n1–6 renders the title as a plain `div`.",
|
|
200
|
+
"default": "2",
|
|
201
|
+
"required": false,
|
|
202
|
+
"category": "Content"
|
|
203
|
+
},
|
|
204
|
+
{
|
|
205
|
+
"name": "text",
|
|
206
|
+
"type": {
|
|
207
|
+
"kind": "primitive",
|
|
208
|
+
"name": "string"
|
|
209
|
+
},
|
|
210
|
+
"description": "The message of the alert.\nUse the default slot instead for rich content, such as links or a list of errors.",
|
|
211
|
+
"required": false,
|
|
212
|
+
"category": "Content"
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
"name": "color",
|
|
216
|
+
"type": {
|
|
217
|
+
"kind": "primitive",
|
|
218
|
+
"name": "string"
|
|
219
|
+
},
|
|
220
|
+
"description": "The color of the alert.\nCan be chosen from utility colors like 'success' or 'danger',\nor specified using CSS color codes.\n`info`, `success`, `warning` and `danger` also set the severity: the icon from `icons`,\nthe text screen readers announce before the message, and the default `live` value.\nOther colors show no icon unless one is passed in the `icon` slot.",
|
|
221
|
+
"default": "info",
|
|
222
|
+
"required": false,
|
|
223
|
+
"category": "Presentation"
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "variant",
|
|
227
|
+
"type": {
|
|
228
|
+
"kind": "enum",
|
|
229
|
+
"values": [
|
|
230
|
+
"tonal",
|
|
231
|
+
"bold",
|
|
232
|
+
"outlined"
|
|
233
|
+
]
|
|
234
|
+
},
|
|
235
|
+
"description": "Specifies the visual style of the alert.",
|
|
236
|
+
"default": "tonal",
|
|
237
|
+
"required": false,
|
|
238
|
+
"category": "Presentation"
|
|
239
|
+
},
|
|
240
|
+
{
|
|
241
|
+
"name": "dismissible",
|
|
242
|
+
"type": {
|
|
243
|
+
"kind": "primitive",
|
|
244
|
+
"name": "boolean"
|
|
245
|
+
},
|
|
246
|
+
"description": "Whether the alert shows a dismiss button.\nPressing it emits `dismiss`. The alert stays on the page until you remove it.\nWhen the alert is removed while it has focus, focus moves to the next focusable\nelement on the page, or the previous one when nothing follows. To send focus\nelsewhere, move it in the `dismiss` handler.",
|
|
247
|
+
"required": false,
|
|
248
|
+
"category": "Behavior"
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "live",
|
|
252
|
+
"type": {
|
|
253
|
+
"kind": "enum",
|
|
254
|
+
"values": [
|
|
255
|
+
"assertive",
|
|
256
|
+
"polite",
|
|
257
|
+
"off"
|
|
258
|
+
]
|
|
259
|
+
},
|
|
260
|
+
"description": "How screen readers announce the alert.\n`assertive` (`role=\"alert\"`) interrupts the user, `polite` (`role=\"status\"`) waits\nuntil they are idle, and `off` sets no live region.\nDefaults to `assertive` for `warning` and `danger` and to `polite` for any other color.\nScreen readers only announce content that appears after the page loads, and many\nskip a `polite` alert that appears together with its message. Use `assertive` when\nthe message must be heard, and `off` for notices that are part of the page from the start.",
|
|
261
|
+
"required": false,
|
|
262
|
+
"category": "Accessibility"
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "icons",
|
|
266
|
+
"type": {
|
|
267
|
+
"kind": "object",
|
|
268
|
+
"fields": {}
|
|
269
|
+
},
|
|
270
|
+
"description": "Custom icon configurations: the severity icons and the dismiss icon.\nPass every key, or omit the prop to keep the defaults.",
|
|
271
|
+
"default": "DEFAULT_ICONS",
|
|
272
|
+
"required": false,
|
|
273
|
+
"category": "Configuration"
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "texts",
|
|
277
|
+
"type": {
|
|
278
|
+
"kind": "object",
|
|
279
|
+
"fields": {}
|
|
280
|
+
},
|
|
281
|
+
"description": "Custom text configurations: the severity texts read before the message,\nand the label of the dismiss button.\nPass every key, or omit the prop to keep the defaults.",
|
|
282
|
+
"default": "DEFAULT_TEXTS",
|
|
283
|
+
"required": false,
|
|
284
|
+
"category": "Configuration"
|
|
285
|
+
}
|
|
286
|
+
],
|
|
287
|
+
"events": [
|
|
288
|
+
{
|
|
289
|
+
"name": "dismiss",
|
|
290
|
+
"description": "",
|
|
291
|
+
"type": "[]"
|
|
292
|
+
}
|
|
293
|
+
],
|
|
294
|
+
"slots": [
|
|
295
|
+
{
|
|
296
|
+
"name": "icon",
|
|
297
|
+
"description": "Replaces the severity icon, or adds an icon to an alert in another color.\nThe icon is decorative and hidden from screen readers, so anything it conveys\nmust also be in the message."
|
|
298
|
+
},
|
|
299
|
+
{
|
|
300
|
+
"name": "default",
|
|
301
|
+
"description": "The message, for content that `text` cannot hold, such as links or a list of errors."
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "actions",
|
|
305
|
+
"description": "Buttons or links that act on the alert.\nOn a `bold` alert, a `QButton` here defaults to the `bold` variant in the alert's\non-color, which stands out from the fill. A button that sets its own `color`\nmust contrast with the fill: the theme's primary nearly disappears on a bold\n`danger` alert. For a quieter second action, use `variant=\"bold\"` with the\nalert's own `color`, so the button blends into the fill and only its text shows."
|
|
306
|
+
}
|
|
307
|
+
]
|
|
308
|
+
},
|
|
309
|
+
"examples": [
|
|
310
|
+
{
|
|
311
|
+
"title": "With Title",
|
|
312
|
+
"description": "A title stacks the message below it. The title is a level 2 heading by default, so screen reader users can find the alert by its heading. Set `headingLevel` to fit the page's heading outline.",
|
|
313
|
+
"code": "<QAlert title=\"Unsaved changes\" text=\"Save the record before leaving this page, or your changes will be lost.\" />"
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
"title": "Severities",
|
|
317
|
+
"description": "Each severity color has its own icon and screen reader prefix. Warnings and errors interrupt screen reader users, so keep them for messages that need immediate attention.",
|
|
318
|
+
"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=\"alert in alerts\"\n\t\t\t\t\t:key=\"alert.color\"\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\t:color=\"alert.color\"\n\t\t\t\t\t:text=\"alert.text\" />\n\t\t\t</div>"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"title": "Variants",
|
|
322
|
+
"description": "`tonal` (default), `bold` and `outlined`.",
|
|
323
|
+
"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>"
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
"title": "Custom Color",
|
|
327
|
+
"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.",
|
|
328
|
+
"code": "<q-alert v-bind=\"args\">\n\t\t\t\t<template #icon>\n\t\t\t\t\t<q-icon icon=\"information-outline\" />\n\t\t\t\t</template>\n\t\t\t</q-alert>"
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"title": "Rich Content",
|
|
332
|
+
"description": "The default slot takes rich content, such as a list of errors that link to their fields.",
|
|
333
|
+
"code": "<q-alert v-bind=\"args\">\n\t\t\t\t<ul style=\"margin: 0; padding-inline-start: 1.25rem;\">\n\t\t\t\t\t<li><a href=\"#name\">Enter a name</a></li>\n\t\t\t\t\t<li><a href=\"#email\">Enter a valid email address</a></li>\n\t\t\t\t</ul>\n\t\t\t</q-alert>"
|
|
334
|
+
},
|
|
335
|
+
{
|
|
336
|
+
"title": "Actions",
|
|
337
|
+
"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.",
|
|
338
|
+
"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>"
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"title": "Actions On Bold",
|
|
342
|
+
"description": "On a `bold` alert, the theme's default button color can disappear into the fill. A `QButton` in the `actions` slot therefore defaults to the `bold` variant in the alert's on-color (Undo, Try again). For a quieter second action, give the button the alert's own `color` with `variant=\"bold\"`: it blends into the fill and only its text shows (View trash). A button that sets another color must contrast with the fill.",
|
|
343
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem;\">\n\t\t\t\t<q-alert v-bind=\"args\" color=\"success\" text=\"The record was deleted.\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Undo\" />\n\t\t\t\t\t\t<q-button label=\"View trash\" variant=\"bold\" color=\"success\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t\t<q-alert v-bind=\"args\" color=\"danger\" text=\"The record could not be saved.\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Try again\" />\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\tcolor=\"warning\"\n\t\t\t\t\ttitle=\"Delete record\"\n\t\t\t\t\ttext=\"Do you wish to delete this record?\">\n\t\t\t\t\t<template #actions>\n\t\t\t\t\t\t<q-button label=\"Delete\" />\n\t\t\t\t\t\t<q-button label=\"Cancel\" variant=\"bold\" color=\"warning\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-alert>\n\t\t\t</div>"
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"title": "Dismissible",
|
|
347
|
+
"description": "`dismissible` adds a dismiss button that emits `dismiss`. The alert stays until you remove it. When it leaves the page with focus inside it, focus moves to the next focusable element, or the previous one when nothing follows, so keyboard and screen reader users keep their place. Inside a dialog or popover, focus stays in it, and the dialog itself takes focus when nothing else in it can. To send focus elsewhere, move it in the `dismiss` handler.",
|
|
348
|
+
"code": "<div style=\"display: flex; flex-direction: column; gap: 0.5rem; align-items: start;\">\n\t\t\t\t<q-button\n\t\t\t\t\tlabel=\"Show the alert\"\n\t\t\t\t\t:disabled=\"visible\"\n\t\t\t\t\t@click=\"visible = true\" />\n\t\t\t\t<q-alert\n\t\t\t\t\tv-if=\"visible\"\n\t\t\t\t\tv-bind=\"args\"\n\t\t\t\t\tstyle=\"align-self: stretch;\"\n\t\t\t\t\t@dismiss=\"visible = false\" />\n\t\t\t\t<q-button label=\"Next field\" />\n\t\t\t</div>"
|
|
349
|
+
},
|
|
350
|
+
{
|
|
351
|
+
"title": "Dismissible Bold",
|
|
352
|
+
"description": "`bold` alerts paint the dismiss button's focus ring in the alert's text color, so it stays visible on the solid fill.",
|
|
353
|
+
"code": "<QAlert color=\"danger\" variant=\"bold\" :dismissible=\"true\" title=\"The record could not be saved\" text=\"The server did not respond. Try again in a few minutes.\" />"
|
|
354
|
+
}
|
|
355
|
+
]
|
|
356
|
+
},
|
|
146
357
|
{
|
|
147
358
|
"name": "QAvatar",
|
|
148
359
|
"description": "Avatars visually represent users or entities. They can display an image, initials, or fallback content, and support customization for size, shape, and colors.",
|
|
@@ -164,7 +375,7 @@
|
|
|
164
375
|
"kind": "primitive",
|
|
165
376
|
"name": "string"
|
|
166
377
|
},
|
|
167
|
-
"description": "Initials to display if no image is provided.",
|
|
378
|
+
"description": "Initials to display if no image is provided or the image fails to load.\nWithout initials, the avatar shows its `fallback` slot instead.",
|
|
168
379
|
"required": false,
|
|
169
380
|
"category": "Content"
|
|
170
381
|
},
|
|
@@ -234,6 +445,11 @@
|
|
|
234
445
|
"description": "Displays an avatar with initials.",
|
|
235
446
|
"code": "<QAvatar initials=\"CS\" />"
|
|
236
447
|
},
|
|
448
|
+
{
|
|
449
|
+
"title": "Image Fallback",
|
|
450
|
+
"description": "Shows the initials, or the `fallback` slot without initials, when the image fails to load.",
|
|
451
|
+
"code": "<QAvatar src=\"data:image/png;base64,AAAA\" initials=\"CS\" alt=\"User Avatar\" />"
|
|
452
|
+
},
|
|
237
453
|
{
|
|
238
454
|
"title": "Custom Size",
|
|
239
455
|
"description": "Displays an avatar with a custom size.",
|
|
@@ -432,8 +648,8 @@
|
|
|
432
648
|
},
|
|
433
649
|
{
|
|
434
650
|
"title": "Size",
|
|
435
|
-
"description": "Local size overrides for the badge. Combines with the global density toolbar (product = global × size).",
|
|
436
|
-
"code": "<div style=\"display: flex; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-badge v-bind=\"args\" size=\"small\"
|
|
651
|
+
"description": "Local size overrides for the badge. Combines with the global density toolbar (product = global × size). Icons are sized relative to the badge text, so they scale with it.",
|
|
652
|
+
"code": "<div style=\"display: flex; align-items: center; gap: 0.5rem\">\n\t\t\t\t<q-badge v-bind=\"args\" size=\"small\"><q-icon icon=\"map-marker\" />Small</q-badge>\n\t\t\t\t<q-badge v-bind=\"args\" size=\"medium\"><q-icon icon=\"map-marker\" />Medium</q-badge>\n\t\t\t\t<q-badge v-bind=\"args\" size=\"large\"><q-icon icon=\"map-marker\" />Large</q-badge>\n\t\t\t</div>"
|
|
437
653
|
},
|
|
438
654
|
{
|
|
439
655
|
"title": "Clickable",
|
|
@@ -592,7 +808,7 @@
|
|
|
592
808
|
"kind": "object",
|
|
593
809
|
"fields": {}
|
|
594
810
|
},
|
|
595
|
-
"description": "Custom icons for the default separator and the collapsed-items control.",
|
|
811
|
+
"description": "Custom icons for the default separator and the collapsed-items control.\nPass every key, or omit the prop to keep the defaults.",
|
|
596
812
|
"default": "DEFAULT_ICONS",
|
|
597
813
|
"required": false,
|
|
598
814
|
"category": "Configuration"
|
|
@@ -603,7 +819,7 @@
|
|
|
603
819
|
"kind": "object",
|
|
604
820
|
"fields": {}
|
|
605
821
|
},
|
|
606
|
-
"description": "Custom accessible strings.",
|
|
822
|
+
"description": "Custom accessible strings.\nPass every key, or omit the prop to keep the defaults.",
|
|
607
823
|
"default": "DEFAULT_TEXTS",
|
|
608
824
|
"required": false,
|
|
609
825
|
"category": "Configuration"
|
|
@@ -669,16 +885,63 @@
|
|
|
669
885
|
"required": false,
|
|
670
886
|
"category": "Content"
|
|
671
887
|
},
|
|
888
|
+
{
|
|
889
|
+
"name": "help",
|
|
890
|
+
"type": {
|
|
891
|
+
"kind": "primitive",
|
|
892
|
+
"name": "string"
|
|
893
|
+
},
|
|
894
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the button.\nThe popover title is the button label.\n\nWith help, the root element is a `display: contents` wrapper around the button\n(and the help), not the button itself, so:\n- Anchor popovers, tooltips, and measurements to the inner `button`, not to the\n component's `$el`, which has no box.\n- Do not toggle `help` on a focused button: the button is remounted and loses focus.\n- Direct-child selectors such as those of `QButtonGroup` no longer match the button,\n so `QToggleGroupItem` does not accept help.",
|
|
895
|
+
"required": false,
|
|
896
|
+
"category": "Content"
|
|
897
|
+
},
|
|
898
|
+
{
|
|
899
|
+
"name": "helpDisplay",
|
|
900
|
+
"type": {
|
|
901
|
+
"kind": "enum",
|
|
902
|
+
"values": [
|
|
903
|
+
"popover",
|
|
904
|
+
"tooltip",
|
|
905
|
+
"subtext"
|
|
906
|
+
]
|
|
907
|
+
},
|
|
908
|
+
"description": "How {@link QButtonProps.help} is presented. Defaults to a popover.\n\n`subtext` renders the help under the button only in block flow. In a flex row\n(such as a dialog footer) or in an inline run it becomes a sibling beside the\nbutton, or breaks the line, so prefer `popover` or `tooltip` there.",
|
|
909
|
+
"default": "popover",
|
|
910
|
+
"required": false,
|
|
911
|
+
"category": "Presentation"
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"name": "icons",
|
|
915
|
+
"type": {
|
|
916
|
+
"kind": "object",
|
|
917
|
+
"fields": {}
|
|
918
|
+
},
|
|
919
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
920
|
+
"default": "DEFAULT_ICONS",
|
|
921
|
+
"required": false,
|
|
922
|
+
"category": "Configuration"
|
|
923
|
+
},
|
|
924
|
+
{
|
|
925
|
+
"name": "texts",
|
|
926
|
+
"type": {
|
|
927
|
+
"kind": "object",
|
|
928
|
+
"fields": {}
|
|
929
|
+
},
|
|
930
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
931
|
+
"default": "DEFAULT_TEXTS",
|
|
932
|
+
"required": false,
|
|
933
|
+
"category": "Configuration"
|
|
934
|
+
},
|
|
672
935
|
{
|
|
673
936
|
"name": "variant",
|
|
674
937
|
"type": {
|
|
675
938
|
"kind": "enum",
|
|
676
939
|
"values": [
|
|
677
940
|
"tonal",
|
|
941
|
+
"text",
|
|
678
942
|
"bold",
|
|
679
943
|
"outlined",
|
|
680
|
-
"ghost"
|
|
681
|
-
"text"
|
|
944
|
+
"ghost"
|
|
682
945
|
]
|
|
683
946
|
},
|
|
684
947
|
"description": "Specifies the visual style of the button.",
|
|
@@ -697,6 +960,16 @@
|
|
|
697
960
|
"required": false,
|
|
698
961
|
"category": "Presentation"
|
|
699
962
|
},
|
|
963
|
+
{
|
|
964
|
+
"name": "surface",
|
|
965
|
+
"type": {
|
|
966
|
+
"kind": "primitive",
|
|
967
|
+
"name": "string"
|
|
968
|
+
},
|
|
969
|
+
"description": "The color the button sits on, when it is not the theme background: a utility color\nlike 'primary', or a CSS color code. The label color of the `tonal`, `outlined`,\n`ghost` and `text` variants, and the hover color, are measured against it, so the\nbutton stays readable on a colored banner. Defaults to the theme background.",
|
|
970
|
+
"required": false,
|
|
971
|
+
"category": "Presentation"
|
|
972
|
+
},
|
|
700
973
|
{
|
|
701
974
|
"name": "borderless",
|
|
702
975
|
"type": {
|
|
@@ -836,6 +1109,21 @@
|
|
|
836
1109
|
"description": "The default button, suitable for most situations. Displays a label provided by the `label` prop.",
|
|
837
1110
|
"code": "<QButton label=\"Button\" />"
|
|
838
1111
|
},
|
|
1112
|
+
{
|
|
1113
|
+
"title": "Popover",
|
|
1114
|
+
"description": "Help shown in a popover beside the button. The popover title is the button label.",
|
|
1115
|
+
"code": "<QButton label=\"Button\" help=\"Saves the current record\" />"
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
"title": "Tooltip",
|
|
1119
|
+
"description": "Help is a tooltip on the button.",
|
|
1120
|
+
"code": "<QButton label=\"Button\" help=\"Saves the current record\" help-display=\"tooltip\" />"
|
|
1121
|
+
},
|
|
1122
|
+
{
|
|
1123
|
+
"title": "Subtext",
|
|
1124
|
+
"description": "Help rendered under the button.",
|
|
1125
|
+
"code": "<QButton label=\"Button\" help=\"Saves the current record\" help-display=\"subtext\" />"
|
|
1126
|
+
},
|
|
839
1127
|
{
|
|
840
1128
|
"title": "Icons",
|
|
841
1129
|
"description": "Displays an icon alongside the button label.",
|
|
@@ -856,6 +1144,11 @@
|
|
|
856
1144
|
"description": "Use the primary button once per page to represent the preferred user action.",
|
|
857
1145
|
"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>"
|
|
858
1146
|
},
|
|
1147
|
+
{
|
|
1148
|
+
"title": "Surface",
|
|
1149
|
+
"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.",
|
|
1150
|
+
"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\tcolor=\"background\"\n\t\t\t\t\tsurface=\"primary\"\n\t\t\t\t\t:label=\"variant\" />\n\t\t\t</div>"
|
|
1151
|
+
},
|
|
859
1152
|
{
|
|
860
1153
|
"title": "Disabled",
|
|
861
1154
|
"description": "Cannot be clicked.",
|
|
@@ -1391,7 +1684,7 @@
|
|
|
1391
1684
|
"examples": [
|
|
1392
1685
|
{
|
|
1393
1686
|
"title": "Default",
|
|
1394
|
-
"description": "Default usage with a rich set of beautiful images. No controls or indicators are shown by default.",
|
|
1687
|
+
"description": "Default usage with a rich set of beautiful images. No controls or indicators are shown by default: swipe to change slides on a touch screen.",
|
|
1395
1688
|
"code": "<QCarousel :slides=\"slides\" />"
|
|
1396
1689
|
},
|
|
1397
1690
|
{
|
|
@@ -1416,7 +1709,7 @@
|
|
|
1416
1709
|
},
|
|
1417
1710
|
{
|
|
1418
1711
|
"title": "Non Wrapping",
|
|
1419
|
-
"description": "Carousel that does not wrap back after the last slide.
|
|
1712
|
+
"description": "Carousel that does not wrap back after the last slide. Next does nothing on the last slide, and Previous does nothing on the first.",
|
|
1420
1713
|
"code": "<QCarousel :slides=\"slides\" :show-controls=\"true\" :wrap=\"false\" />"
|
|
1421
1714
|
},
|
|
1422
1715
|
{
|
|
@@ -1465,6 +1758,16 @@
|
|
|
1465
1758
|
"required": false,
|
|
1466
1759
|
"category": "Identification"
|
|
1467
1760
|
},
|
|
1761
|
+
{
|
|
1762
|
+
"name": "required",
|
|
1763
|
+
"type": {
|
|
1764
|
+
"kind": "primitive",
|
|
1765
|
+
"name": "boolean"
|
|
1766
|
+
},
|
|
1767
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).",
|
|
1768
|
+
"required": false,
|
|
1769
|
+
"category": "State"
|
|
1770
|
+
},
|
|
1468
1771
|
{
|
|
1469
1772
|
"name": "label",
|
|
1470
1773
|
"type": {
|
|
@@ -1476,52 +1779,71 @@
|
|
|
1476
1779
|
"category": "Content"
|
|
1477
1780
|
},
|
|
1478
1781
|
{
|
|
1479
|
-
"name": "
|
|
1782
|
+
"name": "for",
|
|
1480
1783
|
"type": {
|
|
1481
1784
|
"kind": "primitive",
|
|
1482
|
-
"name": "
|
|
1785
|
+
"name": "string"
|
|
1483
1786
|
},
|
|
1484
|
-
"description": "
|
|
1787
|
+
"description": "The form field associated with the label.",
|
|
1485
1788
|
"required": false,
|
|
1486
|
-
"category": "
|
|
1789
|
+
"category": "Accessibility"
|
|
1487
1790
|
},
|
|
1488
1791
|
{
|
|
1489
|
-
"name": "
|
|
1792
|
+
"name": "help",
|
|
1490
1793
|
"type": {
|
|
1491
1794
|
"kind": "primitive",
|
|
1492
1795
|
"name": "string"
|
|
1493
1796
|
},
|
|
1494
|
-
"description": "
|
|
1797
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
1495
1798
|
"required": false,
|
|
1496
|
-
"category": "
|
|
1799
|
+
"category": "Content"
|
|
1497
1800
|
},
|
|
1498
1801
|
{
|
|
1499
|
-
"name": "
|
|
1802
|
+
"name": "helpDisplay",
|
|
1500
1803
|
"type": {
|
|
1501
1804
|
"kind": "enum",
|
|
1502
1805
|
"values": [
|
|
1503
|
-
"
|
|
1504
|
-
"
|
|
1505
|
-
"
|
|
1506
|
-
"topleft",
|
|
1507
|
-
"topright"
|
|
1806
|
+
"popover",
|
|
1807
|
+
"tooltip",
|
|
1808
|
+
"subtext"
|
|
1508
1809
|
]
|
|
1509
1810
|
},
|
|
1510
|
-
"description": "
|
|
1811
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
1511
1812
|
"required": false,
|
|
1512
1813
|
"category": "Presentation"
|
|
1513
1814
|
},
|
|
1815
|
+
{
|
|
1816
|
+
"name": "icons",
|
|
1817
|
+
"type": {
|
|
1818
|
+
"kind": "object",
|
|
1819
|
+
"fields": {}
|
|
1820
|
+
},
|
|
1821
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
1822
|
+
"default": "DEFAULT_ICONS",
|
|
1823
|
+
"required": false,
|
|
1824
|
+
"category": "Configuration"
|
|
1825
|
+
},
|
|
1826
|
+
{
|
|
1827
|
+
"name": "texts",
|
|
1828
|
+
"type": {
|
|
1829
|
+
"kind": "object",
|
|
1830
|
+
"fields": {}
|
|
1831
|
+
},
|
|
1832
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
1833
|
+
"required": false,
|
|
1834
|
+
"category": "Configuration"
|
|
1835
|
+
},
|
|
1514
1836
|
{
|
|
1515
1837
|
"name": "labelPlacement",
|
|
1516
1838
|
"type": {
|
|
1517
1839
|
"kind": "enum",
|
|
1518
1840
|
"values": [
|
|
1519
|
-
"
|
|
1520
|
-
"
|
|
1841
|
+
"start",
|
|
1842
|
+
"end"
|
|
1521
1843
|
]
|
|
1522
1844
|
},
|
|
1523
|
-
"description": "
|
|
1524
|
-
"default": "
|
|
1845
|
+
"description": "Where the label sits relative to the checkbox. Same values as `QRadioButton`.\n- 'end': Label follows the box\n- 'start': Label precedes the box",
|
|
1846
|
+
"default": "end",
|
|
1525
1847
|
"required": false,
|
|
1526
1848
|
"category": "Presentation"
|
|
1527
1849
|
},
|
|
@@ -1531,7 +1853,7 @@
|
|
|
1531
1853
|
"kind": "primitive",
|
|
1532
1854
|
"name": "string"
|
|
1533
1855
|
},
|
|
1534
|
-
"description": "
|
|
1856
|
+
"description": "The color of the checkbox.\nCan be chosen from utility colors like 'success' or 'danger',\nor specified using CSS color codes.",
|
|
1535
1857
|
"default": "primary",
|
|
1536
1858
|
"required": false,
|
|
1537
1859
|
"category": "Presentation"
|
|
@@ -1580,17 +1902,6 @@
|
|
|
1580
1902
|
"required": false,
|
|
1581
1903
|
"category": "State"
|
|
1582
1904
|
},
|
|
1583
|
-
{
|
|
1584
|
-
"name": "icons",
|
|
1585
|
-
"type": {
|
|
1586
|
-
"kind": "object",
|
|
1587
|
-
"fields": {}
|
|
1588
|
-
},
|
|
1589
|
-
"description": "Custom icon configurations.",
|
|
1590
|
-
"default": "DEFAULT_ICONS",
|
|
1591
|
-
"required": false,
|
|
1592
|
-
"category": "Configuration"
|
|
1593
|
-
},
|
|
1594
1905
|
{
|
|
1595
1906
|
"name": "hasFocusOutline",
|
|
1596
1907
|
"type": {
|
|
@@ -1621,6 +1932,14 @@
|
|
|
1621
1932
|
}
|
|
1622
1933
|
],
|
|
1623
1934
|
"slots": [
|
|
1935
|
+
{
|
|
1936
|
+
"name": "label.prepend",
|
|
1937
|
+
"description": ""
|
|
1938
|
+
},
|
|
1939
|
+
{
|
|
1940
|
+
"name": "label.append",
|
|
1941
|
+
"description": ""
|
|
1942
|
+
},
|
|
1624
1943
|
{
|
|
1625
1944
|
"name": "extras",
|
|
1626
1945
|
"description": ""
|
|
@@ -1633,10 +1952,15 @@
|
|
|
1633
1952
|
"description": "A default checkbox.",
|
|
1634
1953
|
"code": "<QCheckbox label=\"Accept terms and conditions\" />"
|
|
1635
1954
|
},
|
|
1955
|
+
{
|
|
1956
|
+
"title": "Help",
|
|
1957
|
+
"description": "Help shown in a popover.",
|
|
1958
|
+
"code": "<QCheckbox label=\"Accept terms and conditions\" help=\"Required to create the account\" />"
|
|
1959
|
+
},
|
|
1636
1960
|
{
|
|
1637
1961
|
"title": "Label Placement",
|
|
1638
1962
|
"description": "A checkbox with a label positioned on the left side. Useful for layouts that require labels on the opposite side of the control.",
|
|
1639
|
-
"code": "<QCheckbox label=\"Accept terms and conditions\" label-placement=\"
|
|
1963
|
+
"code": "<QCheckbox label=\"Accept terms and conditions\" label-placement=\"start\" />"
|
|
1640
1964
|
},
|
|
1641
1965
|
{
|
|
1642
1966
|
"title": "Readonly",
|
|
@@ -1651,7 +1975,7 @@
|
|
|
1651
1975
|
{
|
|
1652
1976
|
"title": "Colors",
|
|
1653
1977
|
"description": "A demonstration of checkboxes with various color themes. Each checkbox displays a different color to signify distinct states or categories.",
|
|
1654
|
-
"code": "<div style=\"display: flex; gap: 2rem\">\n\t\t\t\t<q-checkbox model-value label=\"Primary Color\" color=\"primary\" />\n\t\t\t\t<q-checkbox model-value label=\"Info Color\" color=\"info\" />\n\t\t\t\t<q-checkbox model-value label=\"Success Color\" color=\"success\" />\n\t\t\t\t<q-checkbox model-value label=\"Warning Color\" color=\"warning\" />\n\t\t\t\t<q-checkbox model-value label=\"Danger Color\" color=\"danger\" />\n\t\t\t</div>"
|
|
1978
|
+
"code": "<div style=\"display: flex; gap: 2rem\">\n\t\t\t\t<q-checkbox model-value label=\"Primary Color\" color=\"primary\" />\n\t\t\t\t<q-checkbox model-value label=\"Info Color\" color=\"info\" />\n\t\t\t\t<q-checkbox model-value label=\"Success Color\" color=\"success\" />\n\t\t\t\t<q-checkbox model-value label=\"Warning Color\" color=\"warning\" />\n\t\t\t\t<q-checkbox model-value label=\"Danger Color\" color=\"danger\" />\n\t\t\t\t<q-checkbox model-value label=\"Custom Color\" color=\"#cc00cc\" />\n\t\t\t</div>"
|
|
1655
1979
|
},
|
|
1656
1980
|
{
|
|
1657
1981
|
"title": "Size",
|
|
@@ -1661,17 +1985,17 @@
|
|
|
1661
1985
|
{
|
|
1662
1986
|
"title": "Icons",
|
|
1663
1987
|
"description": "A checkbox with custom icons for the checked and indeterminate states. This allows for a more personalized or context-specific design.",
|
|
1664
|
-
"code": "<QCheckbox :model-value=\"true\" label=\"Diferent icon\" :icons=\"{\n\t\t\tchecked: { icon: 'skip-next' },\n\t\t\tindeterminate: { icon: 'skip-next' }\n\t\t}\" />"
|
|
1988
|
+
"code": "<QCheckbox :model-value=\"true\" label=\"Diferent icon\" :icons=\"{\n\t\t\thelp: { icon: 'help' },\n\t\t\tchecked: { icon: 'skip-next' },\n\t\t\tindeterminate: { icon: 'skip-next' }\n\t\t}\" />"
|
|
1665
1989
|
},
|
|
1666
1990
|
{
|
|
1667
1991
|
"title": "Indeterminate",
|
|
1668
1992
|
"description": "A parent-child checkbox hierarchy with an indeterminate state. The parent checkbox reflects the state of its children, useful for managing lists of options.",
|
|
1669
|
-
"code": "<div>\n\t\t\t\t<q-checkbox v-model=\"model\" :indeterminate=\"child01 || child02 || child03\" label-placement=\"
|
|
1993
|
+
"code": "<div>\n\t\t\t\t<q-checkbox v-model=\"model\" :indeterminate=\"child01 || child02 || child03\" label-placement=\"end\" label=\"Parent Option\" @update:model-value=\"onUpdateModelValue\" />\n\t\t\t\t<div\n\t\t\t\t\tstyle=\"margin-left: 1.5rem; display: flex; gap: .5rem; flex-direction: column; margin-top: .5rem\">\n\t\t\t\t\t<q-checkbox v-model=\"child01\" label=\"Child 1\" @update:model-value=\"onChildUpdateModelValue\"/>\n\t\t\t\t\t<q-checkbox v-model=\"child02\" label=\"Child 2\" @update:model-value=\"onChildUpdateModelValue\"/>\n\t\t\t\t\t<q-checkbox v-model=\"child03\" label=\"Child 3\" @update:model-value=\"onChildUpdateModelValue\"/>\n\t\t\t\t</div>\n\t\t\t</div>"
|
|
1670
1994
|
},
|
|
1671
1995
|
{
|
|
1672
1996
|
"title": "Extras",
|
|
1673
|
-
"description": "
|
|
1674
|
-
"code": "<q-checkbox v-bind
|
|
1997
|
+
"description": "Help goes in `help`. The `extras` slot holds other content under the control, here a link to the terms.",
|
|
1998
|
+
"code": "<q-checkbox v-bind=\"args\">\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>"
|
|
1675
1999
|
},
|
|
1676
2000
|
{
|
|
1677
2001
|
"title": "Borderless",
|
|
@@ -1910,6 +2234,52 @@
|
|
|
1910
2234
|
"required": false,
|
|
1911
2235
|
"category": "Identification"
|
|
1912
2236
|
},
|
|
2237
|
+
{
|
|
2238
|
+
"name": "help",
|
|
2239
|
+
"type": {
|
|
2240
|
+
"kind": "primitive",
|
|
2241
|
+
"name": "string"
|
|
2242
|
+
},
|
|
2243
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
2244
|
+
"required": false,
|
|
2245
|
+
"category": "Content"
|
|
2246
|
+
},
|
|
2247
|
+
{
|
|
2248
|
+
"name": "helpDisplay",
|
|
2249
|
+
"type": {
|
|
2250
|
+
"kind": "enum",
|
|
2251
|
+
"values": [
|
|
2252
|
+
"popover",
|
|
2253
|
+
"tooltip",
|
|
2254
|
+
"subtext"
|
|
2255
|
+
]
|
|
2256
|
+
},
|
|
2257
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
2258
|
+
"required": false,
|
|
2259
|
+
"category": "Presentation"
|
|
2260
|
+
},
|
|
2261
|
+
{
|
|
2262
|
+
"name": "icons",
|
|
2263
|
+
"type": {
|
|
2264
|
+
"kind": "object",
|
|
2265
|
+
"fields": {}
|
|
2266
|
+
},
|
|
2267
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
2268
|
+
"default": "DEFAULT_ICONS",
|
|
2269
|
+
"required": false,
|
|
2270
|
+
"category": "Configuration"
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"name": "texts",
|
|
2274
|
+
"type": {
|
|
2275
|
+
"kind": "object",
|
|
2276
|
+
"fields": {}
|
|
2277
|
+
},
|
|
2278
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
2279
|
+
"default": "DEFAULT_TEXTS",
|
|
2280
|
+
"required": false,
|
|
2281
|
+
"category": "Configuration"
|
|
2282
|
+
},
|
|
1913
2283
|
{
|
|
1914
2284
|
"name": "placeholder",
|
|
1915
2285
|
"type": {
|
|
@@ -1978,17 +2348,6 @@
|
|
|
1978
2348
|
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
1979
2349
|
"required": false,
|
|
1980
2350
|
"category": "State"
|
|
1981
|
-
},
|
|
1982
|
-
{
|
|
1983
|
-
"name": "texts",
|
|
1984
|
-
"type": {
|
|
1985
|
-
"kind": "object",
|
|
1986
|
-
"fields": {}
|
|
1987
|
-
},
|
|
1988
|
-
"description": "Custom text configurations.",
|
|
1989
|
-
"default": "DEFAULT_TEXTS",
|
|
1990
|
-
"required": false,
|
|
1991
|
-
"category": "Configuration"
|
|
1992
2351
|
}
|
|
1993
2352
|
],
|
|
1994
2353
|
"events": [
|
|
@@ -2096,6 +2455,38 @@
|
|
|
2096
2455
|
"required": false,
|
|
2097
2456
|
"category": "Identification"
|
|
2098
2457
|
},
|
|
2458
|
+
{
|
|
2459
|
+
"name": "icons",
|
|
2460
|
+
"type": {
|
|
2461
|
+
"kind": "object",
|
|
2462
|
+
"fields": {}
|
|
2463
|
+
},
|
|
2464
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
2465
|
+
"default": "DEFAULT_ICONS",
|
|
2466
|
+
"required": false,
|
|
2467
|
+
"category": "Configuration"
|
|
2468
|
+
},
|
|
2469
|
+
{
|
|
2470
|
+
"name": "texts",
|
|
2471
|
+
"type": {
|
|
2472
|
+
"kind": "object",
|
|
2473
|
+
"fields": {}
|
|
2474
|
+
},
|
|
2475
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
2476
|
+
"default": "DEFAULT_TEXTS",
|
|
2477
|
+
"required": false,
|
|
2478
|
+
"category": "Configuration"
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "required",
|
|
2482
|
+
"type": {
|
|
2483
|
+
"kind": "primitive",
|
|
2484
|
+
"name": "boolean"
|
|
2485
|
+
},
|
|
2486
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).\nIf set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
2487
|
+
"required": false,
|
|
2488
|
+
"category": "State"
|
|
2489
|
+
},
|
|
2099
2490
|
{
|
|
2100
2491
|
"name": "size",
|
|
2101
2492
|
"type": {
|
|
@@ -2124,17 +2515,6 @@
|
|
|
2124
2515
|
"required": false,
|
|
2125
2516
|
"category": "State"
|
|
2126
2517
|
},
|
|
2127
|
-
{
|
|
2128
|
-
"name": "texts",
|
|
2129
|
-
"type": {
|
|
2130
|
-
"kind": "object",
|
|
2131
|
-
"fields": {}
|
|
2132
|
-
},
|
|
2133
|
-
"description": "Custom text configurations.",
|
|
2134
|
-
"default": "DEFAULT_TEXTS",
|
|
2135
|
-
"required": false,
|
|
2136
|
-
"category": "Configuration"
|
|
2137
|
-
},
|
|
2138
2518
|
{
|
|
2139
2519
|
"name": "label",
|
|
2140
2520
|
"type": {
|
|
@@ -2146,33 +2526,37 @@
|
|
|
2146
2526
|
"category": "Content"
|
|
2147
2527
|
},
|
|
2148
2528
|
{
|
|
2149
|
-
"name": "
|
|
2529
|
+
"name": "help",
|
|
2150
2530
|
"type": {
|
|
2151
2531
|
"kind": "primitive",
|
|
2152
|
-
"name": "
|
|
2532
|
+
"name": "string"
|
|
2153
2533
|
},
|
|
2154
|
-
"description": "
|
|
2534
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
2155
2535
|
"required": false,
|
|
2156
|
-
"category": "
|
|
2536
|
+
"category": "Content"
|
|
2157
2537
|
},
|
|
2158
2538
|
{
|
|
2159
|
-
"name": "
|
|
2539
|
+
"name": "helpDisplay",
|
|
2160
2540
|
"type": {
|
|
2161
|
-
"kind": "
|
|
2162
|
-
"
|
|
2541
|
+
"kind": "enum",
|
|
2542
|
+
"values": [
|
|
2543
|
+
"popover",
|
|
2544
|
+
"tooltip",
|
|
2545
|
+
"subtext"
|
|
2546
|
+
]
|
|
2163
2547
|
},
|
|
2164
|
-
"description": "
|
|
2548
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
2165
2549
|
"required": false,
|
|
2166
|
-
"category": "
|
|
2550
|
+
"category": "Presentation"
|
|
2167
2551
|
},
|
|
2168
2552
|
{
|
|
2169
2553
|
"name": "labelPosition",
|
|
2170
2554
|
"type": {
|
|
2171
2555
|
"kind": "enum",
|
|
2172
2556
|
"values": [
|
|
2173
|
-
"right",
|
|
2174
2557
|
"left",
|
|
2175
2558
|
"center",
|
|
2559
|
+
"right",
|
|
2176
2560
|
"topleft",
|
|
2177
2561
|
"topright"
|
|
2178
2562
|
]
|
|
@@ -2181,6 +2565,16 @@
|
|
|
2181
2565
|
"required": false,
|
|
2182
2566
|
"category": "Presentation"
|
|
2183
2567
|
},
|
|
2568
|
+
{
|
|
2569
|
+
"name": "for",
|
|
2570
|
+
"type": {
|
|
2571
|
+
"kind": "primitive",
|
|
2572
|
+
"name": "string"
|
|
2573
|
+
},
|
|
2574
|
+
"description": "The form field associated with the label.",
|
|
2575
|
+
"required": false,
|
|
2576
|
+
"category": "Accessibility"
|
|
2577
|
+
},
|
|
2184
2578
|
{
|
|
2185
2579
|
"name": "readonly",
|
|
2186
2580
|
"type": {
|
|
@@ -2318,6 +2712,21 @@
|
|
|
2318
2712
|
"required": false,
|
|
2319
2713
|
"category": "Behavior"
|
|
2320
2714
|
},
|
|
2715
|
+
{
|
|
2716
|
+
"name": "overflow",
|
|
2717
|
+
"type": {
|
|
2718
|
+
"kind": "enum",
|
|
2719
|
+
"values": [
|
|
2720
|
+
"wrap",
|
|
2721
|
+
"fit-content",
|
|
2722
|
+
"truncate"
|
|
2723
|
+
]
|
|
2724
|
+
},
|
|
2725
|
+
"description": "How long option labels overflow in the dropdown.\nDefaults to `wrap`.",
|
|
2726
|
+
"default": "wrap",
|
|
2727
|
+
"required": false,
|
|
2728
|
+
"category": "Presentation"
|
|
2729
|
+
},
|
|
2321
2730
|
{
|
|
2322
2731
|
"name": "loading",
|
|
2323
2732
|
"type": {
|
|
@@ -2337,17 +2746,6 @@
|
|
|
2337
2746
|
"description": "The value to be used in comparisons,\nused to check if the field has a selected item.",
|
|
2338
2747
|
"required": false,
|
|
2339
2748
|
"category": "Configuration"
|
|
2340
|
-
},
|
|
2341
|
-
{
|
|
2342
|
-
"name": "icons",
|
|
2343
|
-
"type": {
|
|
2344
|
-
"kind": "object",
|
|
2345
|
-
"fields": {}
|
|
2346
|
-
},
|
|
2347
|
-
"description": "Custom icon configurations.",
|
|
2348
|
-
"default": "DEFAULT_ICONS",
|
|
2349
|
-
"required": false,
|
|
2350
|
-
"category": "Configuration"
|
|
2351
2749
|
}
|
|
2352
2750
|
],
|
|
2353
2751
|
"events": [
|
|
@@ -2453,10 +2851,20 @@
|
|
|
2453
2851
|
"description": "Displays a loading animation that lets users know content is being loaded.",
|
|
2454
2852
|
"code": "<QCombobox :items=\"[]\" :loading=\"true\" />"
|
|
2455
2853
|
},
|
|
2854
|
+
{
|
|
2855
|
+
"title": "Overflow",
|
|
2856
|
+
"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. - `truncate`: the menu matches the field and labels end in an ellipsis; a cut-off label shows its full text in a native `title` on hover. - `fit-content`: the menu grows with the longest option.",
|
|
2857
|
+
"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=\"truncate\">\n\t\t\t\t\t<q-combobox v-bind=\"args\" label=\"Truncate\" overflow=\"truncate\" />\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</div>"
|
|
2858
|
+
},
|
|
2456
2859
|
{
|
|
2457
2860
|
"title": "Description In Items",
|
|
2458
2861
|
"description": "Combobox with description.",
|
|
2459
2862
|
"code": "<QCombobox :items=\"[\n\t\t\t{\n\t\t\t\tkey: 'beatles',\n\t\t\t\tlabel: 'The Beatles',\n\t\t\t\tdescription: 'Were an English rock band formed in Liverpool in 1960'\n\t\t\t},\n\t\t\t{\n\t\t\t\tkey: 'coldplay',\n\t\t\t\tlabel: 'Coldplay',\n\t\t\t\tdescription: 'Are a British rock band formed in London in 1997'\n\t\t\t},\n\t\t\t{\n\t\t\t\tkey: 'guns_n_roses',\n\t\t\t\tlabel: \"Guns N' Roses\",\n\t\t\t\tdescription:\n\t\t\t\t\t'Is an American hard rock band from Los Angeles, California, formed in March 1985.'\n\t\t\t}\n\t\t]\" />"
|
|
2863
|
+
},
|
|
2864
|
+
{
|
|
2865
|
+
"title": "Keyboard Navigation",
|
|
2866
|
+
"description": "The list scrolls to show the selected option when it opens, and keeps the highlighted option in view as the keys move through a long list.",
|
|
2867
|
+
"code": "<QCombobox model-value=\"radiohead\" />"
|
|
2460
2868
|
}
|
|
2461
2869
|
]
|
|
2462
2870
|
},
|
|
@@ -2515,36 +2923,82 @@
|
|
|
2515
2923
|
"kind": "primitive",
|
|
2516
2924
|
"name": "boolean"
|
|
2517
2925
|
},
|
|
2518
|
-
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).\nIf set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
2926
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).\nIf set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
2927
|
+
"required": false,
|
|
2928
|
+
"category": "State"
|
|
2929
|
+
},
|
|
2930
|
+
{
|
|
2931
|
+
"name": "for",
|
|
2932
|
+
"type": {
|
|
2933
|
+
"kind": "primitive",
|
|
2934
|
+
"name": "string"
|
|
2935
|
+
},
|
|
2936
|
+
"description": "The form field associated with the label.",
|
|
2937
|
+
"required": false,
|
|
2938
|
+
"category": "Accessibility"
|
|
2939
|
+
},
|
|
2940
|
+
{
|
|
2941
|
+
"name": "labelPosition",
|
|
2942
|
+
"type": {
|
|
2943
|
+
"kind": "enum",
|
|
2944
|
+
"values": [
|
|
2945
|
+
"left",
|
|
2946
|
+
"center",
|
|
2947
|
+
"right",
|
|
2948
|
+
"topleft",
|
|
2949
|
+
"topright"
|
|
2950
|
+
]
|
|
2951
|
+
},
|
|
2952
|
+
"description": "Position of the label relative to the input field.\n- 'left': Label appears to the left of the input\n- 'center': Label appears above the input, centered\n- 'right': Label appears to the right of the input\n- 'topleft': Label appears above the input, aligned to the left\n- 'topright': Label appears above the input, aligned to the right",
|
|
2519
2953
|
"required": false,
|
|
2520
|
-
"category": "
|
|
2954
|
+
"category": "Presentation"
|
|
2521
2955
|
},
|
|
2522
2956
|
{
|
|
2523
|
-
"name": "
|
|
2957
|
+
"name": "help",
|
|
2524
2958
|
"type": {
|
|
2525
2959
|
"kind": "primitive",
|
|
2526
2960
|
"name": "string"
|
|
2527
2961
|
},
|
|
2528
|
-
"description": "
|
|
2962
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
2529
2963
|
"required": false,
|
|
2530
|
-
"category": "
|
|
2964
|
+
"category": "Content"
|
|
2531
2965
|
},
|
|
2532
2966
|
{
|
|
2533
|
-
"name": "
|
|
2967
|
+
"name": "helpDisplay",
|
|
2534
2968
|
"type": {
|
|
2535
2969
|
"kind": "enum",
|
|
2536
2970
|
"values": [
|
|
2537
|
-
"
|
|
2538
|
-
"
|
|
2539
|
-
"
|
|
2540
|
-
"topleft",
|
|
2541
|
-
"topright"
|
|
2971
|
+
"popover",
|
|
2972
|
+
"tooltip",
|
|
2973
|
+
"subtext"
|
|
2542
2974
|
]
|
|
2543
2975
|
},
|
|
2544
|
-
"description": "
|
|
2976
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
2545
2977
|
"required": false,
|
|
2546
2978
|
"category": "Presentation"
|
|
2547
2979
|
},
|
|
2980
|
+
{
|
|
2981
|
+
"name": "icons",
|
|
2982
|
+
"type": {
|
|
2983
|
+
"kind": "object",
|
|
2984
|
+
"fields": {}
|
|
2985
|
+
},
|
|
2986
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
2987
|
+
"default": "DEFAULT_ICONS",
|
|
2988
|
+
"required": false,
|
|
2989
|
+
"category": "Configuration"
|
|
2990
|
+
},
|
|
2991
|
+
{
|
|
2992
|
+
"name": "texts",
|
|
2993
|
+
"type": {
|
|
2994
|
+
"kind": "object",
|
|
2995
|
+
"fields": {}
|
|
2996
|
+
},
|
|
2997
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
2998
|
+
"default": "DEFAULT_TEXTS",
|
|
2999
|
+
"required": false,
|
|
3000
|
+
"category": "Configuration"
|
|
3001
|
+
},
|
|
2548
3002
|
{
|
|
2549
3003
|
"name": "size",
|
|
2550
3004
|
"type": {
|
|
@@ -2644,28 +3098,6 @@
|
|
|
2644
3098
|
"description": "Enable selecting a range of two dates.",
|
|
2645
3099
|
"required": false,
|
|
2646
3100
|
"category": "Configuration"
|
|
2647
|
-
},
|
|
2648
|
-
{
|
|
2649
|
-
"name": "icons",
|
|
2650
|
-
"type": {
|
|
2651
|
-
"kind": "object",
|
|
2652
|
-
"fields": {}
|
|
2653
|
-
},
|
|
2654
|
-
"description": "Custom icon configurations.",
|
|
2655
|
-
"default": "DEFAULT_ICONS",
|
|
2656
|
-
"required": false,
|
|
2657
|
-
"category": "Configuration"
|
|
2658
|
-
},
|
|
2659
|
-
{
|
|
2660
|
-
"name": "texts",
|
|
2661
|
-
"type": {
|
|
2662
|
-
"kind": "object",
|
|
2663
|
-
"fields": {}
|
|
2664
|
-
},
|
|
2665
|
-
"description": "Custom text configurations.",
|
|
2666
|
-
"default": "DEFAULT_TEXTS",
|
|
2667
|
-
"required": false,
|
|
2668
|
-
"category": "Configuration"
|
|
2669
3101
|
}
|
|
2670
3102
|
],
|
|
2671
3103
|
"events": [
|
|
@@ -2823,10 +3255,19 @@
|
|
|
2823
3255
|
{
|
|
2824
3256
|
"name": "icon",
|
|
2825
3257
|
"type": {
|
|
2826
|
-
"kind": "
|
|
2827
|
-
"
|
|
3258
|
+
"kind": "union",
|
|
3259
|
+
"types": [
|
|
3260
|
+
{
|
|
3261
|
+
"name": "other",
|
|
3262
|
+
"value": "null"
|
|
3263
|
+
},
|
|
3264
|
+
{
|
|
3265
|
+
"name": "object",
|
|
3266
|
+
"value": {}
|
|
3267
|
+
}
|
|
3268
|
+
]
|
|
2828
3269
|
},
|
|
2829
|
-
"description": "The icon of the dialog window.",
|
|
3270
|
+
"description": "The icon of the dialog window. Pass `null` to show no icon.",
|
|
2830
3271
|
"default": "DEFAULT_ICON",
|
|
2831
3272
|
"required": false,
|
|
2832
3273
|
"category": "Content"
|
|
@@ -2840,7 +3281,7 @@
|
|
|
2840
3281
|
"value": {}
|
|
2841
3282
|
}
|
|
2842
3283
|
},
|
|
2843
|
-
"description": "The buttons to interact with the dialog window.",
|
|
3284
|
+
"description": "The buttons to interact with the dialog window. Pass an empty array to show no buttons.",
|
|
2844
3285
|
"default": "DEFAULT_BUTTONS",
|
|
2845
3286
|
"required": false,
|
|
2846
3287
|
"category": "Content"
|
|
@@ -3024,7 +3465,7 @@
|
|
|
3024
3465
|
"kind": "object",
|
|
3025
3466
|
"fields": {}
|
|
3026
3467
|
},
|
|
3027
|
-
"description": "Custom icon configurations.",
|
|
3468
|
+
"description": "Custom icon configurations. Includes the icons of the prompt input.\nPass every key, or omit the prop to keep the defaults.",
|
|
3028
3469
|
"default": "DEFAULT_ICONS",
|
|
3029
3470
|
"required": false,
|
|
3030
3471
|
"category": "Configuration"
|
|
@@ -3035,7 +3476,7 @@
|
|
|
3035
3476
|
"kind": "object",
|
|
3036
3477
|
"fields": {}
|
|
3037
3478
|
},
|
|
3038
|
-
"description": "Custom text configurations.",
|
|
3479
|
+
"description": "Custom text configurations. Includes the strings of the prompt input.\nPass every key, or omit the prop to keep the defaults.",
|
|
3039
3480
|
"default": "DEFAULT_TEXTS",
|
|
3040
3481
|
"required": false,
|
|
3041
3482
|
"category": "Configuration"
|
|
@@ -3120,6 +3561,11 @@
|
|
|
3120
3561
|
"description": "Shows a custom icon instead of the default one.",
|
|
3121
3562
|
"code": "<QDialog text=\"You clicked the button?\" :icon=\"{\n\t\t\ticon: 'help-circle-outline'\n\t\t}\" />"
|
|
3122
3563
|
},
|
|
3564
|
+
{
|
|
3565
|
+
"title": "Without Icon Or Buttons",
|
|
3566
|
+
"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.",
|
|
3567
|
+
"code": "<QDialog title=\"Saved\" text=\"Your changes were saved.\" :icon=\"null\" :buttons=\"[]\" :dismissible=\"true\" />"
|
|
3568
|
+
},
|
|
3123
3569
|
{
|
|
3124
3570
|
"title": "Custom Buttons",
|
|
3125
3571
|
"description": "Custom buttons on the dialog allow the user to customize its look and behavior.",
|
|
@@ -3182,6 +3628,11 @@
|
|
|
3182
3628
|
"meta": {
|
|
3183
3629
|
"props": [],
|
|
3184
3630
|
"events": [
|
|
3631
|
+
{
|
|
3632
|
+
"name": "dismiss",
|
|
3633
|
+
"description": "",
|
|
3634
|
+
"type": "[event: KeyboardEvent | QPointerDownOutsideEvent | QFocusOutsideEvent]"
|
|
3635
|
+
},
|
|
3185
3636
|
{
|
|
3186
3637
|
"name": "escape-key-down",
|
|
3187
3638
|
"description": "",
|
|
@@ -3201,11 +3652,6 @@
|
|
|
3201
3652
|
"name": "interact-outside",
|
|
3202
3653
|
"description": "",
|
|
3203
3654
|
"type": "[event: QPointerDownOutsideEvent | QFocusOutsideEvent]"
|
|
3204
|
-
},
|
|
3205
|
-
{
|
|
3206
|
-
"name": "dismiss",
|
|
3207
|
-
"description": "",
|
|
3208
|
-
"type": "[event: KeyboardEvent | QPointerDownOutsideEvent | QFocusOutsideEvent]"
|
|
3209
3655
|
}
|
|
3210
3656
|
],
|
|
3211
3657
|
"slots": [
|
|
@@ -3428,16 +3874,16 @@
|
|
|
3428
3874
|
"values": [
|
|
3429
3875
|
"top",
|
|
3430
3876
|
"bottom",
|
|
3431
|
-
"right",
|
|
3432
3877
|
"left",
|
|
3878
|
+
"right",
|
|
3433
3879
|
"top-start",
|
|
3434
3880
|
"top-end",
|
|
3435
3881
|
"bottom-start",
|
|
3436
3882
|
"bottom-end",
|
|
3437
|
-
"right-start",
|
|
3438
|
-
"right-end",
|
|
3439
3883
|
"left-start",
|
|
3440
|
-
"left-end"
|
|
3884
|
+
"left-end",
|
|
3885
|
+
"right-start",
|
|
3886
|
+
"right-end"
|
|
3441
3887
|
]
|
|
3442
3888
|
},
|
|
3443
3889
|
"description": "The placement of the dropdown menu.",
|
|
@@ -3488,23 +3934,13 @@
|
|
|
3488
3934
|
"required": false,
|
|
3489
3935
|
"category": "Behavior"
|
|
3490
3936
|
},
|
|
3491
|
-
{
|
|
3492
|
-
"name": "depth",
|
|
3493
|
-
"type": {
|
|
3494
|
-
"kind": "primitive",
|
|
3495
|
-
"name": "number"
|
|
3496
|
-
},
|
|
3497
|
-
"description": "Depth for recursive nesting.",
|
|
3498
|
-
"required": false,
|
|
3499
|
-
"category": "Behavior"
|
|
3500
|
-
},
|
|
3501
3937
|
{
|
|
3502
3938
|
"name": "icons",
|
|
3503
3939
|
"type": {
|
|
3504
3940
|
"kind": "object",
|
|
3505
3941
|
"fields": {}
|
|
3506
3942
|
},
|
|
3507
|
-
"description": "Custom icon configurations.",
|
|
3943
|
+
"description": "Custom icon configurations. Includes the icons of the list.\nPass every key, or omit the prop to keep the defaults.",
|
|
3508
3944
|
"required": false,
|
|
3509
3945
|
"category": "Configuration"
|
|
3510
3946
|
}
|
|
@@ -3627,9 +4063,9 @@
|
|
|
3627
4063
|
"type": {
|
|
3628
4064
|
"kind": "enum",
|
|
3629
4065
|
"values": [
|
|
3630
|
-
"right",
|
|
3631
4066
|
"left",
|
|
3632
4067
|
"center",
|
|
4068
|
+
"right",
|
|
3633
4069
|
"topleft",
|
|
3634
4070
|
"topright"
|
|
3635
4071
|
]
|
|
@@ -3639,6 +4075,53 @@
|
|
|
3639
4075
|
"required": false,
|
|
3640
4076
|
"category": "Presentation"
|
|
3641
4077
|
},
|
|
4078
|
+
{
|
|
4079
|
+
"name": "help",
|
|
4080
|
+
"type": {
|
|
4081
|
+
"kind": "primitive",
|
|
4082
|
+
"name": "string"
|
|
4083
|
+
},
|
|
4084
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
4085
|
+
"required": false,
|
|
4086
|
+
"category": "Content"
|
|
4087
|
+
},
|
|
4088
|
+
{
|
|
4089
|
+
"name": "helpDisplay",
|
|
4090
|
+
"type": {
|
|
4091
|
+
"kind": "enum",
|
|
4092
|
+
"values": [
|
|
4093
|
+
"popover",
|
|
4094
|
+
"tooltip",
|
|
4095
|
+
"subtext"
|
|
4096
|
+
]
|
|
4097
|
+
},
|
|
4098
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
4099
|
+
"default": "popover",
|
|
4100
|
+
"required": false,
|
|
4101
|
+
"category": "Presentation"
|
|
4102
|
+
},
|
|
4103
|
+
{
|
|
4104
|
+
"name": "icons",
|
|
4105
|
+
"type": {
|
|
4106
|
+
"kind": "object",
|
|
4107
|
+
"fields": {}
|
|
4108
|
+
},
|
|
4109
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4110
|
+
"default": "DEFAULT_ICONS",
|
|
4111
|
+
"required": false,
|
|
4112
|
+
"category": "Configuration"
|
|
4113
|
+
},
|
|
4114
|
+
{
|
|
4115
|
+
"name": "texts",
|
|
4116
|
+
"type": {
|
|
4117
|
+
"kind": "object",
|
|
4118
|
+
"fields": {}
|
|
4119
|
+
},
|
|
4120
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4121
|
+
"default": "DEFAULT_TEXTS",
|
|
4122
|
+
"required": false,
|
|
4123
|
+
"category": "Configuration"
|
|
4124
|
+
},
|
|
3642
4125
|
{
|
|
3643
4126
|
"name": "size",
|
|
3644
4127
|
"type": {
|
|
@@ -3782,9 +4265,9 @@
|
|
|
3782
4265
|
"type": {
|
|
3783
4266
|
"kind": "enum",
|
|
3784
4267
|
"values": [
|
|
3785
|
-
"right",
|
|
3786
4268
|
"left",
|
|
3787
4269
|
"center",
|
|
4270
|
+
"right",
|
|
3788
4271
|
"topleft",
|
|
3789
4272
|
"topright"
|
|
3790
4273
|
]
|
|
@@ -3793,6 +4276,52 @@
|
|
|
3793
4276
|
"required": false,
|
|
3794
4277
|
"category": "Presentation"
|
|
3795
4278
|
},
|
|
4279
|
+
{
|
|
4280
|
+
"name": "help",
|
|
4281
|
+
"type": {
|
|
4282
|
+
"kind": "primitive",
|
|
4283
|
+
"name": "string"
|
|
4284
|
+
},
|
|
4285
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
4286
|
+
"required": false,
|
|
4287
|
+
"category": "Content"
|
|
4288
|
+
},
|
|
4289
|
+
{
|
|
4290
|
+
"name": "helpDisplay",
|
|
4291
|
+
"type": {
|
|
4292
|
+
"kind": "enum",
|
|
4293
|
+
"values": [
|
|
4294
|
+
"popover",
|
|
4295
|
+
"tooltip",
|
|
4296
|
+
"subtext"
|
|
4297
|
+
]
|
|
4298
|
+
},
|
|
4299
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
4300
|
+
"required": false,
|
|
4301
|
+
"category": "Presentation"
|
|
4302
|
+
},
|
|
4303
|
+
{
|
|
4304
|
+
"name": "icons",
|
|
4305
|
+
"type": {
|
|
4306
|
+
"kind": "object",
|
|
4307
|
+
"fields": {}
|
|
4308
|
+
},
|
|
4309
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
4310
|
+
"default": "DEFAULT_ICONS",
|
|
4311
|
+
"required": false,
|
|
4312
|
+
"category": "Configuration"
|
|
4313
|
+
},
|
|
4314
|
+
{
|
|
4315
|
+
"name": "texts",
|
|
4316
|
+
"type": {
|
|
4317
|
+
"kind": "object",
|
|
4318
|
+
"fields": {}
|
|
4319
|
+
},
|
|
4320
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations.",
|
|
4321
|
+
"default": "DEFAULT_TEXTS",
|
|
4322
|
+
"required": false,
|
|
4323
|
+
"category": "Configuration"
|
|
4324
|
+
},
|
|
3796
4325
|
{
|
|
3797
4326
|
"name": "size",
|
|
3798
4327
|
"type": {
|
|
@@ -3861,28 +4390,6 @@
|
|
|
3861
4390
|
"description": "Specifies the accepted file types.",
|
|
3862
4391
|
"required": false,
|
|
3863
4392
|
"category": "Behavior"
|
|
3864
|
-
},
|
|
3865
|
-
{
|
|
3866
|
-
"name": "icons",
|
|
3867
|
-
"type": {
|
|
3868
|
-
"kind": "object",
|
|
3869
|
-
"fields": {}
|
|
3870
|
-
},
|
|
3871
|
-
"description": "Custom icon configurations.",
|
|
3872
|
-
"default": "DEFAULT_ICONS",
|
|
3873
|
-
"required": false,
|
|
3874
|
-
"category": "Configuration"
|
|
3875
|
-
},
|
|
3876
|
-
{
|
|
3877
|
-
"name": "texts",
|
|
3878
|
-
"type": {
|
|
3879
|
-
"kind": "object",
|
|
3880
|
-
"fields": {}
|
|
3881
|
-
},
|
|
3882
|
-
"description": "Custom text configurations.",
|
|
3883
|
-
"default": "DEFAULT_TEXTS",
|
|
3884
|
-
"required": false,
|
|
3885
|
-
"category": "Configuration"
|
|
3886
4393
|
}
|
|
3887
4394
|
],
|
|
3888
4395
|
"events": [
|
|
@@ -3922,13 +4429,18 @@
|
|
|
3922
4429
|
},
|
|
3923
4430
|
{
|
|
3924
4431
|
"title": "Accept Images",
|
|
3925
|
-
"description": "A file input with a specific accepted file type (images only).",
|
|
4432
|
+
"description": "A file input with a specific accepted file type (images only). Dragging a file that is not an image, or more than one file, shows that the drop is not allowed.",
|
|
3926
4433
|
"code": "<QFileUpload label=\"Upload an image\" accept=\"image/*\" />"
|
|
3927
4434
|
},
|
|
4435
|
+
{
|
|
4436
|
+
"title": "Help",
|
|
4437
|
+
"description": "Help shown in a popover.",
|
|
4438
|
+
"code": "<QFileUpload label=\"Wallpaper\" help=\"Your wallpaper is public. Pick a great one!\" />"
|
|
4439
|
+
},
|
|
3928
4440
|
{
|
|
3929
4441
|
"title": "Extras",
|
|
3930
|
-
"description": "
|
|
3931
|
-
"code": "<q-file-upload
|
|
4442
|
+
"description": "Help goes in `help`. The `extras` slot holds other content under the control, here the size of the chosen file.",
|
|
4443
|
+
"code": "<q-file-upload\n\t\t\t\tv-model=\"file\"\n\t\t\t\tv-bind=\"args\">\n\t\t\t\t<template\n\t\t\t\t\tv-if=\"file\"\n\t\t\t\t\t#extras>\n\t\t\t\t\tSize: {{ size }} KB\n\t\t\t\t</template>\n\t\t\t</q-file-upload>"
|
|
3932
4444
|
}
|
|
3933
4445
|
]
|
|
3934
4446
|
},
|
|
@@ -4401,14 +4913,24 @@
|
|
|
4401
4913
|
"category": "Identification"
|
|
4402
4914
|
},
|
|
4403
4915
|
{
|
|
4404
|
-
"name": "
|
|
4916
|
+
"name": "icons",
|
|
4405
4917
|
"type": {
|
|
4406
|
-
"kind": "
|
|
4407
|
-
"
|
|
4918
|
+
"kind": "object",
|
|
4919
|
+
"fields": {}
|
|
4408
4920
|
},
|
|
4409
|
-
"description": "
|
|
4921
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4410
4922
|
"required": false,
|
|
4411
|
-
"category": "
|
|
4923
|
+
"category": "Configuration"
|
|
4924
|
+
},
|
|
4925
|
+
{
|
|
4926
|
+
"name": "texts",
|
|
4927
|
+
"type": {
|
|
4928
|
+
"kind": "object",
|
|
4929
|
+
"fields": {}
|
|
4930
|
+
},
|
|
4931
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4932
|
+
"required": false,
|
|
4933
|
+
"category": "Configuration"
|
|
4412
4934
|
},
|
|
4413
4935
|
{
|
|
4414
4936
|
"name": "required",
|
|
@@ -4421,23 +4943,66 @@
|
|
|
4421
4943
|
"category": "State"
|
|
4422
4944
|
},
|
|
4423
4945
|
{
|
|
4424
|
-
"name": "
|
|
4946
|
+
"name": "size",
|
|
4947
|
+
"type": {
|
|
4948
|
+
"kind": "enum",
|
|
4949
|
+
"values": [
|
|
4950
|
+
"medium",
|
|
4951
|
+
"small",
|
|
4952
|
+
"large",
|
|
4953
|
+
"block",
|
|
4954
|
+
"xlarge",
|
|
4955
|
+
"xxlarge",
|
|
4956
|
+
"mini"
|
|
4957
|
+
]
|
|
4958
|
+
},
|
|
4959
|
+
"description": "The size category of the field.",
|
|
4960
|
+
"default": "large",
|
|
4961
|
+
"required": false,
|
|
4962
|
+
"category": "Presentation"
|
|
4963
|
+
},
|
|
4964
|
+
{
|
|
4965
|
+
"name": "label",
|
|
4966
|
+
"type": {
|
|
4967
|
+
"kind": "primitive",
|
|
4968
|
+
"name": "string"
|
|
4969
|
+
},
|
|
4970
|
+
"description": "The label of the input.",
|
|
4971
|
+
"required": false,
|
|
4972
|
+
"category": "Content"
|
|
4973
|
+
},
|
|
4974
|
+
{
|
|
4975
|
+
"name": "help",
|
|
4425
4976
|
"type": {
|
|
4426
4977
|
"kind": "primitive",
|
|
4427
4978
|
"name": "string"
|
|
4428
4979
|
},
|
|
4429
|
-
"description": "
|
|
4980
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
4981
|
+
"required": false,
|
|
4982
|
+
"category": "Content"
|
|
4983
|
+
},
|
|
4984
|
+
{
|
|
4985
|
+
"name": "helpDisplay",
|
|
4986
|
+
"type": {
|
|
4987
|
+
"kind": "enum",
|
|
4988
|
+
"values": [
|
|
4989
|
+
"popover",
|
|
4990
|
+
"tooltip",
|
|
4991
|
+
"subtext"
|
|
4992
|
+
]
|
|
4993
|
+
},
|
|
4994
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
4430
4995
|
"required": false,
|
|
4431
|
-
"category": "
|
|
4996
|
+
"category": "Presentation"
|
|
4432
4997
|
},
|
|
4433
4998
|
{
|
|
4434
4999
|
"name": "labelPosition",
|
|
4435
5000
|
"type": {
|
|
4436
5001
|
"kind": "enum",
|
|
4437
5002
|
"values": [
|
|
4438
|
-
"right",
|
|
4439
5003
|
"left",
|
|
4440
5004
|
"center",
|
|
5005
|
+
"right",
|
|
4441
5006
|
"topleft",
|
|
4442
5007
|
"topright"
|
|
4443
5008
|
]
|
|
@@ -4447,31 +5012,22 @@
|
|
|
4447
5012
|
"category": "Presentation"
|
|
4448
5013
|
},
|
|
4449
5014
|
{
|
|
4450
|
-
"name": "
|
|
5015
|
+
"name": "for",
|
|
4451
5016
|
"type": {
|
|
4452
|
-
"kind": "
|
|
4453
|
-
"
|
|
4454
|
-
"medium",
|
|
4455
|
-
"small",
|
|
4456
|
-
"large",
|
|
4457
|
-
"block",
|
|
4458
|
-
"xlarge",
|
|
4459
|
-
"xxlarge",
|
|
4460
|
-
"mini"
|
|
4461
|
-
]
|
|
5017
|
+
"kind": "primitive",
|
|
5018
|
+
"name": "string"
|
|
4462
5019
|
},
|
|
4463
|
-
"description": "The
|
|
4464
|
-
"default": "large",
|
|
5020
|
+
"description": "The form field associated with the label.",
|
|
4465
5021
|
"required": false,
|
|
4466
|
-
"category": "
|
|
5022
|
+
"category": "Accessibility"
|
|
4467
5023
|
},
|
|
4468
5024
|
{
|
|
4469
|
-
"name": "
|
|
5025
|
+
"name": "invalid",
|
|
4470
5026
|
"type": {
|
|
4471
5027
|
"kind": "primitive",
|
|
4472
5028
|
"name": "boolean"
|
|
4473
5029
|
},
|
|
4474
|
-
"description": "Whether the input is
|
|
5030
|
+
"description": "Whether the input is invalid.",
|
|
4475
5031
|
"required": false,
|
|
4476
5032
|
"category": "State"
|
|
4477
5033
|
},
|
|
@@ -4481,17 +5037,17 @@
|
|
|
4481
5037
|
"kind": "primitive",
|
|
4482
5038
|
"name": "boolean"
|
|
4483
5039
|
},
|
|
4484
|
-
"description": "
|
|
5040
|
+
"description": "Disables the group and every Quidgest UI control in it, buttons included. A control that\nsets its own `disabled` keeps it.",
|
|
4485
5041
|
"required": false,
|
|
4486
5042
|
"category": "State"
|
|
4487
5043
|
},
|
|
4488
5044
|
{
|
|
4489
|
-
"name": "
|
|
5045
|
+
"name": "readonly",
|
|
4490
5046
|
"type": {
|
|
4491
5047
|
"kind": "primitive",
|
|
4492
5048
|
"name": "boolean"
|
|
4493
5049
|
},
|
|
4494
|
-
"description": "
|
|
5050
|
+
"description": "Makes every Quidgest UI field in the group read-only. Buttons stay enabled. A field that\nsets its own `readonly` keeps it.",
|
|
4495
5051
|
"required": false,
|
|
4496
5052
|
"category": "State"
|
|
4497
5053
|
},
|
|
@@ -4600,6 +5156,16 @@
|
|
|
4600
5156
|
"description": "Displays an asterisk next to the group label.",
|
|
4601
5157
|
"code": "<QInputGroup label=\"Full name\" :required=\"true\" />"
|
|
4602
5158
|
},
|
|
5159
|
+
{
|
|
5160
|
+
"title": "Disabled",
|
|
5161
|
+
"description": "Disables the group and every control in it, buttons included. A control that sets its own `disabled` keeps it.",
|
|
5162
|
+
"code": "<QInputGroup :disabled=\"true\" />"
|
|
5163
|
+
},
|
|
5164
|
+
{
|
|
5165
|
+
"title": "Readonly",
|
|
5166
|
+
"description": "Makes every field in the group read-only, while its buttons stay enabled. A field that sets its own `readonly` keeps it.",
|
|
5167
|
+
"code": "<QInputGroup :readonly=\"true\" />"
|
|
5168
|
+
},
|
|
4603
5169
|
{
|
|
4604
5170
|
"title": "Mixed Heights",
|
|
4605
5171
|
"description": "Keeps sibling controls aligned when one child has a larger intrinsic height.",
|
|
@@ -4662,9 +5228,9 @@
|
|
|
4662
5228
|
"type": {
|
|
4663
5229
|
"kind": "enum",
|
|
4664
5230
|
"values": [
|
|
4665
|
-
"right",
|
|
4666
5231
|
"left",
|
|
4667
5232
|
"center",
|
|
5233
|
+
"right",
|
|
4668
5234
|
"topleft",
|
|
4669
5235
|
"topright"
|
|
4670
5236
|
]
|
|
@@ -4893,6 +5459,27 @@
|
|
|
4893
5459
|
"default": "label",
|
|
4894
5460
|
"required": false,
|
|
4895
5461
|
"category": "Configuration"
|
|
5462
|
+
},
|
|
5463
|
+
{
|
|
5464
|
+
"name": "itemTitle",
|
|
5465
|
+
"type": {
|
|
5466
|
+
"kind": "primitive",
|
|
5467
|
+
"name": "boolean"
|
|
5468
|
+
},
|
|
5469
|
+
"description": "Whether an option whose label is cut off shows the full label in a native `title` on hover.\nThe `title` is for sighted mouse users and is only set while the label is cut off, so screen\nreaders do not hear the label twice. The accessible name is unchanged.\nDefaults to `false`.",
|
|
5470
|
+
"required": false,
|
|
5471
|
+
"category": "Behavior"
|
|
5472
|
+
},
|
|
5473
|
+
{
|
|
5474
|
+
"name": "icons",
|
|
5475
|
+
"type": {
|
|
5476
|
+
"kind": "object",
|
|
5477
|
+
"fields": {}
|
|
5478
|
+
},
|
|
5479
|
+
"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.",
|
|
5480
|
+
"default": "DEFAULT_ICONS",
|
|
5481
|
+
"required": false,
|
|
5482
|
+
"category": "Configuration"
|
|
4896
5483
|
}
|
|
4897
5484
|
],
|
|
4898
5485
|
"events": [
|
|
@@ -5044,9 +5631,9 @@
|
|
|
5044
5631
|
"type": {
|
|
5045
5632
|
"kind": "enum",
|
|
5046
5633
|
"values": [
|
|
5047
|
-
"right",
|
|
5048
5634
|
"left",
|
|
5049
5635
|
"center",
|
|
5636
|
+
"right",
|
|
5050
5637
|
"topleft",
|
|
5051
5638
|
"topright"
|
|
5052
5639
|
]
|
|
@@ -5177,9 +5764,9 @@
|
|
|
5177
5764
|
"type": {
|
|
5178
5765
|
"kind": "enum",
|
|
5179
5766
|
"values": [
|
|
5180
|
-
"right",
|
|
5181
5767
|
"left",
|
|
5182
5768
|
"center",
|
|
5769
|
+
"right",
|
|
5183
5770
|
"topleft",
|
|
5184
5771
|
"topright"
|
|
5185
5772
|
]
|
|
@@ -5189,6 +5776,52 @@
|
|
|
5189
5776
|
"required": false,
|
|
5190
5777
|
"category": "Presentation"
|
|
5191
5778
|
},
|
|
5779
|
+
{
|
|
5780
|
+
"name": "help",
|
|
5781
|
+
"type": {
|
|
5782
|
+
"kind": "primitive",
|
|
5783
|
+
"name": "string"
|
|
5784
|
+
},
|
|
5785
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
5786
|
+
"required": false,
|
|
5787
|
+
"category": "Content"
|
|
5788
|
+
},
|
|
5789
|
+
{
|
|
5790
|
+
"name": "helpDisplay",
|
|
5791
|
+
"type": {
|
|
5792
|
+
"kind": "enum",
|
|
5793
|
+
"values": [
|
|
5794
|
+
"popover",
|
|
5795
|
+
"tooltip",
|
|
5796
|
+
"subtext"
|
|
5797
|
+
]
|
|
5798
|
+
},
|
|
5799
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
5800
|
+
"required": false,
|
|
5801
|
+
"category": "Presentation"
|
|
5802
|
+
},
|
|
5803
|
+
{
|
|
5804
|
+
"name": "icons",
|
|
5805
|
+
"type": {
|
|
5806
|
+
"kind": "object",
|
|
5807
|
+
"fields": {}
|
|
5808
|
+
},
|
|
5809
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.\nCustom icon configurations.",
|
|
5810
|
+
"default": "DEFAULT_ICONS",
|
|
5811
|
+
"required": false,
|
|
5812
|
+
"category": "Configuration"
|
|
5813
|
+
},
|
|
5814
|
+
{
|
|
5815
|
+
"name": "texts",
|
|
5816
|
+
"type": {
|
|
5817
|
+
"kind": "object",
|
|
5818
|
+
"fields": {}
|
|
5819
|
+
},
|
|
5820
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.\nCustom text configurations.",
|
|
5821
|
+
"default": "DEFAULT_TEXTS",
|
|
5822
|
+
"required": false,
|
|
5823
|
+
"category": "Configuration"
|
|
5824
|
+
},
|
|
5192
5825
|
{
|
|
5193
5826
|
"name": "size",
|
|
5194
5827
|
"type": {
|
|
@@ -5284,28 +5917,6 @@
|
|
|
5284
5917
|
"default": "12",
|
|
5285
5918
|
"required": false,
|
|
5286
5919
|
"category": "Presentation"
|
|
5287
|
-
},
|
|
5288
|
-
{
|
|
5289
|
-
"name": "icons",
|
|
5290
|
-
"type": {
|
|
5291
|
-
"kind": "object",
|
|
5292
|
-
"fields": {}
|
|
5293
|
-
},
|
|
5294
|
-
"description": "Custom icon configurations.",
|
|
5295
|
-
"default": "DEFAULT_ICONS",
|
|
5296
|
-
"required": false,
|
|
5297
|
-
"category": "Configuration"
|
|
5298
|
-
},
|
|
5299
|
-
{
|
|
5300
|
-
"name": "texts",
|
|
5301
|
-
"type": {
|
|
5302
|
-
"kind": "object",
|
|
5303
|
-
"fields": {}
|
|
5304
|
-
},
|
|
5305
|
-
"description": "Custom text configurations.",
|
|
5306
|
-
"default": "DEFAULT_TEXTS",
|
|
5307
|
-
"required": false,
|
|
5308
|
-
"category": "Configuration"
|
|
5309
5920
|
}
|
|
5310
5921
|
],
|
|
5311
5922
|
"events": [
|
|
@@ -5762,16 +6373,16 @@
|
|
|
5762
6373
|
"values": [
|
|
5763
6374
|
"top",
|
|
5764
6375
|
"bottom",
|
|
5765
|
-
"right",
|
|
5766
6376
|
"left",
|
|
6377
|
+
"right",
|
|
5767
6378
|
"top-start",
|
|
5768
6379
|
"top-end",
|
|
5769
6380
|
"bottom-start",
|
|
5770
6381
|
"bottom-end",
|
|
5771
|
-
"right-start",
|
|
5772
|
-
"right-end",
|
|
5773
6382
|
"left-start",
|
|
5774
|
-
"left-end"
|
|
6383
|
+
"left-end",
|
|
6384
|
+
"right-start",
|
|
6385
|
+
"right-end"
|
|
5775
6386
|
]
|
|
5776
6387
|
},
|
|
5777
6388
|
"description": "The placement of the overlay.",
|
|
@@ -5872,10 +6483,20 @@
|
|
|
5872
6483
|
"kind": "primitive",
|
|
5873
6484
|
"name": "boolean"
|
|
5874
6485
|
},
|
|
5875
|
-
"description": "If enabled,
|
|
6486
|
+
"description": "If enabled, pressing outside the overlay, or moving focus out of it, does not close it.\nEscape still closes it, as a dialog must stay closable from the keyboard.",
|
|
5876
6487
|
"required": false,
|
|
5877
6488
|
"category": "Behavior"
|
|
5878
6489
|
},
|
|
6490
|
+
{
|
|
6491
|
+
"name": "disabled",
|
|
6492
|
+
"type": {
|
|
6493
|
+
"kind": "primitive",
|
|
6494
|
+
"name": "boolean"
|
|
6495
|
+
},
|
|
6496
|
+
"description": "Whether the overlay is disabled. Its anchor does not open it, and an open overlay\ncloses when it becomes disabled.",
|
|
6497
|
+
"required": false,
|
|
6498
|
+
"category": "State"
|
|
6499
|
+
},
|
|
5879
6500
|
{
|
|
5880
6501
|
"name": "spy",
|
|
5881
6502
|
"type": {
|
|
@@ -6008,6 +6629,11 @@
|
|
|
6008
6629
|
"title": "Independent",
|
|
6009
6630
|
"description": "Independent overlays are standalone elements positioned at the center of the screen, designed to capture user attention and present content or messages without being tied to any specific page elements.",
|
|
6010
6631
|
"code": "<q-button label=\"Click me\" @click=\"args.modelValue = !args.modelValue \" />\n\t\t\t<q-overlay v-model=\"args.modelValue\" v-bind=\"args\">\n\t\t\t\t<div style=\"max-width: 600px; padding: 2rem\">\n\t\t\t\t\t<h1>Custom Independent Overlay</h1>\n\t\t\t\t\t<p><strong>Introduction:</strong></p>\n\t\t\t\t\t<p>Welcome to the world of custom independent overlays! These overlays are designed to enhance user experiences by gracefully appearing at the center of the screen, capturing attention without being tied to any specific element.</p>\n\n\t\t\t\t\t<p><strong>Key Features:</strong></p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><strong>Positioned at the Center:</strong> Our custom independent overlays are strategically positioned at the center of the screen, ensuring they are easily visible and accessible.</li>\n\t\t\t\t\t</ul>\n\n\t\t\t\t\t<p><strong>Usage:</strong></p>\n\t\t\t\t\t<ol>\n\t\t\t\t\t\t<li><strong>Initialization:</strong> Include the necessary script or component for the custom independent overlay in your project.</li>\n\t\t\t\t\t\t<li><strong>Triggering the Overlay:</strong> Decide the trigger event or condition that activates the overlay. It could be a button click, a page load, or any other user interaction.</li>\n\t\t\t\t\t\t<li><strong>Enhance User Experience:</strong> Enjoy the seamless presentation of your content or messages in an elegant overlay, providing users with a focused and visually appealing experience.</li>\n\t\t\t\t\t</ol>\n\n\t\t\t\t\t<p><strong>Additional Features:</strong></p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><strong>Scroll Lock:</strong> To prevent scrolling when the overlay is active, use the <code>scrollLock</code> prop.</li>\n\t\t\t\t\t\t<li><strong>Persistent Overlay:</strong> By default, the overlay closes when the user clicks outside. To make it persistent, use the <code>persistent</code> prop.</li>\n\t\t\t\t\t</ul>\n\n\t\t\t\t\t<p><strong>Conclusion:</strong></p>\n\t\t\t\t\t<p>Custom independent overlays are a versatile solution to draw attention to important information or messages without being confined to specific page elements. Elevate your user interface by effortlessly integrating these overlays into your projects.</p>\n\t\t\t\t</div>\n\t\t\t</q-overlay>"
|
|
6632
|
+
},
|
|
6633
|
+
{
|
|
6634
|
+
"title": "Scroll Lock",
|
|
6635
|
+
"description": "With `scrollLock`, the page behind a modal overlay does not scroll. An overlay opened from it keeps the page locked, and the page scrolls again only once the last of them closes.",
|
|
6636
|
+
"code": "<div style=\"height: 100vh\" />\n\t\t\t<q-button label=\"Open overlay\" @click=\"outer = true\" />\n\t\t\t<q-overlay v-model=\"outer\" scroll-lock aria-label=\"Overlay\">\n\t\t\t\t<div style=\"padding: 2rem\">\n\t\t\t\t\t<q-button label=\"Open nested overlay\" @click=\"inner = true\" />\n\t\t\t\t</div>\n\t\t\t</q-overlay>\n\t\t\t<q-overlay v-model=\"inner\" scroll-lock aria-label=\"Nested overlay\">\n\t\t\t\t<div style=\"padding: 2rem\">Nested overlay</div>\n\t\t\t</q-overlay>\n\t\t\t<div style=\"height: 100vh\" />"
|
|
6011
6637
|
}
|
|
6012
6638
|
]
|
|
6013
6639
|
},
|
|
@@ -6044,6 +6670,27 @@
|
|
|
6044
6670
|
"required": false,
|
|
6045
6671
|
"category": "Identification"
|
|
6046
6672
|
},
|
|
6673
|
+
{
|
|
6674
|
+
"name": "icons",
|
|
6675
|
+
"type": {
|
|
6676
|
+
"kind": "object",
|
|
6677
|
+
"fields": {}
|
|
6678
|
+
},
|
|
6679
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
6680
|
+
"default": "DEFAULT_ICONS",
|
|
6681
|
+
"required": false,
|
|
6682
|
+
"category": "Configuration"
|
|
6683
|
+
},
|
|
6684
|
+
{
|
|
6685
|
+
"name": "required",
|
|
6686
|
+
"type": {
|
|
6687
|
+
"kind": "primitive",
|
|
6688
|
+
"name": "boolean"
|
|
6689
|
+
},
|
|
6690
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).\nIf set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
6691
|
+
"required": false,
|
|
6692
|
+
"category": "State"
|
|
6693
|
+
},
|
|
6047
6694
|
{
|
|
6048
6695
|
"name": "size",
|
|
6049
6696
|
"type": {
|
|
@@ -6083,33 +6730,37 @@
|
|
|
6083
6730
|
"category": "Content"
|
|
6084
6731
|
},
|
|
6085
6732
|
{
|
|
6086
|
-
"name": "
|
|
6733
|
+
"name": "help",
|
|
6087
6734
|
"type": {
|
|
6088
6735
|
"kind": "primitive",
|
|
6089
|
-
"name": "
|
|
6736
|
+
"name": "string"
|
|
6090
6737
|
},
|
|
6091
|
-
"description": "
|
|
6738
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
6092
6739
|
"required": false,
|
|
6093
|
-
"category": "
|
|
6740
|
+
"category": "Content"
|
|
6094
6741
|
},
|
|
6095
6742
|
{
|
|
6096
|
-
"name": "
|
|
6743
|
+
"name": "helpDisplay",
|
|
6097
6744
|
"type": {
|
|
6098
|
-
"kind": "
|
|
6099
|
-
"
|
|
6745
|
+
"kind": "enum",
|
|
6746
|
+
"values": [
|
|
6747
|
+
"popover",
|
|
6748
|
+
"tooltip",
|
|
6749
|
+
"subtext"
|
|
6750
|
+
]
|
|
6100
6751
|
},
|
|
6101
|
-
"description": "
|
|
6752
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
6102
6753
|
"required": false,
|
|
6103
|
-
"category": "
|
|
6754
|
+
"category": "Presentation"
|
|
6104
6755
|
},
|
|
6105
6756
|
{
|
|
6106
6757
|
"name": "labelPosition",
|
|
6107
6758
|
"type": {
|
|
6108
6759
|
"kind": "enum",
|
|
6109
6760
|
"values": [
|
|
6110
|
-
"right",
|
|
6111
6761
|
"left",
|
|
6112
6762
|
"center",
|
|
6763
|
+
"right",
|
|
6113
6764
|
"topleft",
|
|
6114
6765
|
"topright"
|
|
6115
6766
|
]
|
|
@@ -6118,6 +6769,16 @@
|
|
|
6118
6769
|
"required": false,
|
|
6119
6770
|
"category": "Presentation"
|
|
6120
6771
|
},
|
|
6772
|
+
{
|
|
6773
|
+
"name": "for",
|
|
6774
|
+
"type": {
|
|
6775
|
+
"kind": "primitive",
|
|
6776
|
+
"name": "string"
|
|
6777
|
+
},
|
|
6778
|
+
"description": "The form field associated with the label.",
|
|
6779
|
+
"required": false,
|
|
6780
|
+
"category": "Accessibility"
|
|
6781
|
+
},
|
|
6121
6782
|
{
|
|
6122
6783
|
"name": "readonly",
|
|
6123
6784
|
"type": {
|
|
@@ -6178,6 +6839,17 @@
|
|
|
6178
6839
|
"required": false,
|
|
6179
6840
|
"category": "Behavior"
|
|
6180
6841
|
},
|
|
6842
|
+
{
|
|
6843
|
+
"name": "autocomplete",
|
|
6844
|
+
"type": {
|
|
6845
|
+
"kind": "primitive",
|
|
6846
|
+
"name": "string"
|
|
6847
|
+
},
|
|
6848
|
+
"description": "The `autocomplete` token for the input. Tells the browser what the field is for.\nDefaults to `new-password`, so the browser does not fill in a saved password.\nBrowsers may still offer to generate or save a password.\nUse `current-password` on login fields.\nMost browsers ignore `off` on password fields.",
|
|
6849
|
+
"default": "new-password",
|
|
6850
|
+
"required": false,
|
|
6851
|
+
"category": "Behavior"
|
|
6852
|
+
},
|
|
6181
6853
|
{
|
|
6182
6854
|
"name": "meterLevels",
|
|
6183
6855
|
"type": {
|
|
@@ -6204,24 +6876,13 @@
|
|
|
6204
6876
|
"required": false,
|
|
6205
6877
|
"category": "Configuration"
|
|
6206
6878
|
},
|
|
6207
|
-
{
|
|
6208
|
-
"name": "icons",
|
|
6209
|
-
"type": {
|
|
6210
|
-
"kind": "object",
|
|
6211
|
-
"fields": {}
|
|
6212
|
-
},
|
|
6213
|
-
"description": "Custom icon configurations.",
|
|
6214
|
-
"default": "DEFAULT_ICONS",
|
|
6215
|
-
"required": false,
|
|
6216
|
-
"category": "Configuration"
|
|
6217
|
-
},
|
|
6218
6879
|
{
|
|
6219
6880
|
"name": "texts",
|
|
6220
6881
|
"type": {
|
|
6221
6882
|
"kind": "object",
|
|
6222
6883
|
"fields": {}
|
|
6223
6884
|
},
|
|
6224
|
-
"description": "Custom text configurations
|
|
6885
|
+
"description": "Custom text configurations. Includes the visibility toggle and the help button label.\nPass every key, or omit the prop to keep the defaults.",
|
|
6225
6886
|
"default": "DEFAULT_TEXTS",
|
|
6226
6887
|
"required": false,
|
|
6227
6888
|
"category": "Configuration"
|
|
@@ -6268,6 +6929,11 @@
|
|
|
6268
6929
|
"description": "Standard password field with the `v-model` property for two-way value binding.",
|
|
6269
6930
|
"code": "<QPasswordField />"
|
|
6270
6931
|
},
|
|
6932
|
+
{
|
|
6933
|
+
"title": "Login",
|
|
6934
|
+
"description": "A login field. The browser can fill in a saved password.",
|
|
6935
|
+
"code": "<QPasswordField autocomplete=\"current-password\" />"
|
|
6936
|
+
},
|
|
6271
6937
|
{
|
|
6272
6938
|
"title": "Rules",
|
|
6273
6939
|
"description": "Enforces validation rules to ensure password strength.",
|
|
@@ -6628,9 +7294,9 @@
|
|
|
6628
7294
|
"type": {
|
|
6629
7295
|
"kind": "enum",
|
|
6630
7296
|
"values": [
|
|
6631
|
-
"right",
|
|
6632
7297
|
"left",
|
|
6633
7298
|
"center",
|
|
7299
|
+
"right",
|
|
6634
7300
|
"topleft",
|
|
6635
7301
|
"topright"
|
|
6636
7302
|
]
|
|
@@ -6639,6 +7305,52 @@
|
|
|
6639
7305
|
"required": false,
|
|
6640
7306
|
"category": "Presentation"
|
|
6641
7307
|
},
|
|
7308
|
+
{
|
|
7309
|
+
"name": "help",
|
|
7310
|
+
"type": {
|
|
7311
|
+
"kind": "primitive",
|
|
7312
|
+
"name": "string"
|
|
7313
|
+
},
|
|
7314
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
7315
|
+
"required": false,
|
|
7316
|
+
"category": "Content"
|
|
7317
|
+
},
|
|
7318
|
+
{
|
|
7319
|
+
"name": "helpDisplay",
|
|
7320
|
+
"type": {
|
|
7321
|
+
"kind": "enum",
|
|
7322
|
+
"values": [
|
|
7323
|
+
"popover",
|
|
7324
|
+
"tooltip",
|
|
7325
|
+
"subtext"
|
|
7326
|
+
]
|
|
7327
|
+
},
|
|
7328
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
7329
|
+
"required": false,
|
|
7330
|
+
"category": "Presentation"
|
|
7331
|
+
},
|
|
7332
|
+
{
|
|
7333
|
+
"name": "icons",
|
|
7334
|
+
"type": {
|
|
7335
|
+
"kind": "object",
|
|
7336
|
+
"fields": {}
|
|
7337
|
+
},
|
|
7338
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
7339
|
+
"default": "DEFAULT_ICONS",
|
|
7340
|
+
"required": false,
|
|
7341
|
+
"category": "Configuration"
|
|
7342
|
+
},
|
|
7343
|
+
{
|
|
7344
|
+
"name": "texts",
|
|
7345
|
+
"type": {
|
|
7346
|
+
"kind": "object",
|
|
7347
|
+
"fields": {}
|
|
7348
|
+
},
|
|
7349
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
7350
|
+
"default": "DEFAULT_TEXTS",
|
|
7351
|
+
"required": false,
|
|
7352
|
+
"category": "Configuration"
|
|
7353
|
+
},
|
|
6642
7354
|
{
|
|
6643
7355
|
"name": "size",
|
|
6644
7356
|
"type": {
|
|
@@ -7252,18 +7964,7 @@
|
|
|
7252
7964
|
},
|
|
7253
7965
|
"description": "Whether to disable teleporting the country selector overlay.",
|
|
7254
7966
|
"required": false,
|
|
7255
|
-
"category": "Behavior"
|
|
7256
|
-
},
|
|
7257
|
-
{
|
|
7258
|
-
"name": "texts",
|
|
7259
|
-
"type": {
|
|
7260
|
-
"kind": "object",
|
|
7261
|
-
"fields": {}
|
|
7262
|
-
},
|
|
7263
|
-
"description": "Custom text configurations.",
|
|
7264
|
-
"default": "DEFAULT_TEXTS",
|
|
7265
|
-
"required": false,
|
|
7266
|
-
"category": "Configuration"
|
|
7967
|
+
"category": "Behavior"
|
|
7267
7968
|
}
|
|
7268
7969
|
],
|
|
7269
7970
|
"events": [
|
|
@@ -7330,7 +8031,7 @@
|
|
|
7330
8031
|
},
|
|
7331
8032
|
{
|
|
7332
8033
|
"title": "Paste Detection",
|
|
7333
|
-
"description": "Paste a number beginning with `+` or `00` to update the country automatically.",
|
|
8034
|
+
"description": "Paste a number beginning with `+` or `00` to update the country automatically. Pasting over part of a number replaces just that part.",
|
|
7334
8035
|
"code": "<QPhoneField label=\"Paste an international number\" />"
|
|
7335
8036
|
},
|
|
7336
8037
|
{
|
|
@@ -7451,16 +8152,16 @@
|
|
|
7451
8152
|
"values": [
|
|
7452
8153
|
"top",
|
|
7453
8154
|
"bottom",
|
|
7454
|
-
"right",
|
|
7455
8155
|
"left",
|
|
8156
|
+
"right",
|
|
7456
8157
|
"top-start",
|
|
7457
8158
|
"top-end",
|
|
7458
8159
|
"bottom-start",
|
|
7459
8160
|
"bottom-end",
|
|
7460
|
-
"right-start",
|
|
7461
|
-
"right-end",
|
|
7462
8161
|
"left-start",
|
|
7463
|
-
"left-end"
|
|
8162
|
+
"left-end",
|
|
8163
|
+
"right-start",
|
|
8164
|
+
"right-end"
|
|
7464
8165
|
]
|
|
7465
8166
|
},
|
|
7466
8167
|
"description": "The placement of the popover.",
|
|
@@ -7551,7 +8252,17 @@
|
|
|
7551
8252
|
{
|
|
7552
8253
|
"title": "Placement Variations",
|
|
7553
8254
|
"description": "Position the popover relative to the anchor element using placement options.",
|
|
7554
|
-
"code": "<div
|
|
8255
|
+
"code": "<div style=\"display: flex; justify-content: center; padding: 14rem 0\">\n <q-button-group>\n <q-button\n v-for=\"(placement, i) in placements\"\n :key=\"placement\"\n :ref=\"(el) => anchors[i] = el\"\n :label=\"placement\"\n />\n </q-button-group>\n <template\n v-for=\"(placement, i) in placements\"\n :key=\"placement\">\n <q-popover\n :anchor=\"anchors[i]?.$el\"\n :placement=\"placement\"\n title=\"Positioning Matters\"\n text=\"This strategically placed popover helps maintain clear visual relationships between UI elements.\"\n />\n </template>\n </div>"
|
|
8256
|
+
},
|
|
8257
|
+
{
|
|
8258
|
+
"title": "Flip",
|
|
8259
|
+
"description": "When the preferred side has no room for the popover, it opens on the opposite side of its anchor. It also slides along the anchor to stay in view, with its arrow still pointing at it.",
|
|
8260
|
+
"code": "<div style=\"display: flex; flex-direction: column; justify-content: space-between; height: calc(100vh - 2rem)\">\n <div style=\"display: flex; justify-content: space-between\">\n <q-button ref=\"start\" label=\"Above\" />\n <q-button ref=\"end\" label=\"To the right\" />\n </div>\n <div>\n <q-button ref=\"bottom\" label=\"Below\" />\n </div>\n </div>\n <q-popover :anchor=\"start?.$el\" placement=\"top\" title=\"Above\" :text=\"text\" />\n <q-popover :anchor=\"end?.$el\" placement=\"right\" title=\"To the right\" :text=\"text\" />\n <q-popover :anchor=\"bottom?.$el\" placement=\"bottom\" title=\"Below\" :text=\"text\" />"
|
|
8261
|
+
},
|
|
8262
|
+
{
|
|
8263
|
+
"title": "Limited Size",
|
|
8264
|
+
"description": "When neither side of its anchor has room for the popover, it opens on the side with more room, takes the room there, and scrolls its content.",
|
|
8265
|
+
"code": "<div style=\"display: flex; align-items: center; justify-content: center; height: calc(100vh - 6rem)\">\n <q-button ref=\"anchor\" label=\"Terms of use\" />\n </div>\n <q-popover :anchor=\"anchor?.$el\" placement=\"top\" title=\"Terms of use\" :text=\"text\" />"
|
|
7555
8266
|
},
|
|
7556
8267
|
{
|
|
7557
8268
|
"title": "HTML Content",
|
|
@@ -7976,6 +8687,36 @@
|
|
|
7976
8687
|
"required": false,
|
|
7977
8688
|
"category": "Identification"
|
|
7978
8689
|
},
|
|
8690
|
+
{
|
|
8691
|
+
"name": "icons",
|
|
8692
|
+
"type": {
|
|
8693
|
+
"kind": "object",
|
|
8694
|
+
"fields": {}
|
|
8695
|
+
},
|
|
8696
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
8697
|
+
"required": false,
|
|
8698
|
+
"category": "Configuration"
|
|
8699
|
+
},
|
|
8700
|
+
{
|
|
8701
|
+
"name": "texts",
|
|
8702
|
+
"type": {
|
|
8703
|
+
"kind": "object",
|
|
8704
|
+
"fields": {}
|
|
8705
|
+
},
|
|
8706
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
8707
|
+
"required": false,
|
|
8708
|
+
"category": "Configuration"
|
|
8709
|
+
},
|
|
8710
|
+
{
|
|
8711
|
+
"name": "required",
|
|
8712
|
+
"type": {
|
|
8713
|
+
"kind": "primitive",
|
|
8714
|
+
"name": "boolean"
|
|
8715
|
+
},
|
|
8716
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).\nIf set to true, an asterisk (*) is displayed\nto indicate that the field is required.",
|
|
8717
|
+
"required": false,
|
|
8718
|
+
"category": "State"
|
|
8719
|
+
},
|
|
7979
8720
|
{
|
|
7980
8721
|
"name": "disabled",
|
|
7981
8722
|
"type": {
|
|
@@ -7997,33 +8738,37 @@
|
|
|
7997
8738
|
"category": "Content"
|
|
7998
8739
|
},
|
|
7999
8740
|
{
|
|
8000
|
-
"name": "
|
|
8741
|
+
"name": "help",
|
|
8001
8742
|
"type": {
|
|
8002
8743
|
"kind": "primitive",
|
|
8003
|
-
"name": "
|
|
8744
|
+
"name": "string"
|
|
8004
8745
|
},
|
|
8005
|
-
"description": "
|
|
8746
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
8006
8747
|
"required": false,
|
|
8007
|
-
"category": "
|
|
8748
|
+
"category": "Content"
|
|
8008
8749
|
},
|
|
8009
8750
|
{
|
|
8010
|
-
"name": "
|
|
8751
|
+
"name": "helpDisplay",
|
|
8011
8752
|
"type": {
|
|
8012
|
-
"kind": "
|
|
8013
|
-
"
|
|
8753
|
+
"kind": "enum",
|
|
8754
|
+
"values": [
|
|
8755
|
+
"popover",
|
|
8756
|
+
"tooltip",
|
|
8757
|
+
"subtext"
|
|
8758
|
+
]
|
|
8014
8759
|
},
|
|
8015
|
-
"description": "
|
|
8760
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
8016
8761
|
"required": false,
|
|
8017
|
-
"category": "
|
|
8762
|
+
"category": "Presentation"
|
|
8018
8763
|
},
|
|
8019
8764
|
{
|
|
8020
8765
|
"name": "labelPosition",
|
|
8021
8766
|
"type": {
|
|
8022
8767
|
"kind": "enum",
|
|
8023
8768
|
"values": [
|
|
8024
|
-
"right",
|
|
8025
8769
|
"left",
|
|
8026
8770
|
"center",
|
|
8771
|
+
"right",
|
|
8027
8772
|
"topleft",
|
|
8028
8773
|
"topright"
|
|
8029
8774
|
]
|
|
@@ -8033,6 +8778,16 @@
|
|
|
8033
8778
|
"required": false,
|
|
8034
8779
|
"category": "Presentation"
|
|
8035
8780
|
},
|
|
8781
|
+
{
|
|
8782
|
+
"name": "for",
|
|
8783
|
+
"type": {
|
|
8784
|
+
"kind": "primitive",
|
|
8785
|
+
"name": "string"
|
|
8786
|
+
},
|
|
8787
|
+
"description": "The form field associated with the label.",
|
|
8788
|
+
"required": false,
|
|
8789
|
+
"category": "Accessibility"
|
|
8790
|
+
},
|
|
8036
8791
|
{
|
|
8037
8792
|
"name": "readonly",
|
|
8038
8793
|
"type": {
|
|
@@ -8166,7 +8921,7 @@
|
|
|
8166
8921
|
{
|
|
8167
8922
|
"title": "Colors",
|
|
8168
8923
|
"description": "A demonstration of radio buttons with different color themes.",
|
|
8169
|
-
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Primary\" value=\"primary\" color=\"primary\" />\n\t\t\t\t<q-radio-button label=\"Info\" value=\"info\" color=\"info\" />\n\t\t\t\t<q-radio-button label=\"Success\" value=\"success\" color=\"success\" />\n\t\t\t\t<q-radio-button label=\"Warning\" value=\"warning\" color=\"warning\" />\n\t\t\t\t<q-radio-button label=\"Danger\" value=\"danger\" color=\"danger\" />\n\t\t\t</q-radio-group>"
|
|
8924
|
+
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Primary\" value=\"primary\" color=\"primary\" />\n\t\t\t\t<q-radio-button label=\"Info\" value=\"info\" color=\"info\" />\n\t\t\t\t<q-radio-button label=\"Success\" value=\"success\" color=\"success\" />\n\t\t\t\t<q-radio-button label=\"Warning\" value=\"warning\" color=\"warning\" />\n\t\t\t\t<q-radio-button label=\"Danger\" value=\"danger\" color=\"danger\" />\n\t\t\t\t<q-radio-button label=\"Custom\" value=\"custom\" color=\"#cc00cc\" />\n\t\t\t</q-radio-group>"
|
|
8170
8925
|
},
|
|
8171
8926
|
{
|
|
8172
8927
|
"title": "Size",
|
|
@@ -8188,10 +8943,15 @@
|
|
|
8188
8943
|
"description": "A radio button group with an invalid state.",
|
|
8189
8944
|
"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>"
|
|
8190
8945
|
},
|
|
8946
|
+
{
|
|
8947
|
+
"title": "Help",
|
|
8948
|
+
"description": "Help shown in a popover.",
|
|
8949
|
+
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Pizza\" value=\"pizza\" />\n\t\t\t\t<q-radio-button label=\"Burger\" value=\"burger\" />\n\t\t\t\t<q-radio-button label=\"Sushi\" value=\"sushi\" />\n\t\t\t</q-radio-group>"
|
|
8950
|
+
},
|
|
8191
8951
|
{
|
|
8192
8952
|
"title": "Extras",
|
|
8193
|
-
"description": "
|
|
8194
|
-
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Pizza\" value=\"pizza\" />\n\t\t\t\t<q-radio-button label=\"Burger\" value=\"burger\" />\n\t\t\t\t<q-radio-button label=\"Sushi\" value=\"sushi\" />\n\t\t\t\t<template #extras>\n\t\t\t\t\t<
|
|
8953
|
+
"description": "Help goes in `help`. The `extras` slot holds other content under the control, here a link to suggest another option.",
|
|
8954
|
+
"code": "<q-radio-group v-bind=\"args\">\n\t\t\t\t<q-radio-button label=\"Pizza\" value=\"pizza\" />\n\t\t\t\t<q-radio-button label=\"Burger\" value=\"burger\" />\n\t\t\t\t<q-radio-button label=\"Sushi\" value=\"sushi\" />\n\t\t\t\t<template #extras>\n\t\t\t\t\t<a href=\"#suggest\">Suggest another dish</a>\n\t\t\t\t</template>\n\t\t\t</q-radio-group>"
|
|
8195
8955
|
}
|
|
8196
8956
|
]
|
|
8197
8957
|
},
|
|
@@ -8286,6 +9046,31 @@
|
|
|
8286
9046
|
"required": false,
|
|
8287
9047
|
"category": "Content"
|
|
8288
9048
|
},
|
|
9049
|
+
{
|
|
9050
|
+
"name": "help",
|
|
9051
|
+
"type": {
|
|
9052
|
+
"kind": "primitive",
|
|
9053
|
+
"name": "string"
|
|
9054
|
+
},
|
|
9055
|
+
"description": "Help text. Plain text only. One display at a time.\n\nHelp needs a `title`, which labels the popover and anchors the tooltip. Without a title,\nno help is shown, whatever the display.\n\nTooltip and popover help is also exposed to assistive tech on the section, as its\ndescription. The section is a named group, labeled by its title.",
|
|
9056
|
+
"required": false,
|
|
9057
|
+
"category": "Content"
|
|
9058
|
+
},
|
|
9059
|
+
{
|
|
9060
|
+
"name": "helpDisplay",
|
|
9061
|
+
"type": {
|
|
9062
|
+
"kind": "enum",
|
|
9063
|
+
"values": [
|
|
9064
|
+
"popover",
|
|
9065
|
+
"tooltip",
|
|
9066
|
+
"subtext"
|
|
9067
|
+
]
|
|
9068
|
+
},
|
|
9069
|
+
"description": "How {@link QSectionProps.help} is presented. Defaults to a popover.\n\nA tooltip opens on hover, or on focus inside the title, which only happens when a\n`title.append` control takes focus. On a section it is therefore pointer-only for sighted\nusers, and `popover` or `subtext` suit keyboard users better. Screen readers get the help\nas the section's description in every display.",
|
|
9070
|
+
"default": "popover",
|
|
9071
|
+
"required": false,
|
|
9072
|
+
"category": "Presentation"
|
|
9073
|
+
},
|
|
8289
9074
|
{
|
|
8290
9075
|
"name": "borderless",
|
|
8291
9076
|
"type": {
|
|
@@ -8322,6 +9107,28 @@
|
|
|
8322
9107
|
"description": "If true, the section spans the full width of its container.",
|
|
8323
9108
|
"required": false,
|
|
8324
9109
|
"category": "Presentation"
|
|
9110
|
+
},
|
|
9111
|
+
{
|
|
9112
|
+
"name": "icons",
|
|
9113
|
+
"type": {
|
|
9114
|
+
"kind": "object",
|
|
9115
|
+
"fields": {}
|
|
9116
|
+
},
|
|
9117
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9118
|
+
"default": "DEFAULT_ICONS",
|
|
9119
|
+
"required": false,
|
|
9120
|
+
"category": "Configuration"
|
|
9121
|
+
},
|
|
9122
|
+
{
|
|
9123
|
+
"name": "texts",
|
|
9124
|
+
"type": {
|
|
9125
|
+
"kind": "object",
|
|
9126
|
+
"fields": {}
|
|
9127
|
+
},
|
|
9128
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9129
|
+
"default": "DEFAULT_TEXTS",
|
|
9130
|
+
"required": false,
|
|
9131
|
+
"category": "Configuration"
|
|
8325
9132
|
}
|
|
8326
9133
|
],
|
|
8327
9134
|
"events": [],
|
|
@@ -8346,6 +9153,21 @@
|
|
|
8346
9153
|
"description": "A basic group box with a title and example content.",
|
|
8347
9154
|
"code": "<q-section v-bind=\"args\">\n\t\t\t\t<span>Example of a group box</span>\n\t\t\t</q-section>"
|
|
8348
9155
|
},
|
|
9156
|
+
{
|
|
9157
|
+
"title": "Popover",
|
|
9158
|
+
"description": "Help shown in a popover on the title.",
|
|
9159
|
+
"code": "<q-section v-bind=\"args\">\n\t\t\t\t<span>Example of a group box</span>\n\t\t\t</q-section>"
|
|
9160
|
+
},
|
|
9161
|
+
{
|
|
9162
|
+
"title": "Tooltip",
|
|
9163
|
+
"description": "Help shown in a tooltip on the title.",
|
|
9164
|
+
"code": "<q-section v-bind=\"args\">\n\t\t\t\t<span>Example of a group box</span>\n\t\t\t</q-section>"
|
|
9165
|
+
},
|
|
9166
|
+
{
|
|
9167
|
+
"title": "Subtext",
|
|
9168
|
+
"description": "Help rendered under the title.",
|
|
9169
|
+
"code": "<q-section v-bind=\"args\">\n\t\t\t\t<span>Example of a group box</span>\n\t\t\t</q-section>"
|
|
9170
|
+
},
|
|
8349
9171
|
{
|
|
8350
9172
|
"title": "No Title",
|
|
8351
9173
|
"description": "A group box without a title.",
|
|
@@ -8446,9 +9268,9 @@
|
|
|
8446
9268
|
"type": {
|
|
8447
9269
|
"kind": "enum",
|
|
8448
9270
|
"values": [
|
|
8449
|
-
"right",
|
|
8450
9271
|
"left",
|
|
8451
9272
|
"center",
|
|
9273
|
+
"right",
|
|
8452
9274
|
"topleft",
|
|
8453
9275
|
"topright"
|
|
8454
9276
|
]
|
|
@@ -8457,6 +9279,52 @@
|
|
|
8457
9279
|
"required": false,
|
|
8458
9280
|
"category": "Presentation"
|
|
8459
9281
|
},
|
|
9282
|
+
{
|
|
9283
|
+
"name": "help",
|
|
9284
|
+
"type": {
|
|
9285
|
+
"kind": "primitive",
|
|
9286
|
+
"name": "string"
|
|
9287
|
+
},
|
|
9288
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
9289
|
+
"required": false,
|
|
9290
|
+
"category": "Content"
|
|
9291
|
+
},
|
|
9292
|
+
{
|
|
9293
|
+
"name": "helpDisplay",
|
|
9294
|
+
"type": {
|
|
9295
|
+
"kind": "enum",
|
|
9296
|
+
"values": [
|
|
9297
|
+
"popover",
|
|
9298
|
+
"tooltip",
|
|
9299
|
+
"subtext"
|
|
9300
|
+
]
|
|
9301
|
+
},
|
|
9302
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
9303
|
+
"required": false,
|
|
9304
|
+
"category": "Presentation"
|
|
9305
|
+
},
|
|
9306
|
+
{
|
|
9307
|
+
"name": "icons",
|
|
9308
|
+
"type": {
|
|
9309
|
+
"kind": "object",
|
|
9310
|
+
"fields": {}
|
|
9311
|
+
},
|
|
9312
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
9313
|
+
"default": "DEFAULT_ICONS",
|
|
9314
|
+
"required": false,
|
|
9315
|
+
"category": "Configuration"
|
|
9316
|
+
},
|
|
9317
|
+
{
|
|
9318
|
+
"name": "texts",
|
|
9319
|
+
"type": {
|
|
9320
|
+
"kind": "object",
|
|
9321
|
+
"fields": {}
|
|
9322
|
+
},
|
|
9323
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
9324
|
+
"default": "DEFAULT_TEXTS",
|
|
9325
|
+
"required": false,
|
|
9326
|
+
"category": "Configuration"
|
|
9327
|
+
},
|
|
8460
9328
|
{
|
|
8461
9329
|
"name": "size",
|
|
8462
9330
|
"type": {
|
|
@@ -8595,6 +9463,21 @@
|
|
|
8595
9463
|
"required": false,
|
|
8596
9464
|
"category": "Behavior"
|
|
8597
9465
|
},
|
|
9466
|
+
{
|
|
9467
|
+
"name": "overflow",
|
|
9468
|
+
"type": {
|
|
9469
|
+
"kind": "enum",
|
|
9470
|
+
"values": [
|
|
9471
|
+
"wrap",
|
|
9472
|
+
"fit-content",
|
|
9473
|
+
"truncate"
|
|
9474
|
+
]
|
|
9475
|
+
},
|
|
9476
|
+
"description": "How long option labels overflow in the dropdown.\nDefaults to `wrap`.",
|
|
9477
|
+
"default": "wrap",
|
|
9478
|
+
"required": false,
|
|
9479
|
+
"category": "Presentation"
|
|
9480
|
+
},
|
|
8598
9481
|
{
|
|
8599
9482
|
"name": "badges",
|
|
8600
9483
|
"type": {
|
|
@@ -8646,28 +9529,6 @@
|
|
|
8646
9529
|
"default": "label",
|
|
8647
9530
|
"required": false,
|
|
8648
9531
|
"category": "Configuration"
|
|
8649
|
-
},
|
|
8650
|
-
{
|
|
8651
|
-
"name": "icons",
|
|
8652
|
-
"type": {
|
|
8653
|
-
"kind": "object",
|
|
8654
|
-
"fields": {}
|
|
8655
|
-
},
|
|
8656
|
-
"description": "Custom icon configurations.",
|
|
8657
|
-
"default": "DEFAULT_ICONS",
|
|
8658
|
-
"required": false,
|
|
8659
|
-
"category": "Configuration"
|
|
8660
|
-
},
|
|
8661
|
-
{
|
|
8662
|
-
"name": "texts",
|
|
8663
|
-
"type": {
|
|
8664
|
-
"kind": "object",
|
|
8665
|
-
"fields": {}
|
|
8666
|
-
},
|
|
8667
|
-
"description": "Custom text configurations.",
|
|
8668
|
-
"default": "DEFAULT_TEXTS",
|
|
8669
|
-
"required": false,
|
|
8670
|
-
"category": "Configuration"
|
|
8671
9532
|
}
|
|
8672
9533
|
],
|
|
8673
9534
|
"events": [
|
|
@@ -8769,6 +9630,11 @@
|
|
|
8769
9630
|
"description": "Displays a loading animation that lets users know content is being loaded.",
|
|
8770
9631
|
"code": "<QSelect :items=\"[]\" :loading=\"true\" />"
|
|
8771
9632
|
},
|
|
9633
|
+
{
|
|
9634
|
+
"title": "Overflow",
|
|
9635
|
+
"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. - `truncate`: the menu matches the field and labels end in an ellipsis; a cut-off label shows its full text in a native `title` on hover. - `fit-content`: the menu grows with the longest option.",
|
|
9636
|
+
"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=\"truncate\">\n\t\t\t\t\t<q-select v-bind=\"args\" label=\"Truncate\" overflow=\"truncate\" />\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</div>"
|
|
9637
|
+
},
|
|
8772
9638
|
{
|
|
8773
9639
|
"title": "Description In Items",
|
|
8774
9640
|
"description": "Select with description items.",
|
|
@@ -8793,6 +9659,21 @@
|
|
|
8793
9659
|
"title": "Badges",
|
|
8794
9660
|
"description": "Displays the selected options as badges.",
|
|
8795
9661
|
"code": "<QSelect :items=\"[\n\t\t\t{ key: 'copy', label: 'Copy', icon: { icon: 'content-copy' } },\n\t\t\t{ key: 'cut', label: 'Cut', icon: { icon: 'content-cut' } },\n\t\t\t{ key: 'duplicate', label: 'Duplicate', icon: { icon: 'content-duplicate' } },\n\t\t\t{ key: 'paste', label: 'Paste', icon: { icon: 'content-paste' } },\n\t\t\t{ key: 'save', label: 'Save', icon: { icon: 'content-save' } }\n\t\t]\" :multiple=\"true\" :badges=\"true\" />"
|
|
9662
|
+
},
|
|
9663
|
+
{
|
|
9664
|
+
"title": "Badge Counter",
|
|
9665
|
+
"description": "When the selected badges do not fit in the field, it shows the ones that fit, followed by a \"+N\" counter for the rest.",
|
|
9666
|
+
"code": "<div style=\"width: 20rem\">\n\t\t\t\t<q-select v-bind=\"args\" aria-label=\"Actions\" />\n\t\t\t</div>"
|
|
9667
|
+
},
|
|
9668
|
+
{
|
|
9669
|
+
"title": "Plain Text Counter",
|
|
9670
|
+
"description": "Without badges, the selected items show as text separated by commas, and the ones that do not fit are counted the same way.",
|
|
9671
|
+
"code": "<QSelect :badges=\"false\" />"
|
|
9672
|
+
},
|
|
9673
|
+
{
|
|
9674
|
+
"title": "Badge Counter Icons",
|
|
9675
|
+
"description": "The same badges with SVG icons. An icon keeps its size while its bundle loads, so the badges are measured at the width they end up with.",
|
|
9676
|
+
"code": "<QSelect :items=\"counterActions.map(([label, icon]) => ({\n\t\t\tkey: label.toLowerCase(),\n\t\t\tlabel,\n\t\t\ticon: { icon }\n\t\t}))\" />"
|
|
8796
9677
|
}
|
|
8797
9678
|
]
|
|
8798
9679
|
},
|
|
@@ -8845,8 +9726,8 @@
|
|
|
8845
9726
|
"type": {
|
|
8846
9727
|
"kind": "enum",
|
|
8847
9728
|
"values": [
|
|
8848
|
-
"
|
|
8849
|
-
"
|
|
9729
|
+
"left",
|
|
9730
|
+
"right"
|
|
8850
9731
|
]
|
|
8851
9732
|
},
|
|
8852
9733
|
"description": "Position of the sidebar on the screen. Can be either 'left' or 'right'.",
|
|
@@ -8922,8 +9803,13 @@
|
|
|
8922
9803
|
},
|
|
8923
9804
|
{
|
|
8924
9805
|
"title": "Resizable",
|
|
8925
|
-
"description": "Sidebar with resizable panels enabled.",
|
|
8926
|
-
"code": "<QSidebar v-bind=\"args\">\n\t\t\t\t<q-sidebar-item
|
|
9806
|
+
"description": "Sidebar with resizable panels enabled. Drag the edge of a panel to resize it. `minWidth` and `maxWidth` limit how far it goes: the Activity panel stays between the `medium` and `large` sizes, and the Chat panel between `small` and `medium`.",
|
|
9807
|
+
"code": "<QSidebar v-bind=\"args\">\n\t\t\t\t<q-sidebar-item\n\t\t\t\t\tvalue=\"activity\"\n\t\t\t\t\ttitle=\"Activity\"\n\t\t\t\t\t:icon=\"{ icon: 'bell' }\"\n\t\t\t\t\tinitial-width=\"large\"\n\t\t\t\t\tmin-width=\"medium\"\n\t\t\t\t\tmax-width=\"large\"\n\t\t\t\t\tresizable />\n\t\t\t\t<q-sidebar-item\n\t\t\t\t\tvalue=\"chat\"\n\t\t\t\t\ttitle=\"Chat\"\n\t\t\t\t\t:icon=\"{ icon: 'chat' }\"\n\t\t\t\t\tinitial-width=\"small\"\n\t\t\t\t\tmax-width=\"medium\"\n\t\t\t\t\tresizable />\n\t\t\t\t<q-sidebar-item value=\"calendar\" title=\"Calendar\" :icon=\"{ icon: 'calendar' }\" resizable />\n\t\t\t\t<q-sidebar-item value=\"calls\" title=\"Calls\" :icon=\"{ icon: 'phone' }\" resizable />\n\t\t\t</QSidebar>"
|
|
9808
|
+
},
|
|
9809
|
+
{
|
|
9810
|
+
"title": "Anchor Width",
|
|
9811
|
+
"description": "Set `anchorWidth` to change the width of the anchor rail, in pixels at regular density. The rail scales with the density, and a resized panel keeps it.",
|
|
9812
|
+
"code": "<QSidebar :anchor-width=\"80\" :show-labels=\"true\" model-value=\"activity\" />"
|
|
8927
9813
|
},
|
|
8928
9814
|
{
|
|
8929
9815
|
"title": "Header",
|
|
@@ -9146,7 +10032,7 @@
|
|
|
9146
10032
|
"kind": "primitive",
|
|
9147
10033
|
"name": "boolean"
|
|
9148
10034
|
},
|
|
9149
|
-
"description": "If true, header clicks cannot skip ahead of the furthest reached step.\n\nNext/Previous navigation still works.",
|
|
10035
|
+
"description": "If true, header clicks cannot skip ahead of the furthest reached step.\n\nNext/Previous navigation still works. A step that is removed loses its visited state, so\nit counts as not reached if it comes back.",
|
|
9150
10036
|
"default": "false",
|
|
9151
10037
|
"required": false,
|
|
9152
10038
|
"category": "Behavior"
|
|
@@ -9157,7 +10043,7 @@
|
|
|
9157
10043
|
"kind": "object",
|
|
9158
10044
|
"fields": {}
|
|
9159
10045
|
},
|
|
9160
|
-
"description": "Custom icons for the previous/next navigation buttons
|
|
10046
|
+
"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.",
|
|
9161
10047
|
"default": "DEFAULT_ICONS",
|
|
9162
10048
|
"required": false,
|
|
9163
10049
|
"category": "Configuration"
|
|
@@ -9168,7 +10054,7 @@
|
|
|
9168
10054
|
"kind": "object",
|
|
9169
10055
|
"fields": {}
|
|
9170
10056
|
},
|
|
9171
|
-
"description": "Custom accessible strings.",
|
|
10057
|
+
"description": "Custom accessible strings. Includes the step buttons, the status badges, and the overflow scroll arrows.\nPass every key, or omit the prop to keep the defaults.",
|
|
9172
10058
|
"default": "DEFAULT_TEXTS",
|
|
9173
10059
|
"required": false,
|
|
9174
10060
|
"category": "Configuration"
|
|
@@ -9206,6 +10092,11 @@
|
|
|
9206
10092
|
]
|
|
9207
10093
|
},
|
|
9208
10094
|
"examples": [
|
|
10095
|
+
{
|
|
10096
|
+
"title": "Subtext Help",
|
|
10097
|
+
"description": "Subtext help at the top of the step content. The header caption stays.",
|
|
10098
|
+
"code": "<q-steps v-model=\"step\" v-bind=\"args\">\n\t\t\t\tStep content\n\t\t\t</q-steps>"
|
|
10099
|
+
},
|
|
9209
10100
|
{
|
|
9210
10101
|
"title": "Default",
|
|
9211
10102
|
"description": "Default horizontal steps with the circle variant.",
|
|
@@ -9251,6 +10142,11 @@
|
|
|
9251
10142
|
"description": "More steps than fit at once — horizontal caps visible steps at 4 and scrolls the rest via arrow buttons (built on `QOverflow`).",
|
|
9252
10143
|
"code": "<q-steps v-model=\"step\" v-bind=\"args\">\n\t\t\t\t<p>Current step: {{ step }}</p>\n\t\t\t</q-steps>"
|
|
9253
10144
|
},
|
|
10145
|
+
{
|
|
10146
|
+
"title": "Open At Later Step",
|
|
10147
|
+
"description": "A long wizard that opens at a later step, such as when it restores saved progress. The active step's header scrolls into view.",
|
|
10148
|
+
"code": "<q-steps v-model=\"step\" v-bind=\"args\">\n\t\t\t\t<p>Current step: {{ step }}</p>\n\t\t\t</q-steps>"
|
|
10149
|
+
},
|
|
9254
10150
|
{
|
|
9255
10151
|
"title": "With Completed Steps",
|
|
9256
10152
|
"description": "Completed and active badges — `step.completed` shows a green check, taking precedence over the active step's pencil badge when both apply. `dot` shows neither badge, painting the dot itself green instead. Switch `variant`/`direction` in the controls panel to see the badge positioning for each combination.",
|
|
@@ -9302,6 +10198,16 @@
|
|
|
9302
10198
|
"required": false,
|
|
9303
10199
|
"category": "Identification"
|
|
9304
10200
|
},
|
|
10201
|
+
{
|
|
10202
|
+
"name": "required",
|
|
10203
|
+
"type": {
|
|
10204
|
+
"kind": "primitive",
|
|
10205
|
+
"name": "boolean"
|
|
10206
|
+
},
|
|
10207
|
+
"description": "If set to true, an asterisk (*) is displayed\nto indicate that the associated field is required.\n\nThe asterisk is decorative (`aria-hidden`). Required state for assistive\ntech should come from the associated control (e.g. native `required` on inputs).",
|
|
10208
|
+
"required": false,
|
|
10209
|
+
"category": "State"
|
|
10210
|
+
},
|
|
9305
10211
|
{
|
|
9306
10212
|
"name": "label",
|
|
9307
10213
|
"type": {
|
|
@@ -9313,30 +10219,65 @@
|
|
|
9313
10219
|
"category": "Content"
|
|
9314
10220
|
},
|
|
9315
10221
|
{
|
|
9316
|
-
"name": "
|
|
10222
|
+
"name": "labelPosition",
|
|
10223
|
+
"type": {
|
|
10224
|
+
"kind": "enum",
|
|
10225
|
+
"values": [
|
|
10226
|
+
"left",
|
|
10227
|
+
"center",
|
|
10228
|
+
"right",
|
|
10229
|
+
"topleft",
|
|
10230
|
+
"topright"
|
|
10231
|
+
]
|
|
10232
|
+
},
|
|
10233
|
+
"description": "Position of the label relative to the input field.\n- 'left': Label appears to the left of the input\n- 'center': Label appears above the input, centered\n- 'right': Label appears to the right of the input\n- 'topleft': Label appears above the input, aligned to the left\n- 'topright': Label appears above the input, aligned to the right",
|
|
10234
|
+
"default": "left",
|
|
10235
|
+
"required": false,
|
|
10236
|
+
"category": "Presentation"
|
|
10237
|
+
},
|
|
10238
|
+
{
|
|
10239
|
+
"name": "help",
|
|
9317
10240
|
"type": {
|
|
9318
10241
|
"kind": "primitive",
|
|
9319
|
-
"name": "
|
|
10242
|
+
"name": "string"
|
|
9320
10243
|
},
|
|
9321
|
-
"description": "
|
|
10244
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
9322
10245
|
"required": false,
|
|
9323
|
-
"category": "
|
|
10246
|
+
"category": "Content"
|
|
9324
10247
|
},
|
|
9325
10248
|
{
|
|
9326
|
-
"name": "
|
|
10249
|
+
"name": "helpDisplay",
|
|
10250
|
+
"type": {
|
|
10251
|
+
"kind": "enum",
|
|
10252
|
+
"values": [
|
|
10253
|
+
"popover",
|
|
10254
|
+
"tooltip",
|
|
10255
|
+
"subtext"
|
|
10256
|
+
]
|
|
10257
|
+
},
|
|
10258
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
10259
|
+
"required": false,
|
|
10260
|
+
"category": "Presentation"
|
|
10261
|
+
},
|
|
10262
|
+
{
|
|
10263
|
+
"name": "icons",
|
|
10264
|
+
"type": {
|
|
10265
|
+
"kind": "object",
|
|
10266
|
+
"fields": {}
|
|
10267
|
+
},
|
|
10268
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
10269
|
+
"required": false,
|
|
10270
|
+
"category": "Configuration"
|
|
10271
|
+
},
|
|
10272
|
+
{
|
|
10273
|
+
"name": "texts",
|
|
9327
10274
|
"type": {
|
|
9328
|
-
"kind": "
|
|
9329
|
-
"
|
|
9330
|
-
"right",
|
|
9331
|
-
"left",
|
|
9332
|
-
"center",
|
|
9333
|
-
"topleft",
|
|
9334
|
-
"topright"
|
|
9335
|
-
]
|
|
10275
|
+
"kind": "object",
|
|
10276
|
+
"fields": {}
|
|
9336
10277
|
},
|
|
9337
|
-
"description": "
|
|
10278
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
9338
10279
|
"required": false,
|
|
9339
|
-
"category": "
|
|
10280
|
+
"category": "Configuration"
|
|
9340
10281
|
},
|
|
9341
10282
|
{
|
|
9342
10283
|
"name": "trueLabel",
|
|
@@ -9559,6 +10500,28 @@
|
|
|
9559
10500
|
"description": "If true, disables all nested tabs via defaults cascade.",
|
|
9560
10501
|
"required": false,
|
|
9561
10502
|
"category": "State"
|
|
10503
|
+
},
|
|
10504
|
+
{
|
|
10505
|
+
"name": "icons",
|
|
10506
|
+
"type": {
|
|
10507
|
+
"kind": "object",
|
|
10508
|
+
"fields": {}
|
|
10509
|
+
},
|
|
10510
|
+
"description": "Icons for the tab strip. Includes the overflow navigation chevrons.\nPass every key, or omit the prop to keep the defaults.",
|
|
10511
|
+
"default": "DEFAULT_ICONS",
|
|
10512
|
+
"required": false,
|
|
10513
|
+
"category": "Configuration"
|
|
10514
|
+
},
|
|
10515
|
+
{
|
|
10516
|
+
"name": "texts",
|
|
10517
|
+
"type": {
|
|
10518
|
+
"kind": "object",
|
|
10519
|
+
"fields": {}
|
|
10520
|
+
},
|
|
10521
|
+
"description": "Accessible strings for the tab strip. Includes the overflow back/forward labels and\nthe strings of the nested tabs, which receive them through the defaults cascade\nunless a tab sets its own `texts`.\nPass every key, or omit the prop to keep the defaults.",
|
|
10522
|
+
"default": "DEFAULT_TEXTS",
|
|
10523
|
+
"required": false,
|
|
10524
|
+
"category": "Configuration"
|
|
9562
10525
|
}
|
|
9563
10526
|
],
|
|
9564
10527
|
"events": [
|
|
@@ -9576,6 +10539,11 @@
|
|
|
9576
10539
|
]
|
|
9577
10540
|
},
|
|
9578
10541
|
"examples": [
|
|
10542
|
+
{
|
|
10543
|
+
"title": "Subtext Help",
|
|
10544
|
+
"description": "Subtext help at the top of a panel. The tab button stays the label.",
|
|
10545
|
+
"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</q-tabs>"
|
|
10546
|
+
},
|
|
9579
10547
|
{
|
|
9580
10548
|
"title": "Default",
|
|
9581
10549
|
"description": "Default horizontal tabs.",
|
|
@@ -9630,6 +10598,11 @@
|
|
|
9630
10598
|
"title": "Overflow Vertical",
|
|
9631
10599
|
"description": "Tall vertical rail — overflow arrows scroll one tab at a time.",
|
|
9632
10600
|
"code": "<div style=\"height: 16rem; display: flex\">\n\t\t\t\t<q-tabs v-bind=\"args\" v-model=\"active\" style=\"min-height: 0; flex: 1\">\n\t\t\t\t\t<q-tab\n\t\t\t\t\t\tv-for=\"(label, index) in labels\"\n\t\t\t\t\t\t:key=\"label\"\n\t\t\t\t\t\t:title=\"label\"\n\t\t\t\t\t\t:value=\"\\"
|
|
10601
|
+
},
|
|
10602
|
+
{
|
|
10603
|
+
"title": "Overflow Controlled",
|
|
10604
|
+
"description": "Selecting a tab from outside the strip, through `v-model`, scrolls it into view.",
|
|
10605
|
+
"code": "<q-button label=\"Show the audit log\" @click=\"active = 'tab-9'\" />\n\t\t\t<q-button label=\"Show the overview\" @click=\"active = 'tab-1'\" />\n\t\t\t<div style=\"max-width: 28rem\">\n\t\t\t\t<q-tabs v-bind=\"args\" v-model=\"active\">\n\t\t\t\t\t<q-tab\n\t\t\t\t\t\tv-for=\"(label, index) in labels\"\n\t\t\t\t\t\t:key=\"label\"\n\t\t\t\t\t\t:title=\"label\"\n\t\t\t\t\t\t:value=\"\\"
|
|
9633
10606
|
}
|
|
9634
10607
|
]
|
|
9635
10608
|
},
|
|
@@ -9692,9 +10665,9 @@
|
|
|
9692
10665
|
"type": {
|
|
9693
10666
|
"kind": "enum",
|
|
9694
10667
|
"values": [
|
|
9695
|
-
"right",
|
|
9696
10668
|
"left",
|
|
9697
10669
|
"center",
|
|
10670
|
+
"right",
|
|
9698
10671
|
"topleft",
|
|
9699
10672
|
"topright"
|
|
9700
10673
|
]
|
|
@@ -9703,6 +10676,50 @@
|
|
|
9703
10676
|
"required": false,
|
|
9704
10677
|
"category": "Presentation"
|
|
9705
10678
|
},
|
|
10679
|
+
{
|
|
10680
|
+
"name": "help",
|
|
10681
|
+
"type": {
|
|
10682
|
+
"kind": "primitive",
|
|
10683
|
+
"name": "string"
|
|
10684
|
+
},
|
|
10685
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
10686
|
+
"required": false,
|
|
10687
|
+
"category": "Content"
|
|
10688
|
+
},
|
|
10689
|
+
{
|
|
10690
|
+
"name": "helpDisplay",
|
|
10691
|
+
"type": {
|
|
10692
|
+
"kind": "enum",
|
|
10693
|
+
"values": [
|
|
10694
|
+
"popover",
|
|
10695
|
+
"tooltip",
|
|
10696
|
+
"subtext"
|
|
10697
|
+
]
|
|
10698
|
+
},
|
|
10699
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
10700
|
+
"required": false,
|
|
10701
|
+
"category": "Presentation"
|
|
10702
|
+
},
|
|
10703
|
+
{
|
|
10704
|
+
"name": "icons",
|
|
10705
|
+
"type": {
|
|
10706
|
+
"kind": "object",
|
|
10707
|
+
"fields": {}
|
|
10708
|
+
},
|
|
10709
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
10710
|
+
"required": false,
|
|
10711
|
+
"category": "Configuration"
|
|
10712
|
+
},
|
|
10713
|
+
{
|
|
10714
|
+
"name": "texts",
|
|
10715
|
+
"type": {
|
|
10716
|
+
"kind": "object",
|
|
10717
|
+
"fields": {}
|
|
10718
|
+
},
|
|
10719
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
10720
|
+
"required": false,
|
|
10721
|
+
"category": "Configuration"
|
|
10722
|
+
},
|
|
9706
10723
|
{
|
|
9707
10724
|
"name": "size",
|
|
9708
10725
|
"type": {
|
|
@@ -9976,9 +10993,9 @@
|
|
|
9976
10993
|
"type": {
|
|
9977
10994
|
"kind": "enum",
|
|
9978
10995
|
"values": [
|
|
9979
|
-
"right",
|
|
9980
10996
|
"left",
|
|
9981
10997
|
"center",
|
|
10998
|
+
"right",
|
|
9982
10999
|
"topleft",
|
|
9983
11000
|
"topright"
|
|
9984
11001
|
]
|
|
@@ -9987,6 +11004,52 @@
|
|
|
9987
11004
|
"required": false,
|
|
9988
11005
|
"category": "Presentation"
|
|
9989
11006
|
},
|
|
11007
|
+
{
|
|
11008
|
+
"name": "help",
|
|
11009
|
+
"type": {
|
|
11010
|
+
"kind": "primitive",
|
|
11011
|
+
"name": "string"
|
|
11012
|
+
},
|
|
11013
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the control.\nTooltip help anchors to the control. Without a label, a popover is a button beside the control.",
|
|
11014
|
+
"required": false,
|
|
11015
|
+
"category": "Content"
|
|
11016
|
+
},
|
|
11017
|
+
{
|
|
11018
|
+
"name": "helpDisplay",
|
|
11019
|
+
"type": {
|
|
11020
|
+
"kind": "enum",
|
|
11021
|
+
"values": [
|
|
11022
|
+
"popover",
|
|
11023
|
+
"tooltip",
|
|
11024
|
+
"subtext"
|
|
11025
|
+
]
|
|
11026
|
+
},
|
|
11027
|
+
"description": "How {@link QFieldHelpProps.help} is presented. Defaults to a popover.",
|
|
11028
|
+
"required": false,
|
|
11029
|
+
"category": "Presentation"
|
|
11030
|
+
},
|
|
11031
|
+
{
|
|
11032
|
+
"name": "icons",
|
|
11033
|
+
"type": {
|
|
11034
|
+
"kind": "object",
|
|
11035
|
+
"fields": {}
|
|
11036
|
+
},
|
|
11037
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\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.",
|
|
11038
|
+
"default": "DEFAULT_ICONS",
|
|
11039
|
+
"required": false,
|
|
11040
|
+
"category": "Configuration"
|
|
11041
|
+
},
|
|
11042
|
+
{
|
|
11043
|
+
"name": "texts",
|
|
11044
|
+
"type": {
|
|
11045
|
+
"kind": "object",
|
|
11046
|
+
"fields": {}
|
|
11047
|
+
},
|
|
11048
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\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.",
|
|
11049
|
+
"default": "DEFAULT_TEXTS",
|
|
11050
|
+
"required": false,
|
|
11051
|
+
"category": "Configuration"
|
|
11052
|
+
},
|
|
9990
11053
|
{
|
|
9991
11054
|
"name": "size",
|
|
9992
11055
|
"type": {
|
|
@@ -10075,16 +11138,6 @@
|
|
|
10075
11138
|
"default": "text",
|
|
10076
11139
|
"required": false,
|
|
10077
11140
|
"category": "Behavior"
|
|
10078
|
-
},
|
|
10079
|
-
{
|
|
10080
|
-
"name": "texts",
|
|
10081
|
-
"type": {
|
|
10082
|
-
"kind": "object",
|
|
10083
|
-
"fields": {}
|
|
10084
|
-
},
|
|
10085
|
-
"description": "Custom text configurations.",
|
|
10086
|
-
"required": false,
|
|
10087
|
-
"category": "Configuration"
|
|
10088
11141
|
}
|
|
10089
11142
|
],
|
|
10090
11143
|
"events": [
|
|
@@ -10128,6 +11181,26 @@
|
|
|
10128
11181
|
"description": "Displays a text field.",
|
|
10129
11182
|
"code": "<QTextField />"
|
|
10130
11183
|
},
|
|
11184
|
+
{
|
|
11185
|
+
"title": "Popover",
|
|
11186
|
+
"description": "Help shown in a popover. The popover title is the field label.",
|
|
11187
|
+
"code": "<QTextField help=\"Shown on the invoice\" />"
|
|
11188
|
+
},
|
|
11189
|
+
{
|
|
11190
|
+
"title": "Tooltip",
|
|
11191
|
+
"description": "Help is a tooltip on the control.",
|
|
11192
|
+
"code": "<QTextField help=\"Shown on the invoice\" help-display=\"tooltip\" />"
|
|
11193
|
+
},
|
|
11194
|
+
{
|
|
11195
|
+
"title": "Subtext",
|
|
11196
|
+
"description": "Help rendered under the control.",
|
|
11197
|
+
"code": "<QTextField help=\"Shown on the invoice\" help-display=\"subtext\" />"
|
|
11198
|
+
},
|
|
11199
|
+
{
|
|
11200
|
+
"title": "Tooltip Without Label",
|
|
11201
|
+
"description": "With no visible label, help is a tooltip on the control and there is no help button. `aria-label` is not a `QTextField` prop, so it stays on the template node to name the input.",
|
|
11202
|
+
"code": "<QTextField label=\"\" help=\"Shown on the invoice\" help-display=\"tooltip\" />"
|
|
11203
|
+
},
|
|
10131
11204
|
{
|
|
10132
11205
|
"title": "Placeholder",
|
|
10133
11206
|
"description": "Provides a hint or example text inside the field.",
|
|
@@ -10175,8 +11248,8 @@
|
|
|
10175
11248
|
},
|
|
10176
11249
|
{
|
|
10177
11250
|
"title": "Extras",
|
|
10178
|
-
"description": "
|
|
10179
|
-
"code": "<q-text-field
|
|
11251
|
+
"description": "Help goes in `help`. The `extras` slot holds other content under the control, here the number of characters left.",
|
|
11252
|
+
"code": "<q-text-field\n\t\t\t\tv-model=\"username\"\n\t\t\t\tv-bind=\"args\">\n\t\t\t\t<template #extras>{{ charactersLeft }} characters left</template>\n\t\t\t</q-text-field>"
|
|
10180
11253
|
}
|
|
10181
11254
|
]
|
|
10182
11255
|
},
|
|
@@ -10225,7 +11298,7 @@
|
|
|
10225
11298
|
},
|
|
10226
11299
|
{
|
|
10227
11300
|
"name": "QToast",
|
|
10228
|
-
"description": "Toasts are commonly used to display quick feedback messages to the user, without removing focus from the main page.",
|
|
11301
|
+
"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`, which announces each one 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.",
|
|
10229
11302
|
"meta": {
|
|
10230
11303
|
"props": [
|
|
10231
11304
|
{
|
|
@@ -10274,7 +11347,7 @@
|
|
|
10274
11347
|
"kind": "primitive",
|
|
10275
11348
|
"name": "string"
|
|
10276
11349
|
},
|
|
10277
|
-
"description": "The color of the toast.\nCan be chosen from utility colors like 'success' or 'danger',\nor specified using CSS color codes.",
|
|
11350
|
+
"description": "The color of the toast.\nCan be chosen from utility colors like 'success' or 'danger',\nor specified using CSS color codes.\n`info`, `success`, `warning` and `danger` also set the severity: the icon from `icons`,\nthe text screen readers announce before the message, and the default `live` value.\nOther colors show no icon unless one is passed in the `icon` slot.",
|
|
10278
11351
|
"default": "info",
|
|
10279
11352
|
"required": false,
|
|
10280
11353
|
"category": "Presentation"
|
|
@@ -10290,7 +11363,7 @@
|
|
|
10290
11363
|
"high"
|
|
10291
11364
|
]
|
|
10292
11365
|
},
|
|
10293
|
-
"description": "The shadow depth of the toast. Defaults to '
|
|
11366
|
+
"description": "The shadow depth of the toast. Defaults to 'medium'.",
|
|
10294
11367
|
"default": "medium",
|
|
10295
11368
|
"required": false,
|
|
10296
11369
|
"category": "Presentation"
|
|
@@ -10316,18 +11389,32 @@
|
|
|
10316
11389
|
"kind": "primitive",
|
|
10317
11390
|
"name": "number"
|
|
10318
11391
|
},
|
|
10319
|
-
"description": "The time (ms) until the toast is dismissed.\nIf set to 0 or negative, the toast will have no timeout timer.\nDefaults to
|
|
11392
|
+
"description": "The time (ms) until the toast is dismissed.\nIf set to 0 or negative, the toast will have no timeout timer.\nDefaults to 5000.",
|
|
10320
11393
|
"default": "5000",
|
|
10321
11394
|
"required": false,
|
|
10322
11395
|
"category": "Behavior"
|
|
10323
11396
|
},
|
|
11397
|
+
{
|
|
11398
|
+
"name": "live",
|
|
11399
|
+
"type": {
|
|
11400
|
+
"kind": "enum",
|
|
11401
|
+
"values": [
|
|
11402
|
+
"assertive",
|
|
11403
|
+
"polite",
|
|
11404
|
+
"off"
|
|
11405
|
+
]
|
|
11406
|
+
},
|
|
11407
|
+
"description": "How screen readers announce the toast.\n`assertive` interrupts the user, `polite` waits until they are idle, and `off`\ndoes not announce it. Defaults to `assertive` for `warning` and `danger` and to\n`polite` for any other color.\nA toast shown by `QToaster` is announced through the toaster's live regions, which\nread the severity text, the `title` and the `text`. A toast used on its own gets\n`role=\"alert\"` or `role=\"status\"` instead, and many screen readers skip a `polite`\ntoast that appears together with its message. Show toasts with `useToast` so they\nare heard.",
|
|
11408
|
+
"required": false,
|
|
11409
|
+
"category": "Accessibility"
|
|
11410
|
+
},
|
|
10324
11411
|
{
|
|
10325
11412
|
"name": "icons",
|
|
10326
11413
|
"type": {
|
|
10327
11414
|
"kind": "object",
|
|
10328
11415
|
"fields": {}
|
|
10329
11416
|
},
|
|
10330
|
-
"description": "Custom icon configurations.",
|
|
11417
|
+
"description": "Custom icon configurations: the severity icons and the dismiss icon.\nPass every key, or omit the prop to keep the defaults.",
|
|
10331
11418
|
"default": "DEFAULT_ICONS",
|
|
10332
11419
|
"required": false,
|
|
10333
11420
|
"category": "Configuration"
|
|
@@ -10338,7 +11425,7 @@
|
|
|
10338
11425
|
"kind": "object",
|
|
10339
11426
|
"fields": {}
|
|
10340
11427
|
},
|
|
10341
|
-
"description": "Custom text configurations.",
|
|
11428
|
+
"description": "Custom text configurations: the severity texts read before the message,\nand the label of the dismiss button.\nPass every key, or omit the prop to keep the defaults.",
|
|
10342
11429
|
"default": "DEFAULT_TEXTS",
|
|
10343
11430
|
"required": false,
|
|
10344
11431
|
"category": "Configuration"
|
|
@@ -10362,6 +11449,10 @@
|
|
|
10362
11449
|
}
|
|
10363
11450
|
],
|
|
10364
11451
|
"slots": [
|
|
11452
|
+
{
|
|
11453
|
+
"name": "icon",
|
|
11454
|
+
"description": ""
|
|
11455
|
+
},
|
|
10365
11456
|
{
|
|
10366
11457
|
"name": "title.prepend",
|
|
10367
11458
|
"description": ""
|
|
@@ -10398,14 +11489,19 @@
|
|
|
10398
11489
|
},
|
|
10399
11490
|
{
|
|
10400
11491
|
"title": "Elevation",
|
|
10401
|
-
"description": "Supports different elevation levels. Defaults to
|
|
11492
|
+
"description": "Supports different elevation levels. Defaults to medium.",
|
|
10402
11493
|
"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>"
|
|
10403
11494
|
},
|
|
10404
11495
|
{
|
|
10405
11496
|
"title": "Colors",
|
|
10406
|
-
"description": "Any color can be applied to the toast. Supports semantic colors (success, danger, info, ...) or css colors (#033, rgba(255, 0, 0, 0.5), ...) Defaults to info.",
|
|
11497
|
+
"description": "Any color can be applied to the toast. Supports semantic colors (success, danger, info, ...) or css colors (#033, rgba(255, 0, 0, 0.5), ...) Defaults to info. `info`, `success`, `warning` and `danger` show a matching icon.",
|
|
10407
11498
|
"code": "<div style=\"display: flex; flex-direction: column; gap: 1rem;\">\n\t\t\t\t<q-toast\n\t\t\t\t\tv-for=\"(_, idx) in colors\"\n\t\t\t\t\t:key=\"colors[idx]\"\n\t\t\t\t\t:color=\"colors[idx]\"\n\t\t\t\t\t:text=\"texts[idx]\" />\n\t\t\t</div>"
|
|
10408
11499
|
},
|
|
11500
|
+
{
|
|
11501
|
+
"title": "Custom Icon",
|
|
11502
|
+
"description": "The `icon` slot replaces the icon of a severity color, or adds one to a toast in another color. The icon is decorative and hidden from screen readers, so anything it conveys must also be in the message. Toasts from `useToast` take no slots, so they show only the severity icons from `icons`.",
|
|
11503
|
+
"code": "<q-toast v-bind=\"args\">\n\t\t\t\t<template #icon>\n\t\t\t\t\t<q-icon icon=\"information-outline\" />\n\t\t\t\t</template>\n\t\t\t</q-toast>"
|
|
11504
|
+
},
|
|
10409
11505
|
{
|
|
10410
11506
|
"title": "Bold",
|
|
10411
11507
|
"description": "Displays the toast with a bold background color.",
|
|
@@ -10423,8 +11519,8 @@
|
|
|
10423
11519
|
},
|
|
10424
11520
|
{
|
|
10425
11521
|
"title": "Header Slots",
|
|
10426
|
-
"description": "The toast header is also customizable through the `title.append` and `title.prepend` slots.",
|
|
10427
|
-
"code": "<q-toast
|
|
11522
|
+
"description": "The toast header is also customizable through the `title.append` and `title.prepend` slots. For an icon, use the `icon` slot instead.",
|
|
11523
|
+
"code": "<q-toast v-bind=\"args\">\n\t\t\t\t<template #[\\"
|
|
10428
11524
|
}
|
|
10429
11525
|
]
|
|
10430
11526
|
},
|
|
@@ -10462,16 +11558,60 @@
|
|
|
10462
11558
|
"required": false,
|
|
10463
11559
|
"category": "Content"
|
|
10464
11560
|
},
|
|
11561
|
+
{
|
|
11562
|
+
"name": "help",
|
|
11563
|
+
"type": {
|
|
11564
|
+
"kind": "primitive",
|
|
11565
|
+
"name": "string"
|
|
11566
|
+
},
|
|
11567
|
+
"description": "Help text. Plain text only. One display at a time.\n\nTooltip and popover help is also exposed to assistive tech on the button.\nThe popover title is the button label.\n\nWith help, the root element is a `display: contents` wrapper around the button\n(and the help), not the button itself, so:\n- Anchor popovers, tooltips, and measurements to the inner `button`, not to the\n component's `$el`, which has no box.\n- Do not toggle `help` on a focused button: the button is remounted and loses focus.\n- Direct-child selectors such as those of `QButtonGroup` no longer match the button,\n so `QToggleGroupItem` does not accept help.",
|
|
11568
|
+
"required": false,
|
|
11569
|
+
"category": "Content"
|
|
11570
|
+
},
|
|
11571
|
+
{
|
|
11572
|
+
"name": "helpDisplay",
|
|
11573
|
+
"type": {
|
|
11574
|
+
"kind": "enum",
|
|
11575
|
+
"values": [
|
|
11576
|
+
"popover",
|
|
11577
|
+
"tooltip",
|
|
11578
|
+
"subtext"
|
|
11579
|
+
]
|
|
11580
|
+
},
|
|
11581
|
+
"description": "How {@link QButtonProps.help} is presented. Defaults to a popover.\n\n`subtext` renders the help under the button only in block flow. In a flex row\n(such as a dialog footer) or in an inline run it becomes a sibling beside the\nbutton, or breaks the line, so prefer `popover` or `tooltip` there.",
|
|
11582
|
+
"required": false,
|
|
11583
|
+
"category": "Presentation"
|
|
11584
|
+
},
|
|
11585
|
+
{
|
|
11586
|
+
"name": "icons",
|
|
11587
|
+
"type": {
|
|
11588
|
+
"kind": "object",
|
|
11589
|
+
"fields": {}
|
|
11590
|
+
},
|
|
11591
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
11592
|
+
"required": false,
|
|
11593
|
+
"category": "Configuration"
|
|
11594
|
+
},
|
|
11595
|
+
{
|
|
11596
|
+
"name": "texts",
|
|
11597
|
+
"type": {
|
|
11598
|
+
"kind": "object",
|
|
11599
|
+
"fields": {}
|
|
11600
|
+
},
|
|
11601
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
11602
|
+
"required": false,
|
|
11603
|
+
"category": "Configuration"
|
|
11604
|
+
},
|
|
10465
11605
|
{
|
|
10466
11606
|
"name": "variant",
|
|
10467
11607
|
"type": {
|
|
10468
11608
|
"kind": "enum",
|
|
10469
11609
|
"values": [
|
|
10470
11610
|
"tonal",
|
|
11611
|
+
"text",
|
|
10471
11612
|
"bold",
|
|
10472
11613
|
"outlined",
|
|
10473
|
-
"ghost"
|
|
10474
|
-
"text"
|
|
11614
|
+
"ghost"
|
|
10475
11615
|
]
|
|
10476
11616
|
},
|
|
10477
11617
|
"description": "Specifies the visual style of the button.",
|
|
@@ -10488,6 +11628,16 @@
|
|
|
10488
11628
|
"required": false,
|
|
10489
11629
|
"category": "Presentation"
|
|
10490
11630
|
},
|
|
11631
|
+
{
|
|
11632
|
+
"name": "surface",
|
|
11633
|
+
"type": {
|
|
11634
|
+
"kind": "primitive",
|
|
11635
|
+
"name": "string"
|
|
11636
|
+
},
|
|
11637
|
+
"description": "The color the button sits on, when it is not the theme background: a utility color\nlike 'primary', or a CSS color code. The label color of the `tonal`, `outlined`,\n`ghost` and `text` variants, and the hover color, are measured against it, so the\nbutton stays readable on a colored banner. Defaults to the theme background.",
|
|
11638
|
+
"required": false,
|
|
11639
|
+
"category": "Presentation"
|
|
11640
|
+
},
|
|
10491
11641
|
{
|
|
10492
11642
|
"name": "borderless",
|
|
10493
11643
|
"type": {
|
|
@@ -10620,6 +11770,11 @@
|
|
|
10620
11770
|
"title": "Default",
|
|
10621
11771
|
"description": "",
|
|
10622
11772
|
"code": "<q-toggle v-bind=\"args\" aria-label=\"Underline\">\n\t\t <q-icon icon=\"format-underline\" />\n\t\t</q-toggle>"
|
|
11773
|
+
},
|
|
11774
|
+
{
|
|
11775
|
+
"title": "Colors",
|
|
11776
|
+
"description": "A pressed toggle uses its own `color`: a tonal fill and a label that clears 4.5:1 on it.",
|
|
11777
|
+
"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>"
|
|
10623
11778
|
}
|
|
10624
11779
|
]
|
|
10625
11780
|
},
|
|
@@ -10759,7 +11914,7 @@
|
|
|
10759
11914
|
{
|
|
10760
11915
|
"name": "update:modelValue",
|
|
10761
11916
|
"description": "",
|
|
10762
|
-
"type": "[value: Primitive | Primitive[]]"
|
|
11917
|
+
"type": "[value: Primitive | Primitive[] | undefined]"
|
|
10763
11918
|
}
|
|
10764
11919
|
],
|
|
10765
11920
|
"slots": [
|
|
@@ -10890,16 +12045,16 @@
|
|
|
10890
12045
|
"values": [
|
|
10891
12046
|
"top",
|
|
10892
12047
|
"bottom",
|
|
10893
|
-
"right",
|
|
10894
12048
|
"left",
|
|
12049
|
+
"right",
|
|
10895
12050
|
"top-start",
|
|
10896
12051
|
"top-end",
|
|
10897
12052
|
"bottom-start",
|
|
10898
12053
|
"bottom-end",
|
|
10899
|
-
"right-start",
|
|
10900
|
-
"right-end",
|
|
10901
12054
|
"left-start",
|
|
10902
|
-
"left-end"
|
|
12055
|
+
"left-end",
|
|
12056
|
+
"right-start",
|
|
12057
|
+
"right-end"
|
|
10903
12058
|
]
|
|
10904
12059
|
},
|
|
10905
12060
|
"description": "The placement of the tooltip.",
|
|
@@ -11019,7 +12174,7 @@
|
|
|
11019
12174
|
{
|
|
11020
12175
|
"title": "Positioning",
|
|
11021
12176
|
"description": "Displays the tooltip on a specific position.",
|
|
11022
|
-
"code": "<q-button-group>\n\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"top?.$el\" placement=\"top\">\n\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t<q-button ref=\"top\" label=\"Top\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-tooltip>\n\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"bottom?.$el\" placement=\"bottom\">\n\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t<q-button ref=\"bottom\" label=\"Bottom\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-tooltip>\n\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"left?.$el\" placement=\"left\">\n\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t<q-button ref=\"left\" label=\"Left\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-tooltip>\n\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"right?.$el\" placement=\"right\">\n\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t<q-button ref=\"right\" label=\"Right\" />\n\t\t\t\t\t</template>\n\t\t\t\t</q-tooltip>\n\t\t\t</q-button-group>"
|
|
12177
|
+
"code": "<div style=\"display: flex; justify-content: center; padding: 6rem 0\">\n\t\t\t\t<q-button-group>\n\t\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"top?.$el\" placement=\"top\">\n\t\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t\t<q-button ref=\"top\" label=\"Top\" v-bind=\"props\" />\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</q-tooltip>\n\t\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"bottom?.$el\" placement=\"bottom\">\n\t\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t\t<q-button ref=\"bottom\" label=\"Bottom\" v-bind=\"props\" />\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</q-tooltip>\n\t\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"left?.$el\" placement=\"left\">\n\t\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t\t<q-button ref=\"left\" label=\"Left\" v-bind=\"props\" />\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</q-tooltip>\n\t\t\t\t\t<q-tooltip v-bind=\"args\" :anchor=\"right?.$el\" placement=\"right\">\n\t\t\t\t\t\t<template #anchor=\"{ props }\">\n\t\t\t\t\t\t\t<q-button ref=\"right\" label=\"Right\" v-bind=\"props\" />\n\t\t\t\t\t\t</template>\n\t\t\t\t\t</q-tooltip>\n\t\t\t\t</q-button-group>\n\t\t\t</div>"
|
|
11023
12178
|
},
|
|
11024
12179
|
{
|
|
11025
12180
|
"title": "Delay",
|
|
@@ -11038,5 +12193,1271 @@
|
|
|
11038
12193
|
}
|
|
11039
12194
|
]
|
|
11040
12195
|
}
|
|
12196
|
+
],
|
|
12197
|
+
"composables": [
|
|
12198
|
+
{
|
|
12199
|
+
"name": "provideTheme",
|
|
12200
|
+
"kind": "function",
|
|
12201
|
+
"description": "Provides and manages a reactive theme instance within Vue’s dependency injection system. This function: - Retrieves the current list of available themes from the existing theme context. - Resolves the input (`nameOrDef`) to either a theme name or a full `QThemeDefinition`. - If a `QThemeDefinition` is provided, it is appended to the existing list of themes. - Creates a new reactive `QThemeInstance` bound to the resolved name and theme list. - Provides the new `QThemeInstance` under `ThemeSymbol`, making it available to descendants via `useTheme()`.",
|
|
12202
|
+
"signature": "provideTheme(nameOrDef: MaybeRefOrGetter<string | QThemeDefinition>): QThemeInstance",
|
|
12203
|
+
"parameters": [
|
|
12204
|
+
{
|
|
12205
|
+
"name": "nameOrDef",
|
|
12206
|
+
"type": "MaybeRefOrGetter<string | QThemeDefinition>",
|
|
12207
|
+
"description": "The theme to activate, given as either: - A theme name (`string`), or a reactive source (`Ref<string>`/getter). - A `QThemeDefinition`, or a reactive source (`Ref<QThemeDefinition>`/getter).",
|
|
12208
|
+
"optional": false
|
|
12209
|
+
}
|
|
12210
|
+
],
|
|
12211
|
+
"returns": {
|
|
12212
|
+
"type": "QThemeInstance",
|
|
12213
|
+
"description": "The newly created and provided `QThemeInstance`."
|
|
12214
|
+
}
|
|
12215
|
+
},
|
|
12216
|
+
{
|
|
12217
|
+
"name": "QDialogItem",
|
|
12218
|
+
"kind": "type",
|
|
12219
|
+
"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.",
|
|
12220
|
+
"signature": "type QDialogItem = {\n id?: string;\n props: QDialogProps;\n options?: QDialogOptions;\n handlers?: QDialogHandlers;\n};"
|
|
12221
|
+
},
|
|
12222
|
+
{
|
|
12223
|
+
"name": "QThemeDefinition",
|
|
12224
|
+
"kind": "type",
|
|
12225
|
+
"description": "Defines the structure of a theme, including its name, mode, and color scheme.",
|
|
12226
|
+
"signature": "type QThemeDefinition = {\n name: string;\n mode: QThemeMode;\n scheme: QColorScheme;\n};"
|
|
12227
|
+
},
|
|
12228
|
+
{
|
|
12229
|
+
"name": "QToastItem",
|
|
12230
|
+
"kind": "type",
|
|
12231
|
+
"description": "Public view of a mounted toast. `id` is set when the toast registers during setup. Prefer `await addToast(...)` to obtain the id.",
|
|
12232
|
+
"signature": "type QToastItem = {\n id?: string;\n props: QToastProps;\n};"
|
|
12233
|
+
},
|
|
12234
|
+
{
|
|
12235
|
+
"name": "QUseDialogReturn",
|
|
12236
|
+
"kind": "type",
|
|
12237
|
+
"description": "Represents the return type of the `useDialog` composable, providing methods and state for managing dialog instances.",
|
|
12238
|
+
"signature": "type QUseDialogReturn = {\n dialogs: ComputedRef<QDialogItem[]>;\n addDialog: (props: QDialogProps, options?: QDialogOptions, handlers?: QDialogHandlers) => Promise<string>;\n removeDialog: (id: string) => void;\n cancelDialog: (id: string) => void;\n};"
|
|
12239
|
+
},
|
|
12240
|
+
{
|
|
12241
|
+
"name": "QUseToastReturn",
|
|
12242
|
+
"kind": "type",
|
|
12243
|
+
"description": "Represents the return type of the `useToast` composable, providing methods and state for managing toast notifications.",
|
|
12244
|
+
"signature": "type QUseToastReturn = {\n toasts: ComputedRef<QToastItem[]>;\n addToast: (props: QToastProps) => Promise<string>;\n removeToast: (id: string) => void;\n cancelToast: (id: string) => void;\n};"
|
|
12245
|
+
},
|
|
12246
|
+
{
|
|
12247
|
+
"name": "useDialog",
|
|
12248
|
+
"kind": "function",
|
|
12249
|
+
"description": "Manages programmatic dialogs for the current app (`createFramework`). Mount exactly one `QDialogProvider` in the app (typically next to the root layout). Every provider renders the same shared list.",
|
|
12250
|
+
"signature": "useDialog(): QUseDialogReturn",
|
|
12251
|
+
"parameters": [],
|
|
12252
|
+
"returns": {
|
|
12253
|
+
"type": "QUseDialogReturn",
|
|
12254
|
+
"description": "An object containing: - dialogs: The array of currently active QDialog instances. - addDialog: A function that adds a QDialog instance according to the given props. - removeDialog: A function to remove a QDialog instance. - cancelDialog: A function to cancel a not-yet-registered dialog by `props.id`."
|
|
12255
|
+
}
|
|
12256
|
+
},
|
|
12257
|
+
{
|
|
12258
|
+
"name": "useTheme",
|
|
12259
|
+
"kind": "function",
|
|
12260
|
+
"description": "Custom hook for accessing the theme configuration in context.",
|
|
12261
|
+
"signature": "useTheme(): QThemeInstance",
|
|
12262
|
+
"parameters": [],
|
|
12263
|
+
"returns": {
|
|
12264
|
+
"type": "QThemeInstance",
|
|
12265
|
+
"description": "The current theme configuration."
|
|
12266
|
+
}
|
|
12267
|
+
},
|
|
12268
|
+
{
|
|
12269
|
+
"name": "useToast",
|
|
12270
|
+
"kind": "function",
|
|
12271
|
+
"description": "Manages programmatic toasts for the current app (`createFramework`). Mount exactly one `QToaster` in the app (typically next to the root layout). Every toaster renders the same shared list.",
|
|
12272
|
+
"signature": "useToast(): QUseToastReturn",
|
|
12273
|
+
"parameters": [],
|
|
12274
|
+
"returns": {
|
|
12275
|
+
"type": "QUseToastReturn",
|
|
12276
|
+
"description": "An object containing: - toasts: The array of currently mounted QToast instances. - addToast: A function that adds a QToast instance to the DOM, according to the given QToastProps. - removeToast: A function to remove a QToast instance from the DOM. - cancelToast: A function to cancel a queued or not-yet-registered toast by `props.id`."
|
|
12277
|
+
}
|
|
12278
|
+
}
|
|
12279
|
+
],
|
|
12280
|
+
"utils": [
|
|
12281
|
+
{
|
|
12282
|
+
"name": "color",
|
|
12283
|
+
"description": "",
|
|
12284
|
+
"exports": [
|
|
12285
|
+
{
|
|
12286
|
+
"name": "COLOR_SCHEME_DARKEN_AMOUNT",
|
|
12287
|
+
"kind": "const",
|
|
12288
|
+
"description": "Amount passed to {@link darken} when auto-generating scheme `*Dark` variants (and `useColor` hover fallback when no scheme `*Dark` token applies).",
|
|
12289
|
+
"signature": "25"
|
|
12290
|
+
},
|
|
12291
|
+
{
|
|
12292
|
+
"name": "COLOR_SCHEME_LIGHTEN_AMOUNT",
|
|
12293
|
+
"kind": "const",
|
|
12294
|
+
"description": "Amount passed to {@link lighten} when auto-generating scheme `*Light` variants.",
|
|
12295
|
+
"signature": "75"
|
|
12296
|
+
},
|
|
12297
|
+
{
|
|
12298
|
+
"name": "darken",
|
|
12299
|
+
"kind": "function",
|
|
12300
|
+
"description": "Darkens a color by a specified amount.",
|
|
12301
|
+
"signature": "darken(rgb: RGB, amount: number): RGB",
|
|
12302
|
+
"parameters": [
|
|
12303
|
+
{
|
|
12304
|
+
"name": "rgb",
|
|
12305
|
+
"type": "RGB",
|
|
12306
|
+
"description": "The color to darken.",
|
|
12307
|
+
"optional": false
|
|
12308
|
+
},
|
|
12309
|
+
{
|
|
12310
|
+
"name": "amount",
|
|
12311
|
+
"type": "number",
|
|
12312
|
+
"description": "The amount to darken the color by, in the range [0, 100].",
|
|
12313
|
+
"optional": false
|
|
12314
|
+
}
|
|
12315
|
+
],
|
|
12316
|
+
"returns": {
|
|
12317
|
+
"type": "RGB",
|
|
12318
|
+
"description": "The darkened color."
|
|
12319
|
+
}
|
|
12320
|
+
},
|
|
12321
|
+
{
|
|
12322
|
+
"name": "ensureContrast",
|
|
12323
|
+
"kind": "function",
|
|
12324
|
+
"description": "Darkens or lightens `color` on the same hue until it clears `minimumRatio` against `background`. A pair that already passes is returned unchanged. Direction follows the surface: darken on a light background, lighten on a dark one.",
|
|
12325
|
+
"signature": "ensureContrast(color: string, background: string, minimumRatio?: number): string",
|
|
12326
|
+
"parameters": [
|
|
12327
|
+
{
|
|
12328
|
+
"name": "color",
|
|
12329
|
+
"type": "string",
|
|
12330
|
+
"description": "Foreground color (hex, rgb, or hsl).",
|
|
12331
|
+
"optional": false
|
|
12332
|
+
},
|
|
12333
|
+
{
|
|
12334
|
+
"name": "background",
|
|
12335
|
+
"type": "string",
|
|
12336
|
+
"description": "Surface the text sits on.",
|
|
12337
|
+
"optional": false
|
|
12338
|
+
},
|
|
12339
|
+
{
|
|
12340
|
+
"name": "minimumRatio",
|
|
12341
|
+
"type": "number",
|
|
12342
|
+
"description": "WCAG contrast ratio to reach. Defaults to 4.5:1.",
|
|
12343
|
+
"optional": true
|
|
12344
|
+
}
|
|
12345
|
+
],
|
|
12346
|
+
"returns": {
|
|
12347
|
+
"type": "string",
|
|
12348
|
+
"description": "The original color when it already passes, otherwise an adjusted hex color."
|
|
12349
|
+
}
|
|
12350
|
+
},
|
|
12351
|
+
{
|
|
12352
|
+
"name": "getComplementaryColor",
|
|
12353
|
+
"kind": "function",
|
|
12354
|
+
"description": "Calculates the complementary color for a given color string. The complementary color is the color directly opposite on the color wheel, often used for strong visual contrast.",
|
|
12355
|
+
"signature": "getComplementaryColor(color: string): string",
|
|
12356
|
+
"parameters": [
|
|
12357
|
+
{
|
|
12358
|
+
"name": "color",
|
|
12359
|
+
"type": "string",
|
|
12360
|
+
"description": "The color string to convert. Can be in various formats (e.g., hex, rgb, rgba, hsl, hsla).",
|
|
12361
|
+
"optional": false
|
|
12362
|
+
}
|
|
12363
|
+
],
|
|
12364
|
+
"returns": {
|
|
12365
|
+
"type": "string",
|
|
12366
|
+
"description": "A hex string representing the complementary color."
|
|
12367
|
+
}
|
|
12368
|
+
},
|
|
12369
|
+
{
|
|
12370
|
+
"name": "getContrastingColor",
|
|
12371
|
+
"kind": "function",
|
|
12372
|
+
"description": "Determines a contrasting color (black or white) based on WCAG relative luminance.",
|
|
12373
|
+
"signature": "getContrastingColor(rgb: RGB): \"#000\" | \"#fff\"",
|
|
12374
|
+
"parameters": [
|
|
12375
|
+
{
|
|
12376
|
+
"name": "rgb",
|
|
12377
|
+
"type": "RGB",
|
|
12378
|
+
"description": "The background color in RGB space.",
|
|
12379
|
+
"optional": false
|
|
12380
|
+
}
|
|
12381
|
+
],
|
|
12382
|
+
"returns": {
|
|
12383
|
+
"type": "\"#000\" | \"#fff\"",
|
|
12384
|
+
"description": "A hex string representing either black ('#000') or white ('#fff')."
|
|
12385
|
+
}
|
|
12386
|
+
},
|
|
12387
|
+
{
|
|
12388
|
+
"name": "getContrastRatio",
|
|
12389
|
+
"kind": "function",
|
|
12390
|
+
"description": "Calculates the WCAG 2.x contrast ratio between two relative luminance values.",
|
|
12391
|
+
"signature": "getContrastRatio(luminanceA: number, luminanceB: number): number",
|
|
12392
|
+
"parameters": [
|
|
12393
|
+
{
|
|
12394
|
+
"name": "luminanceA",
|
|
12395
|
+
"type": "number",
|
|
12396
|
+
"description": "Relative luminance of the first color.",
|
|
12397
|
+
"optional": false
|
|
12398
|
+
},
|
|
12399
|
+
{
|
|
12400
|
+
"name": "luminanceB",
|
|
12401
|
+
"type": "number",
|
|
12402
|
+
"description": "Relative luminance of the second color.",
|
|
12403
|
+
"optional": false
|
|
12404
|
+
}
|
|
12405
|
+
],
|
|
12406
|
+
"returns": {
|
|
12407
|
+
"type": "number",
|
|
12408
|
+
"description": "Contrast ratio, where 1 means no contrast and 21 is the maximum."
|
|
12409
|
+
}
|
|
12410
|
+
},
|
|
12411
|
+
{
|
|
12412
|
+
"name": "getRelativeLuminance",
|
|
12413
|
+
"kind": "function",
|
|
12414
|
+
"description": "Calculates the WCAG 2.x relative luminance for an sRGB color.",
|
|
12415
|
+
"signature": "getRelativeLuminance(rgb: RGB): number",
|
|
12416
|
+
"parameters": [
|
|
12417
|
+
{
|
|
12418
|
+
"name": "rgb",
|
|
12419
|
+
"type": "RGB",
|
|
12420
|
+
"description": "The color in RGB space.",
|
|
12421
|
+
"optional": false
|
|
12422
|
+
}
|
|
12423
|
+
],
|
|
12424
|
+
"returns": {
|
|
12425
|
+
"type": "number",
|
|
12426
|
+
"description": "Relative luminance between 0 and 1."
|
|
12427
|
+
}
|
|
12428
|
+
},
|
|
12429
|
+
{
|
|
12430
|
+
"name": "HSL",
|
|
12431
|
+
"kind": "type",
|
|
12432
|
+
"description": "Represents a color in HSL space.",
|
|
12433
|
+
"signature": "type HSL = {\n h: number;\n s: number;\n l: number;\n};"
|
|
12434
|
+
},
|
|
12435
|
+
{
|
|
12436
|
+
"name": "hslToRgb",
|
|
12437
|
+
"kind": "function",
|
|
12438
|
+
"description": "Converts a color from HSL to RGB space.",
|
|
12439
|
+
"signature": "hslToRgb(hsl: HSL): RGB",
|
|
12440
|
+
"parameters": [
|
|
12441
|
+
{
|
|
12442
|
+
"name": "hsl",
|
|
12443
|
+
"type": "HSL",
|
|
12444
|
+
"description": "",
|
|
12445
|
+
"optional": false
|
|
12446
|
+
}
|
|
12447
|
+
],
|
|
12448
|
+
"returns": {
|
|
12449
|
+
"type": "RGB",
|
|
12450
|
+
"description": "A `RGB` object representing the color in RGB space."
|
|
12451
|
+
}
|
|
12452
|
+
},
|
|
12453
|
+
{
|
|
12454
|
+
"name": "hueToRgb",
|
|
12455
|
+
"kind": "function",
|
|
12456
|
+
"description": "Converts a hue value to a corresponding RGB value.",
|
|
12457
|
+
"signature": "hueToRgb(p: number, q: number, t: number): number",
|
|
12458
|
+
"parameters": [
|
|
12459
|
+
{
|
|
12460
|
+
"name": "p",
|
|
12461
|
+
"type": "number",
|
|
12462
|
+
"description": "The first RGB component.",
|
|
12463
|
+
"optional": false
|
|
12464
|
+
},
|
|
12465
|
+
{
|
|
12466
|
+
"name": "q",
|
|
12467
|
+
"type": "number",
|
|
12468
|
+
"description": "The second RGB component.",
|
|
12469
|
+
"optional": false
|
|
12470
|
+
},
|
|
12471
|
+
{
|
|
12472
|
+
"name": "t",
|
|
12473
|
+
"type": "number",
|
|
12474
|
+
"description": "The hue value.",
|
|
12475
|
+
"optional": false
|
|
12476
|
+
}
|
|
12477
|
+
],
|
|
12478
|
+
"returns": {
|
|
12479
|
+
"type": "number",
|
|
12480
|
+
"description": "The corresponding RGB value."
|
|
12481
|
+
}
|
|
12482
|
+
},
|
|
12483
|
+
{
|
|
12484
|
+
"name": "isThemeColor",
|
|
12485
|
+
"kind": "function",
|
|
12486
|
+
"description": "Checks whether a color string is a theme utility color key. Does not trim: BEM consumers build classes from the raw prop (`q-button--${color}`), so padded keys must not be classified as utilities or the modifier class would miss while the prop still looks theme-like.",
|
|
12487
|
+
"signature": "isThemeColor(color: string): boolean",
|
|
12488
|
+
"parameters": [
|
|
12489
|
+
{
|
|
12490
|
+
"name": "color",
|
|
12491
|
+
"type": "string",
|
|
12492
|
+
"description": "The color value to check.",
|
|
12493
|
+
"optional": false
|
|
12494
|
+
}
|
|
12495
|
+
],
|
|
12496
|
+
"returns": {
|
|
12497
|
+
"type": "boolean",
|
|
12498
|
+
"description": "True when the value matches a key in {@link THEME_COLOR_KEYS}."
|
|
12499
|
+
}
|
|
12500
|
+
},
|
|
12501
|
+
{
|
|
12502
|
+
"name": "isUnsupportedColor",
|
|
12503
|
+
"kind": "function",
|
|
12504
|
+
"description": "Checks whether a color string is an unsupported CSS keyword or function that cannot be resolved by `useColor`.",
|
|
12505
|
+
"signature": "isUnsupportedColor(color: string): boolean",
|
|
12506
|
+
"parameters": [
|
|
12507
|
+
{
|
|
12508
|
+
"name": "color",
|
|
12509
|
+
"type": "string",
|
|
12510
|
+
"description": "The color value to check.",
|
|
12511
|
+
"optional": false
|
|
12512
|
+
}
|
|
12513
|
+
],
|
|
12514
|
+
"returns": {
|
|
12515
|
+
"type": "boolean",
|
|
12516
|
+
"description": "True for `transparent`, `currentColor`, `inherit`, and `var(...)`."
|
|
12517
|
+
}
|
|
12518
|
+
},
|
|
12519
|
+
{
|
|
12520
|
+
"name": "isValidHex",
|
|
12521
|
+
"kind": "function",
|
|
12522
|
+
"description": "Checks if the given string represents a valid hexadecimal color code. When `enforceSixChars` is false, accepts `#rgb`, `#rrggbb`, and `#rrggbbaa` (aligned with {@link tryParseColor} / hex parsing). When true, only `#rrggbb`.",
|
|
12523
|
+
"signature": "isValidHex(hexColorCode: string, enforceSixChars?: boolean): boolean",
|
|
12524
|
+
"parameters": [
|
|
12525
|
+
{
|
|
12526
|
+
"name": "hexColorCode",
|
|
12527
|
+
"type": "string",
|
|
12528
|
+
"description": "The color code to validate.",
|
|
12529
|
+
"optional": false
|
|
12530
|
+
},
|
|
12531
|
+
{
|
|
12532
|
+
"name": "enforceSixChars",
|
|
12533
|
+
"type": "boolean",
|
|
12534
|
+
"description": "Whether to enforce only the 6-character format (default is false).",
|
|
12535
|
+
"optional": true
|
|
12536
|
+
}
|
|
12537
|
+
],
|
|
12538
|
+
"returns": {
|
|
12539
|
+
"type": "boolean",
|
|
12540
|
+
"description": "True if the color code is valid, false otherwise."
|
|
12541
|
+
}
|
|
12542
|
+
},
|
|
12543
|
+
{
|
|
12544
|
+
"name": "lighten",
|
|
12545
|
+
"kind": "function",
|
|
12546
|
+
"description": "Lightens a color by a specified amount.",
|
|
12547
|
+
"signature": "lighten(rgb: RGB, amount: number): RGB",
|
|
12548
|
+
"parameters": [
|
|
12549
|
+
{
|
|
12550
|
+
"name": "rgb",
|
|
12551
|
+
"type": "RGB",
|
|
12552
|
+
"description": "The color to lighten.",
|
|
12553
|
+
"optional": false
|
|
12554
|
+
},
|
|
12555
|
+
{
|
|
12556
|
+
"name": "amount",
|
|
12557
|
+
"type": "number",
|
|
12558
|
+
"description": "The amount to lighten the color by, in the range [0, 100].",
|
|
12559
|
+
"optional": false
|
|
12560
|
+
}
|
|
12561
|
+
],
|
|
12562
|
+
"returns": {
|
|
12563
|
+
"type": "RGB",
|
|
12564
|
+
"description": "The lightened color."
|
|
12565
|
+
}
|
|
12566
|
+
},
|
|
12567
|
+
{
|
|
12568
|
+
"name": "mergeColorSchemes",
|
|
12569
|
+
"kind": "function",
|
|
12570
|
+
"description": "Merges two color schemes, generating color variants and contrasting text colors as needed. This function takes a base color scheme (`a`) and a partial override (`b`), and returns a new color scheme with overrides applied. For each color group (e.g., `primary`, `secondary`, etc.), if a base color is provided in `b`, its light and dark variants are auto-computed, along with appropriate contrasting text colors (`on*`). Individual variant and 'on' color overrides are also respected. Special keys like `background` and `container` are handled separately.",
|
|
12571
|
+
"signature": "mergeColorSchemes(a: QColorScheme, b: Partial<QColorScheme>): QColorScheme",
|
|
12572
|
+
"parameters": [
|
|
12573
|
+
{
|
|
12574
|
+
"name": "a",
|
|
12575
|
+
"type": "QColorScheme",
|
|
12576
|
+
"description": "The base color scheme to merge into.",
|
|
12577
|
+
"optional": false
|
|
12578
|
+
},
|
|
12579
|
+
{
|
|
12580
|
+
"name": "b",
|
|
12581
|
+
"type": "Partial<QColorScheme>",
|
|
12582
|
+
"description": "A partial color scheme containing overrides.",
|
|
12583
|
+
"optional": false
|
|
12584
|
+
}
|
|
12585
|
+
],
|
|
12586
|
+
"returns": {
|
|
12587
|
+
"type": "QColorScheme",
|
|
12588
|
+
"description": "The merged color scheme with computed variants and contrasting colors."
|
|
12589
|
+
}
|
|
12590
|
+
},
|
|
12591
|
+
{
|
|
12592
|
+
"name": "parseColor",
|
|
12593
|
+
"kind": "function",
|
|
12594
|
+
"description": "Parses a supported CSS color string.",
|
|
12595
|
+
"signature": "parseColor(color: string): RGB",
|
|
12596
|
+
"parameters": [
|
|
12597
|
+
{
|
|
12598
|
+
"name": "color",
|
|
12599
|
+
"type": "string",
|
|
12600
|
+
"description": "A CSS color string, e.g. `#aabbcc` or `rgb(170, 187, 204)`.",
|
|
12601
|
+
"optional": false
|
|
12602
|
+
}
|
|
12603
|
+
],
|
|
12604
|
+
"returns": {
|
|
12605
|
+
"type": "RGB",
|
|
12606
|
+
"description": "A `RGB` object representing the parsed color."
|
|
12607
|
+
}
|
|
12608
|
+
},
|
|
12609
|
+
{
|
|
12610
|
+
"name": "QBaseColorScheme",
|
|
12611
|
+
"kind": "type",
|
|
12612
|
+
"description": "",
|
|
12613
|
+
"signature": "type QBaseColorScheme = {\n primary: string;\n primaryLight: string;\n primaryDark: string;\n secondary: string;\n secondaryLight: string;\n secondaryDark: string;\n highlight: string;\n highlightLight: string;\n highlightDark: string;\n info: string;\n infoLight: string;\n infoDark: string;\n success: string;\n successLight: string;\n successDark: string;\n warning: string;\n warningLight: string;\n warningDark: string;\n danger: string;\n dangerLight: string;\n dangerDark: string;\n background: string;\n container: string;\n neutral: string;\n neutralLight: string;\n neutralDark: string;\n};"
|
|
12614
|
+
},
|
|
12615
|
+
{
|
|
12616
|
+
"name": "QColorScheme",
|
|
12617
|
+
"kind": "type",
|
|
12618
|
+
"description": "",
|
|
12619
|
+
"signature": "type QColorScheme = QBaseColorScheme & OnVariants<QBaseColorScheme>;"
|
|
12620
|
+
},
|
|
12621
|
+
{
|
|
12622
|
+
"name": "QThemeColorKey",
|
|
12623
|
+
"kind": "type",
|
|
12624
|
+
"description": "A theme utility color key that resolves against the active color scheme.",
|
|
12625
|
+
"signature": "type QThemeColorKey = (typeof THEME_COLOR_KEYS)[number];"
|
|
12626
|
+
},
|
|
12627
|
+
{
|
|
12628
|
+
"name": "RGB",
|
|
12629
|
+
"kind": "type",
|
|
12630
|
+
"description": "Represents a color in RGB space.",
|
|
12631
|
+
"signature": "type RGB = {\n r: number;\n g: number;\n b: number;\n};"
|
|
12632
|
+
},
|
|
12633
|
+
{
|
|
12634
|
+
"name": "rgbToHex",
|
|
12635
|
+
"kind": "function",
|
|
12636
|
+
"description": "Converts a RGB value to a hex string.",
|
|
12637
|
+
"signature": "rgbToHex(rgb: RGB): string",
|
|
12638
|
+
"parameters": [
|
|
12639
|
+
{
|
|
12640
|
+
"name": "rgb",
|
|
12641
|
+
"type": "RGB",
|
|
12642
|
+
"description": "The color to convert.",
|
|
12643
|
+
"optional": false
|
|
12644
|
+
}
|
|
12645
|
+
],
|
|
12646
|
+
"returns": {
|
|
12647
|
+
"type": "string",
|
|
12648
|
+
"description": "A hex string representing the color."
|
|
12649
|
+
}
|
|
12650
|
+
},
|
|
12651
|
+
{
|
|
12652
|
+
"name": "rgbToHsl",
|
|
12653
|
+
"kind": "function",
|
|
12654
|
+
"description": "Converts a color from RGB to HSL space.",
|
|
12655
|
+
"signature": "rgbToHsl(rgb: RGB): HSL",
|
|
12656
|
+
"parameters": [
|
|
12657
|
+
{
|
|
12658
|
+
"name": "rgb",
|
|
12659
|
+
"type": "RGB",
|
|
12660
|
+
"description": "",
|
|
12661
|
+
"optional": false
|
|
12662
|
+
}
|
|
12663
|
+
],
|
|
12664
|
+
"returns": {
|
|
12665
|
+
"type": "HSL",
|
|
12666
|
+
"description": "An object representing the color in HSL space."
|
|
12667
|
+
}
|
|
12668
|
+
},
|
|
12669
|
+
{
|
|
12670
|
+
"name": "rgbToVariableString",
|
|
12671
|
+
"kind": "function",
|
|
12672
|
+
"description": "Converts an RGB object to a string in the format 'r g b'.",
|
|
12673
|
+
"signature": "rgbToVariableString(rgb: RGB): string",
|
|
12674
|
+
"parameters": [
|
|
12675
|
+
{
|
|
12676
|
+
"name": "rgb",
|
|
12677
|
+
"type": "RGB",
|
|
12678
|
+
"description": "The RGB object to convert.",
|
|
12679
|
+
"optional": false
|
|
12680
|
+
}
|
|
12681
|
+
],
|
|
12682
|
+
"returns": {
|
|
12683
|
+
"type": "string",
|
|
12684
|
+
"description": "A string representing the color in 'r g b' format."
|
|
12685
|
+
}
|
|
12686
|
+
},
|
|
12687
|
+
{
|
|
12688
|
+
"name": "THEME_COLOR_KEYS",
|
|
12689
|
+
"kind": "const",
|
|
12690
|
+
"description": "Theme utility color keys used for BEM classification via `isThemeColor` / `isUtilityColor`. Brand/semantic keys match the historical theme color set. Color CSS vars for QButton / QBadge / QToast come from bound `useColor` styles rather than Sass map loops. `background` remains a utility key so QButton can apply its hand-written `--background` modifier (and skip inline vars for that color). `container` is omitted (scheme resolve only).",
|
|
12691
|
+
"signature": "readonly [\"primary\", \"secondary\", \"highlight\", \"info\", \"success\", \"warning\", \"danger\", \"neutral\", \"background\"]"
|
|
12692
|
+
},
|
|
12693
|
+
{
|
|
12694
|
+
"name": "tryParseColor",
|
|
12695
|
+
"kind": "function",
|
|
12696
|
+
"description": "Attempts to parse a color string into an RGB object without throwing. Supports hex (`#rgb`, `#rrggbb`, `#rrggbbaa`), `rgb`/`rgba`, and `hsl`/`hsla`. Alpha channels are ignored.",
|
|
12697
|
+
"signature": "tryParseColor(color: string): RGB | undefined",
|
|
12698
|
+
"parameters": [
|
|
12699
|
+
{
|
|
12700
|
+
"name": "color",
|
|
12701
|
+
"type": "string",
|
|
12702
|
+
"description": "A CSS color string.",
|
|
12703
|
+
"optional": false
|
|
12704
|
+
}
|
|
12705
|
+
],
|
|
12706
|
+
"returns": {
|
|
12707
|
+
"type": "RGB | undefined",
|
|
12708
|
+
"description": "The parsed RGB object, or undefined when parsing fails."
|
|
12709
|
+
}
|
|
12710
|
+
},
|
|
12711
|
+
{
|
|
12712
|
+
"name": "tryParseRgb",
|
|
12713
|
+
"kind": "function",
|
|
12714
|
+
"description": "Tries to parse an `rgb()` or `rgba()` color string to an RGB object. Supports comma-separated and modern space-separated syntax. Alpha is ignored.",
|
|
12715
|
+
"signature": "tryParseRgb(str: string): RGB | undefined",
|
|
12716
|
+
"parameters": [
|
|
12717
|
+
{
|
|
12718
|
+
"name": "str",
|
|
12719
|
+
"type": "string",
|
|
12720
|
+
"description": "The input string to parse.",
|
|
12721
|
+
"optional": false
|
|
12722
|
+
}
|
|
12723
|
+
],
|
|
12724
|
+
"returns": {
|
|
12725
|
+
"type": "RGB | undefined",
|
|
12726
|
+
"description": "Parsed RGB values when valid, otherwise undefined."
|
|
12727
|
+
}
|
|
12728
|
+
}
|
|
12729
|
+
]
|
|
12730
|
+
},
|
|
12731
|
+
{
|
|
12732
|
+
"name": "date",
|
|
12733
|
+
"description": "",
|
|
12734
|
+
"exports": [
|
|
12735
|
+
{
|
|
12736
|
+
"name": "addDays",
|
|
12737
|
+
"kind": "function",
|
|
12738
|
+
"description": "Adds days to a date.",
|
|
12739
|
+
"signature": "addDays(date: Date, days: number): Date",
|
|
12740
|
+
"parameters": [
|
|
12741
|
+
{
|
|
12742
|
+
"name": "date",
|
|
12743
|
+
"type": "Date",
|
|
12744
|
+
"description": "Source date.",
|
|
12745
|
+
"optional": false
|
|
12746
|
+
},
|
|
12747
|
+
{
|
|
12748
|
+
"name": "days",
|
|
12749
|
+
"type": "number",
|
|
12750
|
+
"description": "Number of days to add (can be negative).",
|
|
12751
|
+
"optional": false
|
|
12752
|
+
}
|
|
12753
|
+
],
|
|
12754
|
+
"returns": {
|
|
12755
|
+
"type": "Date",
|
|
12756
|
+
"description": "New date shifted by the requested amount of days."
|
|
12757
|
+
}
|
|
12758
|
+
},
|
|
12759
|
+
{
|
|
12760
|
+
"name": "addMonths",
|
|
12761
|
+
"kind": "function",
|
|
12762
|
+
"description": "Adds months to a date, keeping its day and time. A day the target month does not have becomes its last day: 31 January plus one month is 28 (or 29) February, not 3 March.",
|
|
12763
|
+
"signature": "addMonths(date: Date, months: number): Date",
|
|
12764
|
+
"parameters": [
|
|
12765
|
+
{
|
|
12766
|
+
"name": "date",
|
|
12767
|
+
"type": "Date",
|
|
12768
|
+
"description": "Source date.",
|
|
12769
|
+
"optional": false
|
|
12770
|
+
},
|
|
12771
|
+
{
|
|
12772
|
+
"name": "months",
|
|
12773
|
+
"type": "number",
|
|
12774
|
+
"description": "Number of months to add (can be negative).",
|
|
12775
|
+
"optional": false
|
|
12776
|
+
}
|
|
12777
|
+
],
|
|
12778
|
+
"returns": {
|
|
12779
|
+
"type": "Date",
|
|
12780
|
+
"description": "New date shifted by the requested amount of months."
|
|
12781
|
+
}
|
|
12782
|
+
},
|
|
12783
|
+
{
|
|
12784
|
+
"name": "advancePastFormatLiteral",
|
|
12785
|
+
"kind": "function",
|
|
12786
|
+
"description": "Advances the value cursor past a format literal when it is present in the input.",
|
|
12787
|
+
"signature": "advancePastFormatLiteral(value: string, cursor: number, token: string): number | null",
|
|
12788
|
+
"parameters": [
|
|
12789
|
+
{
|
|
12790
|
+
"name": "value",
|
|
12791
|
+
"type": "string",
|
|
12792
|
+
"description": "Date formatted string.",
|
|
12793
|
+
"optional": false
|
|
12794
|
+
},
|
|
12795
|
+
{
|
|
12796
|
+
"name": "cursor",
|
|
12797
|
+
"type": "number",
|
|
12798
|
+
"description": "The position of the cursor in value.",
|
|
12799
|
+
"optional": false
|
|
12800
|
+
},
|
|
12801
|
+
{
|
|
12802
|
+
"name": "token",
|
|
12803
|
+
"type": "string",
|
|
12804
|
+
"description": "A string that represents part of the date format (ex. 'yyyy', 'MM', 'dd').",
|
|
12805
|
+
"optional": false
|
|
12806
|
+
}
|
|
12807
|
+
],
|
|
12808
|
+
"returns": {
|
|
12809
|
+
"type": "number | null",
|
|
12810
|
+
"description": "Updated cursor, or `null` when the literal is not yet in the value."
|
|
12811
|
+
}
|
|
12812
|
+
},
|
|
12813
|
+
{
|
|
12814
|
+
"name": "clampDayByMonthYear",
|
|
12815
|
+
"kind": "function",
|
|
12816
|
+
"description": "Get the string value of the datetime where the day is guaranteed to be within it's range of valid values.",
|
|
12817
|
+
"signature": "clampDayByMonthYear(value: string, tokens: string[]): string",
|
|
12818
|
+
"parameters": [
|
|
12819
|
+
{
|
|
12820
|
+
"name": "value",
|
|
12821
|
+
"type": "string",
|
|
12822
|
+
"description": "Date formatted string.",
|
|
12823
|
+
"optional": false
|
|
12824
|
+
},
|
|
12825
|
+
{
|
|
12826
|
+
"name": "tokens",
|
|
12827
|
+
"type": "string[]",
|
|
12828
|
+
"description": "Strings that represent parts of the date format (ex. 'yyyy', 'MM', 'dd').",
|
|
12829
|
+
"optional": false
|
|
12830
|
+
}
|
|
12831
|
+
],
|
|
12832
|
+
"returns": {
|
|
12833
|
+
"type": "string",
|
|
12834
|
+
"description": "String value of the datetime with the day clamped to it's maximum possible value."
|
|
12835
|
+
}
|
|
12836
|
+
},
|
|
12837
|
+
{
|
|
12838
|
+
"name": "clampNumericSegments",
|
|
12839
|
+
"kind": "function",
|
|
12840
|
+
"description": "Clamps fully-typed numeric segments to valid ranges for the provided format.",
|
|
12841
|
+
"signature": "clampNumericSegments(value: string, format: string, options?: { padMaxDigits: boolean; } | undefined): string",
|
|
12842
|
+
"parameters": [
|
|
12843
|
+
{
|
|
12844
|
+
"name": "value",
|
|
12845
|
+
"type": "string",
|
|
12846
|
+
"description": "Masked user input.",
|
|
12847
|
+
"optional": false
|
|
12848
|
+
},
|
|
12849
|
+
{
|
|
12850
|
+
"name": "format",
|
|
12851
|
+
"type": "string",
|
|
12852
|
+
"description": "Date/time format pattern.",
|
|
12853
|
+
"optional": false
|
|
12854
|
+
},
|
|
12855
|
+
{
|
|
12856
|
+
"name": "options",
|
|
12857
|
+
"type": "{ padMaxDigits: boolean; } | undefined",
|
|
12858
|
+
"description": "Options",
|
|
12859
|
+
"optional": true
|
|
12860
|
+
}
|
|
12861
|
+
],
|
|
12862
|
+
"returns": {
|
|
12863
|
+
"type": "string",
|
|
12864
|
+
"description": "Input with out-of-range numeric segments normalized."
|
|
12865
|
+
}
|
|
12866
|
+
},
|
|
12867
|
+
{
|
|
12868
|
+
"name": "completePartialDateInput",
|
|
12869
|
+
"kind": "function",
|
|
12870
|
+
"description": "Completes trailing partial numeric segments with zero defaults. Partial digits are right-padded; missing suffix segments use zero-filled defaults.",
|
|
12871
|
+
"signature": "completePartialDateInput(dateStr: string, format: string, labels?: DateParserLabels | undefined): string | null",
|
|
12872
|
+
"parameters": [
|
|
12873
|
+
{
|
|
12874
|
+
"name": "dateStr",
|
|
12875
|
+
"type": "string",
|
|
12876
|
+
"description": "Partial user input.",
|
|
12877
|
+
"optional": false
|
|
12878
|
+
},
|
|
12879
|
+
{
|
|
12880
|
+
"name": "format",
|
|
12881
|
+
"type": "string",
|
|
12882
|
+
"description": "Date/time format pattern.",
|
|
12883
|
+
"optional": false
|
|
12884
|
+
},
|
|
12885
|
+
{
|
|
12886
|
+
"name": "labels",
|
|
12887
|
+
"type": "DateParserLabels | undefined",
|
|
12888
|
+
"description": "Optional localized text resolvers, to read the date before a missing offset.",
|
|
12889
|
+
"optional": true
|
|
12890
|
+
}
|
|
12891
|
+
],
|
|
12892
|
+
"returns": {
|
|
12893
|
+
"type": "string | null",
|
|
12894
|
+
"description": "Completed string suitable for `parseDate`, or `null` when completion is not possible."
|
|
12895
|
+
}
|
|
12896
|
+
},
|
|
12897
|
+
{
|
|
12898
|
+
"name": "convertDatePatternToMask",
|
|
12899
|
+
"kind": "function",
|
|
12900
|
+
"description": "Converts a date format pattern to an input mask pattern. Supports numeric, textual, weekday, meridiem, milliseconds and quoted literal tokens.",
|
|
12901
|
+
"signature": "convertDatePatternToMask(format: string): string",
|
|
12902
|
+
"parameters": [
|
|
12903
|
+
{
|
|
12904
|
+
"name": "format",
|
|
12905
|
+
"type": "string",
|
|
12906
|
+
"description": "Date format pattern (e.g. `dd/MM/yyyy HH:mm`).",
|
|
12907
|
+
"optional": false
|
|
12908
|
+
}
|
|
12909
|
+
],
|
|
12910
|
+
"returns": {
|
|
12911
|
+
"type": "string",
|
|
12912
|
+
"description": "Mask string."
|
|
12913
|
+
}
|
|
12914
|
+
},
|
|
12915
|
+
{
|
|
12916
|
+
"name": "DateFormatterLabels",
|
|
12917
|
+
"kind": "type",
|
|
12918
|
+
"description": "Formats a date according to a format string.",
|
|
12919
|
+
"signature": "type DateFormatterLabels = {\n getMonthName?: (month: number, short: boolean) => string;\n getWeekdayName?: (weekday: number, short: boolean) => string;\n};"
|
|
12920
|
+
},
|
|
12921
|
+
{
|
|
12922
|
+
"name": "DateParserLabels",
|
|
12923
|
+
"kind": "type",
|
|
12924
|
+
"description": "Optional parsing label resolvers used by `parseDate`. English names are always read too.",
|
|
12925
|
+
"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};"
|
|
12926
|
+
},
|
|
12927
|
+
{
|
|
12928
|
+
"name": "formatDate",
|
|
12929
|
+
"kind": "function",
|
|
12930
|
+
"description": "Formats a date according to a format string. Supports numeric and textual date/time tokens and quoted literals.",
|
|
12931
|
+
"signature": "formatDate(date: Date, format: string, labels?: DateFormatterLabels | undefined): string",
|
|
12932
|
+
"parameters": [
|
|
12933
|
+
{
|
|
12934
|
+
"name": "date",
|
|
12935
|
+
"type": "Date",
|
|
12936
|
+
"description": "Source date to format.",
|
|
12937
|
+
"optional": false
|
|
12938
|
+
},
|
|
12939
|
+
{
|
|
12940
|
+
"name": "format",
|
|
12941
|
+
"type": "string",
|
|
12942
|
+
"description": "Date format pattern.",
|
|
12943
|
+
"optional": false
|
|
12944
|
+
},
|
|
12945
|
+
{
|
|
12946
|
+
"name": "labels",
|
|
12947
|
+
"type": "DateFormatterLabels | undefined",
|
|
12948
|
+
"description": "Optional localized text resolvers for month/weekday names.",
|
|
12949
|
+
"optional": true
|
|
12950
|
+
}
|
|
12951
|
+
],
|
|
12952
|
+
"returns": {
|
|
12953
|
+
"type": "string",
|
|
12954
|
+
"description": "Formatted date string."
|
|
12955
|
+
}
|
|
12956
|
+
},
|
|
12957
|
+
{
|
|
12958
|
+
"name": "formatUsesSeconds",
|
|
12959
|
+
"kind": "function",
|
|
12960
|
+
"description": "Checks if the format string includes seconds components.",
|
|
12961
|
+
"signature": "formatUsesSeconds(format: string): boolean",
|
|
12962
|
+
"parameters": [
|
|
12963
|
+
{
|
|
12964
|
+
"name": "format",
|
|
12965
|
+
"type": "string",
|
|
12966
|
+
"description": "Date/time format pattern.",
|
|
12967
|
+
"optional": false
|
|
12968
|
+
}
|
|
12969
|
+
],
|
|
12970
|
+
"returns": {
|
|
12971
|
+
"type": "boolean",
|
|
12972
|
+
"description": "`true` when format includes seconds token (`s`/`ss`) outside quoted literals."
|
|
12973
|
+
}
|
|
12974
|
+
},
|
|
12975
|
+
{
|
|
12976
|
+
"name": "formatUsesTime",
|
|
12977
|
+
"kind": "function",
|
|
12978
|
+
"description": "Checks if the format string includes time components.",
|
|
12979
|
+
"signature": "formatUsesTime(format: string): boolean",
|
|
12980
|
+
"parameters": [
|
|
12981
|
+
{
|
|
12982
|
+
"name": "format",
|
|
12983
|
+
"type": "string",
|
|
12984
|
+
"description": "Date/time format pattern.",
|
|
12985
|
+
"optional": false
|
|
12986
|
+
}
|
|
12987
|
+
],
|
|
12988
|
+
"returns": {
|
|
12989
|
+
"type": "boolean",
|
|
12990
|
+
"description": "`true` when format includes any of `H`, `h`, `m`, `s`, or `a` outside quoted literals."
|
|
12991
|
+
}
|
|
12992
|
+
},
|
|
12993
|
+
{
|
|
12994
|
+
"name": "getDaysInMonth",
|
|
12995
|
+
"kind": "function",
|
|
12996
|
+
"description": "Gets the number of days in a month.",
|
|
12997
|
+
"signature": "getDaysInMonth(month: number, year: number): number",
|
|
12998
|
+
"parameters": [
|
|
12999
|
+
{
|
|
13000
|
+
"name": "month",
|
|
13001
|
+
"type": "number",
|
|
13002
|
+
"description": "Zero-based month index (`0` = January).",
|
|
13003
|
+
"optional": false
|
|
13004
|
+
},
|
|
13005
|
+
{
|
|
13006
|
+
"name": "year",
|
|
13007
|
+
"type": "number",
|
|
13008
|
+
"description": "Full year number.",
|
|
13009
|
+
"optional": false
|
|
13010
|
+
}
|
|
13011
|
+
],
|
|
13012
|
+
"returns": {
|
|
13013
|
+
"type": "number",
|
|
13014
|
+
"description": "Number of days in the month (28-31)."
|
|
13015
|
+
}
|
|
13016
|
+
},
|
|
13017
|
+
{
|
|
13018
|
+
"name": "getEndOfDay",
|
|
13019
|
+
"kind": "function",
|
|
13020
|
+
"description": "Gets the end of a day (23:59:59).",
|
|
13021
|
+
"signature": "getEndOfDay(date: Date): Date",
|
|
13022
|
+
"parameters": [
|
|
13023
|
+
{
|
|
13024
|
+
"name": "date",
|
|
13025
|
+
"type": "Date",
|
|
13026
|
+
"description": "Source date.",
|
|
13027
|
+
"optional": false
|
|
13028
|
+
}
|
|
13029
|
+
],
|
|
13030
|
+
"returns": {
|
|
13031
|
+
"type": "Date",
|
|
13032
|
+
"description": "New date at `23:59:59.999` for the same calendar day."
|
|
13033
|
+
}
|
|
13034
|
+
},
|
|
13035
|
+
{
|
|
13036
|
+
"name": "getFirstDayOfMonth",
|
|
13037
|
+
"kind": "function",
|
|
13038
|
+
"description": "Gets the first day of a month.",
|
|
13039
|
+
"signature": "getFirstDayOfMonth(date: Date): Date",
|
|
13040
|
+
"parameters": [
|
|
13041
|
+
{
|
|
13042
|
+
"name": "date",
|
|
13043
|
+
"type": "Date",
|
|
13044
|
+
"description": "Any date within the target month.",
|
|
13045
|
+
"optional": false
|
|
13046
|
+
}
|
|
13047
|
+
],
|
|
13048
|
+
"returns": {
|
|
13049
|
+
"type": "Date",
|
|
13050
|
+
"description": "New date set to the first day of that month."
|
|
13051
|
+
}
|
|
13052
|
+
},
|
|
13053
|
+
{
|
|
13054
|
+
"name": "getFirstDayOfWeek",
|
|
13055
|
+
"kind": "function",
|
|
13056
|
+
"description": "Gets the first day of the week for a given date.",
|
|
13057
|
+
"signature": "getFirstDayOfWeek(date: Date): number",
|
|
13058
|
+
"parameters": [
|
|
13059
|
+
{
|
|
13060
|
+
"name": "date",
|
|
13061
|
+
"type": "Date",
|
|
13062
|
+
"description": "Input date.",
|
|
13063
|
+
"optional": false
|
|
13064
|
+
}
|
|
13065
|
+
],
|
|
13066
|
+
"returns": {
|
|
13067
|
+
"type": "number",
|
|
13068
|
+
"description": "Weekday index (`0` = Sunday, `6` = Saturday)."
|
|
13069
|
+
}
|
|
13070
|
+
},
|
|
13071
|
+
{
|
|
13072
|
+
"name": "getLastDayOfMonth",
|
|
13073
|
+
"kind": "function",
|
|
13074
|
+
"description": "Gets the last day of a month.",
|
|
13075
|
+
"signature": "getLastDayOfMonth(date: Date): Date",
|
|
13076
|
+
"parameters": [
|
|
13077
|
+
{
|
|
13078
|
+
"name": "date",
|
|
13079
|
+
"type": "Date",
|
|
13080
|
+
"description": "Any date within the target month.",
|
|
13081
|
+
"optional": false
|
|
13082
|
+
}
|
|
13083
|
+
],
|
|
13084
|
+
"returns": {
|
|
13085
|
+
"type": "Date",
|
|
13086
|
+
"description": "New date set to the last day of that month."
|
|
13087
|
+
}
|
|
13088
|
+
},
|
|
13089
|
+
{
|
|
13090
|
+
"name": "getStartOfDay",
|
|
13091
|
+
"kind": "function",
|
|
13092
|
+
"description": "Gets the start of a day (00:00:00).",
|
|
13093
|
+
"signature": "getStartOfDay(date: Date): Date",
|
|
13094
|
+
"parameters": [
|
|
13095
|
+
{
|
|
13096
|
+
"name": "date",
|
|
13097
|
+
"type": "Date",
|
|
13098
|
+
"description": "Source date.",
|
|
13099
|
+
"optional": false
|
|
13100
|
+
}
|
|
13101
|
+
],
|
|
13102
|
+
"returns": {
|
|
13103
|
+
"type": "Date",
|
|
13104
|
+
"description": "New date at `00:00:00.000` for the same calendar day."
|
|
13105
|
+
}
|
|
13106
|
+
},
|
|
13107
|
+
{
|
|
13108
|
+
"name": "inputIncludesTimePortion",
|
|
13109
|
+
"kind": "function",
|
|
13110
|
+
"description": "Whether user input includes digits in the time portion of the format.",
|
|
13111
|
+
"signature": "inputIncludesTimePortion(dateStr: string, format: string): boolean",
|
|
13112
|
+
"parameters": [
|
|
13113
|
+
{
|
|
13114
|
+
"name": "dateStr",
|
|
13115
|
+
"type": "string",
|
|
13116
|
+
"description": "Raw user input.",
|
|
13117
|
+
"optional": false
|
|
13118
|
+
},
|
|
13119
|
+
{
|
|
13120
|
+
"name": "format",
|
|
13121
|
+
"type": "string",
|
|
13122
|
+
"description": "Date/time format pattern.",
|
|
13123
|
+
"optional": false
|
|
13124
|
+
}
|
|
13125
|
+
],
|
|
13126
|
+
"returns": {
|
|
13127
|
+
"type": "boolean",
|
|
13128
|
+
"description": ""
|
|
13129
|
+
}
|
|
13130
|
+
},
|
|
13131
|
+
{
|
|
13132
|
+
"name": "isBetween",
|
|
13133
|
+
"kind": "function",
|
|
13134
|
+
"description": "Checks if a date is between two dates.",
|
|
13135
|
+
"signature": "isBetween(date: Date, startDate: Date, endDate: Date): boolean",
|
|
13136
|
+
"parameters": [
|
|
13137
|
+
{
|
|
13138
|
+
"name": "date",
|
|
13139
|
+
"type": "Date",
|
|
13140
|
+
"description": "Date to evaluate.",
|
|
13141
|
+
"optional": false
|
|
13142
|
+
},
|
|
13143
|
+
{
|
|
13144
|
+
"name": "startDate",
|
|
13145
|
+
"type": "Date",
|
|
13146
|
+
"description": "Range start (exclusive).",
|
|
13147
|
+
"optional": false
|
|
13148
|
+
},
|
|
13149
|
+
{
|
|
13150
|
+
"name": "endDate",
|
|
13151
|
+
"type": "Date",
|
|
13152
|
+
"description": "Range end (exclusive).",
|
|
13153
|
+
"optional": false
|
|
13154
|
+
}
|
|
13155
|
+
],
|
|
13156
|
+
"returns": {
|
|
13157
|
+
"type": "boolean",
|
|
13158
|
+
"description": "`true` when `date` is strictly between start and end."
|
|
13159
|
+
}
|
|
13160
|
+
},
|
|
13161
|
+
{
|
|
13162
|
+
"name": "isLeapYear",
|
|
13163
|
+
"kind": "function",
|
|
13164
|
+
"description": "Checks if a year is a leap year.",
|
|
13165
|
+
"signature": "isLeapYear(year: number): boolean",
|
|
13166
|
+
"parameters": [
|
|
13167
|
+
{
|
|
13168
|
+
"name": "year",
|
|
13169
|
+
"type": "number",
|
|
13170
|
+
"description": "Full year number (e.g. `2026`).",
|
|
13171
|
+
"optional": false
|
|
13172
|
+
}
|
|
13173
|
+
],
|
|
13174
|
+
"returns": {
|
|
13175
|
+
"type": "boolean",
|
|
13176
|
+
"description": "`true` if year is leap according to Gregorian rules."
|
|
13177
|
+
}
|
|
13178
|
+
},
|
|
13179
|
+
{
|
|
13180
|
+
"name": "isSameDay",
|
|
13181
|
+
"kind": "function",
|
|
13182
|
+
"description": "Checks if two dates are the same day.",
|
|
13183
|
+
"signature": "isSameDay(date1: Date, date2: Date): boolean",
|
|
13184
|
+
"parameters": [
|
|
13185
|
+
{
|
|
13186
|
+
"name": "date1",
|
|
13187
|
+
"type": "Date",
|
|
13188
|
+
"description": "First date to compare.",
|
|
13189
|
+
"optional": false
|
|
13190
|
+
},
|
|
13191
|
+
{
|
|
13192
|
+
"name": "date2",
|
|
13193
|
+
"type": "Date",
|
|
13194
|
+
"description": "Second date to compare.",
|
|
13195
|
+
"optional": false
|
|
13196
|
+
}
|
|
13197
|
+
],
|
|
13198
|
+
"returns": {
|
|
13199
|
+
"type": "boolean",
|
|
13200
|
+
"description": "`true` when year/month/day are equal."
|
|
13201
|
+
}
|
|
13202
|
+
},
|
|
13203
|
+
{
|
|
13204
|
+
"name": "isTimeOnlyFormat",
|
|
13205
|
+
"kind": "function",
|
|
13206
|
+
"description": "Checks if the format is time-only.",
|
|
13207
|
+
"signature": "isTimeOnlyFormat(format: string): boolean",
|
|
13208
|
+
"parameters": [
|
|
13209
|
+
{
|
|
13210
|
+
"name": "format",
|
|
13211
|
+
"type": "string",
|
|
13212
|
+
"description": "Date/time format pattern.",
|
|
13213
|
+
"optional": false
|
|
13214
|
+
}
|
|
13215
|
+
],
|
|
13216
|
+
"returns": {
|
|
13217
|
+
"type": "boolean",
|
|
13218
|
+
"description": "`true` when no date tokens are present and time tokens are present."
|
|
13219
|
+
}
|
|
13220
|
+
},
|
|
13221
|
+
{
|
|
13222
|
+
"name": "normalizeNumericToken",
|
|
13223
|
+
"kind": "function",
|
|
13224
|
+
"description": "Get the string value of the part of the datetime within it's range of possible valid values and padded to the specified number of digits.",
|
|
13225
|
+
"signature": "normalizeNumericToken(token: string, digits: string, value: number): string",
|
|
13226
|
+
"parameters": [
|
|
13227
|
+
{
|
|
13228
|
+
"name": "token",
|
|
13229
|
+
"type": "string",
|
|
13230
|
+
"description": "A string that represents part of the date format (ex. 'yyyy', 'MM', 'dd').",
|
|
13231
|
+
"optional": false
|
|
13232
|
+
},
|
|
13233
|
+
{
|
|
13234
|
+
"name": "digits",
|
|
13235
|
+
"type": "string",
|
|
13236
|
+
"description": "A string of digit characters that represents part of a datetime value (year, month, day etc.)",
|
|
13237
|
+
"optional": false
|
|
13238
|
+
},
|
|
13239
|
+
{
|
|
13240
|
+
"name": "value",
|
|
13241
|
+
"type": "number",
|
|
13242
|
+
"description": "The actual numeric value of a part of a datetime (year, month, day etc.)",
|
|
13243
|
+
"optional": false
|
|
13244
|
+
}
|
|
13245
|
+
],
|
|
13246
|
+
"returns": {
|
|
13247
|
+
"type": "string",
|
|
13248
|
+
"description": "Normalized string value of the part of the datetime."
|
|
13249
|
+
}
|
|
13250
|
+
},
|
|
13251
|
+
{
|
|
13252
|
+
"name": "padNumber",
|
|
13253
|
+
"kind": "function",
|
|
13254
|
+
"description": "Pads a number with leading zeros.",
|
|
13255
|
+
"signature": "padNumber(num: string | number, length?: number): string",
|
|
13256
|
+
"parameters": [
|
|
13257
|
+
{
|
|
13258
|
+
"name": "num",
|
|
13259
|
+
"type": "string | number",
|
|
13260
|
+
"description": "Number (or numeric string) to pad.",
|
|
13261
|
+
"optional": false
|
|
13262
|
+
},
|
|
13263
|
+
{
|
|
13264
|
+
"name": "length",
|
|
13265
|
+
"type": "number",
|
|
13266
|
+
"description": "Target minimum string length.",
|
|
13267
|
+
"optional": true
|
|
13268
|
+
}
|
|
13269
|
+
],
|
|
13270
|
+
"returns": {
|
|
13271
|
+
"type": "string",
|
|
13272
|
+
"description": "Left-zero-padded string value."
|
|
13273
|
+
}
|
|
13274
|
+
},
|
|
13275
|
+
{
|
|
13276
|
+
"name": "parseDate",
|
|
13277
|
+
"kind": "function",
|
|
13278
|
+
"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.",
|
|
13279
|
+
"signature": "parseDate(dateStr: string, format: string, labels?: DateParserLabels | undefined, options?: { ignoreWeekday?: boolean; } | undefined): Date | null",
|
|
13280
|
+
"parameters": [
|
|
13281
|
+
{
|
|
13282
|
+
"name": "dateStr",
|
|
13283
|
+
"type": "string",
|
|
13284
|
+
"description": "Input string to parse.",
|
|
13285
|
+
"optional": false
|
|
13286
|
+
},
|
|
13287
|
+
{
|
|
13288
|
+
"name": "format",
|
|
13289
|
+
"type": "string",
|
|
13290
|
+
"description": "Format pattern expected in `dateStr`.",
|
|
13291
|
+
"optional": false
|
|
13292
|
+
},
|
|
13293
|
+
{
|
|
13294
|
+
"name": "labels",
|
|
13295
|
+
"type": "DateParserLabels | undefined",
|
|
13296
|
+
"description": "Optional localized text resolvers for month/weekday parsing.",
|
|
13297
|
+
"optional": true
|
|
13298
|
+
},
|
|
13299
|
+
{
|
|
13300
|
+
"name": "options",
|
|
13301
|
+
"type": "{ ignoreWeekday?: boolean; } | undefined",
|
|
13302
|
+
"description": "",
|
|
13303
|
+
"optional": true
|
|
13304
|
+
}
|
|
13305
|
+
],
|
|
13306
|
+
"returns": {
|
|
13307
|
+
"type": "Date | null",
|
|
13308
|
+
"description": "Parsed `Date` instance or `null` when parsing fails."
|
|
13309
|
+
}
|
|
13310
|
+
},
|
|
13311
|
+
{
|
|
13312
|
+
"name": "parseDateWithCompletion",
|
|
13313
|
+
"kind": "function",
|
|
13314
|
+
"description": "Parses a date string, completing trailing partial numeric segments when needed.",
|
|
13315
|
+
"signature": "parseDateWithCompletion(dateStr: string, format: string, labels?: DateParserLabels | undefined, options?: { ignoreWeekday?: boolean; } | undefined): Date | null",
|
|
13316
|
+
"parameters": [
|
|
13317
|
+
{
|
|
13318
|
+
"name": "dateStr",
|
|
13319
|
+
"type": "string",
|
|
13320
|
+
"description": "Input string to parse.",
|
|
13321
|
+
"optional": false
|
|
13322
|
+
},
|
|
13323
|
+
{
|
|
13324
|
+
"name": "format",
|
|
13325
|
+
"type": "string",
|
|
13326
|
+
"description": "Format pattern expected in `dateStr`.",
|
|
13327
|
+
"optional": false
|
|
13328
|
+
},
|
|
13329
|
+
{
|
|
13330
|
+
"name": "labels",
|
|
13331
|
+
"type": "DateParserLabels | undefined",
|
|
13332
|
+
"description": "Optional localized text resolvers for month/weekday parsing.",
|
|
13333
|
+
"optional": true
|
|
13334
|
+
},
|
|
13335
|
+
{
|
|
13336
|
+
"name": "options",
|
|
13337
|
+
"type": "{ ignoreWeekday?: boolean; } | undefined",
|
|
13338
|
+
"description": "Passed to `parseDate`.",
|
|
13339
|
+
"optional": true
|
|
13340
|
+
}
|
|
13341
|
+
],
|
|
13342
|
+
"returns": {
|
|
13343
|
+
"type": "Date | null",
|
|
13344
|
+
"description": "Parsed `Date` instance or `null` when parsing fails."
|
|
13345
|
+
}
|
|
13346
|
+
},
|
|
13347
|
+
{
|
|
13348
|
+
"name": "parseIsoDate",
|
|
13349
|
+
"kind": "function",
|
|
13350
|
+
"description": "Parses an ISO 8601 date or date-time string.",
|
|
13351
|
+
"signature": "parseIsoDate(dateStr: string): Date | null",
|
|
13352
|
+
"parameters": [
|
|
13353
|
+
{
|
|
13354
|
+
"name": "dateStr",
|
|
13355
|
+
"type": "string",
|
|
13356
|
+
"description": "Input such as `2026-06-19` or `2026-06-19T15:25:00.000Z`.",
|
|
13357
|
+
"optional": false
|
|
13358
|
+
}
|
|
13359
|
+
],
|
|
13360
|
+
"returns": {
|
|
13361
|
+
"type": "Date | null",
|
|
13362
|
+
"description": "Parsed `Date` instance or `null` when the string is not ISO-shaped or invalid."
|
|
13363
|
+
}
|
|
13364
|
+
},
|
|
13365
|
+
{
|
|
13366
|
+
"name": "uses12HourFormat",
|
|
13367
|
+
"kind": "function",
|
|
13368
|
+
"description": "Checks if the format uses 12-hour format.",
|
|
13369
|
+
"signature": "uses12HourFormat(format: string): boolean",
|
|
13370
|
+
"parameters": [
|
|
13371
|
+
{
|
|
13372
|
+
"name": "format",
|
|
13373
|
+
"type": "string",
|
|
13374
|
+
"description": "Date/time format pattern.",
|
|
13375
|
+
"optional": false
|
|
13376
|
+
}
|
|
13377
|
+
],
|
|
13378
|
+
"returns": {
|
|
13379
|
+
"type": "boolean",
|
|
13380
|
+
"description": "`true` when format includes `h` or `a` outside quoted literals."
|
|
13381
|
+
}
|
|
13382
|
+
}
|
|
13383
|
+
]
|
|
13384
|
+
},
|
|
13385
|
+
{
|
|
13386
|
+
"name": "density",
|
|
13387
|
+
"description": "",
|
|
13388
|
+
"exports": [
|
|
13389
|
+
{
|
|
13390
|
+
"name": "DENSITIES",
|
|
13391
|
+
"kind": "const",
|
|
13392
|
+
"description": "",
|
|
13393
|
+
"signature": "readonly [\"compact\", \"regular\", \"loose\"]"
|
|
13394
|
+
},
|
|
13395
|
+
{
|
|
13396
|
+
"name": "getGlobalDensity",
|
|
13397
|
+
"kind": "function",
|
|
13398
|
+
"description": "Returns the current global density. Falls back to `regular`.",
|
|
13399
|
+
"signature": "getGlobalDensity(): \"compact\" | \"regular\" | \"loose\"",
|
|
13400
|
+
"parameters": [],
|
|
13401
|
+
"returns": {
|
|
13402
|
+
"type": "\"compact\" | \"regular\" | \"loose\"",
|
|
13403
|
+
"description": ""
|
|
13404
|
+
}
|
|
13405
|
+
},
|
|
13406
|
+
{
|
|
13407
|
+
"name": "QDensity",
|
|
13408
|
+
"kind": "type",
|
|
13409
|
+
"description": "",
|
|
13410
|
+
"signature": "type QDensity = (typeof DENSITIES)[number];"
|
|
13411
|
+
},
|
|
13412
|
+
{
|
|
13413
|
+
"name": "setGlobalDensity",
|
|
13414
|
+
"kind": "function",
|
|
13415
|
+
"description": "Applies a global density (`compact` | `regular` | `loose`) to the root element. CSS mode selectors own `--q-density-scale`; this only sets the attribute and class.",
|
|
13416
|
+
"signature": "setGlobalDensity(density: \"compact\" | \"regular\" | \"loose\"): \"compact\" | \"regular\" | \"loose\"",
|
|
13417
|
+
"parameters": [
|
|
13418
|
+
{
|
|
13419
|
+
"name": "density",
|
|
13420
|
+
"type": "\"compact\" | \"regular\" | \"loose\"",
|
|
13421
|
+
"description": "",
|
|
13422
|
+
"optional": false
|
|
13423
|
+
}
|
|
13424
|
+
],
|
|
13425
|
+
"returns": {
|
|
13426
|
+
"type": "\"compact\" | \"regular\" | \"loose\"",
|
|
13427
|
+
"description": ""
|
|
13428
|
+
}
|
|
13429
|
+
}
|
|
13430
|
+
]
|
|
13431
|
+
},
|
|
13432
|
+
{
|
|
13433
|
+
"name": "mask",
|
|
13434
|
+
"description": "",
|
|
13435
|
+
"exports": [
|
|
13436
|
+
{
|
|
13437
|
+
"name": "applyMask",
|
|
13438
|
+
"kind": "function",
|
|
13439
|
+
"description": "Applies a mask pattern to an input value. The mask supports: - `#` / `n`: single numeric digit - `A`: single alphabetic character, normalized to uppercase - `a`: single alphabetic character, normalized to lowercase - `p`: meridiem token (`AM` or `PM` only) - `W`: variable-width alphabetic segment - `±`: a sign, `+` or `-` (the sign of a time zone offset) - any other character: fixed separator/literal",
|
|
13440
|
+
"signature": "applyMask(value: string, maskPattern: string): string",
|
|
13441
|
+
"parameters": [
|
|
13442
|
+
{
|
|
13443
|
+
"name": "value",
|
|
13444
|
+
"type": "string",
|
|
13445
|
+
"description": "Raw user input.",
|
|
13446
|
+
"optional": false
|
|
13447
|
+
},
|
|
13448
|
+
{
|
|
13449
|
+
"name": "maskPattern",
|
|
13450
|
+
"type": "string",
|
|
13451
|
+
"description": "Mask to apply.",
|
|
13452
|
+
"optional": false
|
|
13453
|
+
}
|
|
13454
|
+
],
|
|
13455
|
+
"returns": {
|
|
13456
|
+
"type": "string",
|
|
13457
|
+
"description": "Masked value normalized to the provided pattern."
|
|
13458
|
+
}
|
|
13459
|
+
}
|
|
13460
|
+
]
|
|
13461
|
+
}
|
|
11041
13462
|
]
|
|
11042
13463
|
}
|