@telesign/boreal-web-components 0.1.0-alpha.3 → 0.1.0-alpha.4
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/components-build/bds-avatar.d.ts +11 -0
- package/components-build/bds-avatar.js +1 -0
- package/components-build/bds-badge.d.ts +11 -0
- package/components-build/bds-badge.js +1 -0
- package/components-build/bds-banner.js +1 -1
- package/components-build/bds-button.js +1 -1
- package/components-build/bds-checkbox.js +1 -1
- package/components-build/bds-dialog.js +1 -1
- package/components-build/bds-divider.d.ts +11 -0
- package/components-build/bds-divider.js +1 -0
- package/components-build/bds-flag.js +1 -1
- package/components-build/bds-grid-item.d.ts +11 -0
- package/components-build/bds-grid-item.js +1 -0
- package/components-build/bds-grid.d.ts +11 -0
- package/components-build/bds-grid.js +1 -0
- package/components-build/bds-list-menu-item.d.ts +11 -0
- package/components-build/bds-list-menu-item.js +1 -0
- package/components-build/bds-list-menu.d.ts +11 -0
- package/components-build/bds-list-menu.js +1 -0
- package/components-build/bds-popover.js +1 -1
- package/components-build/bds-spinner.js +1 -1
- package/components-build/bds-status.d.ts +11 -0
- package/components-build/bds-status.js +1 -0
- package/components-build/bds-tag.d.ts +11 -0
- package/components-build/bds-tag.js +1 -0
- package/components-build/bds-text-field.js +1 -1
- package/components-build/bds-toggle.d.ts +11 -0
- package/components-build/bds-toggle.js +1 -0
- package/components-build/bds-tooltip.js +1 -1
- package/components-build/bds-typography.js +1 -1
- package/components-build/index.js +1 -1
- package/components-build/p-B8n1ru5i.js +1 -0
- package/components-build/p-Bfazyxqi.js +1 -0
- package/components-build/p-CGdxFth9.js +1 -0
- package/components-build/p-CrAt6pGl.js +1 -0
- package/components-build/p-DCwT43Kz.js +1 -0
- package/components-build/p-DIY3CDNL.js +1 -0
- package/components-build/p-DhSchGPI.js +1 -0
- package/components-build/p-kGnB15Lz.js +1 -0
- package/custom-elements.json +2588 -540
- package/dist/boreal-web-components/boreal-web-components.esm.js +1 -1
- package/dist/boreal-web-components/boreal-web-components.js +1 -1
- package/dist/boreal-web-components/css/boreal.css +1066 -1074
- package/dist/boreal-web-components/css/global.css +403 -407
- package/dist/boreal-web-components/css/theme-connect.css +163 -164
- package/dist/boreal-web-components/css/theme-engage.css +163 -164
- package/dist/boreal-web-components/css/theme-protect.css +163 -164
- package/dist/boreal-web-components/css/theme-proximus.css +164 -165
- package/dist/boreal-web-components/p-0028481c.entry.js +1 -0
- package/dist/boreal-web-components/p-127a4134.entry.js +1 -0
- package/dist/boreal-web-components/p-1466de58.system.entry.js +1 -0
- package/dist/boreal-web-components/p-1d1bb9d2.entry.js +1 -0
- package/dist/boreal-web-components/p-2158a7cd.entry.js +1 -0
- package/dist/boreal-web-components/{p-8c57e06a.entry.js → p-251b3002.entry.js} +1 -1
- package/dist/boreal-web-components/p-251d35df.system.entry.js +1 -0
- package/dist/boreal-web-components/{p-fc2cb919.entry.js → p-2b8bd1dd.entry.js} +1 -1
- package/dist/boreal-web-components/p-32c23246.system.entry.js +1 -0
- package/dist/boreal-web-components/p-3fbcc233.entry.js +1 -0
- package/dist/boreal-web-components/p-401f1aee.system.entry.js +1 -0
- package/dist/boreal-web-components/p-41b48701.system.entry.js +1 -0
- package/dist/boreal-web-components/p-41cac1b8.system.entry.js +1 -0
- package/dist/boreal-web-components/p-44ceff4e.system.entry.js +1 -0
- package/dist/boreal-web-components/{p-efe57901.system.entry.js → p-52600375.system.entry.js} +1 -1
- package/dist/boreal-web-components/p-627b19a5.system.entry.js +1 -0
- package/dist/boreal-web-components/p-649737e5.entry.js +1 -0
- package/dist/boreal-web-components/p-64cb5825.entry.js +1 -0
- package/dist/boreal-web-components/p-66360e63.entry.js +1 -0
- package/dist/boreal-web-components/p-695d0830.entry.js +1 -0
- package/dist/boreal-web-components/p-6a99f4c6.system.entry.js +1 -0
- package/dist/boreal-web-components/p-731b88cc.entry.js +1 -0
- package/dist/boreal-web-components/{p-22378341.system.entry.js → p-74c13bed.system.entry.js} +1 -1
- package/dist/boreal-web-components/p-7a4efddd.system.entry.js +1 -0
- package/dist/boreal-web-components/p-7db870b7.entry.js +1 -0
- package/dist/boreal-web-components/p-7f7ac40f.entry.js +1 -0
- package/dist/boreal-web-components/p-80822731.system.entry.js +1 -0
- package/dist/boreal-web-components/p-82d49661.entry.js +1 -0
- package/dist/boreal-web-components/p-83ca193e.entry.js +1 -0
- package/dist/boreal-web-components/p-871c9a9f.system.entry.js +1 -0
- package/dist/boreal-web-components/p-BQ_zoZa2.js +1 -0
- package/dist/boreal-web-components/p-Bfazyxqi.js +1 -0
- package/dist/boreal-web-components/{p-D4EFsvs1.js → p-BqJlOB6b.js} +2 -2
- package/dist/boreal-web-components/p-BsZkk4oK.system.js +1 -0
- package/dist/boreal-web-components/p-CXz1RLGi.system.js +1 -0
- package/dist/boreal-web-components/p-CtknSula.system.js +1 -0
- package/dist/boreal-web-components/p-CvK2d92c.js +1 -0
- package/dist/boreal-web-components/p-CzYQb3pP.js +1 -0
- package/dist/boreal-web-components/p-DCKg5Cg_.system.js +2 -0
- package/dist/boreal-web-components/p-DZcx75cy.system.js +1 -0
- package/dist/boreal-web-components/p-DhSchGPI.js +1 -0
- package/dist/boreal-web-components/{p-BkDQsB4R.system.js → p-Dme-NuTD.system.js} +1 -1
- package/dist/boreal-web-components/p-RhSdMyWk.system.js +1 -0
- package/dist/boreal-web-components/{p-5fa53a80.system.entry.js → p-ab5ffa15.system.entry.js} +1 -1
- package/dist/boreal-web-components/p-b12d4788.system.entry.js +1 -0
- package/dist/boreal-web-components/p-ba2b625a.system.entry.js +1 -0
- package/dist/boreal-web-components/p-bf2ef10b.entry.js +1 -0
- package/dist/boreal-web-components/{p-6de2b44c.system.entry.js → p-c7aee9f4.system.entry.js} +1 -1
- package/dist/boreal-web-components/p-e0bf8a6e.entry.js +1 -0
- package/dist/boreal-web-components/p-edca16b6.system.entry.js +1 -0
- package/dist/boreal-web-components/p-fc24d963.entry.js +1 -0
- package/dist/boreal-web-components/p-kGnB15Lz.js +1 -0
- package/dist/boreal-web-components/p-vzZJGcYF.system.js +1 -0
- package/dist/boreal-web-components/scss/maps/_primitives.scss +404 -408
- package/dist/boreal-web-components/scss/maps/_theme-connect.scss +164 -165
- package/dist/boreal-web-components/scss/maps/_theme-engage.scss +164 -165
- package/dist/boreal-web-components/scss/maps/_theme-protect.scss +164 -165
- package/dist/boreal-web-components/scss/maps/_theme-proximus.scss +165 -166
- package/dist/boreal-web-components/scss/variables/_primitives.scss +404 -408
- package/dist/boreal-web-components/scss/variables/_theme-connect.scss +164 -165
- package/dist/boreal-web-components/scss/variables/_theme-engage.scss +164 -165
- package/dist/boreal-web-components/scss/variables/_theme-protect.scss +164 -165
- package/dist/boreal-web-components/scss/variables/_theme-proximus.scss +165 -166
- package/dist/cjs/BaseAttributes-DBBhKt7O.js +14 -0
- package/dist/cjs/Keys-DbIXSJF2.js +22 -0
- package/dist/cjs/bds-avatar.cjs.entry.js +89 -0
- package/dist/cjs/bds-badge.cjs.entry.js +50 -0
- package/dist/cjs/bds-banner.cjs.entry.js +12 -5
- package/dist/cjs/bds-button.cjs.entry.js +5 -5
- package/dist/cjs/bds-checkbox.cjs.entry.js +6 -6
- package/dist/cjs/bds-dialog.cjs.entry.js +7 -6
- package/dist/cjs/bds-divider.cjs.entry.js +46 -0
- package/dist/cjs/bds-flag.cjs.entry.js +3 -3
- package/dist/cjs/bds-grid-item.cjs.entry.js +93 -0
- package/dist/cjs/bds-grid.cjs.entry.js +37 -0
- package/dist/cjs/bds-list-menu-item.cjs.entry.js +468 -0
- package/dist/cjs/bds-list-menu.cjs.entry.js +130 -0
- package/dist/cjs/bds-popover.cjs.entry.js +17 -8
- package/dist/cjs/bds-spinner.cjs.entry.js +4 -4
- package/dist/cjs/bds-status.cjs.entry.js +59 -0
- package/dist/cjs/bds-tag.cjs.entry.js +140 -0
- package/dist/cjs/bds-text-field.cjs.entry.js +12 -22
- package/dist/cjs/bds-toggle.cjs.entry.js +186 -0
- package/dist/cjs/bds-tooltip_2.cjs.entry.js +320 -0
- package/dist/cjs/boreal-web-components.cjs.js +2 -2
- package/dist/cjs/{anchored.mixin-CnIwkaUi.js → getOffset-m4hBgyVP.js} +42 -26
- package/dist/cjs/{index-BcSjvXJk.js → index-CwYIVC9N.js} +64 -0
- package/dist/cjs/loader.cjs.js +2 -2
- package/dist/cjs/{states-iIYiazaM.js → states-BweP5Vpu.js} +8 -0
- package/dist/cjs/validateProps-CJe9X5x8.js +42 -0
- package/dist/collection/collection-manifest.json +10 -0
- package/dist/collection/components/actions/bds-button/bds-button.js +2 -2
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu/bds-list-menu.css +25 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu/bds-list-menu.js +301 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu-item/bds-list-menu-item.css +71 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu-item/bds-list-menu-item.js +437 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu-item/types/IListMenuItem.js +1 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu-item/types/enum.js +4 -0
- package/dist/collection/components/actions/bds-list-menu/bds-list-menu-item/types/types.js +1 -0
- package/dist/collection/components/actions/bds-toggle/bds-toggle.css +120 -0
- package/dist/collection/components/actions/bds-toggle/bds-toggle.js +544 -0
- package/dist/collection/components/actions/bds-toggle/types/IEventChange.js +1 -0
- package/dist/collection/components/actions/bds-toggle/types/IToggle.js +1 -0
- package/dist/collection/components/actions/bds-toggle/types/enum.js +4 -0
- package/dist/collection/components/actions/bds-toggle/types/index.js +4 -0
- package/dist/collection/components/actions/bds-toggle/types/types.js +1 -0
- package/dist/collection/components/feedback/bds-badge/bds-badge.css +76 -0
- package/dist/collection/components/feedback/bds-badge/bds-badge.js +120 -0
- package/dist/collection/components/feedback/bds-badge/types/IBadge.js +1 -0
- package/dist/collection/components/feedback/bds-badge/types/enum.js +5 -0
- package/dist/collection/components/feedback/bds-banner/bds-banner.css +1 -2
- package/dist/collection/components/feedback/bds-banner/bds-banner.js +30 -6
- package/dist/collection/components/feedback/bds-spinner/bds-spinner.css +7 -8
- package/dist/collection/components/feedback/bds-spinner/bds-spinner.js +1 -1
- package/dist/collection/components/feedback/bds-status/bds-status.css +101 -0
- package/dist/collection/components/feedback/bds-status/bds-status.js +122 -0
- package/dist/collection/components/feedback/bds-status/types/IStatus.js +1 -0
- package/dist/collection/components/feedback/bds-status/types/enum.js +5 -0
- package/dist/collection/components/feedback/bds-status/types/types.js +1 -0
- package/dist/collection/components/feedback/bds-tag/bds-tag.css +202 -0
- package/dist/collection/components/feedback/bds-tag/bds-tag.js +375 -0
- package/dist/collection/components/feedback/bds-tag/types/ITag.js +1 -0
- package/dist/collection/components/feedback/bds-tag/types/enum.js +10 -0
- package/dist/collection/components/feedback/bds-tag/types/index.js +3 -0
- package/dist/collection/components/feedback/bds-tag/types/types.js +1 -0
- package/dist/collection/components/forms/bds-checkbox/bds-checkbox.js +1 -1
- package/dist/collection/components/forms/bds-flag/bds-flag.js +1 -1
- package/dist/collection/components/forms/bds-text-field/bds-text-field.js +1 -1
- package/dist/collection/components/helpers/bds-divider.css +36 -0
- package/dist/collection/components/helpers/bds-divider.js +88 -0
- package/dist/collection/components/helpers/types/IDivider.js +1 -0
- package/dist/collection/components/helpers/types/enum.js +4 -0
- package/dist/collection/components/helpers/types/types.js +1 -0
- package/dist/collection/components/images-icons/bds-avatar/bds-avatar.css +52 -0
- package/dist/collection/components/images-icons/bds-avatar/bds-avatar.js +219 -0
- package/dist/collection/components/images-icons/bds-avatar/types/IAvatar.js +1 -0
- package/dist/collection/components/images-icons/bds-avatar/types/enum.js +5 -0
- package/dist/collection/components/images-icons/bds-avatar/types/index.js +3 -0
- package/dist/collection/components/images-icons/bds-avatar/types/types.js +1 -0
- package/dist/collection/components/layouts/bds-grid/grid/bds-grid.css +57 -0
- package/dist/collection/components/layouts/bds-grid/grid/bds-grid.js +100 -0
- package/dist/collection/components/layouts/bds-grid/grid/types/IGrid.js +1 -0
- package/dist/collection/components/layouts/bds-grid/grid/types/enum.js +4 -0
- package/dist/collection/components/layouts/bds-grid/grid/types/index.js +3 -0
- package/dist/collection/components/layouts/bds-grid/grid/types/types.js +1 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/bds-grid-item.css +70 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/bds-grid-item.js +306 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/types/IGridItem.js +1 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/types/enum.js +10 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/types/index.js +3 -0
- package/dist/collection/components/layouts/bds-grid/grid-item/types/types.js +1 -0
- package/dist/collection/components/overlays/bds-dialog/bds-dialog.js +4 -3
- package/dist/collection/components/overlays/bds-popover/bds-popover.css +16 -2
- package/dist/collection/components/overlays/bds-popover/bds-popover.js +12 -4
- package/dist/collection/components/overlays/bds-popover/constants/Offset.js +1 -0
- package/dist/collection/components/overlays/bds-tooltip/bds-tooltip.css +2 -13
- package/dist/collection/components/overlays/bds-tooltip/bds-tooltip.js +4 -2
- package/dist/collection/components/overlays/bds-tooltip/constants/Offset.js +1 -0
- package/dist/collection/components/titles-text/bds-typography/bds-typography.css +4 -0
- package/dist/collection/components/titles-text/bds-typography/bds-typography.js +20 -19
- package/dist/collection/components/titles-text/bds-typography/utils/bds-typography-utils.js +2 -2
- package/dist/collection/css/boreal.css +1066 -1074
- package/dist/collection/css/global.css +403 -407
- package/dist/collection/css/theme-connect.css +163 -164
- package/dist/collection/css/theme-engage.css +163 -164
- package/dist/collection/css/theme-protect.css +163 -164
- package/dist/collection/css/theme-proximus.css +164 -165
- package/dist/collection/mixins/anchored.mixin.js +14 -1
- package/dist/collection/mixins/index.js +2 -0
- package/dist/collection/mixins/links.mixin.js +153 -0
- package/dist/collection/mixins/menu-behavior.mixin.js +113 -0
- package/dist/collection/scss/maps/_primitives.scss +404 -408
- package/dist/collection/scss/maps/_theme-connect.scss +164 -165
- package/dist/collection/scss/maps/_theme-engage.scss +164 -165
- package/dist/collection/scss/maps/_theme-protect.scss +164 -165
- package/dist/collection/scss/maps/_theme-proximus.scss +165 -166
- package/dist/collection/scss/variables/_primitives.scss +404 -408
- package/dist/collection/scss/variables/_theme-connect.scss +164 -165
- package/dist/collection/scss/variables/_theme-engage.scss +164 -165
- package/dist/collection/scss/variables/_theme-protect.scss +164 -165
- package/dist/collection/scss/variables/_theme-proximus.scss +165 -166
- package/dist/collection/services/floating/positioning.service.js +1 -1
- package/dist/collection/types/IFormProps.js +1 -0
- package/dist/collection/types/index.js +3 -0
- package/dist/collection/types/links.js +1 -0
- package/dist/collection/types/menu.js +8 -0
- package/dist/collection/types/position.js +6 -2
- package/dist/collection/utils/constants/common/Keys.js +12 -0
- package/dist/collection/utils/helpers/overlays/getOffset.js +13 -0
- package/dist/collection/utils/helpers/validateProps.js +21 -0
- package/dist/collection/utils/index.js +2 -1
- package/dist/collection/utils/menu/index.js +1 -0
- package/dist/collection/utils/menu/menu-item.utils.js +81 -0
- package/dist/collection/utils/{__test__ → testing}/index.js +0 -2
- package/dist/collection/utils/testing/mocks/console.js +30 -0
- package/dist/collection/utils/testing/mocks/index.js +4 -0
- package/dist/css/boreal.css +1066 -1074
- package/dist/css/global.css +403 -407
- package/dist/css/theme-connect.css +163 -164
- package/dist/css/theme-engage.css +163 -164
- package/dist/css/theme-protect.css +163 -164
- package/dist/css/theme-proximus.css +164 -165
- package/dist/esm/BaseAttributes-DhSchGPI.js +12 -0
- package/dist/esm/Keys-CzYQb3pP.js +20 -0
- package/dist/esm/bds-avatar.entry.js +87 -0
- package/dist/esm/bds-badge.entry.js +48 -0
- package/dist/esm/bds-banner.entry.js +12 -5
- package/dist/esm/bds-button.entry.js +5 -5
- package/dist/esm/bds-checkbox.entry.js +3 -3
- package/dist/esm/bds-dialog.entry.js +7 -6
- package/dist/esm/bds-divider.entry.js +44 -0
- package/dist/esm/bds-flag.entry.js +3 -3
- package/dist/esm/bds-grid-item.entry.js +91 -0
- package/dist/esm/bds-grid.entry.js +35 -0
- package/dist/esm/bds-list-menu-item.entry.js +466 -0
- package/dist/esm/bds-list-menu.entry.js +128 -0
- package/dist/esm/bds-popover.entry.js +16 -7
- package/dist/esm/bds-spinner.entry.js +4 -4
- package/dist/esm/bds-status.entry.js +57 -0
- package/dist/esm/bds-tag.entry.js +138 -0
- package/dist/esm/bds-text-field.entry.js +5 -15
- package/dist/esm/bds-toggle.entry.js +184 -0
- package/dist/esm/bds-tooltip_2.entry.js +317 -0
- package/dist/esm/boreal-web-components.js +3 -3
- package/dist/esm/{anchored.mixin-Y3MkGc2X.js → getOffset-DKPjeBHi.js} +40 -25
- package/dist/esm/{index-D4EFsvs1.js → index-BqJlOB6b.js} +64 -0
- package/dist/esm/loader.js +3 -3
- package/dist/esm/{states-BhTPNsBb.js → states-Bfazyxqi.js} +8 -1
- package/dist/esm/validateProps-kGnB15Lz.js +39 -0
- package/dist/esm-es5/BaseAttributes-DhSchGPI.js +1 -0
- package/dist/esm-es5/Keys-CzYQb3pP.js +1 -0
- package/dist/esm-es5/bds-avatar.entry.js +1 -0
- package/dist/esm-es5/bds-badge.entry.js +1 -0
- package/dist/esm-es5/bds-banner.entry.js +1 -1
- package/dist/esm-es5/bds-button.entry.js +1 -1
- package/dist/esm-es5/bds-checkbox.entry.js +1 -1
- package/dist/esm-es5/bds-dialog.entry.js +1 -1
- package/dist/esm-es5/bds-divider.entry.js +1 -0
- package/dist/esm-es5/bds-flag.entry.js +1 -1
- package/dist/esm-es5/bds-grid-item.entry.js +1 -0
- package/dist/esm-es5/bds-grid.entry.js +1 -0
- package/dist/esm-es5/bds-list-menu-item.entry.js +1 -0
- package/dist/esm-es5/bds-list-menu.entry.js +1 -0
- package/dist/esm-es5/bds-popover.entry.js +1 -1
- package/dist/esm-es5/bds-spinner.entry.js +1 -1
- package/dist/esm-es5/bds-status.entry.js +1 -0
- package/dist/esm-es5/bds-tag.entry.js +1 -0
- package/dist/esm-es5/bds-text-field.entry.js +1 -1
- package/dist/esm-es5/bds-toggle.entry.js +1 -0
- package/dist/esm-es5/bds-tooltip_2.entry.js +1 -0
- package/dist/esm-es5/boreal-web-components.js +1 -1
- package/dist/esm-es5/form-associated.mixin-CvK2d92c.js +1 -0
- package/dist/esm-es5/getOffset-DKPjeBHi.js +1 -0
- package/dist/esm-es5/index-BqJlOB6b.js +2 -0
- package/dist/esm-es5/loader.js +1 -1
- package/dist/esm-es5/states-Bfazyxqi.js +1 -0
- package/dist/esm-es5/validateProps-kGnB15Lz.js +1 -0
- package/dist/scss/maps/_primitives.scss +404 -408
- package/dist/scss/maps/_theme-connect.scss +164 -165
- package/dist/scss/maps/_theme-engage.scss +164 -165
- package/dist/scss/maps/_theme-protect.scss +164 -165
- package/dist/scss/maps/_theme-proximus.scss +165 -166
- package/dist/scss/variables/_primitives.scss +404 -408
- package/dist/scss/variables/_theme-connect.scss +164 -165
- package/dist/scss/variables/_theme-engage.scss +164 -165
- package/dist/scss/variables/_theme-protect.scss +164 -165
- package/dist/scss/variables/_theme-proximus.scss +165 -166
- package/dist/types/components/actions/bds-list-menu/bds-list-menu/bds-list-menu.d.ts +70 -0
- package/dist/types/components/actions/bds-list-menu/bds-list-menu-item/bds-list-menu-item.d.ts +116 -0
- package/dist/types/components/actions/bds-list-menu/bds-list-menu-item/types/IListMenuItem.d.ts +12 -0
- package/dist/types/components/actions/bds-list-menu/bds-list-menu-item/types/enum.d.ts +5 -0
- package/dist/types/components/actions/bds-list-menu/bds-list-menu-item/types/types.d.ts +3 -0
- package/dist/types/components/actions/bds-toggle/bds-toggle.d.ts +91 -0
- package/dist/types/components/actions/bds-toggle/types/IEventChange.d.ts +5 -0
- package/dist/types/components/actions/bds-toggle/types/IToggle.d.ts +12 -0
- package/dist/types/components/actions/bds-toggle/types/enum.d.ts +5 -0
- package/dist/types/components/actions/bds-toggle/types/index.d.ts +5 -0
- package/dist/types/components/actions/bds-toggle/types/types.d.ts +3 -0
- package/dist/types/components/feedback/bds-badge/bds-badge.d.ts +31 -0
- package/dist/types/components/feedback/bds-badge/types/IBadge.d.ts +6 -0
- package/dist/types/components/feedback/bds-badge/types/enum.d.ts +9 -0
- package/dist/types/components/feedback/bds-banner/bds-banner.d.ts +8 -4
- package/dist/types/components/feedback/bds-status/bds-status.d.ts +26 -0
- package/dist/types/components/feedback/bds-status/types/IStatus.d.ts +7 -0
- package/dist/types/components/feedback/bds-status/types/enum.d.ts +6 -0
- package/dist/types/components/feedback/bds-status/types/types.d.ts +3 -0
- package/dist/types/components/feedback/bds-tag/bds-tag.d.ts +71 -0
- package/dist/types/components/feedback/bds-tag/types/ITag.d.ts +13 -0
- package/dist/types/components/feedback/bds-tag/types/enum.d.ts +11 -0
- package/dist/types/components/feedback/bds-tag/types/index.d.ts +4 -0
- package/dist/types/components/feedback/bds-tag/types/types.d.ts +8 -0
- package/dist/types/components/forms/bds-flag/bds-flag.d.ts +3 -4
- package/dist/types/components/helpers/bds-divider.d.ts +26 -0
- package/dist/types/components/helpers/types/IDivider.d.ts +5 -0
- package/dist/types/components/helpers/types/enum.d.ts +5 -0
- package/dist/types/components/helpers/types/types.d.ts +3 -0
- package/dist/types/components/images-icons/bds-avatar/bds-avatar.d.ts +51 -0
- package/dist/types/components/images-icons/bds-avatar/types/IAvatar.d.ts +9 -0
- package/dist/types/components/images-icons/bds-avatar/types/enum.d.ts +6 -0
- package/dist/types/components/images-icons/bds-avatar/types/index.d.ts +4 -0
- package/dist/types/components/images-icons/bds-avatar/types/types.d.ts +3 -0
- package/dist/types/components/layouts/bds-grid/grid/bds-grid.d.ts +19 -0
- package/dist/types/components/layouts/bds-grid/grid/types/IGrid.d.ts +6 -0
- package/dist/types/components/layouts/bds-grid/grid/types/enum.d.ts +5 -0
- package/dist/types/components/layouts/bds-grid/grid/types/index.d.ts +4 -0
- package/dist/types/components/layouts/bds-grid/grid/types/types.d.ts +3 -0
- package/dist/types/components/layouts/bds-grid/grid-item/bds-grid-item.d.ts +31 -0
- package/dist/types/components/layouts/bds-grid/grid-item/types/IGridItem.d.ts +12 -0
- package/dist/types/components/layouts/bds-grid/grid-item/types/enum.d.ts +11 -0
- package/dist/types/components/layouts/bds-grid/grid-item/types/index.d.ts +4 -0
- package/dist/types/components/layouts/bds-grid/grid-item/types/types.d.ts +3 -0
- package/dist/types/components/overlays/bds-dialog/bds-dialog.d.ts +2 -2
- package/dist/types/components/overlays/bds-popover/bds-popover.d.ts +1 -0
- package/dist/types/components/overlays/bds-popover/constants/Offset.d.ts +2 -0
- package/dist/types/components/overlays/bds-tooltip/bds-tooltip.d.ts +1 -0
- package/dist/types/components/overlays/bds-tooltip/constants/Offset.d.ts +2 -0
- package/dist/types/components/titles-text/bds-typography/bds-typography.d.ts +9 -9
- package/dist/types/components/titles-text/bds-typography/types/ITypography.d.ts +2 -2
- package/dist/types/components/titles-text/bds-typography/utils/bds-typography-utils.d.ts +1 -1
- package/dist/types/components.d.ts +1268 -54
- package/dist/types/mixins/anchored.mixin.d.ts +5 -0
- package/dist/types/mixins/index.d.ts +2 -0
- package/dist/types/mixins/links.mixin.d.ts +85 -0
- package/dist/types/mixins/menu-behavior.mixin.d.ts +91 -0
- package/dist/types/types/IFormProps.d.ts +25 -0
- package/dist/types/types/index.d.ts +3 -0
- package/dist/types/types/links.d.ts +14 -0
- package/dist/types/types/menu.d.ts +16 -0
- package/dist/types/types/position.d.ts +6 -2
- package/dist/types/utils/constants/common/Keys.d.ts +7 -6
- package/dist/types/utils/helpers/overlays/getOffset.d.ts +9 -0
- package/dist/types/utils/helpers/validateProps.d.ts +11 -0
- package/dist/types/utils/index.d.ts +2 -1
- package/dist/types/utils/menu/index.d.ts +2 -0
- package/dist/types/utils/menu/menu-item.utils.d.ts +50 -0
- package/dist/types/utils/{__test__ → testing}/index.d.ts +0 -2
- package/dist/types/utils/{__test__/backdrop-mock.d.ts → testing/mocks/backdrop.d.ts} +1 -1
- package/dist/types/utils/testing/mocks/console.d.ts +17 -0
- package/dist/types/utils/{__test__/mocks/ElementInternals.d.ts → testing/mocks/elementInternals.d.ts} +1 -1
- package/dist/types/utils/testing/mocks/index.d.ts +5 -0
- package/dist/types/utils/{__test__/popover-mock.d.ts → testing/mocks/popover.d.ts} +1 -1
- package/package.json +1 -1
- package/components-build/p-B6R9EVXK.js +0 -1
- package/components-build/p-BSpJ_e9f.js +0 -1
- package/components-build/p-BYEAJCas.js +0 -1
- package/components-build/p-BhTPNsBb.js +0 -1
- package/components-build/p-CYojP4vI.js +0 -1
- package/components-build/p-D5omSME4.js +0 -1
- package/components-build/p-vfAIdwy0.js +0 -1
- package/dist/boreal-web-components/p-07a933df.entry.js +0 -1
- package/dist/boreal-web-components/p-1bb2b33f.entry.js +0 -1
- package/dist/boreal-web-components/p-1fccea3f.system.entry.js +0 -1
- package/dist/boreal-web-components/p-20af732b.system.entry.js +0 -1
- package/dist/boreal-web-components/p-39c26e58.entry.js +0 -1
- package/dist/boreal-web-components/p-6210d025.entry.js +0 -1
- package/dist/boreal-web-components/p-91b9e94e.entry.js +0 -1
- package/dist/boreal-web-components/p-9e06910d.system.entry.js +0 -1
- package/dist/boreal-web-components/p-BIJhHSAt.system.js +0 -1
- package/dist/boreal-web-components/p-BKRyWlfr.js +0 -1
- package/dist/boreal-web-components/p-BhTPNsBb.js +0 -1
- package/dist/boreal-web-components/p-DoDeP7KR.system.js +0 -1
- package/dist/boreal-web-components/p-Dtp4O0H2.system.js +0 -1
- package/dist/boreal-web-components/p-Dy7QKP9e.js +0 -1
- package/dist/boreal-web-components/p-GjKJvOVG.system.js +0 -2
- package/dist/boreal-web-components/p-ac64d4a5.system.entry.js +0 -1
- package/dist/boreal-web-components/p-b61fe06c.entry.js +0 -1
- package/dist/boreal-web-components/p-cdc87437.entry.js +0 -1
- package/dist/boreal-web-components/p-d8ec8557.system.entry.js +0 -1
- package/dist/boreal-web-components/p-ea889727.entry.js +0 -1
- package/dist/boreal-web-components/p-fa327346.system.entry.js +0 -1
- package/dist/boreal-web-components/p-sDZFaZMN.system.js +0 -1
- package/dist/boreal-web-components/p-vfAIdwy0.js +0 -1
- package/dist/cjs/bds-tooltip.cjs.entry.js +0 -152
- package/dist/cjs/bds-typography.cjs.entry.js +0 -168
- package/dist/cjs/validateProps-BNOBk1Xs.js +0 -20
- package/dist/collection/utils/__test__/mocks/index.js +0 -1
- package/dist/esm/bds-tooltip.entry.js +0 -150
- package/dist/esm/bds-typography.entry.js +0 -166
- package/dist/esm/validateProps-vfAIdwy0.js +0 -18
- package/dist/esm-es5/anchored.mixin-Y3MkGc2X.js +0 -1
- package/dist/esm-es5/bds-tooltip.entry.js +0 -1
- package/dist/esm-es5/bds-typography.entry.js +0 -1
- package/dist/esm-es5/index-D4EFsvs1.js +0 -2
- package/dist/esm-es5/internals-Dy7QKP9e.js +0 -1
- package/dist/esm-es5/states-BhTPNsBb.js +0 -1
- package/dist/esm-es5/validateProps-vfAIdwy0.js +0 -1
- package/dist/types/utils/__test__/mocks/index.d.ts +0 -2
- package/dist/cjs/{internals-X77qKxsK.js → form-associated.mixin-DXwvF_vW.js} +30 -30
- package/dist/collection/utils/{__test__ → testing}/constants.js +0 -0
- package/dist/collection/utils/{__test__ → testing}/fixtures.js +0 -0
- package/dist/collection/utils/{__test__ → testing}/helpers.js +0 -0
- package/dist/collection/utils/{__test__/backdrop-mock.js → testing/mocks/backdrop.js} +0 -0
- package/dist/collection/utils/{__test__/mocks/ElementInternals.js → testing/mocks/elementInternals.js} +0 -0
- package/dist/collection/utils/{__test__/popover-mock.js → testing/mocks/popover.js} +0 -0
- package/dist/esm/{internals-Dy7QKP9e.js → form-associated.mixin-CvK2d92c.js} +30 -30
- /package/dist/types/utils/{__test__ → testing}/constants.d.ts +0 -0
- /package/dist/types/utils/{__test__ → testing}/fixtures.d.ts +0 -0
- /package/dist/types/utils/{__test__ → testing}/helpers.d.ts +0 -0
|
@@ -5,33 +5,110 @@
|
|
|
5
5
|
* It contains typing information for all components that exist in this project.
|
|
6
6
|
*/
|
|
7
7
|
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
|
|
8
|
+
import { IAvatar } from "./components/images-icons/bds-avatar/types";
|
|
9
|
+
import { IBadge } from "./components/feedback/bds-badge/types/IBadge";
|
|
8
10
|
import { IBanner } from "./components/feedback/bds-banner/types/IBanner";
|
|
9
11
|
import { IButton } from "./components/actions/bds-button/types/IButton";
|
|
10
12
|
import { CheckboxChangeDetail } from "./components/forms/bds-checkbox/types/ICheckbox";
|
|
11
13
|
import { IDialog } from "./components/overlays/bds-dialog/types";
|
|
14
|
+
import { IDivider } from "./components/helpers/types/IDivider";
|
|
12
15
|
import { IFlag } from "./components/forms/bds-flag/interfaces/IFlag";
|
|
16
|
+
import { IGrid } from "./components/layouts/bds-grid/grid/types";
|
|
17
|
+
import { IGridItem } from "./components/layouts/bds-grid/grid-item/types";
|
|
18
|
+
import { IListMenuItem, IListMenuItemEvent } from "./components/actions/bds-list-menu/bds-list-menu-item/types/IListMenuItem";
|
|
13
19
|
import { IPopover } from "./components/overlays/bds-popover/types/IPopover";
|
|
14
20
|
import { ISpinner } from "./components/feedback/bds-spinner/types/ISpinner";
|
|
21
|
+
import { IStatus } from "./components/feedback/bds-status/types/IStatus";
|
|
22
|
+
import { ITag, TagEventPayload } from "./components/feedback/bds-tag/types";
|
|
15
23
|
import { IFormValidator } from "./types/index";
|
|
16
24
|
import { TextFieldType, TextFieldValidationTiming, TextFieldVariant } from "./components/forms/bds-text-field/types";
|
|
17
25
|
import { Event } from "./stencil-public-runtime";
|
|
26
|
+
import { IToggle } from "./components/actions/bds-toggle/types";
|
|
27
|
+
import { IToggleEventChange } from "./components/actions/bds-toggle/types/IEventChange";
|
|
18
28
|
import { ITooltip } from "./components/overlays/bds-tooltip/types/ITooltip";
|
|
19
29
|
import { FloatingTooltipProp } from "./services/index";
|
|
20
30
|
import { ITypography } from "./components/titles-text/bds-typography/types/ITypography";
|
|
31
|
+
export { IAvatar } from "./components/images-icons/bds-avatar/types";
|
|
32
|
+
export { IBadge } from "./components/feedback/bds-badge/types/IBadge";
|
|
21
33
|
export { IBanner } from "./components/feedback/bds-banner/types/IBanner";
|
|
22
34
|
export { IButton } from "./components/actions/bds-button/types/IButton";
|
|
23
35
|
export { CheckboxChangeDetail } from "./components/forms/bds-checkbox/types/ICheckbox";
|
|
24
36
|
export { IDialog } from "./components/overlays/bds-dialog/types";
|
|
37
|
+
export { IDivider } from "./components/helpers/types/IDivider";
|
|
25
38
|
export { IFlag } from "./components/forms/bds-flag/interfaces/IFlag";
|
|
39
|
+
export { IGrid } from "./components/layouts/bds-grid/grid/types";
|
|
40
|
+
export { IGridItem } from "./components/layouts/bds-grid/grid-item/types";
|
|
41
|
+
export { IListMenuItem, IListMenuItemEvent } from "./components/actions/bds-list-menu/bds-list-menu-item/types/IListMenuItem";
|
|
26
42
|
export { IPopover } from "./components/overlays/bds-popover/types/IPopover";
|
|
27
43
|
export { ISpinner } from "./components/feedback/bds-spinner/types/ISpinner";
|
|
44
|
+
export { IStatus } from "./components/feedback/bds-status/types/IStatus";
|
|
45
|
+
export { ITag, TagEventPayload } from "./components/feedback/bds-tag/types";
|
|
28
46
|
export { IFormValidator } from "./types/index";
|
|
29
47
|
export { TextFieldType, TextFieldValidationTiming, TextFieldVariant } from "./components/forms/bds-text-field/types";
|
|
30
48
|
export { Event } from "./stencil-public-runtime";
|
|
49
|
+
export { IToggle } from "./components/actions/bds-toggle/types";
|
|
50
|
+
export { IToggleEventChange } from "./components/actions/bds-toggle/types/IEventChange";
|
|
31
51
|
export { ITooltip } from "./components/overlays/bds-tooltip/types/ITooltip";
|
|
32
52
|
export { FloatingTooltipProp } from "./services/index";
|
|
33
53
|
export { ITypography } from "./components/titles-text/bds-typography/types/ITypography";
|
|
34
54
|
export namespace Components {
|
|
55
|
+
/**
|
|
56
|
+
* Avatar component used to display user initials or names for visual identification.
|
|
57
|
+
* @summary Displays a circular avatar with user initials and optional name label.
|
|
58
|
+
* Uses Boreal Design System tokens for consistent styling across platforms.
|
|
59
|
+
* @attr {string} username - The full name used to generate initials or display as label.
|
|
60
|
+
* @attr {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
61
|
+
* @attr {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
62
|
+
* @attr {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
63
|
+
* @property {string} username - The full name used to generate initials or display as label.
|
|
64
|
+
* @property {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
65
|
+
* @property {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
66
|
+
* @property {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
67
|
+
* @cssprop --bds-avatar-background - Custom background color HEX code.
|
|
68
|
+
* @cssprop --bds-avatar-initials-color - Custom text color HEX code.
|
|
69
|
+
*/
|
|
70
|
+
interface BdsAvatar {
|
|
71
|
+
/**
|
|
72
|
+
* Custom background color as hex code. If not provided, defaults to Boreal success color *
|
|
73
|
+
* @default ''
|
|
74
|
+
*/
|
|
75
|
+
"background": IAvatar['background'];
|
|
76
|
+
/**
|
|
77
|
+
* Custom text color as hex code. If not provided, defaults to white *
|
|
78
|
+
* @default ''
|
|
79
|
+
*/
|
|
80
|
+
"initialsColor": IAvatar['initialsColor'];
|
|
81
|
+
/**
|
|
82
|
+
* The full name used to generate initials or display as label *
|
|
83
|
+
* @default ''
|
|
84
|
+
*/
|
|
85
|
+
"username": IAvatar['username'];
|
|
86
|
+
/**
|
|
87
|
+
* Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
88
|
+
* @default 'full'
|
|
89
|
+
*/
|
|
90
|
+
"variant": IAvatar['variant'];
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Badge component for displaying contextual status information with optional icon support.
|
|
94
|
+
* @summary A compact label component that communicates status or category using color-coded variants. Supports an optional icon slot and a disabled state.
|
|
95
|
+
* @attr {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
96
|
+
* @attr {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
97
|
+
* @property {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
98
|
+
* @property {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
99
|
+
*/
|
|
100
|
+
interface BdsBadge {
|
|
101
|
+
/**
|
|
102
|
+
* Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
103
|
+
* @default false
|
|
104
|
+
*/
|
|
105
|
+
"disabled": IBadge['disabled'];
|
|
106
|
+
/**
|
|
107
|
+
* Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
108
|
+
* @default BADGE_VARIANT.DEFAULT
|
|
109
|
+
*/
|
|
110
|
+
"variant": IBadge['variant'];
|
|
111
|
+
}
|
|
35
112
|
/**
|
|
36
113
|
* Banner component used to display important messages with different status variants.
|
|
37
114
|
* @summary Displays a dismissible banner with an icon, title, body content, and optional actions.
|
|
@@ -40,8 +117,8 @@ export namespace Components {
|
|
|
40
117
|
* @property {"info"|"success"|"warning"|"danger"} variant - Visual style variant: 'info', 'success', 'warning', or 'danger'. Defaults to "info".
|
|
41
118
|
* @property {boolean} closable - Shows a close button that allows users to close the banner. Defaults to false.
|
|
42
119
|
* @property {boolean} closeButtonLabel - Aria label for the close button when visible.
|
|
43
|
-
* @fires bdsClose - Emitted when the banner is closed via the close button or `
|
|
44
|
-
* @method
|
|
120
|
+
* @fires bdsClose - Emitted when the banner is closed via the close button or `close` method.
|
|
121
|
+
* @method close - Programmatic method to close the banner and emit the `bdsClose` event.
|
|
45
122
|
*/
|
|
46
123
|
interface BdsBanner {
|
|
47
124
|
/**
|
|
@@ -52,12 +129,16 @@ export namespace Components {
|
|
|
52
129
|
/**
|
|
53
130
|
* Programmatic method to close the banner and emit the `bdsClose` event
|
|
54
131
|
*/
|
|
55
|
-
"
|
|
132
|
+
"close": () => Promise<void>;
|
|
56
133
|
/**
|
|
57
134
|
* The aria label for the close button.
|
|
58
135
|
* @default ""
|
|
59
136
|
*/
|
|
60
137
|
"closeButtonLabel": IBanner['closeButtonLabel'];
|
|
138
|
+
/**
|
|
139
|
+
* Programmatic method to close the banner and emit the `bdsClose` event
|
|
140
|
+
*/
|
|
141
|
+
"open": () => Promise<void>;
|
|
61
142
|
/**
|
|
62
143
|
* Visual style variant: 'info', 'success', 'warning', or 'danger'.
|
|
63
144
|
* @default "info"
|
|
@@ -305,6 +386,20 @@ export namespace Components {
|
|
|
305
386
|
*/
|
|
306
387
|
"width": IDialog['width'];
|
|
307
388
|
}
|
|
389
|
+
/**
|
|
390
|
+
* Divider component for creating visual separators between content sections.
|
|
391
|
+
* @summary A simple visual separator that can be oriented horizontally or vertically.
|
|
392
|
+
* @csspart divider - A divider element that visually separates content.
|
|
393
|
+
* @attr {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
394
|
+
* @property {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
395
|
+
*/
|
|
396
|
+
interface BdsDivider {
|
|
397
|
+
/**
|
|
398
|
+
* The orientation of the divider. Allowed values: horizontal | vertical
|
|
399
|
+
* @default DIVIDER_ORIENTATIONS.HORIZONTAL
|
|
400
|
+
*/
|
|
401
|
+
"orientation": IDivider['orientation'];
|
|
402
|
+
}
|
|
308
403
|
/**
|
|
309
404
|
* Flag component used to display a country flag together with its corresponding label.
|
|
310
405
|
* @summary Renders a flag icon based on a country identifier and optionally displays
|
|
@@ -369,6 +464,179 @@ export namespace Components {
|
|
|
369
464
|
*/
|
|
370
465
|
"shortName": IFlag['shortName'];
|
|
371
466
|
}
|
|
467
|
+
/**
|
|
468
|
+
* 12-column CSS Grid layout container with 5 responsive breakpoints.
|
|
469
|
+
* Minimum browser support: Chrome/Edge (last 2), Firefox (last 2), Safari (last 2).
|
|
470
|
+
*/
|
|
471
|
+
interface BdsGrid {
|
|
472
|
+
/**
|
|
473
|
+
* `'fluid'` fills full width; `'fixed'` caps the column area at 960px and centres the container.
|
|
474
|
+
* @default GRID_LAYOUT.FLUID
|
|
475
|
+
*/
|
|
476
|
+
"layout": IGrid['layout'];
|
|
477
|
+
/**
|
|
478
|
+
* Overrides the row gap independently of the column gutter.
|
|
479
|
+
*/
|
|
480
|
+
"rowGap": IGrid['rowGap'];
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* Grid item child of `bds-grid`. Must be a direct child of `bds-grid`.
|
|
484
|
+
*/
|
|
485
|
+
interface BdsGridItem {
|
|
486
|
+
/**
|
|
487
|
+
* Column span at all breakpoints (fallback). `'full'` spans all columns (`grid-column: 1 / -1`).
|
|
488
|
+
* @default GRID_ITEM_COL_SPAN.DEFAULT
|
|
489
|
+
*/
|
|
490
|
+
"colSpan": IGridItem['colSpan'];
|
|
491
|
+
/**
|
|
492
|
+
* Override col-span at the `2xl` breakpoint (≥1344px).
|
|
493
|
+
*/
|
|
494
|
+
"colSpan2xl": IGridItem['colSpan2xl'];
|
|
495
|
+
/**
|
|
496
|
+
* Override col-span at the `lg` breakpoint (≥960px).
|
|
497
|
+
*/
|
|
498
|
+
"colSpanLg": IGridItem['colSpanLg'];
|
|
499
|
+
/**
|
|
500
|
+
* Override col-span at the `md` breakpoint (≥769px).
|
|
501
|
+
*/
|
|
502
|
+
"colSpanMd": IGridItem['colSpanMd'];
|
|
503
|
+
/**
|
|
504
|
+
* Override col-span at the `sm` breakpoint (≥320px).
|
|
505
|
+
*/
|
|
506
|
+
"colSpanSm": IGridItem['colSpanSm'];
|
|
507
|
+
/**
|
|
508
|
+
* Override col-span at the `xl` breakpoint (≥1152px).
|
|
509
|
+
*/
|
|
510
|
+
"colSpanXl": IGridItem['colSpanXl'];
|
|
511
|
+
/**
|
|
512
|
+
* Column offset: shifts the item right by N columns (0–11).
|
|
513
|
+
* @default 0
|
|
514
|
+
*/
|
|
515
|
+
"offset": IGridItem['offset'];
|
|
516
|
+
/**
|
|
517
|
+
* Row span. `'full'` maps to `grid-row: 1 / -1`.
|
|
518
|
+
*/
|
|
519
|
+
"rowSpan": IGridItem['rowSpan'];
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* Container component that manages a list of menu items.
|
|
523
|
+
* It handles selection logic (single/multiple) and maintains the data state.
|
|
524
|
+
* @summary A list menu component that can contain multiple menu items and manage their selection state.
|
|
525
|
+
* @attr {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
526
|
+
* @attr {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
527
|
+
* @property {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
528
|
+
* @property {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
529
|
+
* @event bdsChange - Emitted when the selection changes, providing the current selected value(s).
|
|
530
|
+
* @method getSelectedValues - Returns the currently selected value(s). If multiple is true, returns an array of strings; otherwise, returns a single string or undefined.
|
|
531
|
+
* @method setSelectedValues - Sets the selected value(s). Accepts a string for single selection or an array of strings for multiple selection.
|
|
532
|
+
* @default false - By default, the menu does not allow multiple selections (single selection mode).
|
|
533
|
+
* @default 'menu' - The default ARIA role for the menu is 'menu'.
|
|
534
|
+
*/
|
|
535
|
+
interface BdsListMenu {
|
|
536
|
+
/**
|
|
537
|
+
* Retrieves the currently selected value(s) programmatically.
|
|
538
|
+
* @method getSelectedValues
|
|
539
|
+
* @returns The selected value(s) based on the 'multiple' prop.
|
|
540
|
+
*/
|
|
541
|
+
"getSelectedValues": () => Promise<string | string[]>;
|
|
542
|
+
/**
|
|
543
|
+
* Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
544
|
+
* @default 'menu'
|
|
545
|
+
*/
|
|
546
|
+
"menuRole": 'menu' | 'listbox';
|
|
547
|
+
/**
|
|
548
|
+
* If true, allows multiple items to be selected. Default is false (single selection).
|
|
549
|
+
* @default false
|
|
550
|
+
*/
|
|
551
|
+
"multiple": boolean;
|
|
552
|
+
/**
|
|
553
|
+
* Sets the selected values programmatically. Useful for initializing the menu from an external data source or form reset.
|
|
554
|
+
* @method setSelectedValues
|
|
555
|
+
* @param values - The value or values to be marked as selected.
|
|
556
|
+
*/
|
|
557
|
+
"setSelectedValues": (values: string | string[]) => Promise<void>;
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
* Component representing an individual item within a list menu for navigations and selection.
|
|
561
|
+
* @summary A menu item component that supports different variants, disabled state, and selection state, it also supports link behavior when the href prop is provided.
|
|
562
|
+
* @attr {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
563
|
+
* @attr {string} name - The name of the list menu item.
|
|
564
|
+
* @attr {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
565
|
+
* @attr {boolean} selected - If true, the menu item is styled as selected.
|
|
566
|
+
* @attr {boolean} activeItem - If true, the menu item is styled as active.
|
|
567
|
+
* @attr {string} value - The value associated with the menu item, emitted in events when activated.\
|
|
568
|
+
* @attr {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
569
|
+
* @attr {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
570
|
+
* @attr {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
571
|
+
* @attr {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
572
|
+
* @property {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
573
|
+
* @property {string} name - The name of the list menu item.
|
|
574
|
+
* @property {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
575
|
+
* @property {boolean} selected - If true, the menu item is styled as selected.
|
|
576
|
+
* @property {boolean} activeItem - If true, the menu item is styled as active.
|
|
577
|
+
* @property {string} value - The value associated with the menu item, emitted in events when activated.
|
|
578
|
+
* @property {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
579
|
+
* @property {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
580
|
+
* @property {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
581
|
+
* @property {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
582
|
+
* @default 'button' - The default variant for the menu item is 'button', which is a standard clickable item.
|
|
583
|
+
* @default '' - By default, the name of the menu item is an empty string.
|
|
584
|
+
* @default false - By default, the menu item is not disabled and is interactive.
|
|
585
|
+
* @default false - By default, the menu item is not selected.
|
|
586
|
+
* @default false - By default, the menu item is not active.
|
|
587
|
+
* @default '' - By default, the value of the menu item is an empty string.
|
|
588
|
+
* @default '' - By default, the href is an empty string, meaning the menu item will not behave as a link.
|
|
589
|
+
* @default false - By default, the newTab property is false, meaning links will open in the same tab.
|
|
590
|
+
* @default false - By default, the downloadable property is false, meaning links will not be treated as download links.
|
|
591
|
+
* @default '' - By default, the filename is an empty string, meaning no suggested filename for downloads.
|
|
592
|
+
*/
|
|
593
|
+
interface BdsListMenuItem {
|
|
594
|
+
/**
|
|
595
|
+
* Active state item
|
|
596
|
+
* @default false
|
|
597
|
+
*/
|
|
598
|
+
"activeItem": IListMenuItem['activeItem'];
|
|
599
|
+
/**
|
|
600
|
+
* Disabled state item
|
|
601
|
+
* @default false
|
|
602
|
+
*/
|
|
603
|
+
"disabled": IListMenuItem['disabled'];
|
|
604
|
+
/**
|
|
605
|
+
* Makes the link downloadable if true
|
|
606
|
+
* @default ''
|
|
607
|
+
*/
|
|
608
|
+
"download": IListMenuItem['download'];
|
|
609
|
+
/**
|
|
610
|
+
* Link behavior props
|
|
611
|
+
* @default ''
|
|
612
|
+
*/
|
|
613
|
+
"href": IListMenuItem['href'];
|
|
614
|
+
/**
|
|
615
|
+
* The name of the list menu item
|
|
616
|
+
* @default ''
|
|
617
|
+
*/
|
|
618
|
+
"name": IListMenuItem['name'];
|
|
619
|
+
/**
|
|
620
|
+
* Opens the link in a new tab if true
|
|
621
|
+
* @default false
|
|
622
|
+
*/
|
|
623
|
+
"newTab": IListMenuItem['newTab'];
|
|
624
|
+
/**
|
|
625
|
+
* Selected item state
|
|
626
|
+
* @default false
|
|
627
|
+
*/
|
|
628
|
+
"selected": IListMenuItem['selected'];
|
|
629
|
+
/**
|
|
630
|
+
* Value associated with the menu item
|
|
631
|
+
* @default ''
|
|
632
|
+
*/
|
|
633
|
+
"value": IListMenuItem['value'];
|
|
634
|
+
/**
|
|
635
|
+
* Defines the visual style of the list menu item. - 'button': A standard clickable item. - 'label': A non-interactive label, typically used for grouping items.
|
|
636
|
+
* @default LIST_MENU_ITEM_VARIANTS.BUTTON
|
|
637
|
+
*/
|
|
638
|
+
"variant": IListMenuItem['variant'];
|
|
639
|
+
}
|
|
372
640
|
/**
|
|
373
641
|
* @attr {boolean} disabled - When true, prevents the popover from being shown.
|
|
374
642
|
* @attr {number | 'full' | 'auto'} width - Controls the width of the popover content.
|
|
@@ -434,6 +702,59 @@ export namespace Components {
|
|
|
434
702
|
*/
|
|
435
703
|
"size": ISpinner['size'];
|
|
436
704
|
}
|
|
705
|
+
/**
|
|
706
|
+
* Status badge component for communicating the current state of an item or process.
|
|
707
|
+
*/
|
|
708
|
+
interface BdsStatus {
|
|
709
|
+
/**
|
|
710
|
+
* indicator is a string attribute. Controls the type of indicator rendered before the slotted label. An invalid value falls back to `"none"` and a warning is set on the host element.
|
|
711
|
+
* @default INDICATOR_TYPES.NONE
|
|
712
|
+
*/
|
|
713
|
+
"indicator": IStatus['indicator'];
|
|
714
|
+
/**
|
|
715
|
+
* state is a string attribute. Controls the visual state variant of the status badge. Determines the background, accent, and text colors applied to the element. An invalid value falls back to `"neutral"` and a warning is set on the host element.
|
|
716
|
+
* @default PROCESS_STATUS.NEUTRAL
|
|
717
|
+
*/
|
|
718
|
+
"state": IStatus['state'];
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* Tag component used to represent categories, metadata, or removable filters.
|
|
722
|
+
* @summary Displays a label with optional leading/trailing icons and dismissal capability.
|
|
723
|
+
* @fires bdsClose - Emitted when the tag is closed via the close button or Delete key.
|
|
724
|
+
* @fires bdsSelect - Emitted when the tag is selected via a click or Space/Enter key.
|
|
725
|
+
*/
|
|
726
|
+
interface BdsTag {
|
|
727
|
+
/**
|
|
728
|
+
* Aria label for the close button when visible.
|
|
729
|
+
* @default 'Close tag'
|
|
730
|
+
*/
|
|
731
|
+
"closeButtonLabel": ITag['closeButtonLabel'];
|
|
732
|
+
/**
|
|
733
|
+
* Visual color variant: 'gray', 'cyan', 'cobalt', 'teal', 'lime', 'orange', 'rose', or 'purple'.
|
|
734
|
+
* @default "gray"
|
|
735
|
+
*/
|
|
736
|
+
"color": ITag['color'];
|
|
737
|
+
/**
|
|
738
|
+
* Disables interaction with the tag. Reduces opacity and prevents interactions.
|
|
739
|
+
* @default false
|
|
740
|
+
*/
|
|
741
|
+
"disabled": ITag['disabled'];
|
|
742
|
+
/**
|
|
743
|
+
* Whether the tag is selectable or not.
|
|
744
|
+
* @default false
|
|
745
|
+
*/
|
|
746
|
+
"multiselect": ITag['multiselect'];
|
|
747
|
+
/**
|
|
748
|
+
* Hides the close button that allows users to dismiss the tag.
|
|
749
|
+
* @default false
|
|
750
|
+
*/
|
|
751
|
+
"readonly": ITag['readonly'];
|
|
752
|
+
/**
|
|
753
|
+
* Whether the tag is selected or not.
|
|
754
|
+
* @default false
|
|
755
|
+
*/
|
|
756
|
+
"selected": ITag['selected'];
|
|
757
|
+
}
|
|
437
758
|
/**
|
|
438
759
|
* Text field component for user input with validation and form integration.
|
|
439
760
|
* @summary Single-line text input with label, validation, password toggle, and clear action.
|
|
@@ -614,6 +935,76 @@ export namespace Components {
|
|
|
614
935
|
*/
|
|
615
936
|
"variant": TextFieldVariant;
|
|
616
937
|
}
|
|
938
|
+
/**
|
|
939
|
+
* Toggle/Switch component for boolean selection.
|
|
940
|
+
* @summary A toggle switch form control with label positioning support.
|
|
941
|
+
* @property {string} name - Name of the form control, submitted as a key in the form data.
|
|
942
|
+
* @property {boolean} disabled - Disables the control. Defaults to `false`.
|
|
943
|
+
* @property {boolean} required - Marks the control as required for form submission. Defaults to `false`.
|
|
944
|
+
* @property {boolean} checked - Whether the toggle is on. Defaults to `false`.
|
|
945
|
+
* @property {string} placement - Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `"left"`.
|
|
946
|
+
* @property {string} label - Label displayed next to the toggle. Defaults to `""`.
|
|
947
|
+
* @property {string} helperText - Help text displayed below the toggle. Defaults to `""`.
|
|
948
|
+
* @property {string} value - Value submitted with the form data when checked. Defaults to `"on"`.
|
|
949
|
+
* @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model). Payload: `boolean`.
|
|
950
|
+
* @fires bdsChange - Emitted when the user toggles the switch. Payload: `IToggleEventChange`.
|
|
951
|
+
*/
|
|
952
|
+
interface BdsToggle {
|
|
953
|
+
/**
|
|
954
|
+
* Whether the toggle is on. Defaults to `false`.
|
|
955
|
+
* @default false
|
|
956
|
+
*/
|
|
957
|
+
"checked": IToggle['checked'];
|
|
958
|
+
/**
|
|
959
|
+
* Disables the control. Defaults to `false`.
|
|
960
|
+
* @default false
|
|
961
|
+
*/
|
|
962
|
+
"disabled": IToggle['disabled'];
|
|
963
|
+
/**
|
|
964
|
+
* When `true`, applies the error visual state.
|
|
965
|
+
* @default false
|
|
966
|
+
*/
|
|
967
|
+
"error": IToggle['error'];
|
|
968
|
+
/**
|
|
969
|
+
* Message shown below the input when `error` is `true`. Replaces `helperText`.
|
|
970
|
+
* @default ''
|
|
971
|
+
*/
|
|
972
|
+
"errorMessage": IToggle['errorMessage'];
|
|
973
|
+
/**
|
|
974
|
+
* Help text displayed below the toggle. Defaults to `""`.
|
|
975
|
+
* @default ''
|
|
976
|
+
*/
|
|
977
|
+
"helperText": IToggle['helperText'];
|
|
978
|
+
/**
|
|
979
|
+
* Tooltip content attached to the label. Rendered via `bds-typography` `tooltipText` prop.
|
|
980
|
+
* @default ''
|
|
981
|
+
*/
|
|
982
|
+
"info": IToggle['info'];
|
|
983
|
+
/**
|
|
984
|
+
* Label displayed next to the toggle. Defaults to `""`.
|
|
985
|
+
* @default ''
|
|
986
|
+
*/
|
|
987
|
+
"label": IToggle['label'];
|
|
988
|
+
/**
|
|
989
|
+
* Name of the form control, submitted as a key in the form data.
|
|
990
|
+
*/
|
|
991
|
+
"name": IToggle['name'];
|
|
992
|
+
/**
|
|
993
|
+
* Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `TOGGLE_PLACEMENT.LEFT`.
|
|
994
|
+
* @default TOGGLE_PLACEMENT.LEFT
|
|
995
|
+
*/
|
|
996
|
+
"placement": IToggle['placement'];
|
|
997
|
+
/**
|
|
998
|
+
* Marks the control as required for form submission. Defaults to `false`.
|
|
999
|
+
* @default false
|
|
1000
|
+
*/
|
|
1001
|
+
"required": IToggle['required'];
|
|
1002
|
+
/**
|
|
1003
|
+
* Value submitted with the form data when checked. Behaves like the `value` attribute of a native `<input type="checkbox">`. Defaults to `"on"`.
|
|
1004
|
+
* @default 'on'
|
|
1005
|
+
*/
|
|
1006
|
+
"value": IToggle['value'];
|
|
1007
|
+
}
|
|
617
1008
|
/**
|
|
618
1009
|
* Tooltip component that displays a short label anchored to a trigger element on hover.
|
|
619
1010
|
* @summary Displays a floating tooltip anchored to a trigger element on mouseenter/mouseleave,
|
|
@@ -652,12 +1043,12 @@ export namespace Components {
|
|
|
652
1043
|
* @attr {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
653
1044
|
* @attr {string} align - The text alignment. Options: start, center, end, inherit
|
|
654
1045
|
* @attr {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
655
|
-
* @attr {boolean}
|
|
1046
|
+
* @attr {boolean} required - Shows a required indicator when used with `label` variant.
|
|
656
1047
|
* @attr {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
657
1048
|
* @attr {number} max-lines - Maximum number of lines to show before truncating with ellipsis.
|
|
658
1049
|
* @attr {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
659
1050
|
* @attr {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
660
|
-
* @attr {boolean}
|
|
1051
|
+
* @attr {boolean} downloadable - Makes the `link` download a file.
|
|
661
1052
|
* @attr {string} filename - Suggested filename when downloading a file from the `link`.
|
|
662
1053
|
* @attr {string} html-for - The for attribute when rendered as a label
|
|
663
1054
|
* @attr {string} tooltip-text - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -667,12 +1058,12 @@ export namespace Components {
|
|
|
667
1058
|
* @property {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
668
1059
|
* @property {string} align - The text alignment. Options: start, center, end, inherit
|
|
669
1060
|
* @property {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
670
|
-
* @property {boolean}
|
|
1061
|
+
* @property {boolean} required - Shows a required indicator when used with `label` variant.
|
|
671
1062
|
* @property {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
672
1063
|
* @property {number} maxLines - Maximum number of lines to show before truncating with ellipsis.
|
|
673
1064
|
* @property {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
674
1065
|
* @property {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
675
|
-
* @property {boolean}
|
|
1066
|
+
* @property {boolean} downloadable - Makes the `link` download a file.
|
|
676
1067
|
* @property {string} filename - Suggested filename when downloading a file from the `link`.
|
|
677
1068
|
* @property {string} htmlFor - The for attribute when rendered as a label
|
|
678
1069
|
* @property {string} tooltipText - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -682,12 +1073,12 @@ export namespace Components {
|
|
|
682
1073
|
* @default 'start' - Default align value
|
|
683
1074
|
* @default 'md' - Default size value
|
|
684
1075
|
* @default 'default' - Default state value
|
|
685
|
-
* @default false - Default
|
|
1076
|
+
* @default false - Default required state
|
|
686
1077
|
* @default false - Default ellipsis state
|
|
687
1078
|
* @default 1 - Default maxLines value
|
|
688
1079
|
* @default '' - Default href value
|
|
689
1080
|
* @default '' - Default target value
|
|
690
|
-
* @default false - Default
|
|
1081
|
+
* @default false - Default downloadable state
|
|
691
1082
|
* @default 'download' - Default filename value
|
|
692
1083
|
* @default '' - Default tooltipText value
|
|
693
1084
|
*/
|
|
@@ -702,6 +1093,11 @@ export namespace Components {
|
|
|
702
1093
|
* @default ''
|
|
703
1094
|
*/
|
|
704
1095
|
"customClass": string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Enables download behavior for anchor.
|
|
1098
|
+
* @default false
|
|
1099
|
+
*/
|
|
1100
|
+
"downloadable": ITypography['downloadable'];
|
|
705
1101
|
/**
|
|
706
1102
|
* HTML tag used for rendering.
|
|
707
1103
|
* @default TAG_ELEMENT.P
|
|
@@ -728,20 +1124,15 @@ export namespace Components {
|
|
|
728
1124
|
*/
|
|
729
1125
|
"htmlFor": ITypography['htmlFor'];
|
|
730
1126
|
/**
|
|
731
|
-
*
|
|
732
|
-
* @default
|
|
1127
|
+
* Max lines when ellipsis is enabled.
|
|
1128
|
+
* @default 1
|
|
733
1129
|
*/
|
|
734
|
-
"
|
|
1130
|
+
"maxLines": ITypography['maxLines'];
|
|
735
1131
|
/**
|
|
736
1132
|
* Marks the field as required.
|
|
737
1133
|
* @default false
|
|
738
1134
|
*/
|
|
739
|
-
"
|
|
740
|
-
/**
|
|
741
|
-
* Max lines when ellipsis is enabled.
|
|
742
|
-
* @default 1
|
|
743
|
-
*/
|
|
744
|
-
"maxLines": ITypography['maxLines'];
|
|
1135
|
+
"required": ITypography['required'];
|
|
745
1136
|
/**
|
|
746
1137
|
* Typography size token.
|
|
747
1138
|
* @default SIZES.M
|
|
@@ -785,11 +1176,62 @@ export interface BdsDialogCustomEvent<T> extends CustomEvent<T> {
|
|
|
785
1176
|
detail: T;
|
|
786
1177
|
target: HTMLBdsDialogElement;
|
|
787
1178
|
}
|
|
1179
|
+
export interface BdsListMenuCustomEvent<T> extends CustomEvent<T> {
|
|
1180
|
+
detail: T;
|
|
1181
|
+
target: HTMLBdsListMenuElement;
|
|
1182
|
+
}
|
|
1183
|
+
export interface BdsListMenuItemCustomEvent<T> extends CustomEvent<T> {
|
|
1184
|
+
detail: T;
|
|
1185
|
+
target: HTMLBdsListMenuItemElement;
|
|
1186
|
+
}
|
|
1187
|
+
export interface BdsTagCustomEvent<T> extends CustomEvent<T> {
|
|
1188
|
+
detail: T;
|
|
1189
|
+
target: HTMLBdsTagElement;
|
|
1190
|
+
}
|
|
788
1191
|
export interface BdsTextFieldCustomEvent<T> extends CustomEvent<T> {
|
|
789
1192
|
detail: T;
|
|
790
1193
|
target: HTMLBdsTextFieldElement;
|
|
791
1194
|
}
|
|
1195
|
+
export interface BdsToggleCustomEvent<T> extends CustomEvent<T> {
|
|
1196
|
+
detail: T;
|
|
1197
|
+
target: HTMLBdsToggleElement;
|
|
1198
|
+
}
|
|
792
1199
|
declare global {
|
|
1200
|
+
/**
|
|
1201
|
+
* Avatar component used to display user initials or names for visual identification.
|
|
1202
|
+
* @summary Displays a circular avatar with user initials and optional name label.
|
|
1203
|
+
* Uses Boreal Design System tokens for consistent styling across platforms.
|
|
1204
|
+
* @attr {string} username - The full name used to generate initials or display as label.
|
|
1205
|
+
* @attr {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
1206
|
+
* @attr {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
1207
|
+
* @attr {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
1208
|
+
* @property {string} username - The full name used to generate initials or display as label.
|
|
1209
|
+
* @property {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
1210
|
+
* @property {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
1211
|
+
* @property {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
1212
|
+
* @cssprop --bds-avatar-background - Custom background color HEX code.
|
|
1213
|
+
* @cssprop --bds-avatar-initials-color - Custom text color HEX code.
|
|
1214
|
+
*/
|
|
1215
|
+
interface HTMLBdsAvatarElement extends Components.BdsAvatar, HTMLStencilElement {
|
|
1216
|
+
}
|
|
1217
|
+
var HTMLBdsAvatarElement: {
|
|
1218
|
+
prototype: HTMLBdsAvatarElement;
|
|
1219
|
+
new (): HTMLBdsAvatarElement;
|
|
1220
|
+
};
|
|
1221
|
+
/**
|
|
1222
|
+
* Badge component for displaying contextual status information with optional icon support.
|
|
1223
|
+
* @summary A compact label component that communicates status or category using color-coded variants. Supports an optional icon slot and a disabled state.
|
|
1224
|
+
* @attr {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
1225
|
+
* @attr {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
1226
|
+
* @property {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
1227
|
+
* @property {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
1228
|
+
*/
|
|
1229
|
+
interface HTMLBdsBadgeElement extends Components.BdsBadge, HTMLStencilElement {
|
|
1230
|
+
}
|
|
1231
|
+
var HTMLBdsBadgeElement: {
|
|
1232
|
+
prototype: HTMLBdsBadgeElement;
|
|
1233
|
+
new (): HTMLBdsBadgeElement;
|
|
1234
|
+
};
|
|
793
1235
|
interface HTMLBdsBannerElementEventMap {
|
|
794
1236
|
"bdsClose": void;
|
|
795
1237
|
}
|
|
@@ -801,8 +1243,8 @@ declare global {
|
|
|
801
1243
|
* @property {"info"|"success"|"warning"|"danger"} variant - Visual style variant: 'info', 'success', 'warning', or 'danger'. Defaults to "info".
|
|
802
1244
|
* @property {boolean} closable - Shows a close button that allows users to close the banner. Defaults to false.
|
|
803
1245
|
* @property {boolean} closeButtonLabel - Aria label for the close button when visible.
|
|
804
|
-
* @fires bdsClose - Emitted when the banner is closed via the close button or `
|
|
805
|
-
* @method
|
|
1246
|
+
* @fires bdsClose - Emitted when the banner is closed via the close button or `close` method.
|
|
1247
|
+
* @method close - Programmatic method to close the banner and emit the `bdsClose` event.
|
|
806
1248
|
*/
|
|
807
1249
|
interface HTMLBdsBannerElement extends Components.BdsBanner, HTMLStencilElement {
|
|
808
1250
|
addEventListener<K extends keyof HTMLBdsBannerElementEventMap>(type: K, listener: (this: HTMLBdsBannerElement, ev: BdsBannerCustomEvent<HTMLBdsBannerElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
|
|
@@ -950,6 +1392,19 @@ declare global {
|
|
|
950
1392
|
prototype: HTMLBdsDialogElement;
|
|
951
1393
|
new (): HTMLBdsDialogElement;
|
|
952
1394
|
};
|
|
1395
|
+
/**
|
|
1396
|
+
* Divider component for creating visual separators between content sections.
|
|
1397
|
+
* @summary A simple visual separator that can be oriented horizontally or vertically.
|
|
1398
|
+
* @csspart divider - A divider element that visually separates content.
|
|
1399
|
+
* @attr {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
1400
|
+
* @property {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
1401
|
+
*/
|
|
1402
|
+
interface HTMLBdsDividerElement extends Components.BdsDivider, HTMLStencilElement {
|
|
1403
|
+
}
|
|
1404
|
+
var HTMLBdsDividerElement: {
|
|
1405
|
+
prototype: HTMLBdsDividerElement;
|
|
1406
|
+
new (): HTMLBdsDividerElement;
|
|
1407
|
+
};
|
|
953
1408
|
/**
|
|
954
1409
|
* Flag component used to display a country flag together with its corresponding label.
|
|
955
1410
|
* @summary Renders a flag icon based on a country identifier and optionally displays
|
|
@@ -978,6 +1433,108 @@ declare global {
|
|
|
978
1433
|
prototype: HTMLBdsFlagElement;
|
|
979
1434
|
new (): HTMLBdsFlagElement;
|
|
980
1435
|
};
|
|
1436
|
+
/**
|
|
1437
|
+
* 12-column CSS Grid layout container with 5 responsive breakpoints.
|
|
1438
|
+
* Minimum browser support: Chrome/Edge (last 2), Firefox (last 2), Safari (last 2).
|
|
1439
|
+
*/
|
|
1440
|
+
interface HTMLBdsGridElement extends Components.BdsGrid, HTMLStencilElement {
|
|
1441
|
+
}
|
|
1442
|
+
var HTMLBdsGridElement: {
|
|
1443
|
+
prototype: HTMLBdsGridElement;
|
|
1444
|
+
new (): HTMLBdsGridElement;
|
|
1445
|
+
};
|
|
1446
|
+
/**
|
|
1447
|
+
* Grid item child of `bds-grid`. Must be a direct child of `bds-grid`.
|
|
1448
|
+
*/
|
|
1449
|
+
interface HTMLBdsGridItemElement extends Components.BdsGridItem, HTMLStencilElement {
|
|
1450
|
+
}
|
|
1451
|
+
var HTMLBdsGridItemElement: {
|
|
1452
|
+
prototype: HTMLBdsGridItemElement;
|
|
1453
|
+
new (): HTMLBdsGridItemElement;
|
|
1454
|
+
};
|
|
1455
|
+
interface HTMLBdsListMenuElementEventMap {
|
|
1456
|
+
"bdsChange": string | string[];
|
|
1457
|
+
"bdsClicked": HTMLElement;
|
|
1458
|
+
}
|
|
1459
|
+
/**
|
|
1460
|
+
* Container component that manages a list of menu items.
|
|
1461
|
+
* It handles selection logic (single/multiple) and maintains the data state.
|
|
1462
|
+
* @summary A list menu component that can contain multiple menu items and manage their selection state.
|
|
1463
|
+
* @attr {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
1464
|
+
* @attr {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
1465
|
+
* @property {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
1466
|
+
* @property {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
1467
|
+
* @event bdsChange - Emitted when the selection changes, providing the current selected value(s).
|
|
1468
|
+
* @method getSelectedValues - Returns the currently selected value(s). If multiple is true, returns an array of strings; otherwise, returns a single string or undefined.
|
|
1469
|
+
* @method setSelectedValues - Sets the selected value(s). Accepts a string for single selection or an array of strings for multiple selection.
|
|
1470
|
+
* @default false - By default, the menu does not allow multiple selections (single selection mode).
|
|
1471
|
+
* @default 'menu' - The default ARIA role for the menu is 'menu'.
|
|
1472
|
+
*/
|
|
1473
|
+
interface HTMLBdsListMenuElement extends Components.BdsListMenu, HTMLStencilElement {
|
|
1474
|
+
addEventListener<K extends keyof HTMLBdsListMenuElementEventMap>(type: K, listener: (this: HTMLBdsListMenuElement, ev: BdsListMenuCustomEvent<HTMLBdsListMenuElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1475
|
+
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1476
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1477
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1478
|
+
removeEventListener<K extends keyof HTMLBdsListMenuElementEventMap>(type: K, listener: (this: HTMLBdsListMenuElement, ev: BdsListMenuCustomEvent<HTMLBdsListMenuElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
|
|
1479
|
+
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1480
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1481
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1482
|
+
}
|
|
1483
|
+
var HTMLBdsListMenuElement: {
|
|
1484
|
+
prototype: HTMLBdsListMenuElement;
|
|
1485
|
+
new (): HTMLBdsListMenuElement;
|
|
1486
|
+
};
|
|
1487
|
+
interface HTMLBdsListMenuItemElementEventMap {
|
|
1488
|
+
"bdsSelect": IListMenuItemEvent;
|
|
1489
|
+
}
|
|
1490
|
+
/**
|
|
1491
|
+
* Component representing an individual item within a list menu for navigations and selection.
|
|
1492
|
+
* @summary A menu item component that supports different variants, disabled state, and selection state, it also supports link behavior when the href prop is provided.
|
|
1493
|
+
* @attr {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
1494
|
+
* @attr {string} name - The name of the list menu item.
|
|
1495
|
+
* @attr {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
1496
|
+
* @attr {boolean} selected - If true, the menu item is styled as selected.
|
|
1497
|
+
* @attr {boolean} activeItem - If true, the menu item is styled as active.
|
|
1498
|
+
* @attr {string} value - The value associated with the menu item, emitted in events when activated.\
|
|
1499
|
+
* @attr {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
1500
|
+
* @attr {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
1501
|
+
* @attr {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
1502
|
+
* @attr {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
1503
|
+
* @property {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
1504
|
+
* @property {string} name - The name of the list menu item.
|
|
1505
|
+
* @property {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
1506
|
+
* @property {boolean} selected - If true, the menu item is styled as selected.
|
|
1507
|
+
* @property {boolean} activeItem - If true, the menu item is styled as active.
|
|
1508
|
+
* @property {string} value - The value associated with the menu item, emitted in events when activated.
|
|
1509
|
+
* @property {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
1510
|
+
* @property {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
1511
|
+
* @property {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
1512
|
+
* @property {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
1513
|
+
* @default 'button' - The default variant for the menu item is 'button', which is a standard clickable item.
|
|
1514
|
+
* @default '' - By default, the name of the menu item is an empty string.
|
|
1515
|
+
* @default false - By default, the menu item is not disabled and is interactive.
|
|
1516
|
+
* @default false - By default, the menu item is not selected.
|
|
1517
|
+
* @default false - By default, the menu item is not active.
|
|
1518
|
+
* @default '' - By default, the value of the menu item is an empty string.
|
|
1519
|
+
* @default '' - By default, the href is an empty string, meaning the menu item will not behave as a link.
|
|
1520
|
+
* @default false - By default, the newTab property is false, meaning links will open in the same tab.
|
|
1521
|
+
* @default false - By default, the downloadable property is false, meaning links will not be treated as download links.
|
|
1522
|
+
* @default '' - By default, the filename is an empty string, meaning no suggested filename for downloads.
|
|
1523
|
+
*/
|
|
1524
|
+
interface HTMLBdsListMenuItemElement extends Components.BdsListMenuItem, HTMLStencilElement {
|
|
1525
|
+
addEventListener<K extends keyof HTMLBdsListMenuItemElementEventMap>(type: K, listener: (this: HTMLBdsListMenuItemElement, ev: BdsListMenuItemCustomEvent<HTMLBdsListMenuItemElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1526
|
+
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1527
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1528
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1529
|
+
removeEventListener<K extends keyof HTMLBdsListMenuItemElementEventMap>(type: K, listener: (this: HTMLBdsListMenuItemElement, ev: BdsListMenuItemCustomEvent<HTMLBdsListMenuItemElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
|
|
1530
|
+
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1531
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1532
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1533
|
+
}
|
|
1534
|
+
var HTMLBdsListMenuItemElement: {
|
|
1535
|
+
prototype: HTMLBdsListMenuItemElement;
|
|
1536
|
+
new (): HTMLBdsListMenuItemElement;
|
|
1537
|
+
};
|
|
981
1538
|
/**
|
|
982
1539
|
* @attr {boolean} disabled - When true, prevents the popover from being shown.
|
|
983
1540
|
* @attr {number | 'full' | 'auto'} width - Controls the width of the popover content.
|
|
@@ -1011,6 +1568,39 @@ declare global {
|
|
|
1011
1568
|
prototype: HTMLBdsSpinnerElement;
|
|
1012
1569
|
new (): HTMLBdsSpinnerElement;
|
|
1013
1570
|
};
|
|
1571
|
+
/**
|
|
1572
|
+
* Status badge component for communicating the current state of an item or process.
|
|
1573
|
+
*/
|
|
1574
|
+
interface HTMLBdsStatusElement extends Components.BdsStatus, HTMLStencilElement {
|
|
1575
|
+
}
|
|
1576
|
+
var HTMLBdsStatusElement: {
|
|
1577
|
+
prototype: HTMLBdsStatusElement;
|
|
1578
|
+
new (): HTMLBdsStatusElement;
|
|
1579
|
+
};
|
|
1580
|
+
interface HTMLBdsTagElementEventMap {
|
|
1581
|
+
"bdsClose": TagEventPayload;
|
|
1582
|
+
"bdsSelect": TagEventPayload;
|
|
1583
|
+
}
|
|
1584
|
+
/**
|
|
1585
|
+
* Tag component used to represent categories, metadata, or removable filters.
|
|
1586
|
+
* @summary Displays a label with optional leading/trailing icons and dismissal capability.
|
|
1587
|
+
* @fires bdsClose - Emitted when the tag is closed via the close button or Delete key.
|
|
1588
|
+
* @fires bdsSelect - Emitted when the tag is selected via a click or Space/Enter key.
|
|
1589
|
+
*/
|
|
1590
|
+
interface HTMLBdsTagElement extends Components.BdsTag, HTMLStencilElement {
|
|
1591
|
+
addEventListener<K extends keyof HTMLBdsTagElementEventMap>(type: K, listener: (this: HTMLBdsTagElement, ev: BdsTagCustomEvent<HTMLBdsTagElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1592
|
+
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1593
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1594
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1595
|
+
removeEventListener<K extends keyof HTMLBdsTagElementEventMap>(type: K, listener: (this: HTMLBdsTagElement, ev: BdsTagCustomEvent<HTMLBdsTagElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
|
|
1596
|
+
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1597
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1598
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1599
|
+
}
|
|
1600
|
+
var HTMLBdsTagElement: {
|
|
1601
|
+
prototype: HTMLBdsTagElement;
|
|
1602
|
+
new (): HTMLBdsTagElement;
|
|
1603
|
+
};
|
|
1014
1604
|
interface HTMLBdsTextFieldElementEventMap {
|
|
1015
1605
|
"valueChange": string;
|
|
1016
1606
|
"bdsInput": { value: string; event: InputEvent };
|
|
@@ -1080,6 +1670,38 @@ declare global {
|
|
|
1080
1670
|
prototype: HTMLBdsTextFieldElement;
|
|
1081
1671
|
new (): HTMLBdsTextFieldElement;
|
|
1082
1672
|
};
|
|
1673
|
+
interface HTMLBdsToggleElementEventMap {
|
|
1674
|
+
"valueChange": boolean;
|
|
1675
|
+
"bdsChange": IToggleEventChange;
|
|
1676
|
+
}
|
|
1677
|
+
/**
|
|
1678
|
+
* Toggle/Switch component for boolean selection.
|
|
1679
|
+
* @summary A toggle switch form control with label positioning support.
|
|
1680
|
+
* @property {string} name - Name of the form control, submitted as a key in the form data.
|
|
1681
|
+
* @property {boolean} disabled - Disables the control. Defaults to `false`.
|
|
1682
|
+
* @property {boolean} required - Marks the control as required for form submission. Defaults to `false`.
|
|
1683
|
+
* @property {boolean} checked - Whether the toggle is on. Defaults to `false`.
|
|
1684
|
+
* @property {string} placement - Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `"left"`.
|
|
1685
|
+
* @property {string} label - Label displayed next to the toggle. Defaults to `""`.
|
|
1686
|
+
* @property {string} helperText - Help text displayed below the toggle. Defaults to `""`.
|
|
1687
|
+
* @property {string} value - Value submitted with the form data when checked. Defaults to `"on"`.
|
|
1688
|
+
* @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model). Payload: `boolean`.
|
|
1689
|
+
* @fires bdsChange - Emitted when the user toggles the switch. Payload: `IToggleEventChange`.
|
|
1690
|
+
*/
|
|
1691
|
+
interface HTMLBdsToggleElement extends Components.BdsToggle, HTMLStencilElement {
|
|
1692
|
+
addEventListener<K extends keyof HTMLBdsToggleElementEventMap>(type: K, listener: (this: HTMLBdsToggleElement, ev: BdsToggleCustomEvent<HTMLBdsToggleElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1693
|
+
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1694
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
1695
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
1696
|
+
removeEventListener<K extends keyof HTMLBdsToggleElementEventMap>(type: K, listener: (this: HTMLBdsToggleElement, ev: BdsToggleCustomEvent<HTMLBdsToggleElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
|
|
1697
|
+
removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1698
|
+
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
|
|
1699
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
1700
|
+
}
|
|
1701
|
+
var HTMLBdsToggleElement: {
|
|
1702
|
+
prototype: HTMLBdsToggleElement;
|
|
1703
|
+
new (): HTMLBdsToggleElement;
|
|
1704
|
+
};
|
|
1083
1705
|
/**
|
|
1084
1706
|
* Tooltip component that displays a short label anchored to a trigger element on hover.
|
|
1085
1707
|
* @summary Displays a floating tooltip anchored to a trigger element on mouseenter/mouseleave,
|
|
@@ -1107,12 +1729,12 @@ declare global {
|
|
|
1107
1729
|
* @attr {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
1108
1730
|
* @attr {string} align - The text alignment. Options: start, center, end, inherit
|
|
1109
1731
|
* @attr {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
1110
|
-
* @attr {boolean}
|
|
1732
|
+
* @attr {boolean} required - Shows a required indicator when used with `label` variant.
|
|
1111
1733
|
* @attr {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
1112
1734
|
* @attr {number} max-lines - Maximum number of lines to show before truncating with ellipsis.
|
|
1113
1735
|
* @attr {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
1114
1736
|
* @attr {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
1115
|
-
* @attr {boolean}
|
|
1737
|
+
* @attr {boolean} downloadable - Makes the `link` download a file.
|
|
1116
1738
|
* @attr {string} filename - Suggested filename when downloading a file from the `link`.
|
|
1117
1739
|
* @attr {string} html-for - The for attribute when rendered as a label
|
|
1118
1740
|
* @attr {string} tooltip-text - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -1122,12 +1744,12 @@ declare global {
|
|
|
1122
1744
|
* @property {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
1123
1745
|
* @property {string} align - The text alignment. Options: start, center, end, inherit
|
|
1124
1746
|
* @property {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
1125
|
-
* @property {boolean}
|
|
1747
|
+
* @property {boolean} required - Shows a required indicator when used with `label` variant.
|
|
1126
1748
|
* @property {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
1127
1749
|
* @property {number} maxLines - Maximum number of lines to show before truncating with ellipsis.
|
|
1128
1750
|
* @property {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
1129
1751
|
* @property {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
1130
|
-
* @property {boolean}
|
|
1752
|
+
* @property {boolean} downloadable - Makes the `link` download a file.
|
|
1131
1753
|
* @property {string} filename - Suggested filename when downloading a file from the `link`.
|
|
1132
1754
|
* @property {string} htmlFor - The for attribute when rendered as a label
|
|
1133
1755
|
* @property {string} tooltipText - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -1137,12 +1759,12 @@ declare global {
|
|
|
1137
1759
|
* @default 'start' - Default align value
|
|
1138
1760
|
* @default 'md' - Default size value
|
|
1139
1761
|
* @default 'default' - Default state value
|
|
1140
|
-
* @default false - Default
|
|
1762
|
+
* @default false - Default required state
|
|
1141
1763
|
* @default false - Default ellipsis state
|
|
1142
1764
|
* @default 1 - Default maxLines value
|
|
1143
1765
|
* @default '' - Default href value
|
|
1144
1766
|
* @default '' - Default target value
|
|
1145
|
-
* @default false - Default
|
|
1767
|
+
* @default false - Default downloadable state
|
|
1146
1768
|
* @default 'download' - Default filename value
|
|
1147
1769
|
* @default '' - Default tooltipText value
|
|
1148
1770
|
*/
|
|
@@ -1153,14 +1775,24 @@ declare global {
|
|
|
1153
1775
|
new (): HTMLBdsTypographyElement;
|
|
1154
1776
|
};
|
|
1155
1777
|
interface HTMLElementTagNameMap {
|
|
1778
|
+
"bds-avatar": HTMLBdsAvatarElement;
|
|
1779
|
+
"bds-badge": HTMLBdsBadgeElement;
|
|
1156
1780
|
"bds-banner": HTMLBdsBannerElement;
|
|
1157
1781
|
"bds-button": HTMLBdsButtonElement;
|
|
1158
1782
|
"bds-checkbox": HTMLBdsCheckboxElement;
|
|
1159
1783
|
"bds-dialog": HTMLBdsDialogElement;
|
|
1784
|
+
"bds-divider": HTMLBdsDividerElement;
|
|
1160
1785
|
"bds-flag": HTMLBdsFlagElement;
|
|
1786
|
+
"bds-grid": HTMLBdsGridElement;
|
|
1787
|
+
"bds-grid-item": HTMLBdsGridItemElement;
|
|
1788
|
+
"bds-list-menu": HTMLBdsListMenuElement;
|
|
1789
|
+
"bds-list-menu-item": HTMLBdsListMenuItemElement;
|
|
1161
1790
|
"bds-popover": HTMLBdsPopoverElement;
|
|
1162
1791
|
"bds-spinner": HTMLBdsSpinnerElement;
|
|
1792
|
+
"bds-status": HTMLBdsStatusElement;
|
|
1793
|
+
"bds-tag": HTMLBdsTagElement;
|
|
1163
1794
|
"bds-text-field": HTMLBdsTextFieldElement;
|
|
1795
|
+
"bds-toggle": HTMLBdsToggleElement;
|
|
1164
1796
|
"bds-tooltip": HTMLBdsTooltipElement;
|
|
1165
1797
|
"bds-typography": HTMLBdsTypographyElement;
|
|
1166
1798
|
}
|
|
@@ -1168,6 +1800,63 @@ declare global {
|
|
|
1168
1800
|
declare namespace LocalJSX {
|
|
1169
1801
|
type OneOf<K extends string, PropT, AttrT = PropT> = { [P in K]: PropT } & { [P in `attr:${K}` | `prop:${K}`]?: never } | { [P in `attr:${K}`]: AttrT } & { [P in K | `prop:${K}`]?: never } | { [P in `prop:${K}`]: PropT } & { [P in K | `attr:${K}`]?: never };
|
|
1170
1802
|
|
|
1803
|
+
/**
|
|
1804
|
+
* Avatar component used to display user initials or names for visual identification.
|
|
1805
|
+
* @summary Displays a circular avatar with user initials and optional name label.
|
|
1806
|
+
* Uses Boreal Design System tokens for consistent styling across platforms.
|
|
1807
|
+
* @attr {string} username - The full name used to generate initials or display as label.
|
|
1808
|
+
* @attr {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
1809
|
+
* @attr {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
1810
|
+
* @attr {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
1811
|
+
* @property {string} username - The full name used to generate initials or display as label.
|
|
1812
|
+
* @property {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
1813
|
+
* @property {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
1814
|
+
* @property {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
1815
|
+
* @cssprop --bds-avatar-background - Custom background color HEX code.
|
|
1816
|
+
* @cssprop --bds-avatar-initials-color - Custom text color HEX code.
|
|
1817
|
+
*/
|
|
1818
|
+
interface BdsAvatar {
|
|
1819
|
+
/**
|
|
1820
|
+
* Custom background color as hex code. If not provided, defaults to Boreal success color *
|
|
1821
|
+
* @default ''
|
|
1822
|
+
*/
|
|
1823
|
+
"background"?: IAvatar['background'];
|
|
1824
|
+
/**
|
|
1825
|
+
* Custom text color as hex code. If not provided, defaults to white *
|
|
1826
|
+
* @default ''
|
|
1827
|
+
*/
|
|
1828
|
+
"initialsColor"?: IAvatar['initialsColor'];
|
|
1829
|
+
/**
|
|
1830
|
+
* The full name used to generate initials or display as label *
|
|
1831
|
+
* @default ''
|
|
1832
|
+
*/
|
|
1833
|
+
"username"?: IAvatar['username'];
|
|
1834
|
+
/**
|
|
1835
|
+
* Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
1836
|
+
* @default 'full'
|
|
1837
|
+
*/
|
|
1838
|
+
"variant"?: IAvatar['variant'];
|
|
1839
|
+
}
|
|
1840
|
+
/**
|
|
1841
|
+
* Badge component for displaying contextual status information with optional icon support.
|
|
1842
|
+
* @summary A compact label component that communicates status or category using color-coded variants. Supports an optional icon slot and a disabled state.
|
|
1843
|
+
* @attr {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
1844
|
+
* @attr {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
1845
|
+
* @property {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
1846
|
+
* @property {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
1847
|
+
*/
|
|
1848
|
+
interface BdsBadge {
|
|
1849
|
+
/**
|
|
1850
|
+
* Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
1851
|
+
* @default false
|
|
1852
|
+
*/
|
|
1853
|
+
"disabled"?: IBadge['disabled'];
|
|
1854
|
+
/**
|
|
1855
|
+
* Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
1856
|
+
* @default BADGE_VARIANT.DEFAULT
|
|
1857
|
+
*/
|
|
1858
|
+
"variant"?: IBadge['variant'];
|
|
1859
|
+
}
|
|
1171
1860
|
/**
|
|
1172
1861
|
* Banner component used to display important messages with different status variants.
|
|
1173
1862
|
* @summary Displays a dismissible banner with an icon, title, body content, and optional actions.
|
|
@@ -1176,8 +1865,8 @@ declare namespace LocalJSX {
|
|
|
1176
1865
|
* @property {"info"|"success"|"warning"|"danger"} variant - Visual style variant: 'info', 'success', 'warning', or 'danger'. Defaults to "info".
|
|
1177
1866
|
* @property {boolean} closable - Shows a close button that allows users to close the banner. Defaults to false.
|
|
1178
1867
|
* @property {boolean} closeButtonLabel - Aria label for the close button when visible.
|
|
1179
|
-
* @fires bdsClose - Emitted when the banner is closed via the close button or `
|
|
1180
|
-
* @method
|
|
1868
|
+
* @fires bdsClose - Emitted when the banner is closed via the close button or `close` method.
|
|
1869
|
+
* @method close - Programmatic method to close the banner and emit the `bdsClose` event.
|
|
1181
1870
|
*/
|
|
1182
1871
|
interface BdsBanner {
|
|
1183
1872
|
/**
|
|
@@ -1191,7 +1880,7 @@ declare namespace LocalJSX {
|
|
|
1191
1880
|
*/
|
|
1192
1881
|
"closeButtonLabel"?: IBanner['closeButtonLabel'];
|
|
1193
1882
|
/**
|
|
1194
|
-
* Emitted when the banner is closed via the close button or
|
|
1883
|
+
* Emitted when the banner is closed via the close button or close method.
|
|
1195
1884
|
*/
|
|
1196
1885
|
"onBdsClose"?: (event: BdsBannerCustomEvent<void>) => void;
|
|
1197
1886
|
/**
|
|
@@ -1465,6 +2154,20 @@ declare namespace LocalJSX {
|
|
|
1465
2154
|
*/
|
|
1466
2155
|
"width"?: IDialog['width'];
|
|
1467
2156
|
}
|
|
2157
|
+
/**
|
|
2158
|
+
* Divider component for creating visual separators between content sections.
|
|
2159
|
+
* @summary A simple visual separator that can be oriented horizontally or vertically.
|
|
2160
|
+
* @csspart divider - A divider element that visually separates content.
|
|
2161
|
+
* @attr {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
2162
|
+
* @property {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
2163
|
+
*/
|
|
2164
|
+
interface BdsDivider {
|
|
2165
|
+
/**
|
|
2166
|
+
* The orientation of the divider. Allowed values: horizontal | vertical
|
|
2167
|
+
* @default DIVIDER_ORIENTATIONS.HORIZONTAL
|
|
2168
|
+
*/
|
|
2169
|
+
"orientation"?: IDivider['orientation'];
|
|
2170
|
+
}
|
|
1468
2171
|
/**
|
|
1469
2172
|
* Flag component used to display a country flag together with its corresponding label.
|
|
1470
2173
|
* @summary Renders a flag icon based on a country identifier and optionally displays
|
|
@@ -1529,6 +2232,179 @@ declare namespace LocalJSX {
|
|
|
1529
2232
|
*/
|
|
1530
2233
|
"shortName"?: IFlag['shortName'];
|
|
1531
2234
|
}
|
|
2235
|
+
/**
|
|
2236
|
+
* 12-column CSS Grid layout container with 5 responsive breakpoints.
|
|
2237
|
+
* Minimum browser support: Chrome/Edge (last 2), Firefox (last 2), Safari (last 2).
|
|
2238
|
+
*/
|
|
2239
|
+
interface BdsGrid {
|
|
2240
|
+
/**
|
|
2241
|
+
* `'fluid'` fills full width; `'fixed'` caps the column area at 960px and centres the container.
|
|
2242
|
+
* @default GRID_LAYOUT.FLUID
|
|
2243
|
+
*/
|
|
2244
|
+
"layout"?: IGrid['layout'];
|
|
2245
|
+
/**
|
|
2246
|
+
* Overrides the row gap independently of the column gutter.
|
|
2247
|
+
*/
|
|
2248
|
+
"rowGap"?: IGrid['rowGap'];
|
|
2249
|
+
}
|
|
2250
|
+
/**
|
|
2251
|
+
* Grid item child of `bds-grid`. Must be a direct child of `bds-grid`.
|
|
2252
|
+
*/
|
|
2253
|
+
interface BdsGridItem {
|
|
2254
|
+
/**
|
|
2255
|
+
* Column span at all breakpoints (fallback). `'full'` spans all columns (`grid-column: 1 / -1`).
|
|
2256
|
+
* @default GRID_ITEM_COL_SPAN.DEFAULT
|
|
2257
|
+
*/
|
|
2258
|
+
"colSpan"?: IGridItem['colSpan'];
|
|
2259
|
+
/**
|
|
2260
|
+
* Override col-span at the `2xl` breakpoint (≥1344px).
|
|
2261
|
+
*/
|
|
2262
|
+
"colSpan2xl"?: IGridItem['colSpan2xl'];
|
|
2263
|
+
/**
|
|
2264
|
+
* Override col-span at the `lg` breakpoint (≥960px).
|
|
2265
|
+
*/
|
|
2266
|
+
"colSpanLg"?: IGridItem['colSpanLg'];
|
|
2267
|
+
/**
|
|
2268
|
+
* Override col-span at the `md` breakpoint (≥769px).
|
|
2269
|
+
*/
|
|
2270
|
+
"colSpanMd"?: IGridItem['colSpanMd'];
|
|
2271
|
+
/**
|
|
2272
|
+
* Override col-span at the `sm` breakpoint (≥320px).
|
|
2273
|
+
*/
|
|
2274
|
+
"colSpanSm"?: IGridItem['colSpanSm'];
|
|
2275
|
+
/**
|
|
2276
|
+
* Override col-span at the `xl` breakpoint (≥1152px).
|
|
2277
|
+
*/
|
|
2278
|
+
"colSpanXl"?: IGridItem['colSpanXl'];
|
|
2279
|
+
/**
|
|
2280
|
+
* Column offset: shifts the item right by N columns (0–11).
|
|
2281
|
+
* @default 0
|
|
2282
|
+
*/
|
|
2283
|
+
"offset"?: IGridItem['offset'];
|
|
2284
|
+
/**
|
|
2285
|
+
* Row span. `'full'` maps to `grid-row: 1 / -1`.
|
|
2286
|
+
*/
|
|
2287
|
+
"rowSpan"?: IGridItem['rowSpan'];
|
|
2288
|
+
}
|
|
2289
|
+
/**
|
|
2290
|
+
* Container component that manages a list of menu items.
|
|
2291
|
+
* It handles selection logic (single/multiple) and maintains the data state.
|
|
2292
|
+
* @summary A list menu component that can contain multiple menu items and manage their selection state.
|
|
2293
|
+
* @attr {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
2294
|
+
* @attr {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
2295
|
+
* @property {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
2296
|
+
* @property {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
2297
|
+
* @event bdsChange - Emitted when the selection changes, providing the current selected value(s).
|
|
2298
|
+
* @method getSelectedValues - Returns the currently selected value(s). If multiple is true, returns an array of strings; otherwise, returns a single string or undefined.
|
|
2299
|
+
* @method setSelectedValues - Sets the selected value(s). Accepts a string for single selection or an array of strings for multiple selection.
|
|
2300
|
+
* @default false - By default, the menu does not allow multiple selections (single selection mode).
|
|
2301
|
+
* @default 'menu' - The default ARIA role for the menu is 'menu'.
|
|
2302
|
+
*/
|
|
2303
|
+
interface BdsListMenu {
|
|
2304
|
+
/**
|
|
2305
|
+
* Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
2306
|
+
* @default 'menu'
|
|
2307
|
+
*/
|
|
2308
|
+
"menuRole"?: 'menu' | 'listbox';
|
|
2309
|
+
/**
|
|
2310
|
+
* If true, allows multiple items to be selected. Default is false (single selection).
|
|
2311
|
+
* @default false
|
|
2312
|
+
*/
|
|
2313
|
+
"multiple"?: boolean;
|
|
2314
|
+
/**
|
|
2315
|
+
* Emitted when the selection changes, providing the current selected value(s).
|
|
2316
|
+
*/
|
|
2317
|
+
"onBdsChange"?: (event: BdsListMenuCustomEvent<string | string[]>) => void;
|
|
2318
|
+
/**
|
|
2319
|
+
* Emitted when the selection changes, providing the current selected value(s).
|
|
2320
|
+
*/
|
|
2321
|
+
"onBdsClicked"?: (event: BdsListMenuCustomEvent<HTMLElement>) => void;
|
|
2322
|
+
}
|
|
2323
|
+
/**
|
|
2324
|
+
* Component representing an individual item within a list menu for navigations and selection.
|
|
2325
|
+
* @summary A menu item component that supports different variants, disabled state, and selection state, it also supports link behavior when the href prop is provided.
|
|
2326
|
+
* @attr {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
2327
|
+
* @attr {string} name - The name of the list menu item.
|
|
2328
|
+
* @attr {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
2329
|
+
* @attr {boolean} selected - If true, the menu item is styled as selected.
|
|
2330
|
+
* @attr {boolean} activeItem - If true, the menu item is styled as active.
|
|
2331
|
+
* @attr {string} value - The value associated with the menu item, emitted in events when activated.\
|
|
2332
|
+
* @attr {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
2333
|
+
* @attr {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
2334
|
+
* @attr {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
2335
|
+
* @attr {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
2336
|
+
* @property {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
2337
|
+
* @property {string} name - The name of the list menu item.
|
|
2338
|
+
* @property {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
2339
|
+
* @property {boolean} selected - If true, the menu item is styled as selected.
|
|
2340
|
+
* @property {boolean} activeItem - If true, the menu item is styled as active.
|
|
2341
|
+
* @property {string} value - The value associated with the menu item, emitted in events when activated.
|
|
2342
|
+
* @property {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
2343
|
+
* @property {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
2344
|
+
* @property {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
2345
|
+
* @property {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
2346
|
+
* @default 'button' - The default variant for the menu item is 'button', which is a standard clickable item.
|
|
2347
|
+
* @default '' - By default, the name of the menu item is an empty string.
|
|
2348
|
+
* @default false - By default, the menu item is not disabled and is interactive.
|
|
2349
|
+
* @default false - By default, the menu item is not selected.
|
|
2350
|
+
* @default false - By default, the menu item is not active.
|
|
2351
|
+
* @default '' - By default, the value of the menu item is an empty string.
|
|
2352
|
+
* @default '' - By default, the href is an empty string, meaning the menu item will not behave as a link.
|
|
2353
|
+
* @default false - By default, the newTab property is false, meaning links will open in the same tab.
|
|
2354
|
+
* @default false - By default, the downloadable property is false, meaning links will not be treated as download links.
|
|
2355
|
+
* @default '' - By default, the filename is an empty string, meaning no suggested filename for downloads.
|
|
2356
|
+
*/
|
|
2357
|
+
interface BdsListMenuItem {
|
|
2358
|
+
/**
|
|
2359
|
+
* Active state item
|
|
2360
|
+
* @default false
|
|
2361
|
+
*/
|
|
2362
|
+
"activeItem"?: IListMenuItem['activeItem'];
|
|
2363
|
+
/**
|
|
2364
|
+
* Disabled state item
|
|
2365
|
+
* @default false
|
|
2366
|
+
*/
|
|
2367
|
+
"disabled"?: IListMenuItem['disabled'];
|
|
2368
|
+
/**
|
|
2369
|
+
* Makes the link downloadable if true
|
|
2370
|
+
* @default ''
|
|
2371
|
+
*/
|
|
2372
|
+
"download"?: IListMenuItem['download'];
|
|
2373
|
+
/**
|
|
2374
|
+
* Link behavior props
|
|
2375
|
+
* @default ''
|
|
2376
|
+
*/
|
|
2377
|
+
"href"?: IListMenuItem['href'];
|
|
2378
|
+
/**
|
|
2379
|
+
* The name of the list menu item
|
|
2380
|
+
* @default ''
|
|
2381
|
+
*/
|
|
2382
|
+
"name"?: IListMenuItem['name'];
|
|
2383
|
+
/**
|
|
2384
|
+
* Opens the link in a new tab if true
|
|
2385
|
+
* @default false
|
|
2386
|
+
*/
|
|
2387
|
+
"newTab"?: IListMenuItem['newTab'];
|
|
2388
|
+
/**
|
|
2389
|
+
* Event handler for activation
|
|
2390
|
+
*/
|
|
2391
|
+
"onBdsSelect"?: (event: BdsListMenuItemCustomEvent<IListMenuItemEvent>) => void;
|
|
2392
|
+
/**
|
|
2393
|
+
* Selected item state
|
|
2394
|
+
* @default false
|
|
2395
|
+
*/
|
|
2396
|
+
"selected"?: IListMenuItem['selected'];
|
|
2397
|
+
/**
|
|
2398
|
+
* Value associated with the menu item
|
|
2399
|
+
* @default ''
|
|
2400
|
+
*/
|
|
2401
|
+
"value"?: IListMenuItem['value'];
|
|
2402
|
+
/**
|
|
2403
|
+
* Defines the visual style of the list menu item. - 'button': A standard clickable item. - 'label': A non-interactive label, typically used for grouping items.
|
|
2404
|
+
* @default LIST_MENU_ITEM_VARIANTS.BUTTON
|
|
2405
|
+
*/
|
|
2406
|
+
"variant"?: IListMenuItem['variant'];
|
|
2407
|
+
}
|
|
1532
2408
|
/**
|
|
1533
2409
|
* @attr {boolean} disabled - When true, prevents the popover from being shown.
|
|
1534
2410
|
* @attr {number | 'full' | 'auto'} width - Controls the width of the popover content.
|
|
@@ -1594,6 +2470,67 @@ declare namespace LocalJSX {
|
|
|
1594
2470
|
*/
|
|
1595
2471
|
"size"?: ISpinner['size'];
|
|
1596
2472
|
}
|
|
2473
|
+
/**
|
|
2474
|
+
* Status badge component for communicating the current state of an item or process.
|
|
2475
|
+
*/
|
|
2476
|
+
interface BdsStatus {
|
|
2477
|
+
/**
|
|
2478
|
+
* indicator is a string attribute. Controls the type of indicator rendered before the slotted label. An invalid value falls back to `"none"` and a warning is set on the host element.
|
|
2479
|
+
* @default INDICATOR_TYPES.NONE
|
|
2480
|
+
*/
|
|
2481
|
+
"indicator"?: IStatus['indicator'];
|
|
2482
|
+
/**
|
|
2483
|
+
* state is a string attribute. Controls the visual state variant of the status badge. Determines the background, accent, and text colors applied to the element. An invalid value falls back to `"neutral"` and a warning is set on the host element.
|
|
2484
|
+
* @default PROCESS_STATUS.NEUTRAL
|
|
2485
|
+
*/
|
|
2486
|
+
"state"?: IStatus['state'];
|
|
2487
|
+
}
|
|
2488
|
+
/**
|
|
2489
|
+
* Tag component used to represent categories, metadata, or removable filters.
|
|
2490
|
+
* @summary Displays a label with optional leading/trailing icons and dismissal capability.
|
|
2491
|
+
* @fires bdsClose - Emitted when the tag is closed via the close button or Delete key.
|
|
2492
|
+
* @fires bdsSelect - Emitted when the tag is selected via a click or Space/Enter key.
|
|
2493
|
+
*/
|
|
2494
|
+
interface BdsTag {
|
|
2495
|
+
/**
|
|
2496
|
+
* Aria label for the close button when visible.
|
|
2497
|
+
* @default 'Close tag'
|
|
2498
|
+
*/
|
|
2499
|
+
"closeButtonLabel"?: ITag['closeButtonLabel'];
|
|
2500
|
+
/**
|
|
2501
|
+
* Visual color variant: 'gray', 'cyan', 'cobalt', 'teal', 'lime', 'orange', 'rose', or 'purple'.
|
|
2502
|
+
* @default "gray"
|
|
2503
|
+
*/
|
|
2504
|
+
"color"?: ITag['color'];
|
|
2505
|
+
/**
|
|
2506
|
+
* Disables interaction with the tag. Reduces opacity and prevents interactions.
|
|
2507
|
+
* @default false
|
|
2508
|
+
*/
|
|
2509
|
+
"disabled"?: ITag['disabled'];
|
|
2510
|
+
/**
|
|
2511
|
+
* Whether the tag is selectable or not.
|
|
2512
|
+
* @default false
|
|
2513
|
+
*/
|
|
2514
|
+
"multiselect"?: ITag['multiselect'];
|
|
2515
|
+
/**
|
|
2516
|
+
* Emitted when the tag is closed via the close button or Delete key.
|
|
2517
|
+
*/
|
|
2518
|
+
"onBdsClose"?: (event: BdsTagCustomEvent<TagEventPayload>) => void;
|
|
2519
|
+
/**
|
|
2520
|
+
* Emitted when the tag is selected via a click or Space/Enter key.
|
|
2521
|
+
*/
|
|
2522
|
+
"onBdsSelect"?: (event: BdsTagCustomEvent<TagEventPayload>) => void;
|
|
2523
|
+
/**
|
|
2524
|
+
* Hides the close button that allows users to dismiss the tag.
|
|
2525
|
+
* @default false
|
|
2526
|
+
*/
|
|
2527
|
+
"readonly"?: ITag['readonly'];
|
|
2528
|
+
/**
|
|
2529
|
+
* Whether the tag is selected or not.
|
|
2530
|
+
* @default false
|
|
2531
|
+
*/
|
|
2532
|
+
"selected"?: ITag['selected'];
|
|
2533
|
+
}
|
|
1597
2534
|
/**
|
|
1598
2535
|
* Text field component for user input with validation and form integration.
|
|
1599
2536
|
* @summary Single-line text input with label, validation, password toggle, and clear action.
|
|
@@ -1804,6 +2741,88 @@ declare namespace LocalJSX {
|
|
|
1804
2741
|
*/
|
|
1805
2742
|
"variant"?: TextFieldVariant;
|
|
1806
2743
|
}
|
|
2744
|
+
/**
|
|
2745
|
+
* Toggle/Switch component for boolean selection.
|
|
2746
|
+
* @summary A toggle switch form control with label positioning support.
|
|
2747
|
+
* @property {string} name - Name of the form control, submitted as a key in the form data.
|
|
2748
|
+
* @property {boolean} disabled - Disables the control. Defaults to `false`.
|
|
2749
|
+
* @property {boolean} required - Marks the control as required for form submission. Defaults to `false`.
|
|
2750
|
+
* @property {boolean} checked - Whether the toggle is on. Defaults to `false`.
|
|
2751
|
+
* @property {string} placement - Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `"left"`.
|
|
2752
|
+
* @property {string} label - Label displayed next to the toggle. Defaults to `""`.
|
|
2753
|
+
* @property {string} helperText - Help text displayed below the toggle. Defaults to `""`.
|
|
2754
|
+
* @property {string} value - Value submitted with the form data when checked. Defaults to `"on"`.
|
|
2755
|
+
* @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model). Payload: `boolean`.
|
|
2756
|
+
* @fires bdsChange - Emitted when the user toggles the switch. Payload: `IToggleEventChange`.
|
|
2757
|
+
*/
|
|
2758
|
+
interface BdsToggle {
|
|
2759
|
+
/**
|
|
2760
|
+
* Whether the toggle is on. Defaults to `false`.
|
|
2761
|
+
* @default false
|
|
2762
|
+
*/
|
|
2763
|
+
"checked"?: IToggle['checked'];
|
|
2764
|
+
/**
|
|
2765
|
+
* Disables the control. Defaults to `false`.
|
|
2766
|
+
* @default false
|
|
2767
|
+
*/
|
|
2768
|
+
"disabled"?: IToggle['disabled'];
|
|
2769
|
+
/**
|
|
2770
|
+
* When `true`, applies the error visual state.
|
|
2771
|
+
* @default false
|
|
2772
|
+
*/
|
|
2773
|
+
"error"?: IToggle['error'];
|
|
2774
|
+
/**
|
|
2775
|
+
* Message shown below the input when `error` is `true`. Replaces `helperText`.
|
|
2776
|
+
* @default ''
|
|
2777
|
+
*/
|
|
2778
|
+
"errorMessage"?: IToggle['errorMessage'];
|
|
2779
|
+
/**
|
|
2780
|
+
* The `id` of a `<form>` element to associate this element with.
|
|
2781
|
+
*/
|
|
2782
|
+
"form"?: string;
|
|
2783
|
+
/**
|
|
2784
|
+
* Help text displayed below the toggle. Defaults to `""`.
|
|
2785
|
+
* @default ''
|
|
2786
|
+
*/
|
|
2787
|
+
"helperText"?: IToggle['helperText'];
|
|
2788
|
+
/**
|
|
2789
|
+
* Tooltip content attached to the label. Rendered via `bds-typography` `tooltipText` prop.
|
|
2790
|
+
* @default ''
|
|
2791
|
+
*/
|
|
2792
|
+
"info"?: IToggle['info'];
|
|
2793
|
+
/**
|
|
2794
|
+
* Label displayed next to the toggle. Defaults to `""`.
|
|
2795
|
+
* @default ''
|
|
2796
|
+
*/
|
|
2797
|
+
"label"?: IToggle['label'];
|
|
2798
|
+
/**
|
|
2799
|
+
* Name of the form control, submitted as a key in the form data.
|
|
2800
|
+
*/
|
|
2801
|
+
"name": IToggle['name'];
|
|
2802
|
+
/**
|
|
2803
|
+
* Emitted when the user toggles the switch. Payload: `{ checked: boolean, value: string }`.
|
|
2804
|
+
*/
|
|
2805
|
+
"onBdsChange"?: (event: BdsToggleCustomEvent<IToggleEventChange>) => void;
|
|
2806
|
+
/**
|
|
2807
|
+
* Emitted when the checked state changes. Useful for 2-way binding / v-model. Payload: `boolean`.
|
|
2808
|
+
*/
|
|
2809
|
+
"onValueChange"?: (event: BdsToggleCustomEvent<boolean>) => void;
|
|
2810
|
+
/**
|
|
2811
|
+
* Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `TOGGLE_PLACEMENT.LEFT`.
|
|
2812
|
+
* @default TOGGLE_PLACEMENT.LEFT
|
|
2813
|
+
*/
|
|
2814
|
+
"placement"?: IToggle['placement'];
|
|
2815
|
+
/**
|
|
2816
|
+
* Marks the control as required for form submission. Defaults to `false`.
|
|
2817
|
+
* @default false
|
|
2818
|
+
*/
|
|
2819
|
+
"required"?: IToggle['required'];
|
|
2820
|
+
/**
|
|
2821
|
+
* Value submitted with the form data when checked. Behaves like the `value` attribute of a native `<input type="checkbox">`. Defaults to `"on"`.
|
|
2822
|
+
* @default 'on'
|
|
2823
|
+
*/
|
|
2824
|
+
"value"?: IToggle['value'];
|
|
2825
|
+
}
|
|
1807
2826
|
/**
|
|
1808
2827
|
* Tooltip component that displays a short label anchored to a trigger element on hover.
|
|
1809
2828
|
* @summary Displays a floating tooltip anchored to a trigger element on mouseenter/mouseleave,
|
|
@@ -1842,12 +2861,12 @@ declare namespace LocalJSX {
|
|
|
1842
2861
|
* @attr {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
1843
2862
|
* @attr {string} align - The text alignment. Options: start, center, end, inherit
|
|
1844
2863
|
* @attr {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
1845
|
-
* @attr {boolean}
|
|
2864
|
+
* @attr {boolean} required - Shows a required indicator when used with `label` variant.
|
|
1846
2865
|
* @attr {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
1847
2866
|
* @attr {number} max-lines - Maximum number of lines to show before truncating with ellipsis.
|
|
1848
2867
|
* @attr {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
1849
2868
|
* @attr {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
1850
|
-
* @attr {boolean}
|
|
2869
|
+
* @attr {boolean} downloadable - Makes the `link` download a file.
|
|
1851
2870
|
* @attr {string} filename - Suggested filename when downloading a file from the `link`.
|
|
1852
2871
|
* @attr {string} html-for - The for attribute when rendered as a label
|
|
1853
2872
|
* @attr {string} tooltip-text - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -1857,12 +2876,12 @@ declare namespace LocalJSX {
|
|
|
1857
2876
|
* @property {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
1858
2877
|
* @property {string} align - The text alignment. Options: start, center, end, inherit
|
|
1859
2878
|
* @property {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
1860
|
-
* @property {boolean}
|
|
2879
|
+
* @property {boolean} required - Shows a required indicator when used with `label` variant.
|
|
1861
2880
|
* @property {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
1862
2881
|
* @property {number} maxLines - Maximum number of lines to show before truncating with ellipsis.
|
|
1863
2882
|
* @property {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
1864
2883
|
* @property {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
1865
|
-
* @property {boolean}
|
|
2884
|
+
* @property {boolean} downloadable - Makes the `link` download a file.
|
|
1866
2885
|
* @property {string} filename - Suggested filename when downloading a file from the `link`.
|
|
1867
2886
|
* @property {string} htmlFor - The for attribute when rendered as a label
|
|
1868
2887
|
* @property {string} tooltipText - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -1872,12 +2891,12 @@ declare namespace LocalJSX {
|
|
|
1872
2891
|
* @default 'start' - Default align value
|
|
1873
2892
|
* @default 'md' - Default size value
|
|
1874
2893
|
* @default 'default' - Default state value
|
|
1875
|
-
* @default false - Default
|
|
2894
|
+
* @default false - Default required state
|
|
1876
2895
|
* @default false - Default ellipsis state
|
|
1877
2896
|
* @default 1 - Default maxLines value
|
|
1878
2897
|
* @default '' - Default href value
|
|
1879
2898
|
* @default '' - Default target value
|
|
1880
|
-
* @default false - Default
|
|
2899
|
+
* @default false - Default downloadable state
|
|
1881
2900
|
* @default 'download' - Default filename value
|
|
1882
2901
|
* @default '' - Default tooltipText value
|
|
1883
2902
|
*/
|
|
@@ -1892,6 +2911,11 @@ declare namespace LocalJSX {
|
|
|
1892
2911
|
* @default ''
|
|
1893
2912
|
*/
|
|
1894
2913
|
"customClass"?: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* Enables download behavior for anchor.
|
|
2916
|
+
* @default false
|
|
2917
|
+
*/
|
|
2918
|
+
"downloadable"?: ITypography['downloadable'];
|
|
1895
2919
|
/**
|
|
1896
2920
|
* HTML tag used for rendering.
|
|
1897
2921
|
* @default TAG_ELEMENT.P
|
|
@@ -1918,20 +2942,15 @@ declare namespace LocalJSX {
|
|
|
1918
2942
|
*/
|
|
1919
2943
|
"htmlFor"?: ITypography['htmlFor'];
|
|
1920
2944
|
/**
|
|
1921
|
-
*
|
|
1922
|
-
* @default
|
|
2945
|
+
* Max lines when ellipsis is enabled.
|
|
2946
|
+
* @default 1
|
|
1923
2947
|
*/
|
|
1924
|
-
"
|
|
2948
|
+
"maxLines"?: ITypography['maxLines'];
|
|
1925
2949
|
/**
|
|
1926
2950
|
* Marks the field as required.
|
|
1927
2951
|
* @default false
|
|
1928
2952
|
*/
|
|
1929
|
-
"
|
|
1930
|
-
/**
|
|
1931
|
-
* Max lines when ellipsis is enabled.
|
|
1932
|
-
* @default 1
|
|
1933
|
-
*/
|
|
1934
|
-
"maxLines"?: ITypography['maxLines'];
|
|
2953
|
+
"required"?: ITypography['required'];
|
|
1935
2954
|
/**
|
|
1936
2955
|
* Typography size token.
|
|
1937
2956
|
* @default SIZES.M
|
|
@@ -1959,6 +2978,16 @@ declare namespace LocalJSX {
|
|
|
1959
2978
|
"variant"?: ITypography['variant'];
|
|
1960
2979
|
}
|
|
1961
2980
|
|
|
2981
|
+
interface BdsAvatarAttributes {
|
|
2982
|
+
"username": IAvatar['username'];
|
|
2983
|
+
"variant": IAvatar['variant'];
|
|
2984
|
+
"background": IAvatar['background'];
|
|
2985
|
+
"initialsColor": IAvatar['initialsColor'];
|
|
2986
|
+
}
|
|
2987
|
+
interface BdsBadgeAttributes {
|
|
2988
|
+
"variant": IBadge['variant'];
|
|
2989
|
+
"disabled": IBadge['disabled'];
|
|
2990
|
+
}
|
|
1962
2991
|
interface BdsBannerAttributes {
|
|
1963
2992
|
"variant": IBanner['variant'];
|
|
1964
2993
|
"closable": boolean;
|
|
@@ -2000,6 +3029,9 @@ declare namespace LocalJSX {
|
|
|
2000
3029
|
"maximizable": IDialog['maximizable'];
|
|
2001
3030
|
"closable": IDialog['closable'];
|
|
2002
3031
|
}
|
|
3032
|
+
interface BdsDividerAttributes {
|
|
3033
|
+
"orientation": IDivider['orientation'];
|
|
3034
|
+
}
|
|
2003
3035
|
interface BdsFlagAttributes {
|
|
2004
3036
|
"alignFlag": IFlag['alignFlag'];
|
|
2005
3037
|
"callSign": IFlag['callSign'];
|
|
@@ -2009,6 +3041,35 @@ declare namespace LocalJSX {
|
|
|
2009
3041
|
"shape": IFlag['shape'];
|
|
2010
3042
|
"shortName": IFlag['shortName'];
|
|
2011
3043
|
}
|
|
3044
|
+
interface BdsGridAttributes {
|
|
3045
|
+
"layout": IGrid['layout'];
|
|
3046
|
+
"rowGap": IGrid['rowGap'];
|
|
3047
|
+
}
|
|
3048
|
+
interface BdsGridItemAttributes {
|
|
3049
|
+
"colSpan": string;
|
|
3050
|
+
"colSpanSm": string;
|
|
3051
|
+
"colSpanMd": string;
|
|
3052
|
+
"colSpanLg": string;
|
|
3053
|
+
"colSpanXl": string;
|
|
3054
|
+
"colSpan2xl": string;
|
|
3055
|
+
"rowSpan": string;
|
|
3056
|
+
"offset": IGridItem['offset'];
|
|
3057
|
+
}
|
|
3058
|
+
interface BdsListMenuAttributes {
|
|
3059
|
+
"multiple": boolean;
|
|
3060
|
+
"menuRole": 'menu' | 'listbox';
|
|
3061
|
+
}
|
|
3062
|
+
interface BdsListMenuItemAttributes {
|
|
3063
|
+
"variant": IListMenuItem['variant'];
|
|
3064
|
+
"name": IListMenuItem['name'];
|
|
3065
|
+
"disabled": IListMenuItem['disabled'];
|
|
3066
|
+
"selected": IListMenuItem['selected'];
|
|
3067
|
+
"value": IListMenuItem['value'];
|
|
3068
|
+
"activeItem": IListMenuItem['activeItem'];
|
|
3069
|
+
"href": IListMenuItem['href'];
|
|
3070
|
+
"newTab": IListMenuItem['newTab'];
|
|
3071
|
+
"download": IListMenuItem['download'];
|
|
3072
|
+
}
|
|
2012
3073
|
interface BdsPopoverAttributes {
|
|
2013
3074
|
"disabled": IPopover['disabled'];
|
|
2014
3075
|
"width": string;
|
|
@@ -2020,6 +3081,18 @@ declare namespace LocalJSX {
|
|
|
2020
3081
|
"size": ISpinner['size'];
|
|
2021
3082
|
"label": ISpinner['label'];
|
|
2022
3083
|
}
|
|
3084
|
+
interface BdsStatusAttributes {
|
|
3085
|
+
"state": IStatus['state'];
|
|
3086
|
+
"indicator": IStatus['indicator'];
|
|
3087
|
+
}
|
|
3088
|
+
interface BdsTagAttributes {
|
|
3089
|
+
"multiselect": ITag['multiselect'];
|
|
3090
|
+
"selected": ITag['selected'];
|
|
3091
|
+
"closeButtonLabel": ITag['closeButtonLabel'];
|
|
3092
|
+
"color": ITag['color'];
|
|
3093
|
+
"readonly": ITag['readonly'];
|
|
3094
|
+
"disabled": ITag['disabled'];
|
|
3095
|
+
}
|
|
2023
3096
|
interface BdsTextFieldAttributes {
|
|
2024
3097
|
"name": string;
|
|
2025
3098
|
"disabled": boolean;
|
|
@@ -2047,6 +3120,19 @@ declare namespace LocalJSX {
|
|
|
2047
3120
|
"counter": boolean;
|
|
2048
3121
|
"customWidth": string;
|
|
2049
3122
|
}
|
|
3123
|
+
interface BdsToggleAttributes {
|
|
3124
|
+
"name": IToggle['name'];
|
|
3125
|
+
"disabled": IToggle['disabled'];
|
|
3126
|
+
"required": IToggle['required'];
|
|
3127
|
+
"info": IToggle['info'];
|
|
3128
|
+
"error": IToggle['error'];
|
|
3129
|
+
"errorMessage": IToggle['errorMessage'];
|
|
3130
|
+
"checked": IToggle['checked'];
|
|
3131
|
+
"placement": IToggle['placement'];
|
|
3132
|
+
"label": IToggle['label'];
|
|
3133
|
+
"helperText": IToggle['helperText'];
|
|
3134
|
+
"value": IToggle['value'];
|
|
3135
|
+
}
|
|
2050
3136
|
interface BdsTooltipAttributes {
|
|
2051
3137
|
"multiline": ITooltip['multiline'];
|
|
2052
3138
|
"disabled": ITooltip['disabled'];
|
|
@@ -2061,23 +3147,33 @@ declare namespace LocalJSX {
|
|
|
2061
3147
|
"ellipsis": ITypography['ellipsis'];
|
|
2062
3148
|
"maxLines": ITypography['maxLines'];
|
|
2063
3149
|
"tooltipText": ITypography['tooltipText'];
|
|
2064
|
-
"
|
|
3150
|
+
"required": ITypography['required'];
|
|
2065
3151
|
"htmlFor": ITypography['htmlFor'];
|
|
2066
3152
|
"href": ITypography['href'];
|
|
2067
3153
|
"target": ITypography['target'];
|
|
2068
|
-
"
|
|
3154
|
+
"downloadable": ITypography['downloadable'];
|
|
2069
3155
|
"filename": ITypography['filename'];
|
|
2070
3156
|
}
|
|
2071
3157
|
|
|
2072
3158
|
interface IntrinsicElements {
|
|
3159
|
+
"bds-avatar": Omit<BdsAvatar, keyof BdsAvatarAttributes> & { [K in keyof BdsAvatar & keyof BdsAvatarAttributes]?: BdsAvatar[K] } & { [K in keyof BdsAvatar & keyof BdsAvatarAttributes as `attr:${K}`]?: BdsAvatarAttributes[K] } & { [K in keyof BdsAvatar & keyof BdsAvatarAttributes as `prop:${K}`]?: BdsAvatar[K] };
|
|
3160
|
+
"bds-badge": Omit<BdsBadge, keyof BdsBadgeAttributes> & { [K in keyof BdsBadge & keyof BdsBadgeAttributes]?: BdsBadge[K] } & { [K in keyof BdsBadge & keyof BdsBadgeAttributes as `attr:${K}`]?: BdsBadgeAttributes[K] } & { [K in keyof BdsBadge & keyof BdsBadgeAttributes as `prop:${K}`]?: BdsBadge[K] };
|
|
2073
3161
|
"bds-banner": Omit<BdsBanner, keyof BdsBannerAttributes> & { [K in keyof BdsBanner & keyof BdsBannerAttributes]?: BdsBanner[K] } & { [K in keyof BdsBanner & keyof BdsBannerAttributes as `attr:${K}`]?: BdsBannerAttributes[K] } & { [K in keyof BdsBanner & keyof BdsBannerAttributes as `prop:${K}`]?: BdsBanner[K] };
|
|
2074
3162
|
"bds-button": Omit<BdsButton, keyof BdsButtonAttributes> & { [K in keyof BdsButton & keyof BdsButtonAttributes]?: BdsButton[K] } & { [K in keyof BdsButton & keyof BdsButtonAttributes as `attr:${K}`]?: BdsButtonAttributes[K] } & { [K in keyof BdsButton & keyof BdsButtonAttributes as `prop:${K}`]?: BdsButton[K] };
|
|
2075
3163
|
"bds-checkbox": Omit<BdsCheckbox, keyof BdsCheckboxAttributes> & { [K in keyof BdsCheckbox & keyof BdsCheckboxAttributes]?: BdsCheckbox[K] } & { [K in keyof BdsCheckbox & keyof BdsCheckboxAttributes as `attr:${K}`]?: BdsCheckboxAttributes[K] } & { [K in keyof BdsCheckbox & keyof BdsCheckboxAttributes as `prop:${K}`]?: BdsCheckbox[K] } & OneOf<"name", BdsCheckbox["name"], BdsCheckboxAttributes["name"]>;
|
|
2076
3164
|
"bds-dialog": Omit<BdsDialog, keyof BdsDialogAttributes> & { [K in keyof BdsDialog & keyof BdsDialogAttributes]?: BdsDialog[K] } & { [K in keyof BdsDialog & keyof BdsDialogAttributes as `attr:${K}`]?: BdsDialogAttributes[K] } & { [K in keyof BdsDialog & keyof BdsDialogAttributes as `prop:${K}`]?: BdsDialog[K] };
|
|
3165
|
+
"bds-divider": Omit<BdsDivider, keyof BdsDividerAttributes> & { [K in keyof BdsDivider & keyof BdsDividerAttributes]?: BdsDivider[K] } & { [K in keyof BdsDivider & keyof BdsDividerAttributes as `attr:${K}`]?: BdsDividerAttributes[K] } & { [K in keyof BdsDivider & keyof BdsDividerAttributes as `prop:${K}`]?: BdsDivider[K] };
|
|
2077
3166
|
"bds-flag": Omit<BdsFlag, keyof BdsFlagAttributes> & { [K in keyof BdsFlag & keyof BdsFlagAttributes]?: BdsFlag[K] } & { [K in keyof BdsFlag & keyof BdsFlagAttributes as `attr:${K}`]?: BdsFlagAttributes[K] } & { [K in keyof BdsFlag & keyof BdsFlagAttributes as `prop:${K}`]?: BdsFlag[K] };
|
|
3167
|
+
"bds-grid": Omit<BdsGrid, keyof BdsGridAttributes> & { [K in keyof BdsGrid & keyof BdsGridAttributes]?: BdsGrid[K] } & { [K in keyof BdsGrid & keyof BdsGridAttributes as `attr:${K}`]?: BdsGridAttributes[K] } & { [K in keyof BdsGrid & keyof BdsGridAttributes as `prop:${K}`]?: BdsGrid[K] };
|
|
3168
|
+
"bds-grid-item": Omit<BdsGridItem, keyof BdsGridItemAttributes> & { [K in keyof BdsGridItem & keyof BdsGridItemAttributes]?: BdsGridItem[K] } & { [K in keyof BdsGridItem & keyof BdsGridItemAttributes as `attr:${K}`]?: BdsGridItemAttributes[K] } & { [K in keyof BdsGridItem & keyof BdsGridItemAttributes as `prop:${K}`]?: BdsGridItem[K] };
|
|
3169
|
+
"bds-list-menu": Omit<BdsListMenu, keyof BdsListMenuAttributes> & { [K in keyof BdsListMenu & keyof BdsListMenuAttributes]?: BdsListMenu[K] } & { [K in keyof BdsListMenu & keyof BdsListMenuAttributes as `attr:${K}`]?: BdsListMenuAttributes[K] } & { [K in keyof BdsListMenu & keyof BdsListMenuAttributes as `prop:${K}`]?: BdsListMenu[K] };
|
|
3170
|
+
"bds-list-menu-item": Omit<BdsListMenuItem, keyof BdsListMenuItemAttributes> & { [K in keyof BdsListMenuItem & keyof BdsListMenuItemAttributes]?: BdsListMenuItem[K] } & { [K in keyof BdsListMenuItem & keyof BdsListMenuItemAttributes as `attr:${K}`]?: BdsListMenuItemAttributes[K] } & { [K in keyof BdsListMenuItem & keyof BdsListMenuItemAttributes as `prop:${K}`]?: BdsListMenuItem[K] };
|
|
2078
3171
|
"bds-popover": Omit<BdsPopover, keyof BdsPopoverAttributes> & { [K in keyof BdsPopover & keyof BdsPopoverAttributes]?: BdsPopover[K] } & { [K in keyof BdsPopover & keyof BdsPopoverAttributes as `attr:${K}`]?: BdsPopoverAttributes[K] } & { [K in keyof BdsPopover & keyof BdsPopoverAttributes as `prop:${K}`]?: BdsPopover[K] };
|
|
2079
3172
|
"bds-spinner": Omit<BdsSpinner, keyof BdsSpinnerAttributes> & { [K in keyof BdsSpinner & keyof BdsSpinnerAttributes]?: BdsSpinner[K] } & { [K in keyof BdsSpinner & keyof BdsSpinnerAttributes as `attr:${K}`]?: BdsSpinnerAttributes[K] } & { [K in keyof BdsSpinner & keyof BdsSpinnerAttributes as `prop:${K}`]?: BdsSpinner[K] };
|
|
3173
|
+
"bds-status": Omit<BdsStatus, keyof BdsStatusAttributes> & { [K in keyof BdsStatus & keyof BdsStatusAttributes]?: BdsStatus[K] } & { [K in keyof BdsStatus & keyof BdsStatusAttributes as `attr:${K}`]?: BdsStatusAttributes[K] } & { [K in keyof BdsStatus & keyof BdsStatusAttributes as `prop:${K}`]?: BdsStatus[K] };
|
|
3174
|
+
"bds-tag": Omit<BdsTag, keyof BdsTagAttributes> & { [K in keyof BdsTag & keyof BdsTagAttributes]?: BdsTag[K] } & { [K in keyof BdsTag & keyof BdsTagAttributes as `attr:${K}`]?: BdsTagAttributes[K] } & { [K in keyof BdsTag & keyof BdsTagAttributes as `prop:${K}`]?: BdsTag[K] };
|
|
2080
3175
|
"bds-text-field": Omit<BdsTextField, keyof BdsTextFieldAttributes> & { [K in keyof BdsTextField & keyof BdsTextFieldAttributes]?: BdsTextField[K] } & { [K in keyof BdsTextField & keyof BdsTextFieldAttributes as `attr:${K}`]?: BdsTextFieldAttributes[K] } & { [K in keyof BdsTextField & keyof BdsTextFieldAttributes as `prop:${K}`]?: BdsTextField[K] };
|
|
3176
|
+
"bds-toggle": Omit<BdsToggle, keyof BdsToggleAttributes> & { [K in keyof BdsToggle & keyof BdsToggleAttributes]?: BdsToggle[K] } & { [K in keyof BdsToggle & keyof BdsToggleAttributes as `attr:${K}`]?: BdsToggleAttributes[K] } & { [K in keyof BdsToggle & keyof BdsToggleAttributes as `prop:${K}`]?: BdsToggle[K] } & OneOf<"name", BdsToggle["name"], BdsToggleAttributes["name"]>;
|
|
2081
3177
|
"bds-tooltip": Omit<BdsTooltip, keyof BdsTooltipAttributes> & { [K in keyof BdsTooltip & keyof BdsTooltipAttributes]?: BdsTooltip[K] } & { [K in keyof BdsTooltip & keyof BdsTooltipAttributes as `attr:${K}`]?: BdsTooltipAttributes[K] } & { [K in keyof BdsTooltip & keyof BdsTooltipAttributes as `prop:${K}`]?: BdsTooltip[K] };
|
|
2082
3178
|
"bds-typography": Omit<BdsTypography, keyof BdsTypographyAttributes> & { [K in keyof BdsTypography & keyof BdsTypographyAttributes]?: BdsTypography[K] } & { [K in keyof BdsTypography & keyof BdsTypographyAttributes as `attr:${K}`]?: BdsTypographyAttributes[K] } & { [K in keyof BdsTypography & keyof BdsTypographyAttributes as `prop:${K}`]?: BdsTypography[K] };
|
|
2083
3179
|
}
|
|
@@ -2086,6 +3182,31 @@ export { LocalJSX as JSX };
|
|
|
2086
3182
|
declare module "@stencil/core" {
|
|
2087
3183
|
export namespace JSX {
|
|
2088
3184
|
interface IntrinsicElements {
|
|
3185
|
+
/**
|
|
3186
|
+
* Avatar component used to display user initials or names for visual identification.
|
|
3187
|
+
* @summary Displays a circular avatar with user initials and optional name label.
|
|
3188
|
+
* Uses Boreal Design System tokens for consistent styling across platforms.
|
|
3189
|
+
* @attr {string} username - The full name used to generate initials or display as label.
|
|
3190
|
+
* @attr {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
3191
|
+
* @attr {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
3192
|
+
* @attr {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
3193
|
+
* @property {string} username - The full name used to generate initials or display as label.
|
|
3194
|
+
* @property {"icon"|"name"|"full"} variant - Controls which avatar elements are displayed: icon (initials), name, or both.
|
|
3195
|
+
* @property {string} background - Custom background color (hex code), defaults to $boreal-ui-success-base.
|
|
3196
|
+
* @property {string} initialsColor - Custom initials text color (hex code), defaults to $boreal-text-inverse.
|
|
3197
|
+
* @cssprop --bds-avatar-background - Custom background color HEX code.
|
|
3198
|
+
* @cssprop --bds-avatar-initials-color - Custom text color HEX code.
|
|
3199
|
+
*/
|
|
3200
|
+
"bds-avatar": LocalJSX.IntrinsicElements["bds-avatar"] & JSXBase.HTMLAttributes<HTMLBdsAvatarElement>;
|
|
3201
|
+
/**
|
|
3202
|
+
* Badge component for displaying contextual status information with optional icon support.
|
|
3203
|
+
* @summary A compact label component that communicates status or category using color-coded variants. Supports an optional icon slot and a disabled state.
|
|
3204
|
+
* @attr {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
3205
|
+
* @attr {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
3206
|
+
* @property {string} variant - Controls the visual style of the badge. Accepted values: 'default' | 'info' | 'success' | 'warning' | 'danger'. Default is 'default'.
|
|
3207
|
+
* @property {boolean} disabled - Disables the badge when true, reducing opacity and preventing pointer interaction. Default is false.
|
|
3208
|
+
*/
|
|
3209
|
+
"bds-badge": LocalJSX.IntrinsicElements["bds-badge"] & JSXBase.HTMLAttributes<HTMLBdsBadgeElement>;
|
|
2089
3210
|
/**
|
|
2090
3211
|
* Banner component used to display important messages with different status variants.
|
|
2091
3212
|
* @summary Displays a dismissible banner with an icon, title, body content, and optional actions.
|
|
@@ -2094,8 +3215,8 @@ declare module "@stencil/core" {
|
|
|
2094
3215
|
* @property {"info"|"success"|"warning"|"danger"} variant - Visual style variant: 'info', 'success', 'warning', or 'danger'. Defaults to "info".
|
|
2095
3216
|
* @property {boolean} closable - Shows a close button that allows users to close the banner. Defaults to false.
|
|
2096
3217
|
* @property {boolean} closeButtonLabel - Aria label for the close button when visible.
|
|
2097
|
-
* @fires bdsClose - Emitted when the banner is closed via the close button or `
|
|
2098
|
-
* @method
|
|
3218
|
+
* @fires bdsClose - Emitted when the banner is closed via the close button or `close` method.
|
|
3219
|
+
* @method close - Programmatic method to close the banner and emit the `bdsClose` event.
|
|
2099
3220
|
*/
|
|
2100
3221
|
"bds-banner": LocalJSX.IntrinsicElements["bds-banner"] & JSXBase.HTMLAttributes<HTMLBdsBannerElement>;
|
|
2101
3222
|
/**
|
|
@@ -2179,6 +3300,14 @@ declare module "@stencil/core" {
|
|
|
2179
3300
|
* @cssprop --bds-dialog-height - Custom height for the dialog.
|
|
2180
3301
|
*/
|
|
2181
3302
|
"bds-dialog": LocalJSX.IntrinsicElements["bds-dialog"] & JSXBase.HTMLAttributes<HTMLBdsDialogElement>;
|
|
3303
|
+
/**
|
|
3304
|
+
* Divider component for creating visual separators between content sections.
|
|
3305
|
+
* @summary A simple visual separator that can be oriented horizontally or vertically.
|
|
3306
|
+
* @csspart divider - A divider element that visually separates content.
|
|
3307
|
+
* @attr {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
3308
|
+
* @property {DividerOrientation} orientation - The orientation of the divider (horizontal or vertical)
|
|
3309
|
+
*/
|
|
3310
|
+
"bds-divider": LocalJSX.IntrinsicElements["bds-divider"] & JSXBase.HTMLAttributes<HTMLBdsDividerElement>;
|
|
2182
3311
|
/**
|
|
2183
3312
|
* Flag component used to display a country flag together with its corresponding label.
|
|
2184
3313
|
* @summary Renders a flag icon based on a country identifier and optionally displays
|
|
@@ -2202,6 +3331,65 @@ declare module "@stencil/core" {
|
|
|
2202
3331
|
* @property {ICountry[]} customFlags - List of custom flag definitions merged with the default catalog. Defaults to `[]`.
|
|
2203
3332
|
*/
|
|
2204
3333
|
"bds-flag": LocalJSX.IntrinsicElements["bds-flag"] & JSXBase.HTMLAttributes<HTMLBdsFlagElement>;
|
|
3334
|
+
/**
|
|
3335
|
+
* 12-column CSS Grid layout container with 5 responsive breakpoints.
|
|
3336
|
+
* Minimum browser support: Chrome/Edge (last 2), Firefox (last 2), Safari (last 2).
|
|
3337
|
+
*/
|
|
3338
|
+
"bds-grid": LocalJSX.IntrinsicElements["bds-grid"] & JSXBase.HTMLAttributes<HTMLBdsGridElement>;
|
|
3339
|
+
/**
|
|
3340
|
+
* Grid item child of `bds-grid`. Must be a direct child of `bds-grid`.
|
|
3341
|
+
*/
|
|
3342
|
+
"bds-grid-item": LocalJSX.IntrinsicElements["bds-grid-item"] & JSXBase.HTMLAttributes<HTMLBdsGridItemElement>;
|
|
3343
|
+
/**
|
|
3344
|
+
* Container component that manages a list of menu items.
|
|
3345
|
+
* It handles selection logic (single/multiple) and maintains the data state.
|
|
3346
|
+
* @summary A list menu component that can contain multiple menu items and manage their selection state.
|
|
3347
|
+
* @attr {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
3348
|
+
* @attr {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
3349
|
+
* @property {boolean} multiple - If true, allows multiple items to be selected. Default is false (single selection).
|
|
3350
|
+
* @property {string} menuRole - Defines the ARIA role of the menu. Can be 'menu' or 'listbox'. Default is 'menu'.
|
|
3351
|
+
* @event bdsChange - Emitted when the selection changes, providing the current selected value(s).
|
|
3352
|
+
* @method getSelectedValues - Returns the currently selected value(s). If multiple is true, returns an array of strings; otherwise, returns a single string or undefined.
|
|
3353
|
+
* @method setSelectedValues - Sets the selected value(s). Accepts a string for single selection or an array of strings for multiple selection.
|
|
3354
|
+
* @default false - By default, the menu does not allow multiple selections (single selection mode).
|
|
3355
|
+
* @default 'menu' - The default ARIA role for the menu is 'menu'.
|
|
3356
|
+
*/
|
|
3357
|
+
"bds-list-menu": LocalJSX.IntrinsicElements["bds-list-menu"] & JSXBase.HTMLAttributes<HTMLBdsListMenuElement>;
|
|
3358
|
+
/**
|
|
3359
|
+
* Component representing an individual item within a list menu for navigations and selection.
|
|
3360
|
+
* @summary A menu item component that supports different variants, disabled state, and selection state, it also supports link behavior when the href prop is provided.
|
|
3361
|
+
* @attr {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
3362
|
+
* @attr {string} name - The name of the list menu item.
|
|
3363
|
+
* @attr {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
3364
|
+
* @attr {boolean} selected - If true, the menu item is styled as selected.
|
|
3365
|
+
* @attr {boolean} activeItem - If true, the menu item is styled as active.
|
|
3366
|
+
* @attr {string} value - The value associated with the menu item, emitted in events when activated.\
|
|
3367
|
+
* @attr {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
3368
|
+
* @attr {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
3369
|
+
* @attr {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
3370
|
+
* @attr {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
3371
|
+
* @property {string} variant - Defines the visual style of the list menu item. Can be 'button' or 'label'. Default is 'button'.
|
|
3372
|
+
* @property {string} name - The name of the list menu item.
|
|
3373
|
+
* @property {boolean} disabled - If true, the menu item is non-interactive and styled as disabled.
|
|
3374
|
+
* @property {boolean} selected - If true, the menu item is styled as selected.
|
|
3375
|
+
* @property {boolean} activeItem - If true, the menu item is styled as active.
|
|
3376
|
+
* @property {string} value - The value associated with the menu item, emitted in events when activated.
|
|
3377
|
+
* @property {string} href - The URL for the link. If provided, the menu item will behave as a link.
|
|
3378
|
+
* @property {boolean} newTab - If true, the link will open in a new tab. Only applicable if href is provided.
|
|
3379
|
+
* @property {boolean} downloadable - If true, the link will be treated as a download link. Only applicable if href is provided.
|
|
3380
|
+
* @property {string} filename - The suggested filename for the download. Only applicable if downloadable is true.
|
|
3381
|
+
* @default 'button' - The default variant for the menu item is 'button', which is a standard clickable item.
|
|
3382
|
+
* @default '' - By default, the name of the menu item is an empty string.
|
|
3383
|
+
* @default false - By default, the menu item is not disabled and is interactive.
|
|
3384
|
+
* @default false - By default, the menu item is not selected.
|
|
3385
|
+
* @default false - By default, the menu item is not active.
|
|
3386
|
+
* @default '' - By default, the value of the menu item is an empty string.
|
|
3387
|
+
* @default '' - By default, the href is an empty string, meaning the menu item will not behave as a link.
|
|
3388
|
+
* @default false - By default, the newTab property is false, meaning links will open in the same tab.
|
|
3389
|
+
* @default false - By default, the downloadable property is false, meaning links will not be treated as download links.
|
|
3390
|
+
* @default '' - By default, the filename is an empty string, meaning no suggested filename for downloads.
|
|
3391
|
+
*/
|
|
3392
|
+
"bds-list-menu-item": LocalJSX.IntrinsicElements["bds-list-menu-item"] & JSXBase.HTMLAttributes<HTMLBdsListMenuItemElement>;
|
|
2205
3393
|
/**
|
|
2206
3394
|
* @attr {boolean} disabled - When true, prevents the popover from being shown.
|
|
2207
3395
|
* @attr {number | 'full' | 'auto'} width - Controls the width of the popover content.
|
|
@@ -2225,6 +3413,17 @@ declare module "@stencil/core" {
|
|
|
2225
3413
|
* @property {string} label - Text used as the accessible label for screen readers.
|
|
2226
3414
|
*/
|
|
2227
3415
|
"bds-spinner": LocalJSX.IntrinsicElements["bds-spinner"] & JSXBase.HTMLAttributes<HTMLBdsSpinnerElement>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Status badge component for communicating the current state of an item or process.
|
|
3418
|
+
*/
|
|
3419
|
+
"bds-status": LocalJSX.IntrinsicElements["bds-status"] & JSXBase.HTMLAttributes<HTMLBdsStatusElement>;
|
|
3420
|
+
/**
|
|
3421
|
+
* Tag component used to represent categories, metadata, or removable filters.
|
|
3422
|
+
* @summary Displays a label with optional leading/trailing icons and dismissal capability.
|
|
3423
|
+
* @fires bdsClose - Emitted when the tag is closed via the close button or Delete key.
|
|
3424
|
+
* @fires bdsSelect - Emitted when the tag is selected via a click or Space/Enter key.
|
|
3425
|
+
*/
|
|
3426
|
+
"bds-tag": LocalJSX.IntrinsicElements["bds-tag"] & JSXBase.HTMLAttributes<HTMLBdsTagElement>;
|
|
2228
3427
|
/**
|
|
2229
3428
|
* Text field component for user input with validation and form integration.
|
|
2230
3429
|
* @summary Single-line text input with label, validation, password toggle, and clear action.
|
|
@@ -2266,6 +3465,21 @@ declare module "@stencil/core" {
|
|
|
2266
3465
|
* @cssprop --bds-text-field-width - Sets a custom width for the component.
|
|
2267
3466
|
*/
|
|
2268
3467
|
"bds-text-field": LocalJSX.IntrinsicElements["bds-text-field"] & JSXBase.HTMLAttributes<HTMLBdsTextFieldElement>;
|
|
3468
|
+
/**
|
|
3469
|
+
* Toggle/Switch component for boolean selection.
|
|
3470
|
+
* @summary A toggle switch form control with label positioning support.
|
|
3471
|
+
* @property {string} name - Name of the form control, submitted as a key in the form data.
|
|
3472
|
+
* @property {boolean} disabled - Disables the control. Defaults to `false`.
|
|
3473
|
+
* @property {boolean} required - Marks the control as required for form submission. Defaults to `false`.
|
|
3474
|
+
* @property {boolean} checked - Whether the toggle is on. Defaults to `false`.
|
|
3475
|
+
* @property {string} placement - Position of the label relative to the switch. Accepts `TOGGLE_PLACEMENT` values. Defaults to `"left"`.
|
|
3476
|
+
* @property {string} label - Label displayed next to the toggle. Defaults to `""`.
|
|
3477
|
+
* @property {string} helperText - Help text displayed below the toggle. Defaults to `""`.
|
|
3478
|
+
* @property {string} value - Value submitted with the form data when checked. Defaults to `"on"`.
|
|
3479
|
+
* @fires valueChange - Emitted when the checked state changes (for 2-way binding / v-model). Payload: `boolean`.
|
|
3480
|
+
* @fires bdsChange - Emitted when the user toggles the switch. Payload: `IToggleEventChange`.
|
|
3481
|
+
*/
|
|
3482
|
+
"bds-toggle": LocalJSX.IntrinsicElements["bds-toggle"] & JSXBase.HTMLAttributes<HTMLBdsToggleElement>;
|
|
2269
3483
|
/**
|
|
2270
3484
|
* Tooltip component that displays a short label anchored to a trigger element on hover.
|
|
2271
3485
|
* @summary Displays a floating tooltip anchored to a trigger element on mouseenter/mouseleave,
|
|
@@ -2288,12 +3502,12 @@ declare module "@stencil/core" {
|
|
|
2288
3502
|
* @attr {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
2289
3503
|
* @attr {string} align - The text alignment. Options: start, center, end, inherit
|
|
2290
3504
|
* @attr {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
2291
|
-
* @attr {boolean}
|
|
3505
|
+
* @attr {boolean} required - Shows a required indicator when used with `label` variant.
|
|
2292
3506
|
* @attr {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
2293
3507
|
* @attr {number} max-lines - Maximum number of lines to show before truncating with ellipsis.
|
|
2294
3508
|
* @attr {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
2295
3509
|
* @attr {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
2296
|
-
* @attr {boolean}
|
|
3510
|
+
* @attr {boolean} downloadable - Makes the `link` download a file.
|
|
2297
3511
|
* @attr {string} filename - Suggested filename when downloading a file from the `link`.
|
|
2298
3512
|
* @attr {string} html-for - The for attribute when rendered as a label
|
|
2299
3513
|
* @attr {string} tooltip-text - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -2303,12 +3517,12 @@ declare module "@stencil/core" {
|
|
|
2303
3517
|
* @property {string} state - The state of the typography. Only available for the `helper` and `label` variants. Options: default, error, disabled, hover, active, focus, visited
|
|
2304
3518
|
* @property {string} align - The text alignment. Options: start, center, end, inherit
|
|
2305
3519
|
* @property {string} size - The size of the typography. For `display` variant all options are available (`xl`, `lg`, `md`, `sm`), while for `link` variant only `md` and `sm` are available.
|
|
2306
|
-
* @property {boolean}
|
|
3520
|
+
* @property {boolean} required - Shows a required indicator when used with `label` variant.
|
|
2307
3521
|
* @property {boolean} ellipsis - Truncates text with an ellipsis when it overflows.
|
|
2308
3522
|
* @property {number} maxLines - Maximum number of lines to show before truncating with ellipsis.
|
|
2309
3523
|
* @property {string} href - URL when the typography is an `a` element and a `link` variant.
|
|
2310
3524
|
* @property {string} target - Specifies where to open the link. Options: _self, _blank, _top, _parent
|
|
2311
|
-
* @property {boolean}
|
|
3525
|
+
* @property {boolean} downloadable - Makes the `link` download a file.
|
|
2312
3526
|
* @property {string} filename - Suggested filename when downloading a file from the `link`.
|
|
2313
3527
|
* @property {string} htmlFor - The for attribute when rendered as a label
|
|
2314
3528
|
* @property {string} tooltipText - Text to display inside the tooltip when hovering the info icon. Only applicable for `heading`, `subheading`, and `label` variants.
|
|
@@ -2318,12 +3532,12 @@ declare module "@stencil/core" {
|
|
|
2318
3532
|
* @default 'start' - Default align value
|
|
2319
3533
|
* @default 'md' - Default size value
|
|
2320
3534
|
* @default 'default' - Default state value
|
|
2321
|
-
* @default false - Default
|
|
3535
|
+
* @default false - Default required state
|
|
2322
3536
|
* @default false - Default ellipsis state
|
|
2323
3537
|
* @default 1 - Default maxLines value
|
|
2324
3538
|
* @default '' - Default href value
|
|
2325
3539
|
* @default '' - Default target value
|
|
2326
|
-
* @default false - Default
|
|
3540
|
+
* @default false - Default downloadable state
|
|
2327
3541
|
* @default 'download' - Default filename value
|
|
2328
3542
|
* @default '' - Default tooltipText value
|
|
2329
3543
|
*/
|