@beeq/core 1.8.3-beta.0 → 1.8.3-beta.1
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/dist/beeq/beeq.esm.js +1 -1
- package/dist/beeq/{p-f83857ac.entry.js → p-59a1b546.entry.js} +2 -2
- package/dist/beeq/{p-2c4cdf27.entry.js → p-6bea33f4.entry.js} +2 -2
- package/dist/beeq/{p-0f9ecc0c.entry.js → p-959c3d05.entry.js} +2 -2
- package/dist/beeq/{p-15bf8ffd.entry.js → p-a941b0bb.entry.js} +2 -2
- package/dist/beeq/{p-1499deaf.entry.js → p-b067c558.entry.js} +2 -2
- package/dist/beeq/{p-3d9ed4fa.entry.js → p-ba1f9637.entry.js} +2 -2
- package/dist/beeq/{p-a56ea1e0.entry.js → p-dbac0368.entry.js} +2 -2
- package/dist/beeq.html-custom-data.json +331 -331
- package/dist/cjs/bq-alert.cjs.entry.js +1 -1
- package/dist/cjs/bq-date-picker.cjs.entry.js +1 -1
- package/dist/cjs/bq-dialog.cjs.entry.js +1 -1
- package/dist/cjs/bq-drawer.cjs.entry.js +1 -1
- package/dist/cjs/bq-input.cjs.entry.js +1 -1
- package/dist/cjs/bq-notification.cjs.entry.js +1 -1
- package/dist/cjs/bq-select.cjs.entry.js +1 -1
- package/dist/collection/components/alert/scss/bq-alert.css +1 -1
- package/dist/collection/components/date-picker/scss/bq-date-picker.css +1 -1
- package/dist/collection/components/dialog/scss/bq-dialog.css +1 -1
- package/dist/collection/components/drawer/scss/bq-drawer.css +1 -1
- package/dist/collection/components/input/scss/bq-input.css +1 -1
- package/dist/collection/components/notification/scss/bq-notification.css +1 -1
- package/dist/collection/components/select/scss/bq-select.css +1 -1
- package/dist/components/bq-alert.js +1 -1
- package/dist/components/bq-date-picker.js +1 -1
- package/dist/components/bq-dialog.js +1 -1
- package/dist/components/bq-drawer.js +1 -1
- package/dist/components/bq-input.js +1 -1
- package/dist/components/bq-notification.js +1 -1
- package/dist/components/bq-select.js +1 -1
- package/dist/custom-elements.json +5678 -5678
- package/dist/esm/bq-alert.entry.js +1 -1
- package/dist/esm/bq-date-picker.entry.js +1 -1
- package/dist/esm/bq-dialog.entry.js +1 -1
- package/dist/esm/bq-drawer.entry.js +1 -1
- package/dist/esm/bq-input.entry.js +1 -1
- package/dist/esm/bq-notification.entry.js +1 -1
- package/dist/esm/bq-select.entry.js +1 -1
- package/dist/hydrate/index.js +7 -7
- package/dist/hydrate/index.mjs +7 -7
- package/package.json +1 -1
- /package/dist/beeq/{p-f83857ac.entry.js.map → p-59a1b546.entry.js.map} +0 -0
- /package/dist/beeq/{p-2c4cdf27.entry.js.map → p-6bea33f4.entry.js.map} +0 -0
- /package/dist/beeq/{p-0f9ecc0c.entry.js.map → p-959c3d05.entry.js.map} +0 -0
- /package/dist/beeq/{p-15bf8ffd.entry.js.map → p-a941b0bb.entry.js.map} +0 -0
- /package/dist/beeq/{p-1499deaf.entry.js.map → p-b067c558.entry.js.map} +0 -0
- /package/dist/beeq/{p-3d9ed4fa.entry.js.map → p-ba1f9637.entry.js.map} +0 -0
- /package/dist/beeq/{p-a56ea1e0.entry.js.map → p-dbac0368.entry.js.map} +0 -0
|
@@ -3,43 +3,38 @@
|
|
|
3
3
|
"version": 1.1,
|
|
4
4
|
"tags": [
|
|
5
5
|
{
|
|
6
|
-
"name": "bq-
|
|
7
|
-
"description": "The
|
|
6
|
+
"name": "bq-accordion",
|
|
7
|
+
"description": "The Accordion is a UI component that allows users to toggle between showing and hiding content sections. It provides a collapsible functionality, where only one section can be expanded at a time, while the others remain collapsed.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-accordion appearance=\"filled\" size=\"medium\">\n<bq-avatar size=\"xsmall\" image=\"/image/url/img.png\" slot=\"prefix\"></bq-avatar>\n<h3 slot=\"header\">Header</h3>\n<div>Lorem ipsum dolor...</div>\n</bq-accordion>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqOpen** - Handler to be called when the accordion is opened\n- **bqAfterOpen** - Handler to be called after the accordion is opened\n- **bqClose** - Handler to be called when the accordion is closed\n- **bqAfterClose** - Handler to be called after the accordion is closed\n- **bqFocus** - Handler to be called when the accordion gets focus\n- **bqClick** - Handler to be called when the accordion is clicked\n- **bqBlur** - Handler to be called when the accordion loses focus\n- **bqBlur** - Handler to be called when the accordion loses focus\n- **bqFocus** - Handler to be called when the accordion gets focus\n- **bqOpen** - Handler to be called when the accordion is opened\n- **bqAfterOpen** - Handler to be called after the accordion is opened\n- **bqClose** - Handler to be called when the accordion is closed\n- **bqAfterClose** - Handler to be called after the accordion is closed\n- **bqClick** - Handler to be called when the accordion is clicked\n\n### **Slots:**\n - _default_ - The accordion panel content\n- **collapse** - The accordion collapse icon\n- **expand** - The accordion expand icon\n- **header** - The accordion header content\n- **prefix** - The accordion prefix content (icon or avatar)\n- **suffix** - The accordion suffix content (icon or avatar)\n\n### **CSS Properties:**\n - **--bq-accordion--small-padding-y** - Accordion small vertical padding _(default: undefined)_\n- **--bq-accordion--small-padding-start** - Accordion small start padding _(default: undefined)_\n- **--bq-accordion--small-padding-end** - Accordion small end padding _(default: undefined)_\n- **--bq-accordion--small-padding-gap** - Accordion small gap distance between suffix, title and prefix _(default: undefined)_\n- **--bq-accordion--small-radius** - Accordion small border radius _(default: undefined)_\n- **--bq-accordion--medium-padding-y** - Accordion medium vertical padding _(default: undefined)_\n- **--bq-accordion--medium-padding-start** - Accordion medium start padding _(default: undefined)_\n- **--bq-accordion--medium-padding-end** - Accordion medium end padding _(default: undefined)_\n- **--bq-accordion--medium-padding-gap** - Accordion medium gap distance between suffix, title and prefix _(default: undefined)_\n- **--bq-accordion--medium-radius** - Accordion medium border radius _(default: undefined)_\n- **--bq-accordion--collapsed-border-color** - Accordion collapsed border color _(default: undefined)_\n- **--bq-accordion--collapsed-border-style** - Accordion collapsed border style _(default: undefined)_\n- **--bq-accordion--collapsed-border-width** - Accordion collapsed border width _(default: undefined)_\n- **--bq-accordion--expanded-border-color** - Accordion expanded border color _(default: undefined)_\n- **--bq-accordion--expanded-border-style** - Accordion expanded border style _(default: undefined)_\n- **--bq-accordion--expanded-border-width** - Accordion expanded border width _(default: undefined)_\n- **--bq-accordion--filled-collapsed-background** - Accordion filled collapsed header background _(default: undefined)_\n- **--bq-accordion--filled-collapsed-text-color** - Accordion filled collapsed header text color _(default: undefined)_\n- **--bq-accordion--filled-expanded-background** - Accordion filled expanded header background _(default: undefined)_\n- **--bq-accordion--filled-expanded-collapsed-hover** - Accordion filled expanded header color on hover _(default: undefined)_\n- **--bq-accordion--filled-expanded-text-color** - Accordion filled expanded header text color _(default: undefined)_\n- **--bq-accordion--ghost-collapsed-background** - Accordion ghost collapsed header background _(default: undefined)_\n- **--bq-accordion--ghost-collapsed-text-color** - Accordion ghost collapsed header text color _(default: undefined)_\n- **--bq-accordion--ghost-expanded-background** - Accordion ghost expanded header background _(default: undefined)_\n- **--bq-accordion--ghost-expanded-collapsed-hover** - Accordion ghost expanded header color on hover _(default: undefined)_\n- **--bq-accordion--ghost-expanded-text-color** - Accordion ghost expanded header text color _(default: undefined)_\n- **--bq-accordion--panel-filled-border-color** - Accordion filled panel border color _(default: undefined)_\n- **--bq-accordion--panel-filled-border-style** - Accordion filled panel border style _(default: undefined)_\n- **--bq-accordion--panel-filled-border-width** - Accordion filled panel border width _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-y** - Accordion small filled panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-start** - Accordion small filled panel start padding _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-end** - Accordion small filled panel end padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-y** - Accordion medium filled panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-start** - Accordion medium filled panel start padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-end** - Accordion medium filled panel end padding _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-color** - Accordion ghost panel border color _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-style** - Accordion ghost panel border style _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-width** - Accordion ghost panel border width _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-y** - Accordion small ghost panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-start** - Accordion small ghost panel start padding _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-end** - Accordion small ghost panel end padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-y** - Accordion medium ghost panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-start** - Accordion medium ghost panel start padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-end** - Accordion medium ghost panel end padding _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The `<details>` that holds the accordion content\n- **header** - The `<summary>` that holds the accordion header content\n- **panel** - The `<div>` that holds the accordion panel content\n- **prefix** - The `<div>` that holds the accordion prefix content\n- **suffix** - The `<div>` that holds the accordion suffix content\n- **text** - The `<div>` that holds the accordion header text content",
|
|
8
8
|
"attributes": [
|
|
9
9
|
{
|
|
10
|
-
"name": "
|
|
11
|
-
"description": "
|
|
12
|
-
"values": []
|
|
10
|
+
"name": "appearance",
|
|
11
|
+
"description": "The appearance style of the Accordion",
|
|
12
|
+
"values": [{ "name": "filled" }, { "name": "ghost" }]
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
|
-
"name": "
|
|
16
|
-
"description": "
|
|
15
|
+
"name": "disabled",
|
|
16
|
+
"description": "If true, the Accordion is disabled",
|
|
17
17
|
"values": []
|
|
18
18
|
},
|
|
19
19
|
{
|
|
20
|
-
"name": "
|
|
21
|
-
"description": "
|
|
20
|
+
"name": "expanded",
|
|
21
|
+
"description": "If true, the Accordion is expanded",
|
|
22
22
|
"values": []
|
|
23
23
|
},
|
|
24
24
|
{
|
|
25
|
-
"name": "
|
|
26
|
-
"description": "
|
|
25
|
+
"name": "no-animation",
|
|
26
|
+
"description": "Animation is set through JS when the browser does not support CSS calc-size() If true, the Accordion animation, will be disabled. No animation will be applied.",
|
|
27
27
|
"values": []
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
|
-
"name": "
|
|
31
|
-
"description": "
|
|
32
|
-
"values": [
|
|
30
|
+
"name": "rotate",
|
|
31
|
+
"description": "If true, the Accordion expand icon is rotate 180deg when expanded",
|
|
32
|
+
"values": []
|
|
33
33
|
},
|
|
34
34
|
{
|
|
35
35
|
"name": "size",
|
|
36
|
-
"description": "The size of the
|
|
37
|
-
"values": [
|
|
38
|
-
{ "name": "xsmall" },
|
|
39
|
-
{ "name": "small" },
|
|
40
|
-
{ "name": "medium" },
|
|
41
|
-
{ "name": "large" }
|
|
42
|
-
]
|
|
36
|
+
"description": "The size of the the Accordion",
|
|
37
|
+
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
43
38
|
}
|
|
44
39
|
],
|
|
45
40
|
"references": []
|
|
@@ -76,43 +71,6 @@
|
|
|
76
71
|
],
|
|
77
72
|
"references": []
|
|
78
73
|
},
|
|
79
|
-
{
|
|
80
|
-
"name": "bq-accordion",
|
|
81
|
-
"description": "The Accordion is a UI component that allows users to toggle between showing and hiding content sections. It provides a collapsible functionality, where only one section can be expanded at a time, while the others remain collapsed.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-accordion appearance=\"filled\" size=\"medium\">\n<bq-avatar size=\"xsmall\" image=\"/image/url/img.png\" slot=\"prefix\"></bq-avatar>\n<h3 slot=\"header\">Header</h3>\n<div>Lorem ipsum dolor...</div>\n</bq-accordion>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqOpen** - Handler to be called when the accordion is opened\n- **bqAfterOpen** - Handler to be called after the accordion is opened\n- **bqClose** - Handler to be called when the accordion is closed\n- **bqAfterClose** - Handler to be called after the accordion is closed\n- **bqFocus** - Handler to be called when the accordion gets focus\n- **bqClick** - Handler to be called when the accordion is clicked\n- **bqBlur** - Handler to be called when the accordion loses focus\n- **bqBlur** - Handler to be called when the accordion loses focus\n- **bqFocus** - Handler to be called when the accordion gets focus\n- **bqOpen** - Handler to be called when the accordion is opened\n- **bqAfterOpen** - Handler to be called after the accordion is opened\n- **bqClose** - Handler to be called when the accordion is closed\n- **bqAfterClose** - Handler to be called after the accordion is closed\n- **bqClick** - Handler to be called when the accordion is clicked\n\n### **Slots:**\n - _default_ - The accordion panel content\n- **collapse** - The accordion collapse icon\n- **expand** - The accordion expand icon\n- **header** - The accordion header content\n- **prefix** - The accordion prefix content (icon or avatar)\n- **suffix** - The accordion suffix content (icon or avatar)\n\n### **CSS Properties:**\n - **--bq-accordion--small-padding-y** - Accordion small vertical padding _(default: undefined)_\n- **--bq-accordion--small-padding-start** - Accordion small start padding _(default: undefined)_\n- **--bq-accordion--small-padding-end** - Accordion small end padding _(default: undefined)_\n- **--bq-accordion--small-padding-gap** - Accordion small gap distance between suffix, title and prefix _(default: undefined)_\n- **--bq-accordion--small-radius** - Accordion small border radius _(default: undefined)_\n- **--bq-accordion--medium-padding-y** - Accordion medium vertical padding _(default: undefined)_\n- **--bq-accordion--medium-padding-start** - Accordion medium start padding _(default: undefined)_\n- **--bq-accordion--medium-padding-end** - Accordion medium end padding _(default: undefined)_\n- **--bq-accordion--medium-padding-gap** - Accordion medium gap distance between suffix, title and prefix _(default: undefined)_\n- **--bq-accordion--medium-radius** - Accordion medium border radius _(default: undefined)_\n- **--bq-accordion--collapsed-border-color** - Accordion collapsed border color _(default: undefined)_\n- **--bq-accordion--collapsed-border-style** - Accordion collapsed border style _(default: undefined)_\n- **--bq-accordion--collapsed-border-width** - Accordion collapsed border width _(default: undefined)_\n- **--bq-accordion--expanded-border-color** - Accordion expanded border color _(default: undefined)_\n- **--bq-accordion--expanded-border-style** - Accordion expanded border style _(default: undefined)_\n- **--bq-accordion--expanded-border-width** - Accordion expanded border width _(default: undefined)_\n- **--bq-accordion--filled-collapsed-background** - Accordion filled collapsed header background _(default: undefined)_\n- **--bq-accordion--filled-collapsed-text-color** - Accordion filled collapsed header text color _(default: undefined)_\n- **--bq-accordion--filled-expanded-background** - Accordion filled expanded header background _(default: undefined)_\n- **--bq-accordion--filled-expanded-collapsed-hover** - Accordion filled expanded header color on hover _(default: undefined)_\n- **--bq-accordion--filled-expanded-text-color** - Accordion filled expanded header text color _(default: undefined)_\n- **--bq-accordion--ghost-collapsed-background** - Accordion ghost collapsed header background _(default: undefined)_\n- **--bq-accordion--ghost-collapsed-text-color** - Accordion ghost collapsed header text color _(default: undefined)_\n- **--bq-accordion--ghost-expanded-background** - Accordion ghost expanded header background _(default: undefined)_\n- **--bq-accordion--ghost-expanded-collapsed-hover** - Accordion ghost expanded header color on hover _(default: undefined)_\n- **--bq-accordion--ghost-expanded-text-color** - Accordion ghost expanded header text color _(default: undefined)_\n- **--bq-accordion--panel-filled-border-color** - Accordion filled panel border color _(default: undefined)_\n- **--bq-accordion--panel-filled-border-style** - Accordion filled panel border style _(default: undefined)_\n- **--bq-accordion--panel-filled-border-width** - Accordion filled panel border width _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-y** - Accordion small filled panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-start** - Accordion small filled panel start padding _(default: undefined)_\n- **--bq-accordion--panel-small-filled-padding-end** - Accordion small filled panel end padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-y** - Accordion medium filled panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-start** - Accordion medium filled panel start padding _(default: undefined)_\n- **--bq-accordion--panel-medium-filled-padding-end** - Accordion medium filled panel end padding _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-color** - Accordion ghost panel border color _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-style** - Accordion ghost panel border style _(default: undefined)_\n- **--bq-accordion--panel-ghost-border-width** - Accordion ghost panel border width _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-y** - Accordion small ghost panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-start** - Accordion small ghost panel start padding _(default: undefined)_\n- **--bq-accordion--panel-small-ghost-padding-end** - Accordion small ghost panel end padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-y** - Accordion medium ghost panel vertical padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-start** - Accordion medium ghost panel start padding _(default: undefined)_\n- **--bq-accordion--panel-medium-ghost-padding-end** - Accordion medium ghost panel end padding _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The `<details>` that holds the accordion content\n- **header** - The `<summary>` that holds the accordion header content\n- **panel** - The `<div>` that holds the accordion panel content\n- **prefix** - The `<div>` that holds the accordion prefix content\n- **suffix** - The `<div>` that holds the accordion suffix content\n- **text** - The `<div>` that holds the accordion header text content",
|
|
82
|
-
"attributes": [
|
|
83
|
-
{
|
|
84
|
-
"name": "appearance",
|
|
85
|
-
"description": "The appearance style of the Accordion",
|
|
86
|
-
"values": [{ "name": "filled" }, { "name": "ghost" }]
|
|
87
|
-
},
|
|
88
|
-
{
|
|
89
|
-
"name": "disabled",
|
|
90
|
-
"description": "If true, the Accordion is disabled",
|
|
91
|
-
"values": []
|
|
92
|
-
},
|
|
93
|
-
{
|
|
94
|
-
"name": "expanded",
|
|
95
|
-
"description": "If true, the Accordion is expanded",
|
|
96
|
-
"values": []
|
|
97
|
-
},
|
|
98
|
-
{
|
|
99
|
-
"name": "no-animation",
|
|
100
|
-
"description": "Animation is set through JS when the browser does not support CSS calc-size() If true, the Accordion animation, will be disabled. No animation will be applied.",
|
|
101
|
-
"values": []
|
|
102
|
-
},
|
|
103
|
-
{
|
|
104
|
-
"name": "rotate",
|
|
105
|
-
"description": "If true, the Accordion expand icon is rotate 180deg when expanded",
|
|
106
|
-
"values": []
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
"name": "size",
|
|
110
|
-
"description": "The size of the the Accordion",
|
|
111
|
-
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
112
|
-
}
|
|
113
|
-
],
|
|
114
|
-
"references": []
|
|
115
|
-
},
|
|
116
74
|
{
|
|
117
75
|
"name": "bq-alert",
|
|
118
76
|
"description": "The Alert is a user interface component used to convey important information to the user in a clear and concise manner.\nIt can be used to notify users of success, failure, warning, or any other type of information that needs to be brought to their attention.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-alert>\n<bq-icon name=\"star\" slot=\"icon\"></bq-icon>\nTitle\n<span slot=\"body\">\nDescription\n<a class=\"bq-link\" href=\"https://example.com\">Link</a>\n</span>\n<div slot=\"footer\">\n<bq-button appearance=\"primary\" size=\"small\">Button</bq-button>\n<bq-button appearance=\"link\" size=\"small\">Button</bq-button>\n</div>\n</bq-alert>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqHide** - Callback handler to be called when the alert is hidden\n- **bqShow** - Callback handler to be called when the alert is shown\n- **bqAfterShow** - Callback handler to be called after the alert has been shown\n- **bqAfterHide** - Callback handler to be called after the alert has been hidden\n- **bqHide** - Callback handler to be called when the alert is hidden\n- **bqShow** - Callback handler to be called when the alert is shown\n- **bqAfterShow** - Callback handler to be called after the alert has been shown\n- **bqAfterHide** - Callback handler to be called after the alert has been hidden\n\n### **Methods:**\n - **hide(): _Promise<void>_** - Method to be called to hide the alert component\n- **show(): _Promise<void>_** - Method to be called to show the alert component\n\n### **Slots:**\n - _default_ - The alert title content (no slot name required)\n- **body** - The alert description content\n- **footer** - The alert footer content\n- **icon** - The predefined icon based on the alert type (info, success, warning, error, default)\n- **btn-close** - The close button of the alert\n\n### **CSS Properties:**\n - **--bq-alert--background** - The alert background color _(default: undefined)_\n- **--bq-alert--border-radius** - The alert border radius _(default: undefined)_\n- **--bq-alert--content-footer-gap** - The alert content and footer gap _(default: undefined)_\n- **--bq-alert--title-body-gap** - The alert title and body gap _(default: undefined)_\n- **--bq-alert--border-color** - The alert border color _(default: undefined)_\n- **--bq-alert--border-style** - The alert border style _(default: undefined)_\n- **--bq-alert--border-width** - The alert border width _(default: undefined)_\n- **--bq-alert--background-info** - The alert background color for info type _(default: undefined)_\n- **--bq-alert--background-success** - The alert background color for success type _(default: undefined)_\n- **--bq-alert--background-warning** - The alert background color for warning type _(default: undefined)_\n- **--bq-alert--background-error** - The alert background color for error type _(default: undefined)_\n- **--bq-alert--border-info** - The alert border color for info type _(default: undefined)_\n- **--bq-alert--border-success** - The alert border color for success type _(default: undefined)_\n- **--bq-alert--border-warning** - The alert border color for warning type _(default: undefined)_\n- **--bq-alert--border-error** - The alert border color for error type _(default: undefined)_\n- **--bq-alert--icon-color-info** - The alert icon color for info type _(default: undefined)_\n- **--bq-alert--icon-color-success** - The alert icon color for success type _(default: undefined)_\n- **--bq-alert--icon-color-warning** - The alert icon color for warning type _(default: undefined)_\n- **--bq-alert--icon-color-error** - The alert icon color for error type _(default: undefined)_\n- **--bq-alert--padding** - The alert padding _(default: undefined)_\n- **--bq-alert--min-width** - The alert min width _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The `<div>` container of the predefined bq-icon component\n- **body** - The container `<div>` that wraps the alert description content\n- **btn-close** - The `bq-button` used to close the alert\n- **content** - The container `<div>` that wraps all the alert content (title, description, footer)\n- **footer** - The container `<div>` that wraps the alert footer content\n- **icon** - The `<bq-icon>` element used to render a predefined icon based on the alert type (info, success, warning, error, default)\n- **icon-outline** - The container `<div>` that wraps the icon element\n- **main** - The container `<div>` that wraps the alert main content (title, description)\n- **svg** - The `<svg>` element of the predefined bq-icon component\n- **title** - The container `<div>` that wraps the alert title content\n- **wrapper** - The wrapper container `<div>` of the element inside the shadow DOM",
|
|
@@ -175,23 +133,39 @@
|
|
|
175
133
|
"references": []
|
|
176
134
|
},
|
|
177
135
|
{
|
|
178
|
-
"name": "bq-
|
|
179
|
-
"description": "The
|
|
136
|
+
"name": "bq-avatar",
|
|
137
|
+
"description": "The Avatar component is a simple and customizable element that displays an image or initials in a circular or square shape.\nThis component is useful for displaying user profile pictures or any other image that represents a person or an entity.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-avatar\nalt-text=\"John Doe profile picture\"\nimage=\"/image/url/photo-1524593689594.jpeg\"\nlabel=\"John Doe profile picture\"\nshape=\"circle\"\nsize=\"medium\"\n>\n<bq-badge slot=\"badge\" text-color=\"#fff\">9</bq-badge>\n</bq-avatar>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - **badge** - The badge slot is used to add a badge to the avatar. The badge is a small circle or square that can be used to display a number or a status.\n\n### **CSS Properties:**\n - **--bq-avatar--background** - Avatar background color _(default: undefined)_\n- **--bq-avatar--border-color** - Avatar border color _(default: undefined)_\n- **--bq-avatar--border-style** - Avatar border style _(default: undefined)_\n- **--bq-avatar--border-width** - Avatar border width _(default: undefined)_\n- **--bq-avatar--border-radius-circle** - Avatar border radius for circle & any size _(default: undefined)_\n- **--bq-avatar--border-radius-squareXs** - Avatar border radius for square & size xsmall _(default: undefined)_\n- **--bq-avatar--border-radius-squareS** - Avatar border radius for square & size small _(default: undefined)_\n- **--bq-avatar--border-radius-squareM** - Avatar border radius for square & size medium/large _(default: undefined)_\n- **--bq-avatar--size-xsmall** - Avatar xsmall size _(default: undefined)_\n- **--bq-avatar--size-small** - Avatar small size _(default: undefined)_\n- **--bq-avatar--size-medium** - Avatar medium size _(default: undefined)_\n- **--bq-avatar--size-large** - Avatar large size _(default: undefined)_\n- **--bq-avatar--badge-top-square** - Badge top position shape square _(default: undefined)_\n- **--bq-avatar--badge-left-square** - Badge left position shape square _(default: undefined)_\n- **--bq-avatar--badge-top-circle** - Badge top position shape circle _(default: undefined)_\n- **--bq-avatar--badge-left-circle** - Badge left position shape circle _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.\n- **img** - The `<image>` tag element that load the image source.\n- **text** - The `<span>` tag element that rendered the `Initials` text string.\n- **badge** - The container that wraps the badge slot element.",
|
|
180
138
|
"attributes": [
|
|
181
139
|
{
|
|
182
|
-
"name": "
|
|
183
|
-
"description": "
|
|
140
|
+
"name": "alt-text",
|
|
141
|
+
"description": "Alternate text for the avatar image if the image cannot be displayed.",
|
|
184
142
|
"values": []
|
|
185
143
|
},
|
|
186
144
|
{
|
|
187
|
-
"name": "
|
|
188
|
-
"description": "
|
|
145
|
+
"name": "image",
|
|
146
|
+
"description": "The image source to load on the avatar (this can be also a base64 encoded image).",
|
|
189
147
|
"values": []
|
|
190
148
|
},
|
|
149
|
+
{
|
|
150
|
+
"name": "label",
|
|
151
|
+
"description": "A text to use for describing the avatar on assistive devices.",
|
|
152
|
+
"values": []
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"name": "initials",
|
|
156
|
+
"description": "The text to display on avatar.",
|
|
157
|
+
"values": []
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
"name": "shape",
|
|
161
|
+
"description": "The shape of the avatar.",
|
|
162
|
+
"values": [{ "name": "circle" }, { "name": "square" }]
|
|
163
|
+
},
|
|
191
164
|
{
|
|
192
165
|
"name": "size",
|
|
193
|
-
"description": "The size of the
|
|
166
|
+
"description": "The size of the avatar.",
|
|
194
167
|
"values": [
|
|
168
|
+
{ "name": "xsmall" },
|
|
195
169
|
{ "name": "small" },
|
|
196
170
|
{ "name": "medium" },
|
|
197
171
|
{ "name": "large" }
|
|
@@ -201,23 +175,27 @@
|
|
|
201
175
|
"references": []
|
|
202
176
|
},
|
|
203
177
|
{
|
|
204
|
-
"name": "bq-
|
|
205
|
-
"description": "The
|
|
178
|
+
"name": "bq-badge",
|
|
179
|
+
"description": "The Badge component is a visual indicator that can be added to various elements within a user interface.\nIt is typically used to highlight important or relevant information, such as alerts, notifications, or statuses.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-badge background-color=\"ui--success\" text-color=\"text--inverse\" size=\"small\">9</bq-badge>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The default slot is used to add content to the badge. The content can be a number or a text.\n\n### **CSS Properties:**\n - **--bq-badge--background-color** - The badge background color _(default: undefined)_\n- **--bq-badge--box-shadow** - The badge box shadow _(default: undefined)_\n- **--bq-badge--border-color** - The badge border color _(default: undefined)_\n- **--bq-badge--border-radius** - The badge border radius _(default: undefined)_\n- **--bq-badge--border-style** - The badge border style _(default: undefined)_\n- **--bq-badge--border-width** - The badge border width _(default: undefined)_\n- **--bq-badge--size-small** - The badge small size _(default: undefined)_\n- **--bq-badge--size-medium** - The badge medium size _(default: undefined)_\n- **--bq-badge--size-large** - The badge large size _(default: undefined)_\n- **--bq-badge--text-color** - The badge text color _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper that holds the count.\n- **number** - The component's internal wrapper that holds the slot.",
|
|
206
180
|
"attributes": [
|
|
207
181
|
{
|
|
208
|
-
"name": "
|
|
209
|
-
"description": "
|
|
182
|
+
"name": "background-color",
|
|
183
|
+
"description": "Badge background color. The value should be a valid value of the palette color.",
|
|
210
184
|
"values": []
|
|
211
185
|
},
|
|
212
186
|
{
|
|
213
|
-
"name": "
|
|
214
|
-
"description": "
|
|
187
|
+
"name": "text-color",
|
|
188
|
+
"description": "Badge number color. The value should be a valid value of the palette color.",
|
|
215
189
|
"values": []
|
|
216
190
|
},
|
|
217
191
|
{
|
|
218
|
-
"name": "
|
|
219
|
-
"description": "
|
|
220
|
-
"values": [
|
|
192
|
+
"name": "size",
|
|
193
|
+
"description": "The size of the badge. Relevant if badge has no content.",
|
|
194
|
+
"values": [
|
|
195
|
+
{ "name": "small" },
|
|
196
|
+
{ "name": "medium" },
|
|
197
|
+
{ "name": "large" }
|
|
198
|
+
]
|
|
221
199
|
}
|
|
222
200
|
],
|
|
223
201
|
"references": []
|
|
@@ -328,89 +306,39 @@
|
|
|
328
306
|
"references": []
|
|
329
307
|
},
|
|
330
308
|
{
|
|
331
|
-
"name": "bq-
|
|
332
|
-
"description": "The
|
|
333
|
-
"attributes": [
|
|
334
|
-
{
|
|
335
|
-
"name": "type",
|
|
336
|
-
"description": "Type of card component",
|
|
337
|
-
"values": [{ "name": "default" }, { "name": "minimal" }]
|
|
338
|
-
},
|
|
339
|
-
{
|
|
340
|
-
"name": "border",
|
|
341
|
-
"description": "The corner radius of the card component",
|
|
342
|
-
"values": [
|
|
343
|
-
{ "name": "none" },
|
|
344
|
-
{ "name": "xs2" },
|
|
345
|
-
{ "name": "xs" },
|
|
346
|
-
{ "name": "s" },
|
|
347
|
-
{ "name": "m" },
|
|
348
|
-
{ "name": "l" },
|
|
349
|
-
{ "name": "full" }
|
|
350
|
-
]
|
|
351
|
-
}
|
|
352
|
-
],
|
|
353
|
-
"references": []
|
|
354
|
-
},
|
|
355
|
-
{
|
|
356
|
-
"name": "bq-checkbox",
|
|
357
|
-
"description": "The checkbox is a UI component that allows users to select one or more options from a list of choices.\nIt is commonly used in forms, surveys, and settings pages.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-checkbox name=\"bq-checkbox\" value=\"checkbox-value\" background-on-hover>\nCheckbox label\n</bq-checkbox>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqChange** - Handler to be called when the checkbox state changes\n- **bqFocus** - Handler to be called when the checkbox gets focus\n- **bqBlur** - Handler to be called when the checkbox loses focus\n- **bqChange** - Handler to be called when the checkbox state changes\n- **bqFocus** - Handler to be called when the checkbox gets focus\n- **bqBlur** - Handler to be called when the checkbox loses focus\n\n### **Methods:**\n - **vClick()** - Simulate a click event on the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.click()`.\n- **vFocus()** - Sets focus on the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.focus()`.\n- **vBlur()** - Remove focus from the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.blur()`.\n\n### **Slots:**\n - _default_ - The content of the checkbox component\n\n### **CSS Properties:**\n - **--bq-checkbox--size** - Checkbox size _(default: undefined)_\n- **--bq-checkbox--border-radius** - Checkbox border radius _(default: undefined)_\n- **--bq-checkbox--border-width** - Checkbox border width _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper of the checkbox component.\n- **control** - The container `<div>` element that holds the custom checkbox.\n- **input** - The native HTML `<input type=\"checkbox\">` used under the hood.\n- **checkbox** - The `<span>` element that renders the custom checked/indeterminate state.\n- **label** - The `<span>` element that holds the text content.",
|
|
309
|
+
"name": "bq-breadcrumb-item",
|
|
310
|
+
"description": "The Breadcrumb Item helps users understand their current location within a website or application's hierarchical structure.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-breadcrumb-item label=\"Home page\">\n<bq-icon name=\"house-line\" size=\"16\"></bq-icon>\nHome\n</bq-breadcrumb-item>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqFocus** - Handler to be called when item is focused\n- **bqClick** - Handler to be called when item is clicked\n- **bqBlur** - Handler to be called when item loses focus\n- **bqBlur** - Handler to be called when item loses focus\n- **bqFocus** - Handler to be called when item is focused\n- **bqClick** - Handler to be called when item is clicked\n\n### **Slots:**\n - _default_ - The default slot is used to add content to the breadcrumb item.\n\n### **CSS Properties:**\n - **--bq-breadcrumb-item--background** - Background color of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--box-shadow** - Box shadow of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--border-color** - Border color of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--border-style** - Border style of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--border-width** - Border width of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--border-radius** - Border radius of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--line-height** - Line height of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--text-color** - Text color of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--text-color-current** - Text color of the current breadcrumb item (active) _(default: undefined)_\n- **--bq-breadcrumb-item--text-size** - Text size of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--text-size-separator** - Text size of the breadcrumb item separator _(default: undefined)_\n- **--bq-breadcrumb-item--padding-start** - Padding start of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--padding-end** - Padding end of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--paddingY** - Padding top and bottom of the breadcrumb item _(default: undefined)_\n- **--bq-breadcrumb-item--padding-start-separator** - Padding start of the breadcrumb item separator _(default: undefined)_\n- **--bq-breadcrumb-item--padding-end-separator** - Padding end of the breadcrumb item separator _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component wrapper container\n- **content** - The `span` tag that wraps the content item\n- **item** - The breadcrumb item wrapper (`button` or `a`)\n- **separator** - The `span` tag that wraps the separator element",
|
|
358
311
|
"attributes": [
|
|
359
312
|
{
|
|
360
|
-
"name": "
|
|
361
|
-
"description": "If
|
|
362
|
-
"values": []
|
|
363
|
-
},
|
|
364
|
-
{
|
|
365
|
-
"name": "form-id",
|
|
366
|
-
"description": "The form ID that the checkbox is associated with",
|
|
367
|
-
"values": []
|
|
368
|
-
},
|
|
369
|
-
{
|
|
370
|
-
"name": "form-validation-message",
|
|
371
|
-
"description": "The native form validation message",
|
|
372
|
-
"values": []
|
|
373
|
-
},
|
|
374
|
-
{
|
|
375
|
-
"name": "checked",
|
|
376
|
-
"description": "If true checkbox is checked",
|
|
377
|
-
"values": []
|
|
378
|
-
},
|
|
379
|
-
{
|
|
380
|
-
"name": "disabled",
|
|
381
|
-
"description": "If true checkbox is disabled",
|
|
382
|
-
"values": []
|
|
383
|
-
},
|
|
384
|
-
{
|
|
385
|
-
"name": "indeterminate",
|
|
386
|
-
"description": "A state that is neither checked nor unchecked",
|
|
387
|
-
"values": []
|
|
388
|
-
},
|
|
389
|
-
{
|
|
390
|
-
"name": "name",
|
|
391
|
-
"description": "Name of the HTML input form control. Submitted with the form as part of a name/value pair",
|
|
313
|
+
"name": "href",
|
|
314
|
+
"description": "If set, the breadcrumb item will be rendered as an `<a>` with this `href`, otherwise, a `<button>` will be rendered.",
|
|
392
315
|
"values": []
|
|
393
316
|
},
|
|
394
317
|
{
|
|
395
|
-
"name": "
|
|
396
|
-
"description": "
|
|
318
|
+
"name": "target",
|
|
319
|
+
"description": "Where to display the link in the browser context. Relevant only if `href` is set.",
|
|
397
320
|
"values": []
|
|
398
321
|
},
|
|
399
322
|
{
|
|
400
|
-
"name": "
|
|
401
|
-
"description": "
|
|
323
|
+
"name": "rel",
|
|
324
|
+
"description": "Where to display the link in the browser context. Relevant only if `href` is set.",
|
|
402
325
|
"values": []
|
|
403
326
|
}
|
|
404
327
|
],
|
|
405
328
|
"references": []
|
|
406
329
|
},
|
|
407
330
|
{
|
|
408
|
-
"name": "bq-
|
|
409
|
-
"description": "The
|
|
331
|
+
"name": "bq-card",
|
|
332
|
+
"description": "The Card component serves as a versatile container designed for flexible content presentation within user interfaces.\nIts structure accommodates various styles, allowing users to customize and adapt it according to their design preferences.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-card type=\"default\" border=\"m\">\n<div class=\"p-m\">\n<h3 class=\"text-xl font-bold\">Card Title</h3>\n<p class=\"text-m\">Card content goes here</p>\n</div>\n</bq-card>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The content of the card component\n\n### **CSS Properties:**\n - **--bq-card--borderColor** - Card border color _(default: undefined)_\n- **--bq-card--borderRadius** - Card border radius _(default: undefined)_\n- **--bq-card--borderStyle** - Card border style _(default: undefined)_\n- **--bq-card--borderWidth** - Card border width _(default: undefined)_\n- **--bq-card--padding** - Card padding _(default: undefined)_\n- **--bq-card--paddingMinimal** - Minimal card padding _(default: undefined)_\n- **--bq-card--background** - Card background color _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The wrapper container `<div>` of the element inside the shadow DOM",
|
|
410
333
|
"attributes": [
|
|
334
|
+
{
|
|
335
|
+
"name": "type",
|
|
336
|
+
"description": "Type of card component",
|
|
337
|
+
"values": [{ "name": "default" }, { "name": "minimal" }]
|
|
338
|
+
},
|
|
411
339
|
{
|
|
412
340
|
"name": "border",
|
|
413
|
-
"description": "
|
|
341
|
+
"description": "The corner radius of the card component",
|
|
414
342
|
"values": [
|
|
415
343
|
{ "name": "none" },
|
|
416
344
|
{ "name": "xs2" },
|
|
@@ -420,45 +348,6 @@
|
|
|
420
348
|
{ "name": "l" },
|
|
421
349
|
{ "name": "full" }
|
|
422
350
|
]
|
|
423
|
-
},
|
|
424
|
-
{
|
|
425
|
-
"name": "disable-backdrop",
|
|
426
|
-
"description": "If true, the backdrop overlay won't be shown when the dialog opens.",
|
|
427
|
-
"values": []
|
|
428
|
-
},
|
|
429
|
-
{
|
|
430
|
-
"name": "disable-close-esc-keydown",
|
|
431
|
-
"description": "If true, the dialog will not close when the [Esc] key is pressed.",
|
|
432
|
-
"values": []
|
|
433
|
-
},
|
|
434
|
-
{
|
|
435
|
-
"name": "disable-close-click-outside",
|
|
436
|
-
"description": "If true, the dialog will not close when clicking on the backdrop overlay.",
|
|
437
|
-
"values": []
|
|
438
|
-
},
|
|
439
|
-
{
|
|
440
|
-
"name": "footer-appearance",
|
|
441
|
-
"description": "The appearance of the footer.",
|
|
442
|
-
"values": [{ "name": "standard" }, { "name": "highlight" }]
|
|
443
|
-
},
|
|
444
|
-
{
|
|
445
|
-
"name": "hide-close-button",
|
|
446
|
-
"description": "If true, it hides the close button.",
|
|
447
|
-
"values": []
|
|
448
|
-
},
|
|
449
|
-
{
|
|
450
|
-
"name": "open",
|
|
451
|
-
"description": "If true, the dialog will be shown as open.",
|
|
452
|
-
"values": []
|
|
453
|
-
},
|
|
454
|
-
{
|
|
455
|
-
"name": "size",
|
|
456
|
-
"description": "The size of the dialog.",
|
|
457
|
-
"values": [
|
|
458
|
-
{ "name": "small" },
|
|
459
|
-
{ "name": "medium" },
|
|
460
|
-
{ "name": "large" }
|
|
461
|
-
]
|
|
462
351
|
}
|
|
463
352
|
],
|
|
464
353
|
"references": []
|
|
@@ -589,49 +478,193 @@
|
|
|
589
478
|
"values": []
|
|
590
479
|
},
|
|
591
480
|
{
|
|
592
|
-
"name": "show-outside-days",
|
|
593
|
-
"description": "Whether to show days outside the month.",
|
|
481
|
+
"name": "show-outside-days",
|
|
482
|
+
"description": "Whether to show days outside the month.",
|
|
483
|
+
"values": []
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
"name": "strategy",
|
|
487
|
+
"description": "Defines the strategy to position the Date picker panel.",
|
|
488
|
+
"values": []
|
|
489
|
+
},
|
|
490
|
+
{
|
|
491
|
+
"name": "tentative",
|
|
492
|
+
"description": "The date that is tentatively selected, e.g. the start of a range selection.",
|
|
493
|
+
"values": []
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "type",
|
|
497
|
+
"description": "It defines how the calendar will behave, allowing single date selection, range selection, or multiple date selection.",
|
|
498
|
+
"values": [
|
|
499
|
+
{ "name": "single" },
|
|
500
|
+
{ "name": "multi" },
|
|
501
|
+
{ "name": "range" }
|
|
502
|
+
]
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "validation-status",
|
|
506
|
+
"description": "The validation status of the Select input.",
|
|
507
|
+
"values": [
|
|
508
|
+
{ "name": "error" },
|
|
509
|
+
{ "name": "none" },
|
|
510
|
+
{ "name": "success" },
|
|
511
|
+
{ "name": "warning" }
|
|
512
|
+
]
|
|
513
|
+
},
|
|
514
|
+
{
|
|
515
|
+
"name": "value",
|
|
516
|
+
"description": "The select input value represents the currently selected date or range and can be used to reset the field to a previous value.",
|
|
517
|
+
"values": []
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "months-per-view",
|
|
521
|
+
"values": [{ "name": "single" }, { "name": "months" }]
|
|
522
|
+
},
|
|
523
|
+
{ "name": "placeholder", "values": [] }
|
|
524
|
+
],
|
|
525
|
+
"references": []
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
"name": "bq-checkbox",
|
|
529
|
+
"description": "The checkbox is a UI component that allows users to select one or more options from a list of choices.\nIt is commonly used in forms, surveys, and settings pages.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-checkbox name=\"bq-checkbox\" value=\"checkbox-value\" background-on-hover>\nCheckbox label\n</bq-checkbox>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqChange** - Handler to be called when the checkbox state changes\n- **bqFocus** - Handler to be called when the checkbox gets focus\n- **bqBlur** - Handler to be called when the checkbox loses focus\n- **bqChange** - Handler to be called when the checkbox state changes\n- **bqFocus** - Handler to be called when the checkbox gets focus\n- **bqBlur** - Handler to be called when the checkbox loses focus\n\n### **Methods:**\n - **vClick()** - Simulate a click event on the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.click()`.\n- **vFocus()** - Sets focus on the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.focus()`.\n- **vBlur()** - Remove focus from the native `<input>` HTML element used under the hood.\nUse this method instead of the global `element.blur()`.\n\n### **Slots:**\n - _default_ - The content of the checkbox component\n\n### **CSS Properties:**\n - **--bq-checkbox--size** - Checkbox size _(default: undefined)_\n- **--bq-checkbox--border-radius** - Checkbox border radius _(default: undefined)_\n- **--bq-checkbox--border-width** - Checkbox border width _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper of the checkbox component.\n- **control** - The container `<div>` element that holds the custom checkbox.\n- **input** - The native HTML `<input type=\"checkbox\">` used under the hood.\n- **checkbox** - The `<span>` element that renders the custom checked/indeterminate state.\n- **label** - The `<span>` element that holds the text content.",
|
|
530
|
+
"attributes": [
|
|
531
|
+
{
|
|
532
|
+
"name": "background-on-hover",
|
|
533
|
+
"description": "If true checkbox displays background on hover",
|
|
534
|
+
"values": []
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "form-id",
|
|
538
|
+
"description": "The form ID that the checkbox is associated with",
|
|
539
|
+
"values": []
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "form-validation-message",
|
|
543
|
+
"description": "The native form validation message",
|
|
544
|
+
"values": []
|
|
545
|
+
},
|
|
546
|
+
{
|
|
547
|
+
"name": "checked",
|
|
548
|
+
"description": "If true checkbox is checked",
|
|
549
|
+
"values": []
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "disabled",
|
|
553
|
+
"description": "If true checkbox is disabled",
|
|
554
|
+
"values": []
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"name": "indeterminate",
|
|
558
|
+
"description": "A state that is neither checked nor unchecked",
|
|
559
|
+
"values": []
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"name": "name",
|
|
563
|
+
"description": "Name of the HTML input form control. Submitted with the form as part of a name/value pair",
|
|
564
|
+
"values": []
|
|
565
|
+
},
|
|
566
|
+
{
|
|
567
|
+
"name": "required",
|
|
568
|
+
"description": "If `true`, it will indicate that the user must specify a value for the checkbox before the owning form can be submitted",
|
|
569
|
+
"values": []
|
|
570
|
+
},
|
|
571
|
+
{
|
|
572
|
+
"name": "value",
|
|
573
|
+
"description": "A string representing the value of the checkbox. Primarily used to differentiate a list of related checkboxes that have the same name",
|
|
574
|
+
"values": []
|
|
575
|
+
}
|
|
576
|
+
],
|
|
577
|
+
"references": []
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "bq-dialog",
|
|
581
|
+
"description": "The Dialog component is used to display additional content or prompt a user for action.\nIt provides a way to display additional information, options, or controls in a separate, non-obstructive interface element.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-dialog footer-appearance=\"standard\" border=\"m\" size=\"medium\">\n<h5 class=\"bold flex items-center gap-s\" slot=\"title\">\n<bq-icon name=\"info\" size=\"30\" color=\"text--accent\" role=\"img\" title=\"Info\"></bq-icon>\nTitle\n</h5>\n<p>\nLorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's\nstandard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a\ntype specimen book.\n</p>\n<div class=\"flex gap-xs\" slot=\"footer\">\n<bq-button appearance=\"link\">Button</bq-button>\n<bq-button variant=\"ghost\">Button</bq-button>\n<bq-button variant=\"standard\" slot=\"footer\">Button</bq-button>\n</div>\n</bq-dialog>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqCancel** - Callback handler emitted when the dialog has been canceled or dismissed.\n- **bqClose** - Callback handler emitted when the dialog will close.\n- **bqOpen** - Callback handler emitted when the dialog will open.\n- **bqAfterOpen** - Callback handler emitted when the dialog finish opening.\n- **bqAfterClose** - Callback handler emitted when the dialog finish closing.\n- **bqCancel** - Callback handler emitted when the dialog has been canceled or dismissed\n- **bqClose** - Callback handler emitted when the dialog will close\n- **bqOpen** - Callback handler emitted when the dialog will open\n- **bqAfterOpen** - Callback handler emitted when the dialog finish opening\n- **bqAfterClose** - Callback handler emitted when the dialog finish closing\n\n### **Methods:**\n - **show()** - Open the dialog\n- **hide()** - Closes the dialog\n- **cancel()** - Dismiss or cancel the dialog\n\n### **Slots:**\n - **title** - The title content of the dialog.\n- _default_ - The body content of the dialog.\n- **footer** - The footer content of the dialog.\n- **button-close** - The close button content of the dialog.\n\n### **CSS Properties:**\n - **--bq-dialog--background** - Dialog background color _(default: undefined)_\n- **--bq-dialog--background-backdrop** - Dialog backdrop background color _(default: undefined)_\n- **--bq-dialog--box-shadow** - Dialog box shadow _(default: undefined)_\n- **--bq-dialog--border-color** - Dialog border color _(default: undefined)_\n- **--bq-dialog--border-style** - Dialog border style _(default: undefined)_\n- **--bq-dialog--border-width** - Dialog border width _(default: undefined)_\n- **--bq-dialog--border-radius** - Dialog border radius _(default: undefined)_\n- **--bq-dialog--padding** - Dialog padding _(default: undefined)_\n- **--bq-dialog--content-footer-gap** - Dialog gap distance between content and footer elements _(default: undefined)_\n- **--bq-dialog--title-body-gap** - Dialog gap distance between title and body elements _(default: undefined)_\n- **--bq-dialog--width-small** - Dialog small width _(default: undefined)_\n- **--bq-dialog--width-medium** - Dialog medium width _(default: undefined)_\n- **--bq-dialog--width-large** - Dialog large width _(default: undefined)_\n- **--bq-dialog-z-index** - Dialog z-index applied when opened _(default: undefined)_\n\n### **CSS Parts:**\n - **body** - The `<main>` that holds the dialog body content.\n- **button-close** - The button that closes the dialog on click.\n- **content** - The `<div>` container that holds the dialog title and body content.\n- **dialog** - The `<dialog>` wrapper container inside the shadow DOM.\n- **footer** - The `<footer>` that holds footer content.\n- **header** - The `<header>` that holds the icon, title, description and close button.\n- **title** - The `<div>` that holds the title content.",
|
|
582
|
+
"attributes": [
|
|
583
|
+
{
|
|
584
|
+
"name": "border",
|
|
585
|
+
"description": "Border radius of the dialog component.",
|
|
586
|
+
"values": [
|
|
587
|
+
{ "name": "none" },
|
|
588
|
+
{ "name": "xs2" },
|
|
589
|
+
{ "name": "xs" },
|
|
590
|
+
{ "name": "s" },
|
|
591
|
+
{ "name": "m" },
|
|
592
|
+
{ "name": "l" },
|
|
593
|
+
{ "name": "full" }
|
|
594
|
+
]
|
|
595
|
+
},
|
|
596
|
+
{
|
|
597
|
+
"name": "disable-backdrop",
|
|
598
|
+
"description": "If true, the backdrop overlay won't be shown when the dialog opens.",
|
|
599
|
+
"values": []
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"name": "disable-close-esc-keydown",
|
|
603
|
+
"description": "If true, the dialog will not close when the [Esc] key is pressed.",
|
|
604
|
+
"values": []
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "disable-close-click-outside",
|
|
608
|
+
"description": "If true, the dialog will not close when clicking on the backdrop overlay.",
|
|
609
|
+
"values": []
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"name": "footer-appearance",
|
|
613
|
+
"description": "The appearance of the footer.",
|
|
614
|
+
"values": [{ "name": "standard" }, { "name": "highlight" }]
|
|
615
|
+
},
|
|
616
|
+
{
|
|
617
|
+
"name": "hide-close-button",
|
|
618
|
+
"description": "If true, it hides the close button.",
|
|
619
|
+
"values": []
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"name": "open",
|
|
623
|
+
"description": "If true, the dialog will be shown as open.",
|
|
624
|
+
"values": []
|
|
625
|
+
},
|
|
626
|
+
{
|
|
627
|
+
"name": "size",
|
|
628
|
+
"description": "The size of the dialog.",
|
|
629
|
+
"values": [
|
|
630
|
+
{ "name": "small" },
|
|
631
|
+
{ "name": "medium" },
|
|
632
|
+
{ "name": "large" }
|
|
633
|
+
]
|
|
634
|
+
}
|
|
635
|
+
],
|
|
636
|
+
"references": []
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"name": "bq-drawer",
|
|
640
|
+
"description": "The Drawer component provides a sliding panel interface commonly used for navigation or presenting additional content without taking up significant screen space.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-drawer position=\"end\">\n<div class=\"flex gap-xs\" slot=\"title\">Title</div>\n<div class=\"...\">\nContent\n</div>\n<div class=\"flex flex-1 justify-center gap-xs\" slot=\"footer\">\n<bq-button appearance=\"primary\" block=\"\" size=\"small\">Button</bq-button>\n<bq-button appearance=\"link\" block=\"\" size=\"small\">Button</bq-button>\n</div>\n</bq-drawer>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClose** - Callback handler to be called when the drawer is closed.\n- **bqOpen** - Callback handler to be called when the drawer is opened.\n- **bqAfterOpen** - Callback handler to be called after the drawer has been opened.\n- **bqAfterClose** - Callback handler to be called after the drawer has been closed.\n- **bqClose** - Callback handler to be called when the drawer is closed\n- **bqOpen** - Callback handler to be called when the drawer is opened\n- **bqAfterOpen** - Callback handler to be called after the drawer has been opened\n- **bqAfterClose** - Callback handler to be called after the drawer has been closed\n\n### **Methods:**\n - **handlePlacementChange()** - !TO BE REMOVED: Delete this `@Watch()` once the deprecated `placement` property is removed\nWe need to maintain retro-compatibility with the deprecated `placement` property\n- **hide(): _Promise<void>_** - Method to be called to hide the drawer component\n- **show(): _Promise<void>_** - Method to be called to show the drawer component\n\n### **Slots:**\n - **title** - The title content of the drawer.\n- _default_ - The body content of the drawer.\n- **footer** - The footer content of the drawer.\n- **button-close** - The close button content of the drawer.\n- **footer-divider** - The footer divider content of the drawer.\n\n### **CSS Properties:**\n - **--bq-drawer--backgroundBackdrop** - Background color of the backdrop _(default: undefined)_\n- **--bq-drawer--gap** - Gap between the drawer and the viewport _(default: undefined)_\n- **--bq-drawer--width** - Width of the drawer _(default: undefined)_\n- **--bq-drawer--paddingX** - Padding left and right of the drawer _(default: undefined)_\n- **--bq-drawer--paddingY** - Padding top and bottom of the drawer _(default: undefined)_\n- **--bq-drawer--zIndex** - Z-index of the drawer component _(default: undefined)_\n\n### **CSS Parts:**\n - **backdrop** - The `<div>` that holds the backdrop overlay.\n- **button-close** - The BqButton that closes the drawer.\n- **button-close__btn** - The native button used under the hood that closes the drawer.\n- **button-close__label** - The text inside the native button that closes the drawer.\n- **panel** - The `<div>` that holds the drawer entire content.\n- **header** - The `<header>` that holds the icon, title, and close button.\n- **title** - The `<div>` that holds the title content.\n- **body** - The `<main>` that holds the drawer body content.\n- **footer** - The `<footer>` that holds footer content.",
|
|
641
|
+
"attributes": [
|
|
642
|
+
{
|
|
643
|
+
"name": "enable-backdrop",
|
|
644
|
+
"description": "If true, the backdrop overlay will be shown when the drawer opens.",
|
|
594
645
|
"values": []
|
|
595
646
|
},
|
|
596
647
|
{
|
|
597
|
-
"name": "
|
|
598
|
-
"description": "
|
|
648
|
+
"name": "close-on-click-outside",
|
|
649
|
+
"description": "If true, the drawer will not close when clicking outside the panel.",
|
|
599
650
|
"values": []
|
|
600
651
|
},
|
|
601
652
|
{
|
|
602
|
-
"name": "
|
|
603
|
-
"description": "
|
|
653
|
+
"name": "close-on-esc",
|
|
654
|
+
"description": "If true, the drawer will not close when the [Esc] key is pressed.",
|
|
604
655
|
"values": []
|
|
605
656
|
},
|
|
606
657
|
{
|
|
607
|
-
"name": "
|
|
608
|
-
"description": "
|
|
609
|
-
"values": [
|
|
610
|
-
{ "name": "single" },
|
|
611
|
-
{ "name": "multi" },
|
|
612
|
-
{ "name": "range" }
|
|
613
|
-
]
|
|
614
|
-
},
|
|
615
|
-
{
|
|
616
|
-
"name": "validation-status",
|
|
617
|
-
"description": "The validation status of the Select input.",
|
|
618
|
-
"values": [
|
|
619
|
-
{ "name": "error" },
|
|
620
|
-
{ "name": "none" },
|
|
621
|
-
{ "name": "success" },
|
|
622
|
-
{ "name": "warning" }
|
|
623
|
-
]
|
|
624
|
-
},
|
|
625
|
-
{
|
|
626
|
-
"name": "value",
|
|
627
|
-
"description": "The select input value represents the currently selected date or range and can be used to reset the field to a previous value.",
|
|
658
|
+
"name": "open",
|
|
659
|
+
"description": "If true, the drawer component will be shown.",
|
|
628
660
|
"values": []
|
|
629
661
|
},
|
|
630
662
|
{
|
|
631
|
-
"name": "
|
|
632
|
-
"
|
|
663
|
+
"name": "position",
|
|
664
|
+
"description": "Defines the position of the drawer.",
|
|
665
|
+
"values": [{ "name": "start" }, { "name": "end" }]
|
|
633
666
|
},
|
|
634
|
-
{ "name": "
|
|
667
|
+
{ "name": "placement", "values": [{ "name": "TDrawerPlacement" }] }
|
|
635
668
|
],
|
|
636
669
|
"references": []
|
|
637
670
|
},
|
|
@@ -695,39 +728,6 @@
|
|
|
695
728
|
],
|
|
696
729
|
"references": []
|
|
697
730
|
},
|
|
698
|
-
{
|
|
699
|
-
"name": "bq-drawer",
|
|
700
|
-
"description": "The Drawer component provides a sliding panel interface commonly used for navigation or presenting additional content without taking up significant screen space.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-drawer position=\"end\">\n<div class=\"flex gap-xs\" slot=\"title\">Title</div>\n<div class=\"...\">\nContent\n</div>\n<div class=\"flex flex-1 justify-center gap-xs\" slot=\"footer\">\n<bq-button appearance=\"primary\" block=\"\" size=\"small\">Button</bq-button>\n<bq-button appearance=\"link\" block=\"\" size=\"small\">Button</bq-button>\n</div>\n</bq-drawer>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClose** - Callback handler to be called when the drawer is closed.\n- **bqOpen** - Callback handler to be called when the drawer is opened.\n- **bqAfterOpen** - Callback handler to be called after the drawer has been opened.\n- **bqAfterClose** - Callback handler to be called after the drawer has been closed.\n- **bqClose** - Callback handler to be called when the drawer is closed\n- **bqOpen** - Callback handler to be called when the drawer is opened\n- **bqAfterOpen** - Callback handler to be called after the drawer has been opened\n- **bqAfterClose** - Callback handler to be called after the drawer has been closed\n\n### **Methods:**\n - **handlePlacementChange()** - !TO BE REMOVED: Delete this `@Watch()` once the deprecated `placement` property is removed\nWe need to maintain retro-compatibility with the deprecated `placement` property\n- **hide(): _Promise<void>_** - Method to be called to hide the drawer component\n- **show(): _Promise<void>_** - Method to be called to show the drawer component\n\n### **Slots:**\n - **title** - The title content of the drawer.\n- _default_ - The body content of the drawer.\n- **footer** - The footer content of the drawer.\n- **button-close** - The close button content of the drawer.\n- **footer-divider** - The footer divider content of the drawer.\n\n### **CSS Properties:**\n - **--bq-drawer--backgroundBackdrop** - Background color of the backdrop _(default: undefined)_\n- **--bq-drawer--gap** - Gap between the drawer and the viewport _(default: undefined)_\n- **--bq-drawer--width** - Width of the drawer _(default: undefined)_\n- **--bq-drawer--paddingX** - Padding left and right of the drawer _(default: undefined)_\n- **--bq-drawer--paddingY** - Padding top and bottom of the drawer _(default: undefined)_\n- **--bq-drawer--zIndex** - Z-index of the drawer component _(default: undefined)_\n\n### **CSS Parts:**\n - **backdrop** - The `<div>` that holds the backdrop overlay.\n- **button-close** - The BqButton that closes the drawer.\n- **button-close__btn** - The native button used under the hood that closes the drawer.\n- **button-close__label** - The text inside the native button that closes the drawer.\n- **panel** - The `<div>` that holds the drawer entire content.\n- **header** - The `<header>` that holds the icon, title, and close button.\n- **title** - The `<div>` that holds the title content.\n- **body** - The `<main>` that holds the drawer body content.\n- **footer** - The `<footer>` that holds footer content.",
|
|
701
|
-
"attributes": [
|
|
702
|
-
{
|
|
703
|
-
"name": "enable-backdrop",
|
|
704
|
-
"description": "If true, the backdrop overlay will be shown when the drawer opens.",
|
|
705
|
-
"values": []
|
|
706
|
-
},
|
|
707
|
-
{
|
|
708
|
-
"name": "close-on-click-outside",
|
|
709
|
-
"description": "If true, the drawer will not close when clicking outside the panel.",
|
|
710
|
-
"values": []
|
|
711
|
-
},
|
|
712
|
-
{
|
|
713
|
-
"name": "close-on-esc",
|
|
714
|
-
"description": "If true, the drawer will not close when the [Esc] key is pressed.",
|
|
715
|
-
"values": []
|
|
716
|
-
},
|
|
717
|
-
{
|
|
718
|
-
"name": "open",
|
|
719
|
-
"description": "If true, the drawer component will be shown.",
|
|
720
|
-
"values": []
|
|
721
|
-
},
|
|
722
|
-
{
|
|
723
|
-
"name": "position",
|
|
724
|
-
"description": "Defines the position of the drawer.",
|
|
725
|
-
"values": [{ "name": "start" }, { "name": "end" }]
|
|
726
|
-
},
|
|
727
|
-
{ "name": "placement", "values": [{ "name": "TDrawerPlacement" }] }
|
|
728
|
-
],
|
|
729
|
-
"references": []
|
|
730
|
-
},
|
|
731
731
|
{
|
|
732
732
|
"name": "bq-dropdown",
|
|
733
733
|
"description": "The Dropdown Component is commonly used when presenting a list of selectable options that are too numerous to fit comfortably on the screen.\nThey provide an efficient way to save space and present a long list of options in a compact and organized manner.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-dropdown placement=\"bottom-start\">\n<bq-button slot=\"trigger\">Dropdown</bq-button>\n<bq-option-list>\n<bq-option value=\"users\">...</bq-option>\n<bq-option value=\"user\">...</bq-option>\n<bq-option value=\"dashboard\">...</bq-option>\n<bq-option value=\"settings\">...</bq-option>\n<bq-option value=\"logout\">...</bq-option>\n</bq-option-list>\n</bq-dropdown>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqOpen** - Callback handler to be called when the dropdown panel is opened or closed.\n- **bqOpen** - Callback handler to be called when the dropdown panel is opened or closed.\n\n### **Methods:**\n - **onClickOutside(event: _MouseEvent_)** - Listens for the 'click' event on the document object\nand closes the dropdown panel if the click is outside the component.\n- **onEscape(event: _KeyboardEvent_)** - Listens for the 'keyup' event on the window object\nand closes the dropdown panel if the 'Escape' key or 'Tab' key outside the component is pressed.\n\n### **Slots:**\n - **trigger** - The trigger element that opens the dropdown panel.\n- _default_ - The content of the dropdown panel.\n\n### **CSS Properties:**\n - **--bq-panel--background** - Panel background color _(default: undefined)_\n- **--bq-panel--border-color** - Panel border color _(default: undefined)_\n- **--bq-panel--border-radius** - Panel border radius _(default: undefined)_\n- **--bq-panel--border-style** - Panel border style _(default: undefined)_\n- **--bq-panel--border-width** - Panel border width _(default: undefined)_\n- **--bq-panel--box-shadow** - Panel box shadow _(default: undefined)_\n- **--bq-panel--padding** - Panel padding _(default: undefined)_\n- **--bq-panel--height** - Panel height _(default: undefined)_\n- **--bq-panel--width** - Panel width _(default: undefined)_\n- **--bq-panel-z-index** - Panel z-index applied when opened _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.\n- **dropdown** - The `<bq-panel>` element used under the hood to display the dropdown panel.\n- **panel** - The `<div>` element used to display and style the panel inside the `<bq-panel>` element.\n- **trigger** - The `<div>` element that hosts the trigger element.",
|
|
@@ -809,6 +809,39 @@
|
|
|
809
809
|
],
|
|
810
810
|
"references": []
|
|
811
811
|
},
|
|
812
|
+
{
|
|
813
|
+
"name": "bq-icon",
|
|
814
|
+
"description": "The Icon component is an image that provides a visual representation of an object, action, or concept displayed on the screen.\nIt is a small graphical element that is used to enhance the user interface and improve user experience.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-icon color=\"text--brand\" name=\"bell-ringing\" size=\"24\"></bq-icon>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **svgLoaded** - Callback handler to be called when the SVG has loaded.\n- **svgLoaded** - Callback handler to be called when the SVG has loaded\n\n### **Methods:**\n - **handleWeightChange()** - !TO BE REMOVED: Delete this `@Watch()` once the deprecated `weight` property is removed\nWe need to maintain retro-compatibility until the next major release\n\n### **CSS Properties:**\n - **--bq-icon--color** - The stroke color of the SVG. _(default: undefined)_\n- **--bq-icon--size** - The size of the SVG. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper that holds the icon SVG content.\n- **svg** - The `<svg>` tag element inside the component.",
|
|
815
|
+
"attributes": [
|
|
816
|
+
{
|
|
817
|
+
"name": "color",
|
|
818
|
+
"description": "Set the stroke color of the SVG. The value should be a valid value of the palette color.",
|
|
819
|
+
"values": []
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"name": "label",
|
|
823
|
+
"description": "Label for the icon, used for accessibility.",
|
|
824
|
+
"values": []
|
|
825
|
+
},
|
|
826
|
+
{
|
|
827
|
+
"name": "name",
|
|
828
|
+
"description": "Icon name to load. Please check all available icons [here](https://phosphoricons.com/).",
|
|
829
|
+
"values": []
|
|
830
|
+
},
|
|
831
|
+
{
|
|
832
|
+
"name": "size",
|
|
833
|
+
"description": "Set the size of the SVG.",
|
|
834
|
+
"values": []
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "src",
|
|
838
|
+
"description": "Set the source of the SVG. If the source is set, the name property will be ignored.",
|
|
839
|
+
"values": []
|
|
840
|
+
},
|
|
841
|
+
{ "name": "weight", "values": [{ "name": "TIconWeight" }] }
|
|
842
|
+
],
|
|
843
|
+
"references": []
|
|
844
|
+
},
|
|
812
845
|
{
|
|
813
846
|
"name": "bq-input",
|
|
814
847
|
"description": "The Input component is a fundamental user interface element that allows users to input data by typing it into a text field.\nIt is commonly used in web and mobile applications for various purposes, such as collecting user information, search inputs, and login forms.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-input name=\"username\" label=\"Username\" placeholder=\"Enter your username\"></bq-input>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqBlur** - Callback handler emitted when the input loses focus.\n- **bqChange** - Callback handler emitted when the input value has changed and the input loses focus.\n- **bqClear** - Callback handler emitted when the input value has been cleared.\n- **bqFocus** - Callback handler emitted when the input has received focus.\n- **bqInput** - Callback handler emitted when the input value changes.\n- **bqBlur** - Callback handler emitted when the input loses focus\n- **bqChange** - Callback handler emitted when the input value has changed and the input loses focus.\nThis handler is called whenever the user finishes typing or pasting text into the input field and then clicks outside of the input field.\n- **bqClear** - Callback handler emitted when the input value has been cleared\n- **bqFocus** - Callback handler emitted when the input has received focus\n- **bqInput** - Callback handler emitted when the input value changes.\nThis handler is called whenever the user types or pastes text into the input field.\n\n### **Slots:**\n - **label** - The label slot container.\n- **prefix** - The prefix slot container.\n- **suffix** - The suffix slot container.\n- **helper-text** - The helper text slot container.\n- **clear-icon** - The clear icon slot container.\n\n### **CSS Properties:**\n - **--bq-input--background-color** - Input background color _(default: undefined)_\n- **--bq-input--border-color** - Input border color _(default: undefined)_\n- **--bq-input--border-color-focus** - Input border color on focus _(default: undefined)_\n- **--bq-input--border-radius** - Input border radius _(default: undefined)_\n- **--bq-input--border-width** - Input border width _(default: undefined)_\n- **--bq-input--border-style** - Input border style _(default: undefined)_\n- **--bq-input--gap** - Gap between input content and prefix/suffix _(default: undefined)_\n- **--bq-input--helper-margin-top** - Helper text margin top _(default: undefined)_\n- **--bq-input--helper-text-color** - Helper text color _(default: undefined)_\n- **--bq-input--helper-text-size** - Helper text size _(default: undefined)_\n- **--bq-input--icon-size** - Icon size to use in prefix/suffix and clear button _(default: undefined)_\n- **--bq-input--label-margin-bottom** - Input label margin bottom _(default: undefined)_\n- **--bq-input--label-text-color** - Input label text color _(default: undefined)_\n- **--bq-input--label-text-size** - Input label text size _(default: undefined)_\n- **--bq-input--padding-start** - Input padding start _(default: undefined)_\n- **--bq-input--padding-end** - Input padding end _(default: undefined)_\n- **--bq-input--paddingY** - Input padding top and bottom _(default: undefined)_\n- **--bq-input--text-color** - Input text color _(default: undefined)_\n- **--bq-input--text-size** - Input text size _(default: undefined)_\n- **--bq-input--text-placeholder-color** - Input placeholder text color _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **button** - The native HTML button used under the hood in the clear button.\n- **clear-btn** - The clear button.\n- **control** - The input control wrapper.\n- **helper-text** - The helper text slot container.\n- **label** - The label slot container.\n- **input** - The native HTML input element used under the hood.\n- **prefix** - The prefix slot container.\n- **suffix** - The suffix slot container.",
|
|
@@ -941,39 +974,6 @@
|
|
|
941
974
|
],
|
|
942
975
|
"references": []
|
|
943
976
|
},
|
|
944
|
-
{
|
|
945
|
-
"name": "bq-icon",
|
|
946
|
-
"description": "The Icon component is an image that provides a visual representation of an object, action, or concept displayed on the screen.\nIt is a small graphical element that is used to enhance the user interface and improve user experience.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-icon color=\"text--brand\" name=\"bell-ringing\" size=\"24\"></bq-icon>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **svgLoaded** - Callback handler to be called when the SVG has loaded.\n- **svgLoaded** - Callback handler to be called when the SVG has loaded\n\n### **Methods:**\n - **handleWeightChange()** - !TO BE REMOVED: Delete this `@Watch()` once the deprecated `weight` property is removed\nWe need to maintain retro-compatibility until the next major release\n\n### **CSS Properties:**\n - **--bq-icon--color** - The stroke color of the SVG. _(default: undefined)_\n- **--bq-icon--size** - The size of the SVG. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper that holds the icon SVG content.\n- **svg** - The `<svg>` tag element inside the component.",
|
|
947
|
-
"attributes": [
|
|
948
|
-
{
|
|
949
|
-
"name": "color",
|
|
950
|
-
"description": "Set the stroke color of the SVG. The value should be a valid value of the palette color.",
|
|
951
|
-
"values": []
|
|
952
|
-
},
|
|
953
|
-
{
|
|
954
|
-
"name": "label",
|
|
955
|
-
"description": "Label for the icon, used for accessibility.",
|
|
956
|
-
"values": []
|
|
957
|
-
},
|
|
958
|
-
{
|
|
959
|
-
"name": "name",
|
|
960
|
-
"description": "Icon name to load. Please check all available icons [here](https://phosphoricons.com/).",
|
|
961
|
-
"values": []
|
|
962
|
-
},
|
|
963
|
-
{
|
|
964
|
-
"name": "size",
|
|
965
|
-
"description": "Set the size of the SVG.",
|
|
966
|
-
"values": []
|
|
967
|
-
},
|
|
968
|
-
{
|
|
969
|
-
"name": "src",
|
|
970
|
-
"description": "Set the source of the SVG. If the source is set, the name property will be ignored.",
|
|
971
|
-
"values": []
|
|
972
|
-
},
|
|
973
|
-
{ "name": "weight", "values": [{ "name": "TIconWeight" }] }
|
|
974
|
-
],
|
|
975
|
-
"references": []
|
|
976
|
-
},
|
|
977
977
|
{
|
|
978
978
|
"name": "bq-notification",
|
|
979
979
|
"description": "The Notification component is a user interface element used to provide information or alerts to users in a non-intrusive manner.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-notification border=\"s\" time=\"3000\" type=\"info\">\nTitle\n<span slot=\"body\">\nThis is some description text text\n<a class=\"bq-link\" href=\"https://example.com\">Link</a>\n</span>\n<div class=\"flex gap-xs\" slot=\"footer\">\n<bq-button appearance=\"primary\" size=\"small\">Button</bq-button>\n<bq-button appearance=\"link\" size=\"small\">Button</bq-button>\n</div>\n</bq-notification>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqAfterClose** - Callback handler to be called after the notification has been closed\n- **bqAfterOpen** - Callback handler to be called after the notification has been opened\n- **bqHide** - Callback handler to be called when the notification is hidden\n- **bqShow** - Callback handler to be called when the notification is shown\n- **bqHide** - Callback handler to be called when the notification is hidden\n- **bqShow** - Callback handler to be called when the notification is shown\n- **bqAfterOpen** - Callback handler to be called after the notification has been opened\n- **bqAfterClose** - Callback handler to be called after the notification has been closed\n\n### **Methods:**\n - **hide(): _Promise<void>_** - Method to be called to hide the notification component\n- **show(): _Promise<void>_** - Method to be called to show the notification component\n- **toast()** - This method can be used to display notifications in a fixed-position element that allows for stacking multiple notifications vertically\n\n### **Slots:**\n - _default_ - The notification title content\n- **body** - The notification description content\n- **footer** - The notification footer content\n- **icon** - The icon to be displayed in the notification\n- **btn-close** - The close button of the notification\n\n### **CSS Properties:**\n - **--bq-notification--background** - The notification background color _(default: undefined)_\n- **--bq-notification--box-shadow** - The notification box shadow _(default: undefined)_\n- **--bq-notification--border-color** - The notification border color _(default: undefined)_\n- **--bq-notification--border-radius** - The notification border radius _(default: undefined)_\n- **--bq-notification--border-style** - The notification border style _(default: undefined)_\n- **--bq-notification--border-width** - The notification border width _(default: undefined)_\n- **--bq-notification--content-footer-gap** - The notification content and footer gap _(default: undefined)_\n- **--bq-notification--title-body-gap** - The notification title and body gap _(default: undefined)_\n- **--bq-notification--icon-color-error** - The notification icon color for error type _(default: undefined)_\n- **--bq-notification--icon-color-info** - The notification icon color for info type _(default: undefined)_\n- **--bq-notification--icon-color-neutral** - The notification icon color for neutral type _(default: undefined)_\n- **--bq-notification--icon-color-success** - The notification icon color for success type _(default: undefined)_\n- **--bq-notification--icon-color-warning** - The notification icon color for warning type _(default: undefined)_\n- **--bq-notification--padding** - The notification padding _(default: undefined)_\n- **--bq-notification--min-width** - The notification min width _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The `<div>` container of the predefined bq-icon component.\n- **body** - The container `<div>` that wraps the notification description content\n- **btn-close** - The `bq-button` used to close the notification\n- **content** - The container `<div>` that wraps all the notification content (title, description, footer)\n- **footer** - The container `<div>` that wraps the notification footer content\n- **icon** - The `<bq-icon>` element used to render a predefined icon based on the notification type\n- **icon-outline** - The container `<div>` that wraps the icon element\n- **main** - The container `<div>` that wraps the notification main content (title, description)\n- **svg** - The `<svg>` element of the predefined bq-icon component.\n- **title** - The container `<div>` that wraps the notification title content\n- **wrapper** - The wrapper container `<div>` of the element inside the shadow DOM",
|
|
@@ -1045,12 +1045,6 @@
|
|
|
1045
1045
|
"attributes": [],
|
|
1046
1046
|
"references": []
|
|
1047
1047
|
},
|
|
1048
|
-
{
|
|
1049
|
-
"name": "bq-page-title",
|
|
1050
|
-
"description": "The Page Title component is a versatile and essential element used to display the main title of a page or section within an application.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-page-title>\n<bq-button appearance=\"link\" slot=\"back\">\n<bq-icon\ncolor=\"text--primary\"\nname=\"arrow-left\"\nweight=\"bold\"\nrole=\"img\"\ntitle=\"Navigate back to the previous page\"\n></bq-icon>\n</bq-button>\nTitle\n<div slot=\"sub-title\">Sub-title</div>\n</bq-page-title>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - **back** - The back navigation button.\n- _default_ - The main title content.\n- **sub-title** - The sub-title content.\n- **suffix** - The suffix content.\n\n### **CSS Properties:**\n - **--paddingY** - Padding top and bottom of the page title wrapper _(default: undefined)_\n- **--subtitle-borderBlockEnd** - Page title border end color _(default: undefined)_\n- **--subtitle-fontWeight** - Page title font weight for subtitle _(default: undefined)_\n- **--subtitle-textColor** - Page title color for sub-title _(default: undefined)_\n- **--subtitle-textSize** - Page title text size for subtitle _(default: undefined)_\n- **--title-fontWeight** - Page title font weight for title _(default: undefined)_\n- **--title-lineHeight** - Page title text line height _(default: undefined)_\n- **--title-textColor** - Page title color for title _(default: undefined)_\n- **--title-textSize** - Page title text size for title _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The inner container `<div>`of element that contains the base page title component.\n- **content** - Defines the main container of the page title component, which includes the title and subtitle elements.\n- **title-suffix** - Defines the container that holds the title and any suffix content.\n- **back** - The container `<div>` page title element that acts as back slot container.\n- **title** - The `<h1>` element serves as a container for the page title content, to improve accessibility.\n- **suffix** - The `<div>` page title element that acts as suffix slot container.\n- **sub-title** - The `<div>` page title element that acts as sub-title slot container.",
|
|
1051
|
-
"attributes": [],
|
|
1052
|
-
"references": []
|
|
1053
|
-
},
|
|
1054
1048
|
{
|
|
1055
1049
|
"name": "bq-option-list",
|
|
1056
1050
|
"description": "The option list component is a container for multiple option elements.\nIt allows to manage the appearance and size of all options at once.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-option-list>\n<bq-option value=\"football\">Football</bq-option>\n<bq-option value=\"basketball\">Basketball</bq-option>\n<bq-option value=\"tennis\">Tennis</bq-option>\n</bq-option-list>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqSelect** - Handler to be called when `bq-option` is selected (on click/enter press).\n\n### **Slots:**\n - _default_ - The option items\n\n### **CSS Properties:**\n - **--bq-option-group--gapY-list** - Option group gap between items Y axis _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.",
|
|
@@ -1063,6 +1057,12 @@
|
|
|
1063
1057
|
],
|
|
1064
1058
|
"references": []
|
|
1065
1059
|
},
|
|
1060
|
+
{
|
|
1061
|
+
"name": "bq-page-title",
|
|
1062
|
+
"description": "The Page Title component is a versatile and essential element used to display the main title of a page or section within an application.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-page-title>\n<bq-button appearance=\"link\" slot=\"back\">\n<bq-icon\ncolor=\"text--primary\"\nname=\"arrow-left\"\nweight=\"bold\"\nrole=\"img\"\ntitle=\"Navigate back to the previous page\"\n></bq-icon>\n</bq-button>\nTitle\n<div slot=\"sub-title\">Sub-title</div>\n</bq-page-title>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - **back** - The back navigation button.\n- _default_ - The main title content.\n- **sub-title** - The sub-title content.\n- **suffix** - The suffix content.\n\n### **CSS Properties:**\n - **--paddingY** - Padding top and bottom of the page title wrapper _(default: undefined)_\n- **--subtitle-borderBlockEnd** - Page title border end color _(default: undefined)_\n- **--subtitle-fontWeight** - Page title font weight for subtitle _(default: undefined)_\n- **--subtitle-textColor** - Page title color for sub-title _(default: undefined)_\n- **--subtitle-textSize** - Page title text size for subtitle _(default: undefined)_\n- **--title-fontWeight** - Page title font weight for title _(default: undefined)_\n- **--title-lineHeight** - Page title text line height _(default: undefined)_\n- **--title-textColor** - Page title color for title _(default: undefined)_\n- **--title-textSize** - Page title text size for title _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The inner container `<div>`of element that contains the base page title component.\n- **content** - Defines the main container of the page title component, which includes the title and subtitle elements.\n- **title-suffix** - Defines the container that holds the title and any suffix content.\n- **back** - The container `<div>` page title element that acts as back slot container.\n- **title** - The `<h1>` element serves as a container for the page title content, to improve accessibility.\n- **suffix** - The `<div>` page title element that acts as suffix slot container.\n- **sub-title** - The `<div>` page title element that acts as sub-title slot container.",
|
|
1063
|
+
"attributes": [],
|
|
1064
|
+
"references": []
|
|
1065
|
+
},
|
|
1066
1066
|
{
|
|
1067
1067
|
"name": "bq-panel",
|
|
1068
1068
|
"description": "The Panel component is a versatile and essential element used to wrap and display content in a floating panel.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-panel open>\n<div>Panel content</div>\n</bq-panel>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The content of the panel.\n\n### **CSS Parts:**\n - **panel** - The `<div>` element used to display and style the panel",
|
|
@@ -1253,6 +1253,32 @@
|
|
|
1253
1253
|
],
|
|
1254
1254
|
"references": []
|
|
1255
1255
|
},
|
|
1256
|
+
{
|
|
1257
|
+
"name": "bq-side-menu",
|
|
1258
|
+
"description": "The default side menu serves as a versatile container for organizing and displaying navigation elements,\n with default side menu items providing a clean and straightforward way to represent individual menu options.\n Together, they form the foundation for building structured and intuitive side menu layouts.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-side-menu>\n<div slot=\"logo\">\n<h1>Your Logo</h1>\n</div>\n<bq-side-menu-item active>\n<bq-icon name=\"home\" slot=\"prefix\"></bq-icon>\nHome\n</bq-side-menu-item>\n<bq-side-menu-item>\n<bq-icon name=\"settings\" slot=\"prefix\"></bq-icon>\nSettings\n</bq-side-menu-item>\n<bq-side-menu-item disabled>\n<bq-icon name=\"help\" slot=\"prefix\"></bq-icon>\nHelp\n</bq-side-menu-item>\n</bq-side-menu>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqCollapse** - Callback handler to be called when the Side menu changes its width from expanded to collapse and vice versa.\n- **bqSelect** - Callback handler to be called when the active/selected menu item changes.\n- **bqCollapse** - Callback handler to be called when the Side menu changes its width from expanded to collapse and vice versa\n- **bqSelect** - Callback handler to be called when the active/selected menu item changes\n\n### **Methods:**\n - **toggleCollapse()** - Toggle the collapse state of the side menu\n\n### **Slots:**\n - **logo** - The section for displaying the logo or brand in the side menu.\n- **The** - main section that holds all menu items.\n- **footer** - The section for adding footer content to the side menu.\n\n### **CSS Properties:**\n - **--bq-side-menu--bg-color** - Side menu background color _(default: undefined)_\n- **--bq-side-menu--brand-color** - Side menu logo color _(default: undefined)_\n- **--bq-side-menu--border-color** - Side menu border color _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - HTML `<aside>` root container\n- **footer** - HTML `<div>` element that holds the footer\n- **logo** - HTML `<div>` element that holds the logo\n- **nav** - HTML `<nav>` element that holds the navigation items",
|
|
1259
|
+
"attributes": [
|
|
1260
|
+
{
|
|
1261
|
+
"name": "appearance",
|
|
1262
|
+
"description": "It sets a predefined appearance of the side menu.",
|
|
1263
|
+
"values": [
|
|
1264
|
+
{ "name": "brand" },
|
|
1265
|
+
{ "name": "default" },
|
|
1266
|
+
{ "name": "inverse" }
|
|
1267
|
+
]
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"name": "collapse",
|
|
1271
|
+
"description": "If `true`, the container will reduce its width.",
|
|
1272
|
+
"values": []
|
|
1273
|
+
},
|
|
1274
|
+
{
|
|
1275
|
+
"description": "size - It sets the size of the navigation menu items.",
|
|
1276
|
+
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1277
|
+
},
|
|
1278
|
+
{ "name": "size", "values": [{ "name": "TSideMenuSize" }] }
|
|
1279
|
+
],
|
|
1280
|
+
"references": []
|
|
1281
|
+
},
|
|
1256
1282
|
{
|
|
1257
1283
|
"name": "bq-select",
|
|
1258
1284
|
"description": "The select input component lets users choose from a predefined list, commonly used in forms for easy data selection.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-select placeholder=\"Placeholder\">\n<label slot=\"label\">Select label</label>\n<span slot=\"helper-text\">\n<bq-icon name=\"star\"></bq-icon>\nHelper text\n</span>\n\n<bq-option value=\"1\">Option 1</bq-option>\n<bq-option value=\"2\">Option 2</bq-option>\n<bq-option value=\"3\">Option 3</bq-option>\n</bq-select>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqBlur** - The callback handler is emitted when the Select input loses focus.\n- **bqClear** - The callback handler is emitted when the selected value has been cleared.\n- **bqFocus** - A callback handler is emitted when the Select input has received focus.\n- **bqSelect** - The callback handler is emitted when the selected value has changed.\n- **bqBlur** - Callback handler emitted when the Select input loses focus\n- **bqClear** - Callback handler emitted when the selected value has been cleared\n- **bqFocus** - Callback handler emitted when the Select input has received focus\n- **bqSelect** - Callback handler emitted when the selected value has changed\n\n### **Methods:**\n - **clear(): _Promise<void>_** - Clears the selected value.\n\n### **Slots:**\n - **label** - The label slot container.\n- **prefix** - The prefix slot container.\n- **tags** - The tags slot container.\n- **clear-icon** - The clear icon slot container.\n- **suffix** - The suffix slot container.\n- **helper-text** - The helper text slot container.\n\n### **CSS Properties:**\n - **--bq-select--background-color** - Select background color _(default: undefined)_\n- **--bq-select--border-color** - Select border color _(default: undefined)_\n- **--bq-select--border-color-focus** - Select border color on focus _(default: undefined)_\n- **--bq-select--border-color-disabled** - Select border color when disabled _(default: undefined)_\n- **--bq-select--border-radius** - Select border radius _(default: undefined)_\n- **--bq-select--border-width** - Select border width _(default: undefined)_\n- **--bq-select--border-style** - Select border style _(default: undefined)_\n- **--bq-select--gap** - Gap between Select content and prefix/suffix _(default: undefined)_\n- **--bq-select--helper-margin-top** - Helper text margin top _(default: undefined)_\n- **--bq-select--helper-text-color** - Helper text color _(default: undefined)_\n- **--bq-select--helper-text-size** - Helper text size _(default: undefined)_\n- **--bq-select--icon-size** - Icon size to use in prefix/suffix and clear button _(default: undefined)_\n- **--bq-select--label-margin-bottom** - Select label margin bottom _(default: undefined)_\n- **--bq-select--label-text-color** - Select label text color _(default: undefined)_\n- **--bq-select--label-text-size** - Select label text size _(default: undefined)_\n- **--bq-select--padding-start** - Select padding start _(default: undefined)_\n- **--bq-select--padding-end** - Select padding end _(default: undefined)_\n- **--bq-select--paddingY** - Select padding top and bottom _(default: undefined)_\n- **--bq-select--text-color** - Select text color _(default: undefined)_\n- **--bq-select--text-size** - Select text size _(default: undefined)_\n- **--bq-select--text-placeholder-color** - Select placeholder text color _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **button** - The native HTML button used under the hood in the clear button.\n- **clear-btn** - The clear button.\n- **control** - The input control wrapper.\n- **input-outline** - The input outline wrapper that holds the tags container and the native HTML input used under the hood.\n- **helper-text** - The helper text slot container.\n- **input** - The native HTML input element used under the hood.\n- **label** - The label slot container.\n- **panel** - The select panel container\n- **prefix** - The prefix slot container.\n- **suffix** - The suffix slot container.\n- **tags** - The tags container of the BqTags for multiple selection.\n- **tag** - The tag container of the BqTag for multiple selection.\n- **tag__base** - The base wrapper of the BqTag for multiple selection.\n- **tag__prefix** - The prefix slot container of the BqTag for multiple selection.\n- **tag__text** - The text slot container of the BqTag for multiple selection.\n- **tag__btn-close** - The close button of the BqTag for multiple selection.\n- **option-list** - The option list container.",
|
|
@@ -1392,32 +1418,6 @@
|
|
|
1392
1418
|
],
|
|
1393
1419
|
"references": []
|
|
1394
1420
|
},
|
|
1395
|
-
{
|
|
1396
|
-
"name": "bq-side-menu",
|
|
1397
|
-
"description": "The default side menu serves as a versatile container for organizing and displaying navigation elements,\n with default side menu items providing a clean and straightforward way to represent individual menu options.\n Together, they form the foundation for building structured and intuitive side menu layouts.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-side-menu>\n<div slot=\"logo\">\n<h1>Your Logo</h1>\n</div>\n<bq-side-menu-item active>\n<bq-icon name=\"home\" slot=\"prefix\"></bq-icon>\nHome\n</bq-side-menu-item>\n<bq-side-menu-item>\n<bq-icon name=\"settings\" slot=\"prefix\"></bq-icon>\nSettings\n</bq-side-menu-item>\n<bq-side-menu-item disabled>\n<bq-icon name=\"help\" slot=\"prefix\"></bq-icon>\nHelp\n</bq-side-menu-item>\n</bq-side-menu>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqCollapse** - Callback handler to be called when the Side menu changes its width from expanded to collapse and vice versa.\n- **bqSelect** - Callback handler to be called when the active/selected menu item changes.\n- **bqCollapse** - Callback handler to be called when the Side menu changes its width from expanded to collapse and vice versa\n- **bqSelect** - Callback handler to be called when the active/selected menu item changes\n\n### **Methods:**\n - **toggleCollapse()** - Toggle the collapse state of the side menu\n\n### **Slots:**\n - **logo** - The section for displaying the logo or brand in the side menu.\n- **The** - main section that holds all menu items.\n- **footer** - The section for adding footer content to the side menu.\n\n### **CSS Properties:**\n - **--bq-side-menu--bg-color** - Side menu background color _(default: undefined)_\n- **--bq-side-menu--brand-color** - Side menu logo color _(default: undefined)_\n- **--bq-side-menu--border-color** - Side menu border color _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - HTML `<aside>` root container\n- **footer** - HTML `<div>` element that holds the footer\n- **logo** - HTML `<div>` element that holds the logo\n- **nav** - HTML `<nav>` element that holds the navigation items",
|
|
1398
|
-
"attributes": [
|
|
1399
|
-
{
|
|
1400
|
-
"name": "appearance",
|
|
1401
|
-
"description": "It sets a predefined appearance of the side menu.",
|
|
1402
|
-
"values": [
|
|
1403
|
-
{ "name": "brand" },
|
|
1404
|
-
{ "name": "default" },
|
|
1405
|
-
{ "name": "inverse" }
|
|
1406
|
-
]
|
|
1407
|
-
},
|
|
1408
|
-
{
|
|
1409
|
-
"name": "collapse",
|
|
1410
|
-
"description": "If `true`, the container will reduce its width.",
|
|
1411
|
-
"values": []
|
|
1412
|
-
},
|
|
1413
|
-
{
|
|
1414
|
-
"description": "size - It sets the size of the navigation menu items.",
|
|
1415
|
-
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1416
|
-
},
|
|
1417
|
-
{ "name": "size", "values": [{ "name": "TSideMenuSize" }] }
|
|
1418
|
-
],
|
|
1419
|
-
"references": []
|
|
1420
|
-
},
|
|
1421
1421
|
{
|
|
1422
1422
|
"name": "bq-side-menu-item",
|
|
1423
1423
|
"description": "Represents the default side menu item for standard navigation elements, providing a clean and straightforward way to display menu options.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-side-menu-item>\n<bq-icon name=\"star-four\" slot=\"prefix\"></bq-icon>\nMenu item\n<bq-badge slot=\"suffix\">5</bq-badge>\n</bq-side-menu-item>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqBlur** - Handler to be called when the button loses focus.\n- **bqClick** - Handler to be called when the button gets focused.\n- **bqFocus** - Handler to be called when the button is clicked.\n- **bqBlur** - Handler to be called when the button loses focus\n- **bqFocus** - Handler to be called when the button is clicked\n- **bqClick** - Handler to be called when button gets focus\n\n### **Slots:**\n - **prefix** - The prefix part of menu item.\n- _default_ - The content of the menu item.\n- **suffix** - The suffix part of menu item.\n\n### **CSS Properties:**\n - **--bq-side-menu-item--bg-default** - Side menu item default background color _(default: undefined)_\n- **--bq-side-menu-item--bg-hover** - Side menu item hover background color _(default: undefined)_\n- **--bq-side-menu-item--bg-active** - Side menu item active background color _(default: undefined)_\n- **--bq-side-menu-item--text-default** - Side menu item default text color _(default: undefined)_\n- **--bq-side-menu-item--text-hover** - Side menu item hover text color _(default: undefined)_\n- **--bq-side-menu-item--text-active** - Side menu item active text color _(default: undefined)_\n- **--bq-side-menu-item--text-disabled** - Side menu item disable text color _(default: undefined)_\n- **--bq-side-menu-item--paddingX** - Side menu item vertical padding _(default: undefined)_\n- **--bq-side-menu-item--paddingY** - Side menu item horizontal padding _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component wrapper container inside the shadow DOM\n- **label** - The label slot\n- **prefix** - The prefix slot\n- **suffix** - The suffix slot\n- **panel** - The `<div>` container that holds the tooltip content (when the side menu is collapsed)\n- **trigger** - The `<div>` container that holds the element which displays tooltip on hover (when the side menu is collapsed)",
|
|
@@ -1540,26 +1540,18 @@
|
|
|
1540
1540
|
"references": []
|
|
1541
1541
|
},
|
|
1542
1542
|
{
|
|
1543
|
-
"name": "bq-
|
|
1544
|
-
"description": "The
|
|
1543
|
+
"name": "bq-status",
|
|
1544
|
+
"description": "The Status Component is a UI element that represents the current state or condition of an item, task, or process.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-status type=\"alert\">Alert status</bq-status>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - **The** - content of the status component.\n\n### **CSS Properties:**\n - **--bq-status-circ** - Status circle size. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper of the status component.\n- **circle** - The colored circle that marks the status type.\n- **text** - The `<div>` container that holds the text label of the status component.",
|
|
1545
1545
|
"attributes": [
|
|
1546
|
-
{
|
|
1547
|
-
"name": "divider-color",
|
|
1548
|
-
"description": "The color of the line that connects the steps. It should be a valid declarative color token.",
|
|
1549
|
-
"values": []
|
|
1550
|
-
},
|
|
1551
|
-
{
|
|
1552
|
-
"name": "size",
|
|
1553
|
-
"description": "The size of the steps",
|
|
1554
|
-
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1555
|
-
},
|
|
1556
1546
|
{
|
|
1557
1547
|
"name": "type",
|
|
1558
|
-
"description": "
|
|
1548
|
+
"description": "It defines the type of status to display.",
|
|
1559
1549
|
"values": [
|
|
1560
|
-
{ "name": "
|
|
1561
|
-
{ "name": "
|
|
1562
|
-
{ "name": "
|
|
1550
|
+
{ "name": "alert" },
|
|
1551
|
+
{ "name": "danger" },
|
|
1552
|
+
{ "name": "info" },
|
|
1553
|
+
{ "name": "neutral" },
|
|
1554
|
+
{ "name": "success" }
|
|
1563
1555
|
]
|
|
1564
1556
|
}
|
|
1565
1557
|
],
|
|
@@ -1598,18 +1590,26 @@
|
|
|
1598
1590
|
"references": []
|
|
1599
1591
|
},
|
|
1600
1592
|
{
|
|
1601
|
-
"name": "bq-
|
|
1602
|
-
"description": "The
|
|
1593
|
+
"name": "bq-steps",
|
|
1594
|
+
"description": "The Steps Component is a UI element used to display a series of steps or stages in a process or task.\nIt is used to guide users through a process or task and to indicate their progress.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-steps divider-color=\"stroke--primary\" type=\"dot\" size=\"medium\">\n<bq-step-item status=\"completed\"> ... </bq-step-item>\n<bq-step-item status=\"error\"> ... </bq-step-item>\n<bq-step-item status=\"current\"> ... </bq-step-item>\n<bq-step-item status=\"default\"> ... </bq-step-item>\n</bq-steps>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The step items\n\n### **CSS Properties:**\n - **--bq-steps--divider-color** - Divider color _(default: undefined)_\n- **--bq-steps--gap** - Gap between steps _(default: undefined)_\n\n### **CSS Parts:**\n - **container** - The container wrapper of the Steps component\n- **divider-base** - The base wrapper of the divider component\n- **divider-dash-start** - The dash start wrapper of the divider component\n- **divider-dash-end** - The dash end wrapper of the divider component",
|
|
1603
1595
|
"attributes": [
|
|
1596
|
+
{
|
|
1597
|
+
"name": "divider-color",
|
|
1598
|
+
"description": "The color of the line that connects the steps. It should be a valid declarative color token.",
|
|
1599
|
+
"values": []
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"name": "size",
|
|
1603
|
+
"description": "The size of the steps",
|
|
1604
|
+
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1605
|
+
},
|
|
1604
1606
|
{
|
|
1605
1607
|
"name": "type",
|
|
1606
|
-
"description": "
|
|
1608
|
+
"description": "The type of prefix element to use on the step items",
|
|
1607
1609
|
"values": [
|
|
1608
|
-
{ "name": "
|
|
1609
|
-
{ "name": "
|
|
1610
|
-
{ "name": "
|
|
1611
|
-
{ "name": "neutral" },
|
|
1612
|
-
{ "name": "success" }
|
|
1610
|
+
{ "name": "numeric" },
|
|
1611
|
+
{ "name": "icon" },
|
|
1612
|
+
{ "name": "dot" }
|
|
1613
1613
|
]
|
|
1614
1614
|
}
|
|
1615
1615
|
],
|