@beeq/core 1.8.0-beta.16 → 1.8.0-beta.17
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/index.esm.js +1 -1
- package/dist/beeq/index.esm.js.map +1 -1
- package/dist/beeq/p-01de6133.js +6 -0
- package/dist/beeq/p-01de6133.js.map +1 -0
- package/dist/beeq/p-07b82e50.js +6 -0
- package/dist/beeq/p-07b82e50.js.map +1 -0
- package/dist/beeq/p-19c94c6d.entry.js +6 -0
- package/dist/beeq/{p-c65d21e2.entry.js.map → p-19c94c6d.entry.js.map} +1 -1
- package/dist/beeq/p-2eab5223.entry.js +6 -0
- package/dist/beeq/p-2eab5223.entry.js.map +1 -0
- package/dist/beeq/p-36b653f6.entry.js +6 -0
- package/dist/beeq/p-36b653f6.entry.js.map +1 -0
- package/dist/beeq/{p-e68dcd3d.entry.js → p-3b4c9ea2.entry.js} +2 -2
- package/dist/{collection/global/scripts/global.js → beeq/p-45800965.js} +2 -2
- package/dist/beeq/p-45800965.js.map +1 -0
- package/dist/beeq/{p-7a719a9b.entry.js → p-4c3b0cc9.entry.js} +2 -2
- package/dist/beeq/{p-56c43424.entry.js → p-4d1619a8.entry.js} +2 -2
- package/dist/beeq/{p-3fd0d92d.js → p-55b0aea8.js} +2 -2
- package/dist/beeq/p-55b0aea8.js.map +1 -0
- package/dist/beeq/{p-6a0b0106.entry.js → p-5c7a719c.entry.js} +2 -2
- package/dist/beeq/{p-a5e01629.entry.js.map → p-5c7a719c.entry.js.map} +1 -1
- package/dist/beeq/p-7636aff3.entry.js +6 -0
- package/dist/beeq/{p-8ca2588f.entry.js.map → p-7636aff3.entry.js.map} +1 -1
- package/dist/beeq/p-a7fb6ffd.entry.js +6 -0
- package/dist/beeq/p-a7fb6ffd.entry.js.map +1 -0
- package/dist/beeq/p-c3a0bd23.js +6 -0
- package/dist/beeq/p-c3a0bd23.js.map +1 -0
- package/dist/beeq/{p-8ca2588f.entry.js → p-c786dd5e.entry.js} +2 -2
- package/dist/beeq/p-c786dd5e.entry.js.map +1 -0
- package/dist/beeq/p-cf523684.entry.js +6 -0
- package/dist/beeq/{p-09323635.entry.js.map → p-cf523684.entry.js.map} +1 -1
- package/dist/beeq/p-f0ba3429.entry.js +6 -0
- package/dist/beeq/p-f0ba3429.entry.js.map +1 -0
- package/dist/beeq.html-custom-data.json +313 -313
- package/dist/cjs/app-globals-42eaedec.js +11 -0
- package/dist/cjs/app-globals-42eaedec.js.map +1 -0
- package/dist/cjs/{assetsPath-0ec85a1a.js → assetsPath-5e03c40e.js} +5 -4
- package/dist/cjs/assetsPath-5e03c40e.js.map +1 -0
- package/dist/cjs/beeq.cjs.js +1 -1
- package/dist/cjs/bq-badge.cjs.entry.js +2 -1
- package/dist/cjs/bq-badge.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-button_2.cjs.entry.js +6 -5
- package/dist/cjs/bq-button_2.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-date-picker.cjs.entry.js +10 -4
- package/dist/cjs/bq-date-picker.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-divider.cjs.entry.js +2 -1
- package/dist/cjs/bq-divider.cjs.entry.js.map +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 +10 -5
- package/dist/cjs/bq-notification.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-option-list_2.cjs.entry.js +3 -2
- package/dist/cjs/bq-option-list_2.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-select.cjs.entry.js +1 -1
- package/dist/cjs/bq-side-menu.cjs.entry.js +5 -2
- package/dist/cjs/bq-side-menu.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-spinner.cjs.entry.js +2 -1
- package/dist/cjs/bq-spinner.cjs.entry.js.map +1 -1
- package/dist/cjs/bq-toast.cjs.entry.js +8 -3
- package/dist/cjs/bq-toast.cjs.entry.js.map +1 -1
- package/dist/cjs/{app-globals-b11284b9.js → cally-9297cdd8.js} +5 -6
- package/dist/cjs/cally-9297cdd8.js.map +1 -0
- package/dist/cjs/{cssVariables-dd190bc2.js → cssVariables-55ad4942.js} +4 -2
- package/dist/cjs/cssVariables-55ad4942.js.map +1 -0
- package/dist/cjs/index.cjs.js +4 -2
- package/dist/cjs/index.cjs.js.map +1 -1
- package/dist/cjs/isClient-c22372aa.js +17 -0
- package/dist/cjs/isClient-c22372aa.js.map +1 -0
- package/dist/cjs/loader.cjs.js +1 -1
- package/dist/collection/collection-manifest.json +1 -2
- package/dist/collection/components/button/bq-button.js +4 -4
- package/dist/collection/components/button/bq-button.js.map +1 -1
- package/dist/collection/components/date-picker/bq-date-picker.js +9 -4
- package/dist/collection/components/date-picker/bq-date-picker.js.map +1 -1
- package/dist/collection/components/date-picker/scss/bq-date-picker.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/bq-notification.js +9 -5
- package/dist/collection/components/notification/bq-notification.js.map +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/collection/components/side-menu/bq-side-menu.js +5 -3
- package/dist/collection/components/side-menu/bq-side-menu.js.map +1 -1
- package/dist/collection/components/tag/scss/bq-tag.css +1 -1
- package/dist/collection/components/toast/bq-toast.js +8 -4
- package/dist/collection/components/toast/bq-toast.js.map +1 -1
- package/dist/collection/shared/utils/assetsPath.js +4 -3
- package/dist/collection/shared/utils/assetsPath.js.map +1 -1
- package/dist/collection/shared/utils/cssVariables.js +2 -1
- package/dist/collection/shared/utils/cssVariables.js.map +1 -1
- package/dist/collection/shared/utils/index.js +1 -0
- package/dist/collection/shared/utils/index.js.map +1 -1
- package/dist/collection/shared/utils/isClient.js +12 -0
- package/dist/collection/shared/utils/isClient.js.map +1 -0
- package/dist/components/bq-accordion.js +1 -1
- package/dist/components/bq-alert.js +1 -1
- package/dist/components/bq-badge.js +1 -1
- package/dist/components/bq-button.js +1 -1
- package/dist/components/bq-date-picker.js +1 -1
- package/dist/components/bq-date-picker.js.map +1 -1
- package/dist/components/bq-dialog.js +1 -1
- package/dist/components/bq-divider.js +1 -1
- package/dist/components/bq-drawer.js +1 -1
- package/dist/components/bq-empty-state.js +1 -1
- package/dist/components/bq-icon.js +1 -1
- package/dist/components/bq-input.js +1 -1
- package/dist/components/bq-notification.js +1 -1
- package/dist/components/bq-notification.js.map +1 -1
- package/dist/components/bq-select.js +1 -1
- package/dist/components/bq-side-menu.js +1 -1
- package/dist/components/bq-side-menu.js.map +1 -1
- package/dist/components/bq-spinner.js +1 -1
- package/dist/components/bq-status.js +1 -1
- package/dist/components/bq-steps.js +1 -1
- package/dist/components/bq-switch.js +1 -1
- package/dist/components/bq-tag.js +1 -1
- package/dist/components/bq-toast.js +1 -1
- package/dist/components/bq-toast.js.map +1 -1
- package/dist/components/index.js +1 -1
- package/dist/components/index.js.map +1 -1
- package/dist/components/p-07b82e50.js +6 -0
- package/dist/components/p-07b82e50.js.map +1 -0
- package/dist/components/{p-fe0b66e5.js → p-1566efe3.js} +2 -2
- package/dist/{beeq/p-5d6fc48a.entry.js → components/p-28da2321.js} +2 -2
- package/dist/components/p-28da2321.js.map +1 -0
- package/dist/components/p-55b0aea8.js +6 -0
- package/dist/components/p-55b0aea8.js.map +1 -0
- package/dist/components/{p-9f037c57.js → p-603c898d.js} +2 -2
- package/dist/components/{p-f5cd1f38.js → p-7d7f1f7e.js} +2 -2
- package/dist/components/p-c3a0bd23.js +6 -0
- package/dist/components/p-c3a0bd23.js.map +1 -0
- package/dist/components/p-d62fdbae.js +6 -0
- package/dist/components/p-d62fdbae.js.map +1 -0
- package/dist/custom-elements.json +6919 -6919
- package/dist/esm/app-globals-7655df21.js +9 -0
- package/dist/esm/app-globals-7655df21.js.map +1 -0
- package/dist/esm/{assetsPath-6c498eae.js → assetsPath-eed21007.js} +5 -4
- package/dist/esm/assetsPath-eed21007.js.map +1 -0
- package/dist/esm/beeq.js +1 -1
- package/dist/esm/bq-badge.entry.js +2 -1
- package/dist/esm/bq-badge.entry.js.map +1 -1
- package/dist/esm/bq-button_2.entry.js +6 -5
- package/dist/esm/bq-button_2.entry.js.map +1 -1
- package/dist/esm/bq-date-picker.entry.js +10 -4
- package/dist/esm/bq-date-picker.entry.js.map +1 -1
- package/dist/esm/bq-divider.entry.js +2 -1
- package/dist/esm/bq-divider.entry.js.map +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 +10 -5
- package/dist/esm/bq-notification.entry.js.map +1 -1
- package/dist/esm/bq-option-list_2.entry.js +3 -2
- package/dist/esm/bq-option-list_2.entry.js.map +1 -1
- package/dist/esm/bq-select.entry.js +1 -1
- package/dist/esm/bq-side-menu.entry.js +5 -2
- package/dist/esm/bq-side-menu.entry.js.map +1 -1
- package/dist/esm/bq-spinner.entry.js +2 -1
- package/dist/esm/bq-spinner.entry.js.map +1 -1
- package/dist/esm/bq-toast.entry.js +8 -3
- package/dist/esm/bq-toast.entry.js.map +1 -1
- package/dist/esm/{app-globals-de5a646b.js → cally-1a3258d6.js} +2 -6
- package/dist/esm/cally-1a3258d6.js.map +1 -0
- package/dist/esm/{cssVariables-000c23ad.js → cssVariables-3665b51c.js} +4 -2
- package/dist/esm/cssVariables-3665b51c.js.map +1 -0
- package/dist/esm/index.js +3 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/isClient-c6eae7ba.js +15 -0
- package/dist/esm/isClient-c6eae7ba.js.map +1 -0
- package/dist/esm/loader.js +1 -1
- package/dist/hydrate/index.js +3656 -3625
- package/dist/hydrate/index.mjs +3656 -3625
- package/dist/stencil.config.js +0 -2
- package/dist/stencil.config.js.map +1 -1
- package/dist/types/components/date-picker/bq-date-picker.d.ts +1 -0
- package/dist/types/shared/utils/index.d.ts +1 -0
- package/dist/types/shared/utils/isClient.d.ts +5 -0
- package/package.json +1 -1
- package/dist/beeq/p-09323635.entry.js +0 -6
- package/dist/beeq/p-3fd0d92d.js.map +0 -1
- package/dist/beeq/p-52603411.entry.js +0 -6
- package/dist/beeq/p-52603411.entry.js.map +0 -1
- package/dist/beeq/p-5d6fc48a.entry.js.map +0 -1
- package/dist/beeq/p-6a0b0106.entry.js.map +0 -1
- package/dist/beeq/p-99b5d671.entry.js +0 -6
- package/dist/beeq/p-99b5d671.entry.js.map +0 -1
- package/dist/beeq/p-a5e01629.entry.js +0 -6
- package/dist/beeq/p-adec3d5b.entry.js +0 -6
- package/dist/beeq/p-adec3d5b.entry.js.map +0 -1
- package/dist/beeq/p-c65d21e2.entry.js +0 -6
- package/dist/beeq/p-c9ed66d9.js +0 -6
- package/dist/beeq/p-c9ed66d9.js.map +0 -1
- package/dist/beeq/p-edfd9767.js +0 -6
- package/dist/beeq/p-edfd9767.js.map +0 -1
- package/dist/cjs/app-globals-b11284b9.js.map +0 -1
- package/dist/cjs/assetsPath-0ec85a1a.js.map +0 -1
- package/dist/cjs/cssVariables-dd190bc2.js.map +0 -1
- package/dist/collection/global/scripts/global.js.map +0 -1
- package/dist/components/p-295b174b.js +0 -6
- package/dist/components/p-295b174b.js.map +0 -1
- package/dist/components/p-cbfc423f.js +0 -6
- package/dist/components/p-cbfc423f.js.map +0 -1
- package/dist/components/p-edfd9767.js +0 -6
- package/dist/components/p-edfd9767.js.map +0 -1
- package/dist/esm/app-globals-de5a646b.js.map +0 -1
- package/dist/esm/assetsPath-6c498eae.js.map +0 -1
- package/dist/esm/cssVariables-000c23ad.js.map +0 -1
- package/dist/types/global/scripts/global.d.ts +0 -1
- /package/dist/beeq/{p-e68dcd3d.entry.js.map → p-3b4c9ea2.entry.js.map} +0 -0
- /package/dist/beeq/{p-7a719a9b.entry.js.map → p-4c3b0cc9.entry.js.map} +0 -0
- /package/dist/beeq/{p-56c43424.entry.js.map → p-4d1619a8.entry.js.map} +0 -0
- /package/dist/components/{p-fe0b66e5.js.map → p-1566efe3.js.map} +0 -0
- /package/dist/components/{p-9f037c57.js.map → p-603c898d.js.map} +0 -0
- /package/dist/components/{p-f5cd1f38.js.map → p-7d7f1f7e.js.map} +0 -0
|
@@ -34,6 +34,43 @@
|
|
|
34
34
|
],
|
|
35
35
|
"references": []
|
|
36
36
|
},
|
|
37
|
+
{
|
|
38
|
+
"name": "bq-accordion",
|
|
39
|
+
"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",
|
|
40
|
+
"attributes": [
|
|
41
|
+
{
|
|
42
|
+
"name": "appearance",
|
|
43
|
+
"description": "The appearance style of the Accordion",
|
|
44
|
+
"values": [{ "name": "filled" }, { "name": "ghost" }]
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "disabled",
|
|
48
|
+
"description": "If true, the Accordion is disabled",
|
|
49
|
+
"values": []
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"name": "expanded",
|
|
53
|
+
"description": "If true, the Accordion is expanded",
|
|
54
|
+
"values": []
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "no-animation",
|
|
58
|
+
"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.",
|
|
59
|
+
"values": []
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"name": "rotate",
|
|
63
|
+
"description": "If true, the Accordion expand icon is rotate 180deg when expanded",
|
|
64
|
+
"values": []
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "size",
|
|
68
|
+
"description": "The size of the the Accordion",
|
|
69
|
+
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
70
|
+
}
|
|
71
|
+
],
|
|
72
|
+
"references": []
|
|
73
|
+
},
|
|
37
74
|
{
|
|
38
75
|
"name": "bq-alert",
|
|
39
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",
|
|
@@ -138,38 +175,13 @@
|
|
|
138
175
|
"references": []
|
|
139
176
|
},
|
|
140
177
|
{
|
|
141
|
-
"name": "bq-
|
|
142
|
-
"description": "The
|
|
178
|
+
"name": "bq-breadcrumb",
|
|
179
|
+
"description": "The Breadcrumb is used to wraps a series of breadcrumb items to indicate the current page's location within a navigational hierarchy.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-breadcrumb label=\"Breadcrumb\">\n<bq-breadcrumb-item>Home</bq-breadcrumb-item>\n<bq-breadcrumb-item>Men's clothing</bq-breadcrumb-item>\n<bq-breadcrumb-item>Shirt</bq-breadcrumb-item>\n<bq-breadcrumb-item>Casual shirts</bq-breadcrumb-item>\n</bq-breadcrumb>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The default slot is used to add `bq-breadcrumb-item` items to the breadcrumb.\n- **separator** - The slot to add a separator between breadcrumb items. Default separator is `/`.\n\n### **CSS Parts:**\n - **navigation** - The `nav` tag that loads the breadcrumb items\n- **separator** - The container that wraps the separator element",
|
|
143
180
|
"attributes": [
|
|
144
181
|
{
|
|
145
|
-
"name": "
|
|
146
|
-
"description": "The
|
|
147
|
-
"values": [{ "name": "filled" }, { "name": "ghost" }]
|
|
148
|
-
},
|
|
149
|
-
{
|
|
150
|
-
"name": "disabled",
|
|
151
|
-
"description": "If true, the Accordion is disabled",
|
|
152
|
-
"values": []
|
|
153
|
-
},
|
|
154
|
-
{
|
|
155
|
-
"name": "expanded",
|
|
156
|
-
"description": "If true, the Accordion is expanded",
|
|
157
|
-
"values": []
|
|
158
|
-
},
|
|
159
|
-
{
|
|
160
|
-
"name": "no-animation",
|
|
161
|
-
"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.",
|
|
162
|
-
"values": []
|
|
163
|
-
},
|
|
164
|
-
{
|
|
165
|
-
"name": "rotate",
|
|
166
|
-
"description": "If true, the Accordion expand icon is rotate 180deg when expanded",
|
|
182
|
+
"name": "label",
|
|
183
|
+
"description": "The `aria-label` attribute to describe the type of navigation",
|
|
167
184
|
"values": []
|
|
168
|
-
},
|
|
169
|
-
{
|
|
170
|
-
"name": "size",
|
|
171
|
-
"description": "The size of the the Accordion",
|
|
172
|
-
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
173
185
|
}
|
|
174
186
|
],
|
|
175
187
|
"references": []
|
|
@@ -200,18 +212,6 @@
|
|
|
200
212
|
],
|
|
201
213
|
"references": []
|
|
202
214
|
},
|
|
203
|
-
{
|
|
204
|
-
"name": "bq-breadcrumb",
|
|
205
|
-
"description": "The Breadcrumb is used to wraps a series of breadcrumb items to indicate the current page's location within a navigational hierarchy.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-breadcrumb label=\"Breadcrumb\">\n<bq-breadcrumb-item>Home</bq-breadcrumb-item>\n<bq-breadcrumb-item>Men's clothing</bq-breadcrumb-item>\n<bq-breadcrumb-item>Shirt</bq-breadcrumb-item>\n<bq-breadcrumb-item>Casual shirts</bq-breadcrumb-item>\n</bq-breadcrumb>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The default slot is used to add `bq-breadcrumb-item` items to the breadcrumb.\n- **separator** - The slot to add a separator between breadcrumb items. Default separator is `/`.\n\n### **CSS Parts:**\n - **navigation** - The `nav` tag that loads the breadcrumb items\n- **separator** - The container that wraps the separator element",
|
|
206
|
-
"attributes": [
|
|
207
|
-
{
|
|
208
|
-
"name": "label",
|
|
209
|
-
"description": "The `aria-label` attribute to describe the type of navigation",
|
|
210
|
-
"values": []
|
|
211
|
-
}
|
|
212
|
-
],
|
|
213
|
-
"references": []
|
|
214
|
-
},
|
|
215
215
|
{
|
|
216
216
|
"name": "bq-breadcrumb-item",
|
|
217
217
|
"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",
|
|
@@ -352,6 +352,58 @@
|
|
|
352
352
|
],
|
|
353
353
|
"references": []
|
|
354
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.",
|
|
358
|
+
"attributes": [
|
|
359
|
+
{
|
|
360
|
+
"name": "background-on-hover",
|
|
361
|
+
"description": "If true checkbox displays background on hover",
|
|
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",
|
|
392
|
+
"values": []
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "required",
|
|
396
|
+
"description": "If `true`, it will indicate that the user must specify a value for the checkbox before the owning form can be submitted",
|
|
397
|
+
"values": []
|
|
398
|
+
},
|
|
399
|
+
{
|
|
400
|
+
"name": "value",
|
|
401
|
+
"description": "A string representing the value of the checkbox. Primarily used to differentiate a list of related checkboxes that have the same name",
|
|
402
|
+
"values": []
|
|
403
|
+
}
|
|
404
|
+
],
|
|
405
|
+
"references": []
|
|
406
|
+
},
|
|
355
407
|
{
|
|
356
408
|
"name": "bq-date-picker",
|
|
357
409
|
"description": "The Date Picker is a intuitive UI element component allows users to select dates from a visual calendar interface, providing an intuitive way to input date information.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-date-picker\nfirst-day-of-week=\"1\"\nlocale=\"en-GB\"\nmonths-per-view=\"single\"\nmonths=\"2\"\nname=\"bq-date-picker\"\nplaceholder=\"Enter your date\"\nplacement=\"bottom-end\"\nshow-outside-days=\"false\"\ntype=\"range\"\nvalidation-status=\"none\"\nvalue=\"2024-05-25\"\n>\n<label class=\"flex flex-grow items-center\" slot=\"label\">\nDate picker label\n</label>\n</bq-date-picker>\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- **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\n### **Methods:**\n - **clear(): _Promise<void>_** - Clears the selected value.\n\n### **CSS Properties:**\n - **--bq-date-picker--background-color** - Date picker background color. _(default: undefined)_\n- **--bq-date-picker--border-color** - Date picker border color. _(default: undefined)_\n- **--bq-date-picker--border-color-disabled** - Date picker border color when disabled. _(default: undefined)_\n- **--bq-date-picker--border-color-focus** - Date picker border color on focus. _(default: undefined)_\n- **--bq-date-picker--border-radius** - Date picker border radius. _(default: undefined)_\n- **--bq-date-picker--border-style** - Date picker border style. _(default: undefined)_\n- **--bq-date-picker--border-width** - Date picker border width. _(default: undefined)_\n- **--bq-date-picker--currentDate-border-color** - Date picker border color for current date. _(default: undefined)_\n- **--bq-date-picker--currentDate-border-width** - Date picker border width for current date. _(default: undefined)_\n- **--bq-date-picker--day-size** - Date picker button day size. _(default: undefined)_\n- **--bq-date-picker--gap** - Gap between Date picker content and prefix/suffix. _(default: undefined)_\n- **--bq-date-picker--icon-size** - Icon size to use in prefix/suffix and clear button. _(default: undefined)_\n- **--bq-date-picker--label-margin-bottom** - Date picker label margin bottom. _(default: undefined)_\n- **--bq-date-picker--label-text-color** - Date picker label text color. _(default: undefined)_\n- **--bq-date-picker--label-text-size** - Date picker label text size. _(default: undefined)_\n- **--bq-date-picker--padding-end** - Date picker padding end. _(default: undefined)_\n- **--bq-date-picker--padding-start** - Date picker padding start. _(default: undefined)_\n- **--bq-date-picker--paddingY** - Date picker padding top and bottom. _(default: undefined)_\n- **--bq-date-picker--range-background-color** - Background color for the selected date range in the date picker. _(default: undefined)_\n- **--bq-date-picker--range-inner-background-color** - Background color for the selected dates inside the date range in the date picker. _(default: undefined)_\n- **--bq-date-picker--text-color** - Date picker text color. _(default: undefined)_\n- **--bq-date-picker--text-placeholder-color** - Date picker placeholder text color. _(default: undefined)_\n- **--bq-date-picker--text-size** - Date picker text size. _(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- **calendar__button** - Any button used in the calendar-month component.\n- **calendar__button** - Any button within the calendar-range component.\n- **calendar__container** - The calendar-range container for the entire component.\n- **calendar__day** - The buttons corresponding to each day in the calendar-month grid.\n- **calendar__disabled** - A button that is disabled due to min/max on the calendar-range component.\n- **calendar__disallowed** - Any day that has been disallowed via isDateDisallowed.\n- **calendar__head** - The calendar-month table's header row.\n- **calendar__header** - The calendar-range container for the heading and buttons.\n- **calendar__heading** - The calendar-month heading container that labels the month.\n- **calendar__heading** - The calendar-range heading containing the month and year.\n- **calendar__next** - The next page button on the calendar-range component.\n- **calendar__outside** - Any days which are outside the current month.\n- **calendar__previous** - The previous page button on the calendar-range component.\n- **calendar__range-end** - The day at the end of a date range.\n- **calendar__range-inner** - Any days between the start and end of a date range.\n- **calendar__range-start** - The day at the start of a date range.\n- **calendar__selected** - Any days which are selected.\n- **calendar__table** - The calendar-month <table> element.\n- **calendar__td** - The calendar-month table's body cells.\n- **calendar__th** - The calendar-month table's header cells.\n- **calendar__today** - The Today's day.\n- **calendar__tr** - Any row within the table on the calendar-month component.\n- **calendar__week** - The calendar-month table's body rows.\n- **clear-btn** - The clear button.\n- **control** - The input control wrapper.\n- **input** - The native HTML input element used under the hood.\n- **label** - The label slot container.\n- **panel** - The date picker panel container\n- **prefix** - The prefix slot container.\n- **suffix** - The suffix slot container.",
|
|
@@ -519,58 +571,6 @@
|
|
|
519
571
|
],
|
|
520
572
|
"references": []
|
|
521
573
|
},
|
|
522
|
-
{
|
|
523
|
-
"name": "bq-checkbox",
|
|
524
|
-
"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.",
|
|
525
|
-
"attributes": [
|
|
526
|
-
{
|
|
527
|
-
"name": "background-on-hover",
|
|
528
|
-
"description": "If true checkbox displays background on hover",
|
|
529
|
-
"values": []
|
|
530
|
-
},
|
|
531
|
-
{
|
|
532
|
-
"name": "form-id",
|
|
533
|
-
"description": "The form ID that the checkbox is associated with",
|
|
534
|
-
"values": []
|
|
535
|
-
},
|
|
536
|
-
{
|
|
537
|
-
"name": "form-validation-message",
|
|
538
|
-
"description": "The native form validation message",
|
|
539
|
-
"values": []
|
|
540
|
-
},
|
|
541
|
-
{
|
|
542
|
-
"name": "checked",
|
|
543
|
-
"description": "If true checkbox is checked",
|
|
544
|
-
"values": []
|
|
545
|
-
},
|
|
546
|
-
{
|
|
547
|
-
"name": "disabled",
|
|
548
|
-
"description": "If true checkbox is disabled",
|
|
549
|
-
"values": []
|
|
550
|
-
},
|
|
551
|
-
{
|
|
552
|
-
"name": "indeterminate",
|
|
553
|
-
"description": "A state that is neither checked nor unchecked",
|
|
554
|
-
"values": []
|
|
555
|
-
},
|
|
556
|
-
{
|
|
557
|
-
"name": "name",
|
|
558
|
-
"description": "Name of the HTML input form control. Submitted with the form as part of a name/value pair",
|
|
559
|
-
"values": []
|
|
560
|
-
},
|
|
561
|
-
{
|
|
562
|
-
"name": "required",
|
|
563
|
-
"description": "If `true`, it will indicate that the user must specify a value for the checkbox before the owning form can be submitted",
|
|
564
|
-
"values": []
|
|
565
|
-
},
|
|
566
|
-
{
|
|
567
|
-
"name": "value",
|
|
568
|
-
"description": "A string representing the value of the checkbox. Primarily used to differentiate a list of related checkboxes that have the same name",
|
|
569
|
-
"values": []
|
|
570
|
-
}
|
|
571
|
-
],
|
|
572
|
-
"references": []
|
|
573
|
-
},
|
|
574
574
|
{
|
|
575
575
|
"name": "bq-dialog",
|
|
576
576
|
"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.",
|
|
@@ -630,39 +630,6 @@
|
|
|
630
630
|
],
|
|
631
631
|
"references": []
|
|
632
632
|
},
|
|
633
|
-
{
|
|
634
|
-
"name": "bq-drawer",
|
|
635
|
-
"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.",
|
|
636
|
-
"attributes": [
|
|
637
|
-
{
|
|
638
|
-
"name": "enable-backdrop",
|
|
639
|
-
"description": "If true, the backdrop overlay will be shown when the drawer opens.",
|
|
640
|
-
"values": []
|
|
641
|
-
},
|
|
642
|
-
{
|
|
643
|
-
"name": "close-on-click-outside",
|
|
644
|
-
"description": "If true, the drawer will not close when clicking outside the panel.",
|
|
645
|
-
"values": []
|
|
646
|
-
},
|
|
647
|
-
{
|
|
648
|
-
"name": "close-on-esc",
|
|
649
|
-
"description": "If true, the drawer will not close when the [Esc] key is pressed.",
|
|
650
|
-
"values": []
|
|
651
|
-
},
|
|
652
|
-
{
|
|
653
|
-
"name": "open",
|
|
654
|
-
"description": "If true, the drawer component will be shown.",
|
|
655
|
-
"values": []
|
|
656
|
-
},
|
|
657
|
-
{
|
|
658
|
-
"name": "position",
|
|
659
|
-
"description": "Defines the position of the drawer.",
|
|
660
|
-
"values": [{ "name": "start" }, { "name": "end" }]
|
|
661
|
-
},
|
|
662
|
-
{ "name": "placement", "values": [{ "name": "TDrawerPlacement" }] }
|
|
663
|
-
],
|
|
664
|
-
"references": []
|
|
665
|
-
},
|
|
666
633
|
{
|
|
667
634
|
"name": "bq-divider",
|
|
668
635
|
"description": "The Divider component is used to visually separate content in a layout.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-divider orientation=\"horizontal\" stroke-color=\"stroke--primary\" title-alignment=\"middle\">\n<span slot=\"title\">Divider Title</span>\n</bq-divider>\n```\n\n</figure>\n---\n\n\n### **Slots:**\n - _default_ - The title content of the divider.\n\n### **CSS Properties:**\n - **--bq-divider--color** - Divider color _(default: undefined)_\n- **--bq-divider--title-marginX** - Divider space between title and delimiters _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper.\n- **dash-start** - The component's internal svg wrapper for the start line of the divider's stroke.\n- **dash-end** - The component's internal svg wrapper for the end line of the divider's stroke.\n- **dash-start-line** - The component's internal line component of the divider's stroke.\n- **dash-end-line** - The component's internal line component of the divider's stroke.",
|
|
@@ -723,6 +690,39 @@
|
|
|
723
690
|
],
|
|
724
691
|
"references": []
|
|
725
692
|
},
|
|
693
|
+
{
|
|
694
|
+
"name": "bq-drawer",
|
|
695
|
+
"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.",
|
|
696
|
+
"attributes": [
|
|
697
|
+
{
|
|
698
|
+
"name": "enable-backdrop",
|
|
699
|
+
"description": "If true, the backdrop overlay will be shown when the drawer opens.",
|
|
700
|
+
"values": []
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"name": "close-on-click-outside",
|
|
704
|
+
"description": "If true, the drawer will not close when clicking outside the panel.",
|
|
705
|
+
"values": []
|
|
706
|
+
},
|
|
707
|
+
{
|
|
708
|
+
"name": "close-on-esc",
|
|
709
|
+
"description": "If true, the drawer will not close when the [Esc] key is pressed.",
|
|
710
|
+
"values": []
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"name": "open",
|
|
714
|
+
"description": "If true, the drawer component will be shown.",
|
|
715
|
+
"values": []
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
"name": "position",
|
|
719
|
+
"description": "Defines the position of the drawer.",
|
|
720
|
+
"values": [{ "name": "start" }, { "name": "end" }]
|
|
721
|
+
},
|
|
722
|
+
{ "name": "placement", "values": [{ "name": "TDrawerPlacement" }] }
|
|
723
|
+
],
|
|
724
|
+
"references": []
|
|
725
|
+
},
|
|
726
726
|
{
|
|
727
727
|
"name": "bq-dropdown",
|
|
728
728
|
"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.",
|
|
@@ -1059,8 +1059,54 @@
|
|
|
1059
1059
|
"references": []
|
|
1060
1060
|
},
|
|
1061
1061
|
{
|
|
1062
|
-
"name": "bq-
|
|
1063
|
-
"description": "The
|
|
1062
|
+
"name": "bq-progress",
|
|
1063
|
+
"description": "The progress bar is a user interface component that visually represents the completion status of a task or process.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-progress value=\"50\"></bq-progress>\n```\n\n</figure>\n---\n\n\n### **CSS Properties:**\n - **--bq-progress-bar--height** - The progress bars height _(default: undefined)_\n- **--bq-progress-bar--indeterminateWidth** - The progress bar width when its indeterminate _(default: undefined)_\n- **--bq-progress-bar--indicatorColor** - The progress bar color (inside the track area) _(default: undefined)_\n- **--bq-progress-bar--trackColor** - The progress bar track area (the grey one) _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The component wrapper container inside the shadow DOM\n- **progress** - The `<div>` container that holds the native progress element\n- **progress-bar** - The native html for progress element\n- **label** - The `<div>` container that holds the label value (in percentage)\n- **indeterminate** - The `<div>` container that holds the indeterminate progress bar\n- **base** - The base container for the tooltip component inside the shadow DOM when hovering over the progress bar\n- **trigger** - The container holding the element that triggers the tooltip display when hovering over the progress bar\n- **panel** - The container holding the content of the tooltip when hovering over the progress bar",
|
|
1064
|
+
"attributes": [
|
|
1065
|
+
{
|
|
1066
|
+
"name": "border-shape",
|
|
1067
|
+
"description": "It will set the border style of the progress bar",
|
|
1068
|
+
"values": [{ "name": "rounded" }, { "name": "rounded-full" }]
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "enable-tooltip",
|
|
1072
|
+
"description": "If `true`, a tooltip will be shown displaying the progress value",
|
|
1073
|
+
"values": []
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "indeterminate",
|
|
1077
|
+
"description": "If `true` the indeterminate state of progress bar is enabled",
|
|
1078
|
+
"values": []
|
|
1079
|
+
},
|
|
1080
|
+
{
|
|
1081
|
+
"name": "label",
|
|
1082
|
+
"description": "If `true`, a label text showing the value (in percentage) will be shown",
|
|
1083
|
+
"values": []
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "thickness",
|
|
1087
|
+
"description": "Progress bar thickness",
|
|
1088
|
+
"values": [
|
|
1089
|
+
{ "name": "small" },
|
|
1090
|
+
{ "name": "medium" },
|
|
1091
|
+
{ "name": "large" }
|
|
1092
|
+
]
|
|
1093
|
+
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "type",
|
|
1096
|
+
"description": "Progress type",
|
|
1097
|
+
"values": [{ "name": "default" }, { "name": "error" }]
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "value",
|
|
1101
|
+
"description": "A number representing the current value of the progress bar",
|
|
1102
|
+
"values": []
|
|
1103
|
+
}
|
|
1104
|
+
],
|
|
1105
|
+
"references": []
|
|
1106
|
+
},
|
|
1107
|
+
{
|
|
1108
|
+
"name": "bq-panel",
|
|
1109
|
+
"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",
|
|
1064
1110
|
"attributes": [
|
|
1065
1111
|
{
|
|
1066
1112
|
"name": "distance",
|
|
@@ -1108,52 +1154,6 @@
|
|
|
1108
1154
|
],
|
|
1109
1155
|
"references": []
|
|
1110
1156
|
},
|
|
1111
|
-
{
|
|
1112
|
-
"name": "bq-progress",
|
|
1113
|
-
"description": "The progress bar is a user interface component that visually represents the completion status of a task or process.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-progress value=\"50\"></bq-progress>\n```\n\n</figure>\n---\n\n\n### **CSS Properties:**\n - **--bq-progress-bar--height** - The progress bars height _(default: undefined)_\n- **--bq-progress-bar--indeterminateWidth** - The progress bar width when its indeterminate _(default: undefined)_\n- **--bq-progress-bar--indicatorColor** - The progress bar color (inside the track area) _(default: undefined)_\n- **--bq-progress-bar--trackColor** - The progress bar track area (the grey one) _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The component wrapper container inside the shadow DOM\n- **progress** - The `<div>` container that holds the native progress element\n- **progress-bar** - The native html for progress element\n- **label** - The `<div>` container that holds the label value (in percentage)\n- **indeterminate** - The `<div>` container that holds the indeterminate progress bar\n- **base** - The base container for the tooltip component inside the shadow DOM when hovering over the progress bar\n- **trigger** - The container holding the element that triggers the tooltip display when hovering over the progress bar\n- **panel** - The container holding the content of the tooltip when hovering over the progress bar",
|
|
1114
|
-
"attributes": [
|
|
1115
|
-
{
|
|
1116
|
-
"name": "border-shape",
|
|
1117
|
-
"description": "It will set the border style of the progress bar",
|
|
1118
|
-
"values": [{ "name": "rounded" }, { "name": "rounded-full" }]
|
|
1119
|
-
},
|
|
1120
|
-
{
|
|
1121
|
-
"name": "enable-tooltip",
|
|
1122
|
-
"description": "If `true`, a tooltip will be shown displaying the progress value",
|
|
1123
|
-
"values": []
|
|
1124
|
-
},
|
|
1125
|
-
{
|
|
1126
|
-
"name": "indeterminate",
|
|
1127
|
-
"description": "If `true` the indeterminate state of progress bar is enabled",
|
|
1128
|
-
"values": []
|
|
1129
|
-
},
|
|
1130
|
-
{
|
|
1131
|
-
"name": "label",
|
|
1132
|
-
"description": "If `true`, a label text showing the value (in percentage) will be shown",
|
|
1133
|
-
"values": []
|
|
1134
|
-
},
|
|
1135
|
-
{
|
|
1136
|
-
"name": "thickness",
|
|
1137
|
-
"description": "Progress bar thickness",
|
|
1138
|
-
"values": [
|
|
1139
|
-
{ "name": "small" },
|
|
1140
|
-
{ "name": "medium" },
|
|
1141
|
-
{ "name": "large" }
|
|
1142
|
-
]
|
|
1143
|
-
},
|
|
1144
|
-
{
|
|
1145
|
-
"name": "type",
|
|
1146
|
-
"description": "Progress type",
|
|
1147
|
-
"values": [{ "name": "default" }, { "name": "error" }]
|
|
1148
|
-
},
|
|
1149
|
-
{
|
|
1150
|
-
"name": "value",
|
|
1151
|
-
"description": "A number representing the current value of the progress bar",
|
|
1152
|
-
"values": []
|
|
1153
|
-
}
|
|
1154
|
-
],
|
|
1155
|
-
"references": []
|
|
1156
|
-
},
|
|
1157
1157
|
{
|
|
1158
1158
|
"name": "bq-radio",
|
|
1159
1159
|
"description": "The radio button is a user interface element that allows users to select a single option.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-radio value=\"option1\">Radio option 1</bq-radio>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqBlur** - Handler to be called when the radio loses focus\n- **bqClick** - Handler to be called when the radio state changes\n- **bqFocus** - Handler to be called when the radio gets focused\n- **bqKeyDown** - The handler is to be called when the radio key is pressed\n- **bqClick** - Handler to be called when the radio state changes\n- **bqFocus** - Handler to be called when the radio gets focus\n- **bqBlur** - Handler to be called when the radio loses focus\n- **bqKeyDown** - Handler to be called when the radio key is pressed\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- **getNativeInput()** - Returns the native `<input>` HTML element used under the hood.\n\n### **Slots:**\n - _default_ - The bq-radio item\n\n### **CSS Properties:**\n - **--bq-radio--size** - Radio size _(default: undefined)_\n- **--bq-radio--border-width** - Radio border width _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's internal wrapper of the radio component.\n- **input** - The native HTML `<input type=\"radio\">` used under the hood.\n- **radio** - The component's internal wrapper of the radio component.\n- **label** - The `<span>` element that holds the text content.",
|
|
@@ -1248,6 +1248,32 @@
|
|
|
1248
1248
|
],
|
|
1249
1249
|
"references": []
|
|
1250
1250
|
},
|
|
1251
|
+
{
|
|
1252
|
+
"name": "bq-side-menu",
|
|
1253
|
+
"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",
|
|
1254
|
+
"attributes": [
|
|
1255
|
+
{
|
|
1256
|
+
"name": "appearance",
|
|
1257
|
+
"description": "It sets a predefined appearance of the side menu.",
|
|
1258
|
+
"values": [
|
|
1259
|
+
{ "name": "brand" },
|
|
1260
|
+
{ "name": "default" },
|
|
1261
|
+
{ "name": "inverse" }
|
|
1262
|
+
]
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"name": "collapse",
|
|
1266
|
+
"description": "If `true`, the container will reduce its width.",
|
|
1267
|
+
"values": []
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"description": "size - It sets the size of the navigation menu items.",
|
|
1271
|
+
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1272
|
+
},
|
|
1273
|
+
{ "name": "size", "values": [{ "name": "TSideMenuSize" }] }
|
|
1274
|
+
],
|
|
1275
|
+
"references": []
|
|
1276
|
+
},
|
|
1251
1277
|
{
|
|
1252
1278
|
"name": "bq-select",
|
|
1253
1279
|
"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.",
|
|
@@ -1388,28 +1414,24 @@
|
|
|
1388
1414
|
"references": []
|
|
1389
1415
|
},
|
|
1390
1416
|
{
|
|
1391
|
-
"name": "bq-side-menu",
|
|
1392
|
-
"description": "
|
|
1417
|
+
"name": "bq-side-menu-item",
|
|
1418
|
+
"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)",
|
|
1393
1419
|
"attributes": [
|
|
1394
1420
|
{
|
|
1395
|
-
"name": "
|
|
1396
|
-
"description": "
|
|
1397
|
-
"values": [
|
|
1398
|
-
{ "name": "brand" },
|
|
1399
|
-
{ "name": "default" },
|
|
1400
|
-
{ "name": "inverse" }
|
|
1401
|
-
]
|
|
1421
|
+
"name": "active",
|
|
1422
|
+
"description": "If `true`, the menu item will be shown as active/selected.",
|
|
1423
|
+
"values": []
|
|
1402
1424
|
},
|
|
1403
1425
|
{
|
|
1404
1426
|
"name": "collapse",
|
|
1405
|
-
"description": "If `true`, the
|
|
1427
|
+
"description": "If `true`, the item label and suffix will be hidden and the with will be reduced according to its parent.",
|
|
1406
1428
|
"values": []
|
|
1407
1429
|
},
|
|
1408
1430
|
{
|
|
1409
|
-
"
|
|
1410
|
-
"
|
|
1411
|
-
|
|
1412
|
-
|
|
1431
|
+
"name": "disabled",
|
|
1432
|
+
"description": "If `true`, the menu item will be disabled (no interaction allowed).",
|
|
1433
|
+
"values": []
|
|
1434
|
+
}
|
|
1413
1435
|
],
|
|
1414
1436
|
"references": []
|
|
1415
1437
|
},
|
|
@@ -1512,28 +1534,6 @@
|
|
|
1512
1534
|
],
|
|
1513
1535
|
"references": []
|
|
1514
1536
|
},
|
|
1515
|
-
{
|
|
1516
|
-
"name": "bq-side-menu-item",
|
|
1517
|
-
"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)",
|
|
1518
|
-
"attributes": [
|
|
1519
|
-
{
|
|
1520
|
-
"name": "active",
|
|
1521
|
-
"description": "If `true`, the menu item will be shown as active/selected.",
|
|
1522
|
-
"values": []
|
|
1523
|
-
},
|
|
1524
|
-
{
|
|
1525
|
-
"name": "collapse",
|
|
1526
|
-
"description": "If `true`, the item label and suffix will be hidden and the with will be reduced according to its parent.",
|
|
1527
|
-
"values": []
|
|
1528
|
-
},
|
|
1529
|
-
{
|
|
1530
|
-
"name": "disabled",
|
|
1531
|
-
"description": "If `true`, the menu item will be disabled (no interaction allowed).",
|
|
1532
|
-
"values": []
|
|
1533
|
-
}
|
|
1534
|
-
],
|
|
1535
|
-
"references": []
|
|
1536
|
-
},
|
|
1537
1537
|
{
|
|
1538
1538
|
"name": "bq-status",
|
|
1539
1539
|
"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.",
|
|
@@ -1553,22 +1553,28 @@
|
|
|
1553
1553
|
"references": []
|
|
1554
1554
|
},
|
|
1555
1555
|
{
|
|
1556
|
-
"name": "bq-
|
|
1557
|
-
"description": "The
|
|
1556
|
+
"name": "bq-step-item",
|
|
1557
|
+
"description": "The Step Item Component is a UI element used to display a single step or stage in a process or task.\nIt should be used inside the Steps component.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-step-item status=\"completed\">\n<bq-icon slot=\"prefix\" name=\"check-circle\"></bq-icon>\n<span>Title</span>\n<span slot=\"description\">Description</span>\n</bq-step-item>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClick** - Callback handler emitted when the step item is clicked\n- **bqClick** - Callback handler emitted when the step item is clicked\n\n### **Slots:**\n - _default_ - The step item content\n- **prefix** - The step item prefix\n- **description** - The step item description\n\n### **CSS Properties:**\n - **--bq-step-item--prefix-color** - Color of the prefix icon _(default: undefined)_\n- **--bq-step-item--prefix-color-current** - Color of the prefix icon when current _(default: undefined)_\n- **--bq-step-item--prefix-color-completed** - Color of the prefix icon when completed _(default: undefined)_\n- **--bq-step-item--prefix-color-error** - Color of the prefix icon when error _(default: undefined)_\n- **--bq-step-item--prefix-num-size** - Size of the prefix number _(default: undefined)_\n- **--bq-step-item--prefix-num-bg-color** - Background color of the prefix number _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **title** - The component's title.\n- **description** - The component's description.",
|
|
1558
1558
|
"attributes": [
|
|
1559
1559
|
{
|
|
1560
|
-
"name": "
|
|
1561
|
-
"description": "
|
|
1562
|
-
"values": []
|
|
1560
|
+
"name": "size",
|
|
1561
|
+
"description": "It defines prefix size",
|
|
1562
|
+
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
1563
1563
|
},
|
|
1564
1564
|
{
|
|
1565
|
-
"name": "
|
|
1566
|
-
"description": "
|
|
1567
|
-
"values": [
|
|
1565
|
+
"name": "status",
|
|
1566
|
+
"description": "It defines step item appearance based on its status",
|
|
1567
|
+
"values": [
|
|
1568
|
+
{ "name": "completed" },
|
|
1569
|
+
{ "name": "current" },
|
|
1570
|
+
{ "name": "error" },
|
|
1571
|
+
{ "name": "default" },
|
|
1572
|
+
{ "name": "disabled" }
|
|
1573
|
+
]
|
|
1568
1574
|
},
|
|
1569
1575
|
{
|
|
1570
1576
|
"name": "type",
|
|
1571
|
-
"description": "
|
|
1577
|
+
"description": "It defines the step item type used",
|
|
1572
1578
|
"values": [
|
|
1573
1579
|
{ "name": "numeric" },
|
|
1574
1580
|
{ "name": "icon" },
|
|
@@ -1647,38 +1653,6 @@
|
|
|
1647
1653
|
],
|
|
1648
1654
|
"references": []
|
|
1649
1655
|
},
|
|
1650
|
-
{
|
|
1651
|
-
"name": "bq-step-item",
|
|
1652
|
-
"description": "The Step Item Component is a UI element used to display a single step or stage in a process or task.\nIt should be used inside the Steps component.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-step-item status=\"completed\">\n<bq-icon slot=\"prefix\" name=\"check-circle\"></bq-icon>\n<span>Title</span>\n<span slot=\"description\">Description</span>\n</bq-step-item>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClick** - Callback handler emitted when the step item is clicked\n- **bqClick** - Callback handler emitted when the step item is clicked\n\n### **Slots:**\n - _default_ - The step item content\n- **prefix** - The step item prefix\n- **description** - The step item description\n\n### **CSS Properties:**\n - **--bq-step-item--prefix-color** - Color of the prefix icon _(default: undefined)_\n- **--bq-step-item--prefix-color-current** - Color of the prefix icon when current _(default: undefined)_\n- **--bq-step-item--prefix-color-completed** - Color of the prefix icon when completed _(default: undefined)_\n- **--bq-step-item--prefix-color-error** - Color of the prefix icon when error _(default: undefined)_\n- **--bq-step-item--prefix-num-size** - Size of the prefix number _(default: undefined)_\n- **--bq-step-item--prefix-num-bg-color** - Background color of the prefix number _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **title** - The component's title.\n- **description** - The component's description.",
|
|
1653
|
-
"attributes": [
|
|
1654
|
-
{
|
|
1655
|
-
"name": "size",
|
|
1656
|
-
"description": "It defines prefix size",
|
|
1657
|
-
"values": [{ "name": "small" }, { "name": "medium" }]
|
|
1658
|
-
},
|
|
1659
|
-
{
|
|
1660
|
-
"name": "status",
|
|
1661
|
-
"description": "It defines step item appearance based on its status",
|
|
1662
|
-
"values": [
|
|
1663
|
-
{ "name": "completed" },
|
|
1664
|
-
{ "name": "current" },
|
|
1665
|
-
{ "name": "error" },
|
|
1666
|
-
{ "name": "default" },
|
|
1667
|
-
{ "name": "disabled" }
|
|
1668
|
-
]
|
|
1669
|
-
},
|
|
1670
|
-
{
|
|
1671
|
-
"name": "type",
|
|
1672
|
-
"description": "It defines the step item type used",
|
|
1673
|
-
"values": [
|
|
1674
|
-
{ "name": "numeric" },
|
|
1675
|
-
{ "name": "icon" },
|
|
1676
|
-
{ "name": "dot" }
|
|
1677
|
-
]
|
|
1678
|
-
}
|
|
1679
|
-
],
|
|
1680
|
-
"references": []
|
|
1681
|
-
},
|
|
1682
1656
|
{
|
|
1683
1657
|
"name": "bq-tab",
|
|
1684
1658
|
"description": "The tab is a user interface element that allows users to navigate between different sections of a page.\nIt should be used inside `<bq-tab-group>` component.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-tab tab-id=\"1\" controls=\"panel-1\">Tab 1</bq-tab>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClick** - Handler to be called when the tab state changes\n- **bqFocus** - Handler to be called when the tab gets focus\n- **bqBlur** - Handler to be called when the tab loses focus\n- **bqKeyDown** - Handler to be called when the tab key is pressed\n- **bqClick** - Handler to be called when the tab state changes\n- **bqFocus** - Handler to be called when the tab gets focus\n- **bqBlur** - Handler to be called when the tab loses focus\n- **bqKeyDown** - Handler to be called when the tab key is pressed\n\n### **Methods:**\n - **vClick()** - Simulate a click event on the native `<button>` HTML element used under the hood.\nUse this method instead of the global `element.click()`.\n- **vFocus()** - Sets focus on the native `<button>` HTML element used under the hood.\nUse this method instead of the global `element.focus()`.\n- **vBlur()** - Remove focus from the native `<button>` HTML element used under the hood.\nUse this method instead of the global `element.blur()`.\n\n### **CSS Properties:**\n - **--bq-tab--font-size** - Font size _(default: undefined)_\n- **--bq-tab--font-weight** - Font weight _(default: undefined)_\n- **--bq-tab--icon-size-large** - Icon size for large tab _(default: undefined)_\n- **--bq-tab--icon-size-medium** - Icon size for medium tab _(default: undefined)_\n- **--bq-tab--icon-size-small** - Icon size for small tab _(default: undefined)_\n- **--bq-tab--label-icon-gap** - Gap between label and icon _(default: undefined)_\n- **--bq-tab--line-height** - Line height _(default: undefined)_\n- **--bq-tab--padding-horizontal-large** - Horizontal padding for large tab _(default: undefined)_\n- **--bq-tab--padding-horizontal-medium** - Horizontal padding for medium tab _(default: undefined)_\n- **--bq-tab--padding-horizontal-small** - Horizontal padding for small tab _(default: undefined)_\n- **--bq-tab--padding-vertical-large** - Vertical padding for large tab _(default: undefined)_\n- **--bq-tab--padding-vertical-medium** - Vertical padding for medium tab _(default: undefined)_\n- **--bq-tab--padding-vertical-small** - Vertical padding for small tab _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The HTML button used under the hood.\n- **content** - The HTML `<div>` element that holds the content.\n- **icon** - The HTML `<div>` element that holds the icon content.\n- **text** - The HTML `<div>` element that holds the text content.\n- **underline** - The HTML `<div>` element that display active state.",
|
|
@@ -1713,6 +1687,32 @@
|
|
|
1713
1687
|
],
|
|
1714
1688
|
"references": []
|
|
1715
1689
|
},
|
|
1690
|
+
{
|
|
1691
|
+
"name": "bq-steps",
|
|
1692
|
+
"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",
|
|
1693
|
+
"attributes": [
|
|
1694
|
+
{
|
|
1695
|
+
"name": "divider-color",
|
|
1696
|
+
"description": "The color of the line that connects the steps. It should be a valid declarative color token.",
|
|
1697
|
+
"values": []
|
|
1698
|
+
},
|
|
1699
|
+
{
|
|
1700
|
+
"name": "size",
|
|
1701
|
+
"description": "The size of the steps",
|
|
1702
|
+
"values": [{ "name": "medium" }, { "name": "small" }]
|
|
1703
|
+
},
|
|
1704
|
+
{
|
|
1705
|
+
"name": "type",
|
|
1706
|
+
"description": "The type of prefix element to use on the step items",
|
|
1707
|
+
"values": [
|
|
1708
|
+
{ "name": "numeric" },
|
|
1709
|
+
{ "name": "icon" },
|
|
1710
|
+
{ "name": "dot" }
|
|
1711
|
+
]
|
|
1712
|
+
}
|
|
1713
|
+
],
|
|
1714
|
+
"references": []
|
|
1715
|
+
},
|
|
1716
1716
|
{
|
|
1717
1717
|
"name": "bq-tab-group",
|
|
1718
1718
|
"description": "The tab group is a user interface element that allows users wrap a set of tab items.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-tab-group value=\"5\">\n<bq-tab tab-id=\"1\">Tab</bq-tab>\n<bq-tab tab-id=\"2\" active>Tab</bq-tab>\n<bq-tab tab-id=\"3\">Long Tab name</bq-tab>\n<bq-tab tab-id=\"4\" disabled>Tab</bq-tab>\n</bq-tab-group>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqChange** - Handler to be called when the tab value changes\n- **bqChange** - Handler to be called when the tab value changes\n\n### **Slots:**\n - _default_ - The bq-tab items\n\n### **CSS Parts:**\n - **base** - The HTML div wrapper inside the shadow DOM.\n- **tabs** - The HTML div used to hold the tab buttons.",
|
|
@@ -1746,68 +1746,6 @@
|
|
|
1746
1746
|
],
|
|
1747
1747
|
"references": []
|
|
1748
1748
|
},
|
|
1749
|
-
{
|
|
1750
|
-
"name": "bq-tag",
|
|
1751
|
-
"description": "The Tag Component is a UI element used to label and categorize content within an application.\nTags are commonly used to label items with keywords or categories, making it easier to find and organize content.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-tag color=\"success\" size=\"medium\" variant=\"filled\">Success</bq-tag>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClose** - Callback handler to be called when the tag is close/hidden\n- **bqOpen** - Callback handler to be called when the tag is not open/shown\n- **bqBlur** - Handler to be called when tag loses focus\n- **bqClick** - Handler to be called when tag is clicked\n- **bqFocus** - Handler to be called when tag is focused\n- **bqClose** - Callback handler to be called when the tag is close/hidden\n- **bqOpen** - Callback handler to be called when the tag is not open/shown\n- **bqBlur** - Handler to be called when tag loses focus\n- **bqClick** - Handler to be called when tag is clicked\n- **bqFocus** - Handler to be called when tag is focused\n\n### **Methods:**\n - **hide(): _Promise<void>_** - Method to be called to remove the tag component\n- **show(): _Promise<void>_** - Method to be called to show the tag component\n\n### **Slots:**\n - **prefix** - The prefix slot to add an icon or any other content before the text\n- _default_ - The text content of the tag\n\n### **CSS Properties:**\n - **--bq-tag--background-color** - Tag background color _(default: undefined)_\n- **--bq-tag--border-color** - Tag border color _(default: undefined)_\n- **--bq-tag--border-radius** - Tag border radius _(default: undefined)_\n- **--bq-tag--border-style** - Tag border style _(default: undefined)_\n- **--bq-tag--border-width** - Tag border width _(default: undefined)_\n- **--bq-tag--small-border-radius** - Tag small border radius _(default: undefined)_\n- **--bq-tag--small-gap** - Tag small gap between content _(default: undefined)_\n- **--bq-tag--small-padding-x** - Tag small padding horizontal _(default: undefined)_\n- **--bq-tag--small-padding-y** - Tag small padding vertical _(default: undefined)_\n- **--bq-tag--medium-gap** - Tag medium gap between content _(default: undefined)_\n- **--bq-tag--medium-padding-x** - Tag medium padding horizontal _(default: undefined)_\n- **--bq-tag--medium-padding-y** - Tag medium padding vertical _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The wrapper container `<div>` of the element inside the shadow DOM.\n- **prefix** - The `<span>` tag element that acts as prefix container (when icon exists in front of tag).\n- **text** - The `<div>` element containing the text of the tag component.\n- **btn-close** - The close button element to remove the tag component.",
|
|
1752
|
-
"attributes": [
|
|
1753
|
-
{
|
|
1754
|
-
"name": "border",
|
|
1755
|
-
"description": "The corner radius of the Tag (will override size's predefined border)",
|
|
1756
|
-
"values": []
|
|
1757
|
-
},
|
|
1758
|
-
{
|
|
1759
|
-
"name": "clickable",
|
|
1760
|
-
"description": "If `true`, the Tag can be clickable",
|
|
1761
|
-
"values": []
|
|
1762
|
-
},
|
|
1763
|
-
{
|
|
1764
|
-
"name": "color",
|
|
1765
|
-
"description": "The color style of the Tag",
|
|
1766
|
-
"values": [
|
|
1767
|
-
{ "name": "error" },
|
|
1768
|
-
{ "name": "gray" },
|
|
1769
|
-
{ "name": "info" },
|
|
1770
|
-
{ "name": "success" },
|
|
1771
|
-
{ "name": "warning" }
|
|
1772
|
-
]
|
|
1773
|
-
},
|
|
1774
|
-
{
|
|
1775
|
-
"name": "disabled",
|
|
1776
|
-
"description": "If `true`, the Tag will be disabled (only if clickable = `true`, no interaction allowed)",
|
|
1777
|
-
"values": []
|
|
1778
|
-
},
|
|
1779
|
-
{
|
|
1780
|
-
"name": "hidden",
|
|
1781
|
-
"description": "If `true`, the Tag component will hidden (only if removable = `true`)",
|
|
1782
|
-
"values": []
|
|
1783
|
-
},
|
|
1784
|
-
{
|
|
1785
|
-
"name": "removable",
|
|
1786
|
-
"description": "If `true`, the Tag component can be removed",
|
|
1787
|
-
"values": []
|
|
1788
|
-
},
|
|
1789
|
-
{
|
|
1790
|
-
"name": "selected",
|
|
1791
|
-
"description": "If `true`, the Tag is selected (only if clickable = `true`)",
|
|
1792
|
-
"values": []
|
|
1793
|
-
},
|
|
1794
|
-
{
|
|
1795
|
-
"name": "size",
|
|
1796
|
-
"description": "The size of the Tag component",
|
|
1797
|
-
"values": [
|
|
1798
|
-
{ "name": "xsmall" },
|
|
1799
|
-
{ "name": "small" },
|
|
1800
|
-
{ "name": "medium" }
|
|
1801
|
-
]
|
|
1802
|
-
},
|
|
1803
|
-
{
|
|
1804
|
-
"name": "variant",
|
|
1805
|
-
"description": "The variant of Tag to apply on top of the variant",
|
|
1806
|
-
"values": [{ "name": "outline" }, { "name": "filled" }]
|
|
1807
|
-
}
|
|
1808
|
-
],
|
|
1809
|
-
"references": []
|
|
1810
|
-
},
|
|
1811
1749
|
{
|
|
1812
1750
|
"name": "bq-toast",
|
|
1813
1751
|
"description": "Toasts are time-based components used to display short messages.\nCommonly used for errors, confirmations, or progress updates.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-toast type=\"info\">\nThis is a message\n</bq-toast>\n```\n\n</figure>\n---\n\n\n### **Events:**\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\n### **Methods:**\n - **show(): _Promise<void>_** - Method to be called to show the toast component\n- **hide(): _Promise<void>_** - Method to be called to hide the toast component\n- **toast()** - This method can be used to display toasts in a fixed-position element that allows for stacking multiple toasts vertically\n\n### **Slots:**\n - _default_ - The content to be displayed in the toast component.\n- **icon** - The icon to be displayed in the toast component.\n\n### **CSS Properties:**\n - **--bq-toast--background** - Toast background color _(default: undefined)_\n- **--bq-toast--box-shadow** - Toast box shadow _(default: undefined)_\n- **--bq-toast--padding-y** - Toast vertical padding _(default: undefined)_\n- **--bq-toast--padding-x** - Toast horizontal padding _(default: undefined)_\n- **--bq-toast--gap** - Toast distance between icon and text _(default: undefined)_\n- **--bq-toast--border-radius** - Toast border radius _(default: undefined)_\n- **--bq-toast--border-color** - Toast border color _(default: undefined)_\n- **--bq-toast--border-style** - Toast border style _(default: undefined)_\n- **--bq-toast--border-width** - Toast border width _(default: undefined)_\n- **--bq-toast--icon-color-info** - Toast icon color when type is 'info' _(default: undefined)_\n- **--bq-toast--icon-color-success** - Toast icon color when type is 'success' _(default: undefined)_\n- **--bq-toast--icon-color-alert** - Toast icon color when type is 'alert' _(default: undefined)_\n- **--bq-toast--icon-color-error** - Toast icon color when type is 'error' _(default: undefined)_\n- **--bq-toast--icon-color-loading** - Toast icon color when type is 'loading' _(default: undefined)_\n- **--bq-toast--icon-color-custom** - Toast icon color when type is 'custom' _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The component's internal wrapper inside the shadow DOM.\n- **icon-info** - The `<div>` container that holds the icon component.\n- **base** - The `<div>` container of the internal bq-icon component.\n- **svg** - The `<svg>` element of the internal bq-icon component.",
|
|
@@ -1978,6 +1916,68 @@
|
|
|
1978
1916
|
],
|
|
1979
1917
|
"references": []
|
|
1980
1918
|
},
|
|
1919
|
+
{
|
|
1920
|
+
"name": "bq-tag",
|
|
1921
|
+
"description": "The Tag Component is a UI element used to label and categorize content within an application.\nTags are commonly used to label items with keywords or categories, making it easier to find and organize content.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-tag color=\"success\" size=\"medium\" variant=\"filled\">Success</bq-tag>\n```\n\n</figure>\n---\n\n\n### **Events:**\n - **bqClose** - Callback handler to be called when the tag is close/hidden\n- **bqOpen** - Callback handler to be called when the tag is not open/shown\n- **bqBlur** - Handler to be called when tag loses focus\n- **bqClick** - Handler to be called when tag is clicked\n- **bqFocus** - Handler to be called when tag is focused\n- **bqClose** - Callback handler to be called when the tag is close/hidden\n- **bqOpen** - Callback handler to be called when the tag is not open/shown\n- **bqBlur** - Handler to be called when tag loses focus\n- **bqClick** - Handler to be called when tag is clicked\n- **bqFocus** - Handler to be called when tag is focused\n\n### **Methods:**\n - **hide(): _Promise<void>_** - Method to be called to remove the tag component\n- **show(): _Promise<void>_** - Method to be called to show the tag component\n\n### **Slots:**\n - **prefix** - The prefix slot to add an icon or any other content before the text\n- _default_ - The text content of the tag\n\n### **CSS Properties:**\n - **--bq-tag--background-color** - Tag background color _(default: undefined)_\n- **--bq-tag--border-color** - Tag border color _(default: undefined)_\n- **--bq-tag--border-radius** - Tag border radius _(default: undefined)_\n- **--bq-tag--border-style** - Tag border style _(default: undefined)_\n- **--bq-tag--border-width** - Tag border width _(default: undefined)_\n- **--bq-tag--small-border-radius** - Tag small border radius _(default: undefined)_\n- **--bq-tag--small-gap** - Tag small gap between content _(default: undefined)_\n- **--bq-tag--small-padding-x** - Tag small padding horizontal _(default: undefined)_\n- **--bq-tag--small-padding-y** - Tag small padding vertical _(default: undefined)_\n- **--bq-tag--medium-gap** - Tag medium gap between content _(default: undefined)_\n- **--bq-tag--medium-padding-x** - Tag medium padding horizontal _(default: undefined)_\n- **--bq-tag--medium-padding-y** - Tag medium padding vertical _(default: undefined)_\n\n### **CSS Parts:**\n - **wrapper** - The wrapper container `<div>` of the element inside the shadow DOM.\n- **prefix** - The `<span>` tag element that acts as prefix container (when icon exists in front of tag).\n- **text** - The `<div>` element containing the text of the tag component.\n- **btn-close** - The close button element to remove the tag component.",
|
|
1922
|
+
"attributes": [
|
|
1923
|
+
{
|
|
1924
|
+
"name": "border",
|
|
1925
|
+
"description": "The corner radius of the Tag (will override size's predefined border)",
|
|
1926
|
+
"values": []
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"name": "clickable",
|
|
1930
|
+
"description": "If `true`, the Tag can be clickable",
|
|
1931
|
+
"values": []
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
"name": "color",
|
|
1935
|
+
"description": "The color style of the Tag",
|
|
1936
|
+
"values": [
|
|
1937
|
+
{ "name": "error" },
|
|
1938
|
+
{ "name": "gray" },
|
|
1939
|
+
{ "name": "info" },
|
|
1940
|
+
{ "name": "success" },
|
|
1941
|
+
{ "name": "warning" }
|
|
1942
|
+
]
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "disabled",
|
|
1946
|
+
"description": "If `true`, the Tag will be disabled (only if clickable = `true`, no interaction allowed)",
|
|
1947
|
+
"values": []
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "hidden",
|
|
1951
|
+
"description": "If `true`, the Tag component will hidden (only if removable = `true`)",
|
|
1952
|
+
"values": []
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
"name": "removable",
|
|
1956
|
+
"description": "If `true`, the Tag component can be removed",
|
|
1957
|
+
"values": []
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "selected",
|
|
1961
|
+
"description": "If `true`, the Tag is selected (only if clickable = `true`)",
|
|
1962
|
+
"values": []
|
|
1963
|
+
},
|
|
1964
|
+
{
|
|
1965
|
+
"name": "size",
|
|
1966
|
+
"description": "The size of the Tag component",
|
|
1967
|
+
"values": [
|
|
1968
|
+
{ "name": "xsmall" },
|
|
1969
|
+
{ "name": "small" },
|
|
1970
|
+
{ "name": "medium" }
|
|
1971
|
+
]
|
|
1972
|
+
},
|
|
1973
|
+
{
|
|
1974
|
+
"name": "variant",
|
|
1975
|
+
"description": "The variant of Tag to apply on top of the variant",
|
|
1976
|
+
"values": [{ "name": "outline" }, { "name": "filled" }]
|
|
1977
|
+
}
|
|
1978
|
+
],
|
|
1979
|
+
"references": []
|
|
1980
|
+
},
|
|
1981
1981
|
{
|
|
1982
1982
|
"name": "bq-tooltip",
|
|
1983
1983
|
"description": "The Tooltip component is a small pop-up box that appears when a user hovers over or clicks on an element, providing additional information or context.\n\n## Examples\n\n<figure class=\"example\"><figcaption>How to use it</figcaption>\n\n```html\n<bq-tooltip visible>\nYuhu! I'm a tooltip 🙃\n<bq-button slot=\"trigger\">Hover me!</bq-button>\n</bq-tooltip>\n```\n\n</figure>\n---\n\n\n### **Methods:**\n - **show()** - Shows the tooltip\n- **hide()** - Hides the tooltip\n\n### **Slots:**\n - **trigger** - The element which displays tooltip on hover\n- _default_ - The tooltip content\n\n### **CSS Properties:**\n - **--bq-tooltip--background-color** - Tooltip background color _(default: undefined)_\n- **--bq-tooltip--box-shadow** - Tooltip box shadow _(default: undefined)_\n- **--bq-tooltip--font-size** - Tooltip font size _(default: undefined)_\n- **--bq-tooltip--line-height** - Tooltip line height _(default: undefined)_\n- **--bq-tooltip--text-color** - Tooltip text color _(default: undefined)_\n- **--bq-tooltip--paddingX** - Tooltip horizontal padding _(default: undefined)_\n- **--bq-tooltip--paddingY** - Tooltip vertical padding _(default: undefined)_\n- **--bq-tooltip--border-color** - Tooltip border color _(default: undefined)_\n- **--bq-tooltip--border-radius** - Tooltip border radius _(default: undefined)_\n- **--bq-tooltip--border-style** - Tooltip border style _(default: undefined)_\n- **--bq-tooltip--border-width** - Tooltip border width _(default: undefined)_\n- **--bq-tooltip--z-index:** - Tooltip z-index _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component wrapper container inside the shadow DOM\n- **trigger** - The `<div>` container that holds the element which displays tooltip on hover\n- **panel** - The `<div>` container that holds the tooltip content",
|