@quidgest/ui 0.28.0 → 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 +51 -8
- package/README.md +19 -0
- package/dist/json/api.json +1517 -86
- package/dist/manifest/components.json +0 -1
- package/dist/ui.css +59 -68
- package/dist/ui.esm.js +1031 -1043
- package/dist/ui.js +1000 -1013
- package/dist/ui.min.css +1 -1
- package/dist/ui.min.js +1000 -1013
- package/dist/ui.scss +83 -27
- package/esm/components/QAccordion/QAccordion.d.ts +3 -3
- package/esm/components/QAccordion/QAccordion.d.ts.map +1 -1
- package/esm/components/QAccordion/QAccordion.vue.js +33 -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/index.d.ts +20 -11
- package/esm/components/QAccordion/index.d.ts.map +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/types.d.ts +2 -1
- package/esm/components/QAvatar/types.d.ts.map +1 -1
- package/esm/components/QBadge/QBadge.d.ts.map +1 -1
- package/esm/components/QBadge/QBadge.vue.js +36 -37
- package/esm/components/QButtonGroup/QButtonGroup.vue.js +18 -18
- 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 +99 -95
- package/esm/components/QCarousel/constants.d.ts +1 -0
- package/esm/components/QCarousel/constants.d.ts.map +1 -1
- package/esm/components/QCarousel/constants.js +2 -1
- package/esm/components/QCarousel/index.d.ts +3 -3
- package/esm/components/QCheckbox/QCheckbox.d.ts +0 -2
- package/esm/components/QCheckbox/QCheckbox.d.ts.map +1 -1
- package/esm/components/QCheckbox/QCheckbox.vue.js +33 -36
- package/esm/components/QCheckbox/index.d.ts +0 -1
- package/esm/components/QCheckbox/index.d.ts.map +1 -1
- package/esm/components/QColorPicker/QColorPicker.d.ts.map +1 -1
- package/esm/components/QColorPicker/QColorPicker.vue.js +1 -2
- package/esm/components/QCombobox/QCombobox.d.ts +9 -0
- package/esm/components/QCombobox/QCombobox.d.ts.map +1 -1
- package/esm/components/QCombobox/QCombobox.vue.js +142 -134
- package/esm/components/QCombobox/index.d.ts +10 -0
- package/esm/components/QCombobox/index.d.ts.map +1 -1
- package/esm/components/QCombobox/types.d.ts +8 -0
- package/esm/components/QCombobox/types.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/QDateTimePicker.d.ts.map +1 -1
- package/esm/components/QDateTimePicker/QDateTimePicker.vue.js +199 -219
- package/esm/components/QDialog/QDialog.d.ts +1 -1
- package/esm/components/QDialog/QDialog.d.ts.map +1 -1
- package/esm/components/QDialog/QDialog.vue.js +4 -4
- package/esm/components/QDialog/QDialogProvider.d.ts.map +1 -1
- package/esm/components/QDialog/index.d.ts +6 -6
- package/esm/components/QDialog/types.d.ts +3 -3
- package/esm/components/QDialog/types.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/QDropdownMenuContent.d.ts +8 -0
- package/esm/components/QDropdownMenu/QDropdownMenuContent.d.ts.map +1 -1
- package/esm/components/QDropdownMenu/QDropdownMenuContent.vue.js +136 -124
- package/esm/components/QFileUpload/QFileUpload.d.ts.map +1 -1
- package/esm/components/QFileUpload/QFileUpload.vue.js +82 -79
- package/esm/components/QFocusWrap/QFocusWrap.d.ts.map +1 -1
- package/esm/components/QIcon/QIconFont.d.ts.map +1 -1
- package/esm/components/QIcon/QSvgSymbol.d.ts.map +1 -1
- package/esm/components/QIcon/QSvgSymbol.vue.js +31 -31
- package/esm/components/QInputGroup/QInputGroup.d.ts.map +1 -1
- package/esm/components/QInputGroup/QInputGroup.vue.js +67 -41
- package/esm/components/QInputGroup/types.d.ts +15 -1
- package/esm/components/QInputGroup/types.d.ts.map +1 -1
- package/esm/components/QList/QList.d.ts +6 -0
- package/esm/components/QList/QList.d.ts.map +1 -1
- package/esm/components/QList/QList.vue.js +4 -1
- 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/index.d.ts +6 -1
- package/esm/components/QList/index.d.ts.map +1 -1
- package/esm/components/QList/types.d.ts +16 -0
- package/esm/components/QList/types.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 +90 -95
- package/esm/components/QOverflow/index.d.ts +3 -3
- package/esm/components/QOverlay/QOverlay.d.ts.map +1 -1
- package/esm/components/QOverlay/QOverlay.vue.js +125 -117
- 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 +1 -0
- package/esm/components/QPasswordField/QPasswordField.d.ts.map +1 -1
- package/esm/components/QPasswordField/QPasswordField.vue.js +5 -0
- package/esm/components/QPasswordField/QPasswordFieldMeterOverlay.vue.js +1 -0
- package/esm/components/QPasswordField/index.d.ts +6 -0
- package/esm/components/QPasswordField/index.d.ts.map +1 -1
- package/esm/components/QPasswordField/types.d.ts +10 -0
- package/esm/components/QPasswordField/types.d.ts.map +1 -1
- package/esm/components/QPhoneField/QPhoneField.d.ts +184 -18
- package/esm/components/QPhoneField/QPhoneField.d.ts.map +1 -1
- package/esm/components/QPhoneField/index.d.ts +92 -9
- package/esm/components/QPhoneField/index.d.ts.map +1 -1
- package/esm/components/QPropertyList/QPropertyList.d.ts.map +1 -1
- package/esm/components/QPropertyList/QPropertyList.vue.js +62 -60
- package/esm/components/QPropertyList/QPropertyListRow.vue.js +2 -2
- package/esm/components/QPropertyList/index.d.ts.map +1 -1
- package/esm/components/QRadioGroup/QRadioButton.vue.js +2 -2
- package/esm/components/QRadioGroup/QRadioGroup.vue.js +46 -46
- 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/QSelect/QSelect.d.ts +157 -0
- package/esm/components/QSelect/QSelect.d.ts.map +1 -1
- package/esm/components/QSelect/QSelect.vue.js +240 -212
- package/esm/components/QSelect/index.d.ts +84 -0
- package/esm/components/QSelect/index.d.ts.map +1 -1
- package/esm/components/QSelect/types.d.ts +8 -0
- 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 +1 -2
- package/esm/components/QSidebar/QSidebarAnchor.vue.js +1 -1
- 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/QSteps/QSteps.d.ts +4 -4
- package/esm/components/QSteps/QSteps.d.ts.map +1 -1
- package/esm/components/QSteps/QSteps.vue.js +9 -15
- package/esm/components/QSteps/index.d.ts +2 -2
- package/esm/components/QSteps/types.d.ts +2 -1
- package/esm/components/QSteps/types.d.ts.map +1 -1
- package/esm/components/QTabs/QTab.d.ts.map +1 -1
- package/esm/components/QTabs/QTab.vue.js +2 -2
- package/esm/components/QTabs/QTabs.d.ts +4 -4
- package/esm/components/QTabs/QTabs.d.ts.map +1 -1
- package/esm/components/QTabs/QTabs.vue.js +86 -85
- 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 +2 -2
- 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 +25 -24
- package/esm/components/QTextArea/index.d.ts +3 -3
- package/esm/components/QToast/QToast.d.ts.map +1 -1
- package/esm/components/QToast/QToast.vue.js +7 -4
- package/esm/components/QToast/QToaster.d.ts.map +1 -1
- package/esm/components/QToast/types.d.ts +3 -3
- 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/index.d.ts +8 -8
- package/esm/components/QTooltip/QTooltip.d.ts.map +1 -1
- package/esm/components/QTooltip/QTooltip.vue.js +1 -1
- 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/useDialog/_internal.js +8 -11
- package/esm/composables/useDialog/index.js +1 -2
- 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 +10 -15
- package/esm/composables/useToast/index.js +1 -2
- package/esm/composables/useToast/types.d.ts.map +1 -1
- package/esm/framework.js +14 -12
- package/esm/index.d.ts +1 -2
- 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 +8 -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/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/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 +55 -41
- 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/package.json +9 -6
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",
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
{
|
|
133
133
|
"name": "update:modelValue",
|
|
134
134
|
"description": "",
|
|
135
|
-
"type": "[value: Primitive | Primitive[]]"
|
|
135
|
+
"type": "[value: Primitive | Primitive[] | undefined]"
|
|
136
136
|
}
|
|
137
137
|
],
|
|
138
138
|
"slots": [
|
|
@@ -375,7 +375,7 @@
|
|
|
375
375
|
"kind": "primitive",
|
|
376
376
|
"name": "string"
|
|
377
377
|
},
|
|
378
|
-
"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.",
|
|
379
379
|
"required": false,
|
|
380
380
|
"category": "Content"
|
|
381
381
|
},
|
|
@@ -445,6 +445,11 @@
|
|
|
445
445
|
"description": "Displays an avatar with initials.",
|
|
446
446
|
"code": "<QAvatar initials=\"CS\" />"
|
|
447
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
|
+
},
|
|
448
453
|
{
|
|
449
454
|
"title": "Custom Size",
|
|
450
455
|
"description": "Displays an avatar with a custom size.",
|
|
@@ -643,8 +648,8 @@
|
|
|
643
648
|
},
|
|
644
649
|
{
|
|
645
650
|
"title": "Size",
|
|
646
|
-
"description": "Local size overrides for the badge. Combines with the global density toolbar (product = global × size).",
|
|
647
|
-
"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>"
|
|
648
653
|
},
|
|
649
654
|
{
|
|
650
655
|
"title": "Clickable",
|
|
@@ -1679,7 +1684,7 @@
|
|
|
1679
1684
|
"examples": [
|
|
1680
1685
|
{
|
|
1681
1686
|
"title": "Default",
|
|
1682
|
-
"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.",
|
|
1683
1688
|
"code": "<QCarousel :slides=\"slides\" />"
|
|
1684
1689
|
},
|
|
1685
1690
|
{
|
|
@@ -1704,7 +1709,7 @@
|
|
|
1704
1709
|
},
|
|
1705
1710
|
{
|
|
1706
1711
|
"title": "Non Wrapping",
|
|
1707
|
-
"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.",
|
|
1708
1713
|
"code": "<QCarousel :slides=\"slides\" :show-controls=\"true\" :wrap=\"false\" />"
|
|
1709
1714
|
},
|
|
1710
1715
|
{
|
|
@@ -1989,8 +1994,8 @@
|
|
|
1989
1994
|
},
|
|
1990
1995
|
{
|
|
1991
1996
|
"title": "Extras",
|
|
1992
|
-
"description": "
|
|
1993
|
-
"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>"
|
|
1994
1999
|
},
|
|
1995
2000
|
{
|
|
1996
2001
|
"title": "Borderless",
|
|
@@ -2707,6 +2712,21 @@
|
|
|
2707
2712
|
"required": false,
|
|
2708
2713
|
"category": "Behavior"
|
|
2709
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
|
+
},
|
|
2710
2730
|
{
|
|
2711
2731
|
"name": "loading",
|
|
2712
2732
|
"type": {
|
|
@@ -2831,10 +2851,20 @@
|
|
|
2831
2851
|
"description": "Displays a loading animation that lets users know content is being loaded.",
|
|
2832
2852
|
"code": "<QCombobox :items=\"[]\" :loading=\"true\" />"
|
|
2833
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
|
+
},
|
|
2834
2859
|
{
|
|
2835
2860
|
"title": "Description In Items",
|
|
2836
2861
|
"description": "Combobox with description.",
|
|
2837
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\" />"
|
|
2838
2868
|
}
|
|
2839
2869
|
]
|
|
2840
2870
|
},
|
|
@@ -3225,10 +3255,19 @@
|
|
|
3225
3255
|
{
|
|
3226
3256
|
"name": "icon",
|
|
3227
3257
|
"type": {
|
|
3228
|
-
"kind": "
|
|
3229
|
-
"
|
|
3258
|
+
"kind": "union",
|
|
3259
|
+
"types": [
|
|
3260
|
+
{
|
|
3261
|
+
"name": "other",
|
|
3262
|
+
"value": "null"
|
|
3263
|
+
},
|
|
3264
|
+
{
|
|
3265
|
+
"name": "object",
|
|
3266
|
+
"value": {}
|
|
3267
|
+
}
|
|
3268
|
+
]
|
|
3230
3269
|
},
|
|
3231
|
-
"description": "The icon of the dialog window.",
|
|
3270
|
+
"description": "The icon of the dialog window. Pass `null` to show no icon.",
|
|
3232
3271
|
"default": "DEFAULT_ICON",
|
|
3233
3272
|
"required": false,
|
|
3234
3273
|
"category": "Content"
|
|
@@ -3242,7 +3281,7 @@
|
|
|
3242
3281
|
"value": {}
|
|
3243
3282
|
}
|
|
3244
3283
|
},
|
|
3245
|
-
"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.",
|
|
3246
3285
|
"default": "DEFAULT_BUTTONS",
|
|
3247
3286
|
"required": false,
|
|
3248
3287
|
"category": "Content"
|
|
@@ -3522,6 +3561,11 @@
|
|
|
3522
3561
|
"description": "Shows a custom icon instead of the default one.",
|
|
3523
3562
|
"code": "<QDialog text=\"You clicked the button?\" :icon=\"{\n\t\t\ticon: 'help-circle-outline'\n\t\t}\" />"
|
|
3524
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
|
+
},
|
|
3525
3569
|
{
|
|
3526
3570
|
"title": "Custom Buttons",
|
|
3527
3571
|
"description": "Custom buttons on the dialog allow the user to customize its look and behavior.",
|
|
@@ -4385,13 +4429,18 @@
|
|
|
4385
4429
|
},
|
|
4386
4430
|
{
|
|
4387
4431
|
"title": "Accept Images",
|
|
4388
|
-
"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.",
|
|
4389
4433
|
"code": "<QFileUpload label=\"Upload an image\" accept=\"image/*\" />"
|
|
4390
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
|
+
},
|
|
4391
4440
|
{
|
|
4392
4441
|
"title": "Extras",
|
|
4393
|
-
"description": "
|
|
4394
|
-
"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>"
|
|
4395
4444
|
}
|
|
4396
4445
|
]
|
|
4397
4446
|
},
|
|
@@ -4864,51 +4913,64 @@
|
|
|
4864
4913
|
"category": "Identification"
|
|
4865
4914
|
},
|
|
4866
4915
|
{
|
|
4867
|
-
"name": "
|
|
4916
|
+
"name": "icons",
|
|
4868
4917
|
"type": {
|
|
4869
|
-
"kind": "
|
|
4870
|
-
"
|
|
4918
|
+
"kind": "object",
|
|
4919
|
+
"fields": {}
|
|
4871
4920
|
},
|
|
4872
|
-
"description": "
|
|
4921
|
+
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4873
4922
|
"required": false,
|
|
4874
|
-
"category": "
|
|
4923
|
+
"category": "Configuration"
|
|
4875
4924
|
},
|
|
4876
4925
|
{
|
|
4877
|
-
"name": "
|
|
4926
|
+
"name": "texts",
|
|
4878
4927
|
"type": {
|
|
4879
|
-
"kind": "
|
|
4880
|
-
"
|
|
4928
|
+
"kind": "object",
|
|
4929
|
+
"fields": {}
|
|
4881
4930
|
},
|
|
4882
|
-
"description": "
|
|
4931
|
+
"description": "Accessible text overrides. Includes the help button label, `showHelp`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4883
4932
|
"required": false,
|
|
4884
|
-
"category": "
|
|
4933
|
+
"category": "Configuration"
|
|
4885
4934
|
},
|
|
4886
4935
|
{
|
|
4887
|
-
"name": "
|
|
4936
|
+
"name": "required",
|
|
4888
4937
|
"type": {
|
|
4889
4938
|
"kind": "primitive",
|
|
4890
|
-
"name": "
|
|
4939
|
+
"name": "boolean"
|
|
4891
4940
|
},
|
|
4892
|
-
"description": "
|
|
4941
|
+
"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.",
|
|
4893
4942
|
"required": false,
|
|
4894
|
-
"category": "
|
|
4943
|
+
"category": "State"
|
|
4895
4944
|
},
|
|
4896
4945
|
{
|
|
4897
|
-
"name": "
|
|
4946
|
+
"name": "size",
|
|
4898
4947
|
"type": {
|
|
4899
4948
|
"kind": "enum",
|
|
4900
4949
|
"values": [
|
|
4901
|
-
"
|
|
4902
|
-
"
|
|
4903
|
-
"
|
|
4904
|
-
"
|
|
4905
|
-
"
|
|
4950
|
+
"medium",
|
|
4951
|
+
"small",
|
|
4952
|
+
"large",
|
|
4953
|
+
"block",
|
|
4954
|
+
"xlarge",
|
|
4955
|
+
"xxlarge",
|
|
4956
|
+
"mini"
|
|
4906
4957
|
]
|
|
4907
4958
|
},
|
|
4908
|
-
"description": "
|
|
4959
|
+
"description": "The size category of the field.",
|
|
4960
|
+
"default": "large",
|
|
4909
4961
|
"required": false,
|
|
4910
4962
|
"category": "Presentation"
|
|
4911
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
|
+
},
|
|
4912
4974
|
{
|
|
4913
4975
|
"name": "help",
|
|
4914
4976
|
"type": {
|
|
@@ -4934,51 +4996,38 @@
|
|
|
4934
4996
|
"category": "Presentation"
|
|
4935
4997
|
},
|
|
4936
4998
|
{
|
|
4937
|
-
"name": "
|
|
4938
|
-
"type": {
|
|
4939
|
-
"kind": "object",
|
|
4940
|
-
"fields": {}
|
|
4941
|
-
},
|
|
4942
|
-
"description": "Icon overrides. Includes the help popover icon, `help`.\nPass every key, or omit the prop to keep the defaults.",
|
|
4943
|
-
"required": false,
|
|
4944
|
-
"category": "Configuration"
|
|
4945
|
-
},
|
|
4946
|
-
{
|
|
4947
|
-
"name": "texts",
|
|
4999
|
+
"name": "labelPosition",
|
|
4948
5000
|
"type": {
|
|
4949
|
-
"kind": "
|
|
4950
|
-
"
|
|
5001
|
+
"kind": "enum",
|
|
5002
|
+
"values": [
|
|
5003
|
+
"left",
|
|
5004
|
+
"center",
|
|
5005
|
+
"right",
|
|
5006
|
+
"topleft",
|
|
5007
|
+
"topright"
|
|
5008
|
+
]
|
|
4951
5009
|
},
|
|
4952
|
-
"description": "
|
|
5010
|
+
"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",
|
|
4953
5011
|
"required": false,
|
|
4954
|
-
"category": "
|
|
5012
|
+
"category": "Presentation"
|
|
4955
5013
|
},
|
|
4956
5014
|
{
|
|
4957
|
-
"name": "
|
|
5015
|
+
"name": "for",
|
|
4958
5016
|
"type": {
|
|
4959
|
-
"kind": "
|
|
4960
|
-
"
|
|
4961
|
-
"medium",
|
|
4962
|
-
"small",
|
|
4963
|
-
"large",
|
|
4964
|
-
"block",
|
|
4965
|
-
"xlarge",
|
|
4966
|
-
"xxlarge",
|
|
4967
|
-
"mini"
|
|
4968
|
-
]
|
|
5017
|
+
"kind": "primitive",
|
|
5018
|
+
"name": "string"
|
|
4969
5019
|
},
|
|
4970
|
-
"description": "The
|
|
4971
|
-
"default": "large",
|
|
5020
|
+
"description": "The form field associated with the label.",
|
|
4972
5021
|
"required": false,
|
|
4973
|
-
"category": "
|
|
5022
|
+
"category": "Accessibility"
|
|
4974
5023
|
},
|
|
4975
5024
|
{
|
|
4976
|
-
"name": "
|
|
5025
|
+
"name": "invalid",
|
|
4977
5026
|
"type": {
|
|
4978
5027
|
"kind": "primitive",
|
|
4979
5028
|
"name": "boolean"
|
|
4980
5029
|
},
|
|
4981
|
-
"description": "Whether the input is
|
|
5030
|
+
"description": "Whether the input is invalid.",
|
|
4982
5031
|
"required": false,
|
|
4983
5032
|
"category": "State"
|
|
4984
5033
|
},
|
|
@@ -4988,17 +5037,17 @@
|
|
|
4988
5037
|
"kind": "primitive",
|
|
4989
5038
|
"name": "boolean"
|
|
4990
5039
|
},
|
|
4991
|
-
"description": "
|
|
5040
|
+
"description": "Disables the group and every Quidgest UI control in it, buttons included. A control that\nsets its own `disabled` keeps it.",
|
|
4992
5041
|
"required": false,
|
|
4993
5042
|
"category": "State"
|
|
4994
5043
|
},
|
|
4995
5044
|
{
|
|
4996
|
-
"name": "
|
|
5045
|
+
"name": "readonly",
|
|
4997
5046
|
"type": {
|
|
4998
5047
|
"kind": "primitive",
|
|
4999
5048
|
"name": "boolean"
|
|
5000
5049
|
},
|
|
5001
|
-
"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.",
|
|
5002
5051
|
"required": false,
|
|
5003
5052
|
"category": "State"
|
|
5004
5053
|
},
|
|
@@ -5107,6 +5156,16 @@
|
|
|
5107
5156
|
"description": "Displays an asterisk next to the group label.",
|
|
5108
5157
|
"code": "<QInputGroup label=\"Full name\" :required=\"true\" />"
|
|
5109
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
|
+
},
|
|
5110
5169
|
{
|
|
5111
5170
|
"title": "Mixed Heights",
|
|
5112
5171
|
"description": "Keeps sibling controls aligned when one child has a larger intrinsic height.",
|
|
@@ -5401,6 +5460,16 @@
|
|
|
5401
5460
|
"required": false,
|
|
5402
5461
|
"category": "Configuration"
|
|
5403
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
|
+
},
|
|
5404
5473
|
{
|
|
5405
5474
|
"name": "icons",
|
|
5406
5475
|
"type": {
|
|
@@ -6414,10 +6483,20 @@
|
|
|
6414
6483
|
"kind": "primitive",
|
|
6415
6484
|
"name": "boolean"
|
|
6416
6485
|
},
|
|
6417
|
-
"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.",
|
|
6418
6487
|
"required": false,
|
|
6419
6488
|
"category": "Behavior"
|
|
6420
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
|
+
},
|
|
6421
6500
|
{
|
|
6422
6501
|
"name": "spy",
|
|
6423
6502
|
"type": {
|
|
@@ -6550,6 +6629,11 @@
|
|
|
6550
6629
|
"title": "Independent",
|
|
6551
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.",
|
|
6552
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\" />"
|
|
6553
6637
|
}
|
|
6554
6638
|
]
|
|
6555
6639
|
},
|
|
@@ -6755,6 +6839,17 @@
|
|
|
6755
6839
|
"required": false,
|
|
6756
6840
|
"category": "Behavior"
|
|
6757
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
|
+
},
|
|
6758
6853
|
{
|
|
6759
6854
|
"name": "meterLevels",
|
|
6760
6855
|
"type": {
|
|
@@ -6834,6 +6929,11 @@
|
|
|
6834
6929
|
"description": "Standard password field with the `v-model` property for two-way value binding.",
|
|
6835
6930
|
"code": "<QPasswordField />"
|
|
6836
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
|
+
},
|
|
6837
6937
|
{
|
|
6838
6938
|
"title": "Rules",
|
|
6839
6939
|
"description": "Enforces validation rules to ensure password strength.",
|
|
@@ -7931,7 +8031,7 @@
|
|
|
7931
8031
|
},
|
|
7932
8032
|
{
|
|
7933
8033
|
"title": "Paste Detection",
|
|
7934
|
-
"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.",
|
|
7935
8035
|
"code": "<QPhoneField label=\"Paste an international number\" />"
|
|
7936
8036
|
},
|
|
7937
8037
|
{
|
|
@@ -8152,7 +8252,17 @@
|
|
|
8152
8252
|
{
|
|
8153
8253
|
"title": "Placement Variations",
|
|
8154
8254
|
"description": "Position the popover relative to the anchor element using placement options.",
|
|
8155
|
-
"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\" />"
|
|
8156
8266
|
},
|
|
8157
8267
|
{
|
|
8158
8268
|
"title": "HTML Content",
|
|
@@ -8833,10 +8943,15 @@
|
|
|
8833
8943
|
"description": "A radio button group with an invalid state.",
|
|
8834
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>"
|
|
8835
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
|
+
},
|
|
8836
8951
|
{
|
|
8837
8952
|
"title": "Extras",
|
|
8838
|
-
"description": "
|
|
8839
|
-
"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>"
|
|
8840
8955
|
}
|
|
8841
8956
|
]
|
|
8842
8957
|
},
|
|
@@ -9348,6 +9463,21 @@
|
|
|
9348
9463
|
"required": false,
|
|
9349
9464
|
"category": "Behavior"
|
|
9350
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
|
+
},
|
|
9351
9481
|
{
|
|
9352
9482
|
"name": "badges",
|
|
9353
9483
|
"type": {
|
|
@@ -9500,6 +9630,11 @@
|
|
|
9500
9630
|
"description": "Displays a loading animation that lets users know content is being loaded.",
|
|
9501
9631
|
"code": "<QSelect :items=\"[]\" :loading=\"true\" />"
|
|
9502
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
|
+
},
|
|
9503
9638
|
{
|
|
9504
9639
|
"title": "Description In Items",
|
|
9505
9640
|
"description": "Select with description items.",
|
|
@@ -9524,6 +9659,21 @@
|
|
|
9524
9659
|
"title": "Badges",
|
|
9525
9660
|
"description": "Displays the selected options as badges.",
|
|
9526
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}))\" />"
|
|
9527
9677
|
}
|
|
9528
9678
|
]
|
|
9529
9679
|
},
|
|
@@ -9653,8 +9803,13 @@
|
|
|
9653
9803
|
},
|
|
9654
9804
|
{
|
|
9655
9805
|
"title": "Resizable",
|
|
9656
|
-
"description": "Sidebar with resizable panels enabled.",
|
|
9657
|
-
"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\" />"
|
|
9658
9813
|
},
|
|
9659
9814
|
{
|
|
9660
9815
|
"title": "Header",
|
|
@@ -9877,7 +10032,7 @@
|
|
|
9877
10032
|
"kind": "primitive",
|
|
9878
10033
|
"name": "boolean"
|
|
9879
10034
|
},
|
|
9880
|
-
"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.",
|
|
9881
10036
|
"default": "false",
|
|
9882
10037
|
"required": false,
|
|
9883
10038
|
"category": "Behavior"
|
|
@@ -9987,6 +10142,11 @@
|
|
|
9987
10142
|
"description": "More steps than fit at once — horizontal caps visible steps at 4 and scrolls the rest via arrow buttons (built on `QOverflow`).",
|
|
9988
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>"
|
|
9989
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
|
+
},
|
|
9990
10150
|
{
|
|
9991
10151
|
"title": "With Completed Steps",
|
|
9992
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.",
|
|
@@ -10438,6 +10598,11 @@
|
|
|
10438
10598
|
"title": "Overflow Vertical",
|
|
10439
10599
|
"description": "Tall vertical rail — overflow arrows scroll one tab at a time.",
|
|
10440
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=\"\\"
|
|
10441
10606
|
}
|
|
10442
10607
|
]
|
|
10443
10608
|
},
|
|
@@ -11083,8 +11248,8 @@
|
|
|
11083
11248
|
},
|
|
11084
11249
|
{
|
|
11085
11250
|
"title": "Extras",
|
|
11086
|
-
"description": "
|
|
11087
|
-
"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>"
|
|
11088
11253
|
}
|
|
11089
11254
|
]
|
|
11090
11255
|
},
|
|
@@ -11198,7 +11363,7 @@
|
|
|
11198
11363
|
"high"
|
|
11199
11364
|
]
|
|
11200
11365
|
},
|
|
11201
|
-
"description": "The shadow depth of the toast. Defaults to '
|
|
11366
|
+
"description": "The shadow depth of the toast. Defaults to 'medium'.",
|
|
11202
11367
|
"default": "medium",
|
|
11203
11368
|
"required": false,
|
|
11204
11369
|
"category": "Presentation"
|
|
@@ -11224,7 +11389,7 @@
|
|
|
11224
11389
|
"kind": "primitive",
|
|
11225
11390
|
"name": "number"
|
|
11226
11391
|
},
|
|
11227
|
-
"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.",
|
|
11228
11393
|
"default": "5000",
|
|
11229
11394
|
"required": false,
|
|
11230
11395
|
"category": "Behavior"
|
|
@@ -11324,7 +11489,7 @@
|
|
|
11324
11489
|
},
|
|
11325
11490
|
{
|
|
11326
11491
|
"title": "Elevation",
|
|
11327
|
-
"description": "Supports different elevation levels. Defaults to
|
|
11492
|
+
"description": "Supports different elevation levels. Defaults to medium.",
|
|
11328
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>"
|
|
11329
11494
|
},
|
|
11330
11495
|
{
|
|
@@ -11749,7 +11914,7 @@
|
|
|
11749
11914
|
{
|
|
11750
11915
|
"name": "update:modelValue",
|
|
11751
11916
|
"description": "",
|
|
11752
|
-
"type": "[value: Primitive | Primitive[]]"
|
|
11917
|
+
"type": "[value: Primitive | Primitive[] | undefined]"
|
|
11753
11918
|
}
|
|
11754
11919
|
],
|
|
11755
11920
|
"slots": [
|
|
@@ -12009,7 +12174,7 @@
|
|
|
12009
12174
|
{
|
|
12010
12175
|
"title": "Positioning",
|
|
12011
12176
|
"description": "Displays the tooltip on a specific position.",
|
|
12012
|
-
"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>"
|
|
12013
12178
|
},
|
|
12014
12179
|
{
|
|
12015
12180
|
"title": "Delay",
|
|
@@ -12028,5 +12193,1271 @@
|
|
|
12028
12193
|
}
|
|
12029
12194
|
]
|
|
12030
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
|
+
}
|
|
12031
13462
|
]
|
|
12032
13463
|
}
|