@duetds/components 4.30.1 → 4.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/hydrate/index.js +230 -1038
- package/lib/cjs/duet-alert.cjs.entry.js +4 -2
- package/lib/cjs/duet-badge.cjs.entry.js +2 -2
- package/lib/cjs/duet-button_2.cjs.entry.js +4 -3
- package/lib/cjs/duet-caption_4.cjs.entry.js +7 -8
- package/lib/cjs/duet-card.cjs.entry.js +4 -4
- package/lib/cjs/duet-checkbox.cjs.entry.js +1 -1
- package/lib/cjs/duet-choice_2.cjs.entry.js +4 -3
- package/lib/cjs/duet-collapsible.cjs.entry.js +2 -2
- package/lib/cjs/duet-cookie-consent.cjs.entry.js +1 -1
- package/lib/cjs/duet-date-picker.cjs.entry.js +22 -12
- package/lib/cjs/duet-divider_2.cjs.entry.js +1 -1
- package/lib/cjs/duet-empty-state.cjs.entry.js +1 -1
- package/lib/cjs/duet-fieldset.cjs.entry.js +1 -1
- package/lib/cjs/duet-footer.cjs.entry.js +4 -4
- package/lib/cjs/duet-grid_2.cjs.entry.js +1 -1
- package/lib/cjs/duet-header_2.cjs.entry.js +25 -9
- package/lib/cjs/duet-hero.cjs.entry.js +6 -6
- package/lib/cjs/duet-icon.cjs.entry.js +3 -3
- package/lib/cjs/duet-input_2.cjs.entry.js +2 -2
- package/lib/cjs/duet-layout.cjs.entry.js +1 -1
- package/lib/cjs/duet-list_2.cjs.entry.js +1 -1
- package/lib/cjs/duet-modal.cjs.entry.js +8 -7
- package/lib/cjs/duet-notification_2.cjs.entry.js +6 -5
- package/lib/cjs/duet-number-input.cjs.entry.js +36 -15
- package/lib/cjs/duet-radio_2.cjs.entry.js +1 -1
- package/lib/cjs/duet-range-slider.cjs.entry.js +1 -1
- package/lib/cjs/duet-select.cjs.entry.js +2 -2
- package/lib/cjs/duet-step_2.cjs.entry.js +1 -1
- package/lib/cjs/duet-tab_2.cjs.entry.js +11 -5
- package/lib/cjs/duet-table.cjs.entry.js +1 -1
- package/lib/cjs/duet-textarea.cjs.entry.js +1 -1
- package/lib/cjs/duet-toggle.cjs.entry.js +1 -1
- package/lib/cjs/duet-tooltip.cjs.entry.js +21 -10
- package/lib/cjs/duet-tray.cjs.entry.js +20 -9
- package/lib/cjs/duet-visually-hidden.cjs.entry.js +1 -1
- package/lib/cjs/duet.cjs.js +2 -2
- package/lib/cjs/{focus-utils-7605778f.js → focus-utils-bd331feb.js} +1 -1
- package/lib/cjs/{index-0c949193.js → index-113c2add.js} +0 -3
- package/lib/cjs/{language-utils-70d6a9a4.js → language-utils-48b8860b.js} +23 -8
- package/lib/cjs/loader.cjs.js +2 -2
- package/lib/cjs/{string-utils-a6de43d8.js → string-utils-267e3dbb.js} +7 -0
- package/lib/collection/collection-manifest.json +0 -6
- package/lib/collection/components/duet-alert/duet-alert.js +10 -4
- package/lib/collection/components/duet-badge/duet-badge.css +1 -0
- package/lib/collection/components/duet-button/duet-button.js +7 -5
- package/lib/collection/components/duet-card/duet-card.css +10 -7
- package/lib/collection/components/duet-card/duet-card.js +3 -5
- package/lib/collection/components/duet-choice/duet-choice.js +5 -3
- package/lib/collection/components/duet-choice-group/duet-choice-group.css +1 -0
- package/lib/collection/components/duet-date-picker/duet-date-picker.css +1 -1
- package/lib/collection/components/duet-date-picker/duet-date-picker.js +73 -38
- package/lib/collection/components/duet-footer/duet-footer.js +7 -5
- package/lib/collection/components/duet-header/duet-header.js +46 -21
- package/lib/collection/components/duet-heading/duet-heading.css +1 -0
- package/lib/collection/components/duet-hero/duet-hero.js +14 -9
- package/lib/collection/components/duet-icon/icon-utils.js +1 -1
- package/lib/collection/components/duet-label/duet-label.css +2 -0
- package/lib/collection/components/duet-link/duet-link.js +10 -11
- package/lib/collection/components/duet-modal/duet-modal.js +16 -11
- package/lib/collection/components/duet-notification-drawer/duet-notification-drawer.js +14 -9
- package/lib/collection/components/duet-number-input/duet-number-input.js +141 -17
- package/lib/collection/components/duet-tab-group/duet-tab-group.js +35 -4
- package/lib/collection/components/duet-tooltip/duet-tooltip.js +72 -10
- package/lib/collection/components/duet-tray/duet-tray.js +71 -9
- package/lib/collection/utils/fixture-utils.js +7 -5
- package/lib/collection/utils/language-utils.js +22 -8
- package/lib/collection/utils/string-utils.js +6 -0
- package/lib/custom-elements-bundle/index.d.ts +0 -6
- package/lib/custom-elements-bundle/index.js +224 -995
- package/lib/duet/duet.esm.js +1 -1
- package/lib/duet/duet.js +1 -1
- package/lib/duet/p-0058512b.js +4 -0
- package/lib/duet/p-0224db45.entry.js +4 -0
- package/lib/duet/{p-345ea4f2.system.entry.js → p-02ad46a0.system.entry.js} +1 -1
- package/lib/duet/{p-62806bb6.system.entry.js → p-07263910.system.entry.js} +1 -1
- package/lib/duet/{p-f82709ba.entry.js → p-1bfbc988.entry.js} +1 -1
- package/lib/duet/p-1cd7177f.entry.js +4 -0
- package/lib/duet/p-1cec5a70.system.entry.js +4 -0
- package/lib/duet/p-1e7222c2.entry.js +4 -0
- package/lib/duet/{p-c0b95b58.entry.js → p-202bbd70.entry.js} +1 -1
- package/lib/duet/{p-d1817efe.system.entry.js → p-22f56356.system.entry.js} +1 -1
- package/lib/duet/{p-f81d8534.entry.js → p-28b67b94.entry.js} +1 -1
- package/lib/duet/{p-b4374f0e.entry.js → p-33426ddc.entry.js} +1 -1
- package/lib/duet/p-33cf6ed1.entry.js +4 -0
- package/lib/duet/p-3d3f773d.system.entry.js +4 -0
- package/lib/duet/p-3e1ef509.system.entry.js +4 -0
- package/lib/duet/p-3f78a826.system.js +4 -0
- package/lib/duet/{p-2a1a9f9f.entry.js → p-44ffb960.entry.js} +1 -1
- package/lib/duet/{p-dee41056.system.entry.js → p-453955cc.system.entry.js} +1 -1
- package/lib/duet/{p-66dde4d2.entry.js → p-4670a654.entry.js} +1 -1
- package/lib/duet/p-47645ea8.system.entry.js +4 -0
- package/lib/duet/p-504dbf8f.system.entry.js +4 -0
- package/lib/duet/{p-62c294d6.system.entry.js → p-5230ee3c.system.entry.js} +1 -1
- package/lib/duet/{p-bbc229d8.system.entry.js → p-56e172f5.system.entry.js} +1 -1
- package/lib/duet/{p-de2be65b.system.js → p-57ea2576.system.js} +1 -1
- package/lib/duet/p-5aa0d34d.entry.js +4 -0
- package/lib/duet/p-5fc7e1f7.system.entry.js +4 -0
- package/lib/duet/{p-3dc9d15d.system.entry.js → p-605bc214.system.entry.js} +1 -1
- package/lib/duet/{p-4a7911fd.entry.js → p-60ab57d4.entry.js} +1 -1
- package/lib/duet/p-64109493.entry.js +4 -0
- package/lib/duet/{p-7e108b7e.entry.js → p-69a5dc6b.entry.js} +1 -1
- package/lib/duet/{p-8cfce39e.system.entry.js → p-6a230911.system.entry.js} +1 -1
- package/lib/duet/p-6a760b8a.entry.js +4 -0
- package/lib/duet/{p-c9303f9a.entry.js → p-6d2da245.entry.js} +1 -1
- package/lib/duet/{p-ceb75b35.system.entry.js → p-712e7dde.system.entry.js} +1 -1
- package/lib/duet/{p-f71f12ed.entry.js → p-746655ba.entry.js} +1 -1
- package/lib/duet/p-7b6db837.system.entry.js +4 -0
- package/lib/duet/p-7d080785.system.entry.js +4 -0
- package/lib/duet/{p-4095dba5.entry.js → p-82dc2e0b.entry.js} +1 -1
- package/lib/duet/p-8c8e82aa.system.js +4 -0
- package/lib/duet/{p-fc397e03.system.entry.js → p-8c980350.system.entry.js} +1 -1
- package/lib/duet/{p-1cfe38b1.system.entry.js → p-8cb47a70.system.entry.js} +1 -1
- package/lib/duet/{p-7ee52f58.entry.js → p-8f03c3eb.entry.js} +1 -1
- package/lib/duet/p-91fa68a5.js +4 -0
- package/lib/duet/{p-e26116e0.system.entry.js → p-92d38668.system.entry.js} +1 -1
- package/lib/duet/p-95626e7e.system.entry.js +4 -0
- package/lib/duet/p-96808a2e.system.entry.js +4 -0
- package/lib/duet/{p-8ffe1461.system.entry.js → p-96c103b2.system.entry.js} +1 -1
- package/lib/duet/p-986779fb.js +4 -0
- package/lib/duet/{p-35e45c19.system.js → p-9a945278.system.js} +1 -1
- package/lib/duet/{p-2d2c45f9.entry.js → p-9c94be45.entry.js} +1 -1
- package/lib/duet/p-9ce1baab.system.entry.js +4 -0
- package/lib/duet/p-9ff25646.entry.js +4 -0
- package/lib/duet/p-a1d12e94.system.entry.js +4 -0
- package/lib/duet/p-b03a46b6.entry.js +4 -0
- package/lib/duet/{p-a88df408.entry.js → p-b1b8e510.entry.js} +1 -1
- package/lib/duet/p-b694cbf5.system.js +4 -0
- package/lib/duet/p-b7e50cfa.entry.js +4 -0
- package/lib/duet/p-b82927b0.system.entry.js +4 -0
- package/lib/duet/{p-c3688975.entry.js → p-ba205dca.entry.js} +1 -1
- package/lib/duet/{p-f71e337e.system.entry.js → p-bcae23fc.system.entry.js} +1 -1
- package/lib/duet/{p-5c5bdb06.system.entry.js → p-be19c57b.system.entry.js} +1 -1
- package/lib/duet/{p-a321a98c.entry.js → p-c4737f88.entry.js} +1 -1
- package/lib/duet/p-c5beceed.js +4 -0
- package/lib/duet/{p-27d538f7.system.entry.js → p-c5f10483.system.entry.js} +1 -1
- package/lib/duet/{p-a6096b05.system.entry.js → p-d35fd913.system.entry.js} +1 -1
- package/lib/duet/p-d4b4bfa6.entry.js +4 -0
- package/lib/duet/p-d7623eb8.system.entry.js +4 -0
- package/lib/duet/{p-36007600.entry.js → p-dc85d2a4.entry.js} +1 -1
- package/lib/duet/p-de093c16.entry.js +4 -0
- package/lib/duet/p-de842863.entry.js +4 -0
- package/lib/duet/{p-59a07cf9.entry.js → p-e08b8909.entry.js} +1 -1
- package/lib/duet/p-e39471b6.entry.js +4 -0
- package/lib/duet/p-e834c8d5.system.entry.js +4 -0
- package/lib/duet/{p-ce1374a4.system.entry.js → p-ef45cfe9.system.entry.js} +1 -1
- package/lib/duet/{p-031c2cd8.system.entry.js → p-f0b1850a.system.entry.js} +1 -1
- package/lib/duet/p-f53c8019.entry.js +4 -0
- package/lib/duet/{p-4265de16.system.entry.js → p-f96c4093.system.entry.js} +1 -1
- package/lib/duet/p-fbd83d67.entry.js +4 -0
- package/lib/duet/{p-1c41525a.entry.js → p-fdecaf46.entry.js} +1 -1
- package/lib/esm/duet-alert.entry.js +4 -2
- package/lib/esm/duet-badge.entry.js +2 -2
- package/lib/esm/duet-button_2.entry.js +4 -3
- package/lib/esm/duet-caption_4.entry.js +7 -8
- package/lib/esm/duet-card.entry.js +4 -4
- package/lib/esm/duet-checkbox.entry.js +1 -1
- package/lib/esm/duet-choice_2.entry.js +4 -3
- package/lib/esm/duet-collapsible.entry.js +2 -2
- package/lib/esm/duet-cookie-consent.entry.js +1 -1
- package/lib/esm/duet-date-picker.entry.js +22 -12
- package/lib/esm/duet-divider_2.entry.js +1 -1
- package/lib/esm/duet-empty-state.entry.js +1 -1
- package/lib/esm/duet-fieldset.entry.js +1 -1
- package/lib/esm/duet-footer.entry.js +4 -4
- package/lib/esm/duet-grid_2.entry.js +1 -1
- package/lib/esm/duet-header_2.entry.js +25 -9
- package/lib/esm/duet-hero.entry.js +6 -6
- package/lib/esm/duet-icon.entry.js +3 -3
- package/lib/esm/duet-input_2.entry.js +2 -2
- package/lib/esm/duet-layout.entry.js +1 -1
- package/lib/esm/duet-list_2.entry.js +1 -1
- package/lib/esm/duet-modal.entry.js +8 -7
- package/lib/esm/duet-notification_2.entry.js +6 -5
- package/lib/esm/duet-number-input.entry.js +36 -15
- package/lib/esm/duet-radio_2.entry.js +1 -1
- package/lib/esm/duet-range-slider.entry.js +1 -1
- package/lib/esm/duet-select.entry.js +2 -2
- package/lib/esm/duet-step_2.entry.js +1 -1
- package/lib/esm/duet-tab_2.entry.js +11 -5
- package/lib/esm/duet-table.entry.js +1 -1
- package/lib/esm/duet-textarea.entry.js +1 -1
- package/lib/esm/duet-toggle.entry.js +1 -1
- package/lib/esm/duet-tooltip.entry.js +21 -10
- package/lib/esm/duet-tray.entry.js +20 -9
- package/lib/esm/duet-visually-hidden.entry.js +1 -1
- package/lib/esm/duet.js +2 -2
- package/lib/esm/{focus-utils-0b12f0df.js → focus-utils-1995e5a9.js} +1 -1
- package/lib/esm/{index-f70ddc7f.js → index-6e246691.js} +0 -3
- package/lib/esm/{language-utils-ab9c3afc.js → language-utils-d5c38f65.js} +23 -8
- package/lib/esm/loader.js +2 -2
- package/lib/esm/{string-utils-69cf0d09.js → string-utils-2f1793b8.js} +7 -1
- package/lib/esm-es5/duet-alert.entry.js +1 -1
- package/lib/esm-es5/duet-badge.entry.js +1 -1
- package/lib/esm-es5/duet-button_2.entry.js +1 -1
- package/lib/esm-es5/duet-caption_4.entry.js +1 -1
- package/lib/esm-es5/duet-card.entry.js +1 -1
- package/lib/esm-es5/duet-checkbox.entry.js +1 -1
- package/lib/esm-es5/duet-choice_2.entry.js +1 -1
- package/lib/esm-es5/duet-collapsible.entry.js +1 -1
- package/lib/esm-es5/duet-cookie-consent.entry.js +1 -1
- package/lib/esm-es5/duet-date-picker.entry.js +1 -1
- package/lib/esm-es5/duet-divider_2.entry.js +1 -1
- package/lib/esm-es5/duet-empty-state.entry.js +1 -1
- package/lib/esm-es5/duet-fieldset.entry.js +1 -1
- package/lib/esm-es5/duet-footer.entry.js +1 -1
- package/lib/esm-es5/duet-grid_2.entry.js +1 -1
- package/lib/esm-es5/duet-header_2.entry.js +1 -1
- package/lib/esm-es5/duet-hero.entry.js +1 -1
- package/lib/esm-es5/duet-icon.entry.js +1 -1
- package/lib/esm-es5/duet-input_2.entry.js +1 -1
- package/lib/esm-es5/duet-layout.entry.js +1 -1
- package/lib/esm-es5/duet-list_2.entry.js +1 -1
- package/lib/esm-es5/duet-modal.entry.js +1 -1
- package/lib/esm-es5/duet-notification_2.entry.js +1 -1
- package/lib/esm-es5/duet-number-input.entry.js +2 -2
- package/lib/esm-es5/duet-radio_2.entry.js +1 -1
- package/lib/esm-es5/duet-range-slider.entry.js +1 -1
- package/lib/esm-es5/duet-select.entry.js +1 -1
- package/lib/esm-es5/duet-step_2.entry.js +1 -1
- package/lib/esm-es5/duet-tab_2.entry.js +1 -1
- package/lib/esm-es5/duet-table.entry.js +1 -1
- package/lib/esm-es5/duet-textarea.entry.js +1 -1
- package/lib/esm-es5/duet-toggle.entry.js +1 -1
- package/lib/esm-es5/duet-tooltip.entry.js +1 -1
- package/lib/esm-es5/duet-tray.entry.js +1 -1
- package/lib/esm-es5/duet-visually-hidden.entry.js +1 -1
- package/lib/esm-es5/duet.js +1 -1
- package/lib/esm-es5/focus-utils-1995e5a9.js +4 -0
- package/lib/esm-es5/{index-f70ddc7f.js → index-6e246691.js} +1 -1
- package/lib/esm-es5/language-utils-d5c38f65.js +4 -0
- package/lib/esm-es5/loader.js +1 -1
- package/lib/esm-es5/{string-utils-69cf0d09.js → string-utils-2f1793b8.js} +1 -1
- package/lib/html.html-data.json +4489 -0
- package/lib/types/components/duet-alert/duet-alert.d.ts +2 -1
- package/lib/types/components/duet-button/duet-button.d.ts +1 -1
- package/lib/types/components/duet-choice/duet-choice.d.ts +1 -1
- package/lib/types/components/duet-date-picker/duet-date-picker.d.ts +13 -7
- package/lib/types/components/duet-footer/duet-footer.d.ts +1 -1
- package/lib/types/components/duet-header/duet-header.d.ts +21 -5
- package/lib/types/components/duet-hero/duet-hero.d.ts +3 -3
- package/lib/types/components/duet-link/duet-link.d.ts +2 -3
- package/lib/types/components/duet-modal/duet-modal.d.ts +3 -3
- package/lib/types/components/duet-notification-drawer/duet-notification-drawer.d.ts +3 -3
- package/lib/types/components/duet-number-input/duet-number-input.d.ts +21 -0
- package/lib/types/components/duet-tab-group/duet-tab-group.d.ts +6 -0
- package/lib/types/components/duet-tooltip/duet-tooltip.d.ts +11 -0
- package/lib/types/components/duet-tray/duet-tray.d.ts +11 -0
- package/lib/types/components.d.ts +146 -384
- package/lib/types/utils/language-utils.d.ts +3 -2
- package/lib/types/utils/string-utils.d.ts +1 -0
- package/package.json +18 -14
- package/lib/cjs/duet-upload.cjs.entry.js +0 -866
- package/lib/collection/components/duet-upload/duet-upload-file-list.js +0 -49
- package/lib/collection/components/duet-upload/duet-upload-validators.js +0 -93
- package/lib/collection/components/duet-upload/duet-upload.css +0 -133
- package/lib/collection/components/duet-upload/duet-upload.js +0 -1440
- package/lib/collection/components/duet-upload/errorcodes.utils.js +0 -20
- package/lib/collection/components/duet-upload/mock.helpers.js +0 -91
- package/lib/collection/components/duet-upload/upload.helpers.js +0 -13
- package/lib/collection/components/duet-upload/xhr.helpers.js +0 -34
- package/lib/duet/p-0733c303.system.entry.js +0 -4
- package/lib/duet/p-095060cc.js +0 -4
- package/lib/duet/p-156864a1.system.entry.js +0 -4
- package/lib/duet/p-1911dfe7.system.entry.js +0 -4
- package/lib/duet/p-2834a302.entry.js +0 -4
- package/lib/duet/p-28a3d38f.system.entry.js +0 -4
- package/lib/duet/p-2a4d7c5b.system.entry.js +0 -4
- package/lib/duet/p-4289b543.entry.js +0 -4
- package/lib/duet/p-46a3ae43.system.js +0 -4
- package/lib/duet/p-4a38cf9d.entry.js +0 -4
- package/lib/duet/p-4be8e814.entry.js +0 -4
- package/lib/duet/p-591b2137.entry.js +0 -4
- package/lib/duet/p-5f70e318.entry.js +0 -4
- package/lib/duet/p-6c2729da.js +0 -4
- package/lib/duet/p-6f107847.system.entry.js +0 -4
- package/lib/duet/p-77a5fe4c.system.js +0 -4
- package/lib/duet/p-7809e78b.system.entry.js +0 -4
- package/lib/duet/p-7a36d76f.system.entry.js +0 -4
- package/lib/duet/p-884693f1.entry.js +0 -4
- package/lib/duet/p-8977b722.entry.js +0 -4
- package/lib/duet/p-89db3b94.entry.js +0 -4
- package/lib/duet/p-9381c2d4.entry.js +0 -4
- package/lib/duet/p-9a450c9a.entry.js +0 -4
- package/lib/duet/p-9bbfe606.system.entry.js +0 -4
- package/lib/duet/p-a0a066cb.system.entry.js +0 -4
- package/lib/duet/p-a89d5d7c.entry.js +0 -4
- package/lib/duet/p-b07055fd.system.entry.js +0 -4
- package/lib/duet/p-b456d684.system.entry.js +0 -4
- package/lib/duet/p-bd18c93f.js +0 -4
- package/lib/duet/p-bddb1c15.system.entry.js +0 -4
- package/lib/duet/p-c4d183e6.entry.js +0 -4
- package/lib/duet/p-cd4e8ccf.js +0 -4
- package/lib/duet/p-cf243bcb.system.entry.js +0 -4
- package/lib/duet/p-d37c8a05.system.js +0 -4
- package/lib/duet/p-d989af11.entry.js +0 -4
- package/lib/duet/p-e6128d82.system.entry.js +0 -4
- package/lib/duet/p-e86cdc17.entry.js +0 -4
- package/lib/duet/p-eadb29c7.entry.js +0 -4
- package/lib/duet/p-f30b14d6.system.entry.js +0 -4
- package/lib/duet/p-f79f8da1.entry.js +0 -4
- package/lib/esm/duet-upload.entry.js +0 -862
- package/lib/esm-es5/duet-upload.entry.js +0 -4
- package/lib/esm-es5/focus-utils-0b12f0df.js +0 -4
- package/lib/esm-es5/language-utils-ab9c3afc.js +0 -4
- package/lib/types/components/duet-upload/duet-upload-file-list.d.ts +0 -9
- package/lib/types/components/duet-upload/duet-upload-validators.d.ts +0 -12
- package/lib/types/components/duet-upload/duet-upload.d.ts +0 -311
- package/lib/types/components/duet-upload/errorcodes.utils.d.ts +0 -7
- package/lib/types/components/duet-upload/mock.helpers.d.ts +0 -2
- package/lib/types/components/duet-upload/upload.helpers.d.ts +0 -1
- package/lib/types/components/duet-upload/xhr.helpers.d.ts +0 -12
|
@@ -0,0 +1,4489 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 1.1,
|
|
3
|
+
"tags": [
|
|
4
|
+
{
|
|
5
|
+
"name": "duet-alert",
|
|
6
|
+
"description": {
|
|
7
|
+
"kind": "markdown",
|
|
8
|
+
"value": "---\ntitle: Alert\nname: duet-alert\nstatus: ready\nreleased: 1.0.50\ncategory: Messaging\nexample_height: 320px\naccessibility: Keyboard, Screen Reader\ninternationalization: Supported\nintro: Informs user about important changes or conditions in the interface. Use\n this component if you need to capture user’s attention in a prominent way.\nplatforms: Web only\nssr: Supported\nexamples:\n - name: alert\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Alert in different styles\n file: fixtures/duet-alert_alert_in_different_styles.html\n - name: Alert with icon\n file: fixtures/duet-alert_alert_with_icon.html\n - name: Dismissible alert\n file: fixtures/duet-alert_dismissible_alert.html\n - name: Alert as a toast message\n file: fixtures/duet-alert_alert_as_a_toast_message.html\n - name: Alert with left aligned content\n file: fixtures/duet-alert_alert_with_left_aligned_content.html\n - name: Alert as a toast message with auto dismiss\n file: fixtures/duet-alert_alert_as_a_toast_message_with_auto_dismiss.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
9
|
+
},
|
|
10
|
+
"attributes": [
|
|
11
|
+
{
|
|
12
|
+
"name": "accessible-label",
|
|
13
|
+
"description": "Adds accessible label for the dismissible alert close button."
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"name": "accessible-label-default",
|
|
17
|
+
"description": "Property to change languageDefaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabel when needed"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"name": "announcements",
|
|
21
|
+
"description": "Enable or disabled announcements by assistive technologies."
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"name": "auto-dismiss",
|
|
25
|
+
"description": "Time in milliseconds which is waited before auto dismiss."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "dismissible",
|
|
29
|
+
"description": "Should a button be rendered to dismiss the alert?"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "icon",
|
|
33
|
+
"description": "Icon to display to the left of the content."
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "margin",
|
|
37
|
+
"description": "Controls the margin of the component.",
|
|
38
|
+
"values": [
|
|
39
|
+
{
|
|
40
|
+
"name": "auto"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"name": "none"
|
|
44
|
+
}
|
|
45
|
+
]
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"name": "padding",
|
|
49
|
+
"description": "Controls the padding of the component.",
|
|
50
|
+
"values": [
|
|
51
|
+
{
|
|
52
|
+
"name": "auto"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "none"
|
|
56
|
+
}
|
|
57
|
+
]
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
"name": "theme",
|
|
61
|
+
"description": "Theme of the card.",
|
|
62
|
+
"values": [
|
|
63
|
+
{
|
|
64
|
+
"name": "default"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"name": "turva"
|
|
68
|
+
}
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
"name": "variation",
|
|
73
|
+
"description": "Style variation of the alert.",
|
|
74
|
+
"values": [
|
|
75
|
+
{
|
|
76
|
+
"name": "danger"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"name": "default"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"name": "success"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "warning"
|
|
86
|
+
}
|
|
87
|
+
]
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"references": [
|
|
91
|
+
{
|
|
92
|
+
"name": "Source code",
|
|
93
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-alert/duet-alert.tsx"
|
|
94
|
+
}
|
|
95
|
+
]
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"name": "duet-badge",
|
|
99
|
+
"description": {
|
|
100
|
+
"kind": "markdown",
|
|
101
|
+
"value": "---\ntitle: Badge\nname: duet-badge\nstatus: ready\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.2.1\nssr: Supported\ncategory: Text\nintro: Badges are used to inform users of the status of an object or of an\n action that’s been taken.\nexamples:\n - name: badge\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default badge\n file: fixtures/duet-badge_default_badge.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
102
|
+
},
|
|
103
|
+
"attributes": [
|
|
104
|
+
{
|
|
105
|
+
"name": "margin",
|
|
106
|
+
"description": "Controls the margin of the component.",
|
|
107
|
+
"values": [
|
|
108
|
+
{
|
|
109
|
+
"name": "auto"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"name": "none"
|
|
113
|
+
}
|
|
114
|
+
]
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"name": "theme",
|
|
118
|
+
"description": "Theme of the badge.",
|
|
119
|
+
"values": [
|
|
120
|
+
{
|
|
121
|
+
"name": "default"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"name": "turva"
|
|
125
|
+
}
|
|
126
|
+
]
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
"name": "variation",
|
|
130
|
+
"description": "Style variation of the alert.",
|
|
131
|
+
"values": [
|
|
132
|
+
{
|
|
133
|
+
"name": "danger"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"name": "default"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "success"
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"name": "warning"
|
|
143
|
+
}
|
|
144
|
+
]
|
|
145
|
+
}
|
|
146
|
+
],
|
|
147
|
+
"references": [
|
|
148
|
+
{
|
|
149
|
+
"name": "Source code",
|
|
150
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-badge/duet-badge.tsx"
|
|
151
|
+
}
|
|
152
|
+
]
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"name": "duet-button",
|
|
156
|
+
"description": {
|
|
157
|
+
"kind": "markdown",
|
|
158
|
+
"value": "---\ntitle: Button\nname: duet-button\nstatus: ready\nreleased: 1.0.15\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Actions\nintro: Buttons are used for interface actions. They default to appearance that\n has dark text with gray border. Primary style should be used only once per\n view for main call-to-action.\ndescription: Users generally expect buttons to submit data or take action, and\n for links to navigate. If navigation is required for the button, use the url\n prop. The control will then output an anchor styled as a button, instead of an\n HTML button.\nplatforms: Web only\nexamples:\n - name: button\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Primary button\n file: fixtures/duet-button_primary_button.html\n - name: Button with icon on left\n file: fixtures/duet-button_button_with_icon_on_left.html\n - name: Button with icon on right\n file: fixtures/duet-button_button_with_icon_on_right.html\n - name: Next and previous buttons\n file: fixtures/duet-button_next_and_previous_buttons.html\n - name: Loading button\n file: fixtures/duet-button_loading_button.html\n - name: Expand button\n file: fixtures/duet-button_expand_button.html\n - name: Secondary button\n file: fixtures/duet-button_secondary_button.html\n - name: Default button\n file: fixtures/duet-button_default_button.html\n - name: Negative button\n file: fixtures/duet-button_negative_button.html\n - name: Destructive button\n file: fixtures/duet-button_destructive_button.html\n - name: Disabled button\n file: fixtures/duet-button_disabled_button.html\n - name: Plain button\n file: fixtures/duet-button_plain_button.html\n - name: Show more button\n file: fixtures/duet-button_show_more_button.html\n - name: Small buttons\n file: fixtures/duet-button_small_buttons.html\n - name: Time selector using small buttons\n file: fixtures/duet-button_time_selector_using_small_buttons.html\n - name: Button in a form\n file: fixtures/duet-button_button_in_a_form.html\n - name: Button as a link\n file: fixtures/duet-button_button_as_a_link.html\n - name: Button with external link\n file: fixtures/duet-button_button_with_external_link.html \n - name: All Button variations\n file: fixtures/duet-button_all_negative_buttons.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
159
|
+
},
|
|
160
|
+
"attributes": [
|
|
161
|
+
{
|
|
162
|
+
"name": "accessible-active-descendant",
|
|
163
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"name": "accessible-controls",
|
|
167
|
+
"description": "Use this property to add an aria-controls attribute to the button. Use\nthe attribute to point to the unique id of the content that the button manages."
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
"name": "accessible-described-by",
|
|
171
|
+
"description": "Indicates the id of a component that describes the button."
|
|
172
|
+
},
|
|
173
|
+
{
|
|
174
|
+
"name": "accessible-expanded",
|
|
175
|
+
"description": "If a button expands or collapses adjacent content, then use the ariaExpanded\nprop to add the aria-expanded attribute to the button. Set the value to convey\nthe current expanded (true) or collapsed (false) state of the content."
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"name": "accessible-label",
|
|
179
|
+
"description": "Adds accessible label for the button that is only shown for screen readers.\nTypically, this label text replaces the visible text on the button for\nusers who use assistive technology."
|
|
180
|
+
},
|
|
181
|
+
{
|
|
182
|
+
"name": "accessible-label-external",
|
|
183
|
+
"description": "Adds accessible label for tooltip that is shown in external link (url & external have both been set)"
|
|
184
|
+
},
|
|
185
|
+
{
|
|
186
|
+
"name": "accessible-label-external-default",
|
|
187
|
+
"description": "Property to change accessibleLabelExternal defaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabelExternal when needed"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"name": "accessible-owns",
|
|
191
|
+
"description": "Indicates the id of a component owned by the button."
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
"name": "accessible-pressed",
|
|
195
|
+
"description": "Tells screen reader the element is pressed."
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"name": "color",
|
|
199
|
+
"description": "Custom color to be used for text, as a design token entered in camelCase or\nkebab-case. Example: \"color-primary\"."
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"name": "disabled",
|
|
203
|
+
"description": "Makes the button component disabled. This prevents users from being able to\ninteract with the button, and conveys its inactive state to assistive technologies."
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "expand",
|
|
207
|
+
"description": "Expands the button to fill 100% of the container width."
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"name": "external",
|
|
211
|
+
"description": "Forces URL to open in a new browser tab. Used together with URL prop."
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"name": "fixed",
|
|
215
|
+
"description": "Keep the button fixed width even on mobile viewports."
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"name": "icon",
|
|
219
|
+
"description": "Icon to display to the left of the button content.\nThis is ignored/overridden when button is used as an external link."
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"name": "icon-only",
|
|
223
|
+
"description": "Whether this button should use styles meant for displaying just an icon."
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"name": "icon-right",
|
|
227
|
+
"description": "Show icon on the right side of the button content."
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "icon-size",
|
|
231
|
+
"description": "Icon size.",
|
|
232
|
+
"values": [
|
|
233
|
+
{
|
|
234
|
+
"name": "large"
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "medium"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"name": "medium-small"
|
|
241
|
+
},
|
|
242
|
+
{
|
|
243
|
+
"name": "small"
|
|
244
|
+
}
|
|
245
|
+
]
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"name": "identifier",
|
|
249
|
+
"description": "Adds a unique identifier for the button. Please note that with this particular\ncomponent this id is added inside Shadow DOM. If you need an id on the html\nelement, use regular id attribute instead."
|
|
250
|
+
},
|
|
251
|
+
{
|
|
252
|
+
"name": "language",
|
|
253
|
+
"description": ""
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "loading",
|
|
257
|
+
"description": "Loading state of the button"
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"name": "margin",
|
|
261
|
+
"description": "Controls the margin of the component.",
|
|
262
|
+
"values": [
|
|
263
|
+
{
|
|
264
|
+
"name": "auto"
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"name": "none"
|
|
268
|
+
}
|
|
269
|
+
]
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "name",
|
|
273
|
+
"description": "The name of the button, which gets paired with the button's value when submitted as part of a form.\nCorresponds with the native HTML name attribute."
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"name": "negative",
|
|
277
|
+
"description": "Negative variation, can be combined with Variation to produce negative versions"
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"name": "padding",
|
|
281
|
+
"description": "Controls the padding of the component.",
|
|
282
|
+
"values": [
|
|
283
|
+
{
|
|
284
|
+
"name": "auto"
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"name": "none"
|
|
288
|
+
}
|
|
289
|
+
]
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
"name": "size",
|
|
293
|
+
"description": "Button’s size.",
|
|
294
|
+
"values": [
|
|
295
|
+
{
|
|
296
|
+
"name": "medium"
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"name": "small"
|
|
300
|
+
}
|
|
301
|
+
]
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "submit",
|
|
305
|
+
"description": "Allows the button to submit a form."
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"name": "theme",
|
|
309
|
+
"description": "Theme of the button.",
|
|
310
|
+
"values": [
|
|
311
|
+
{
|
|
312
|
+
"name": "default"
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "turva"
|
|
316
|
+
}
|
|
317
|
+
]
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
"name": "url",
|
|
321
|
+
"description": "A destination to link to, rendered in the href attribute of a link."
|
|
322
|
+
},
|
|
323
|
+
{
|
|
324
|
+
"name": "value",
|
|
325
|
+
"description": "The value of the button, which gets paired with the button's name when submitted as part of a form.\nCorresponds with the native HTML value attribute."
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"name": "variation",
|
|
329
|
+
"description": "Style variation of the button.",
|
|
330
|
+
"values": [
|
|
331
|
+
{
|
|
332
|
+
"name": "default"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"name": "destructive"
|
|
336
|
+
},
|
|
337
|
+
{
|
|
338
|
+
"name": "negative"
|
|
339
|
+
},
|
|
340
|
+
{
|
|
341
|
+
"name": "plain"
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "primary"
|
|
345
|
+
},
|
|
346
|
+
{
|
|
347
|
+
"name": "secondary"
|
|
348
|
+
}
|
|
349
|
+
]
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"name": "wrapping",
|
|
353
|
+
"description": "Controls the text wrapping.",
|
|
354
|
+
"values": [
|
|
355
|
+
{
|
|
356
|
+
"name": "auto"
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
"name": "none"
|
|
360
|
+
}
|
|
361
|
+
]
|
|
362
|
+
}
|
|
363
|
+
],
|
|
364
|
+
"references": [
|
|
365
|
+
{
|
|
366
|
+
"name": "Source code",
|
|
367
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-button/duet-button.tsx"
|
|
368
|
+
}
|
|
369
|
+
]
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
"name": "duet-caption",
|
|
373
|
+
"description": {
|
|
374
|
+
"kind": "markdown",
|
|
375
|
+
"value": "---\ntitle: Caption\nname: duet-caption\nstatus: ready\nreleased: 2.6.16\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Text\nintro: Captions are used as brief explanations accompanying an illustration,\n form element, or similar. Caption text is smaller than the recommended size\n for general reading.\nexamples:\n - name: caption\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default caption\n file: fixtures/duet-caption_default_caption.html\n - name: Associating caption with an input\n file: fixtures/duet-caption_associating_caption_with_an_input.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
376
|
+
},
|
|
377
|
+
"attributes": [
|
|
378
|
+
{
|
|
379
|
+
"name": "margin",
|
|
380
|
+
"description": "Controls the margin of the component.",
|
|
381
|
+
"values": [
|
|
382
|
+
{
|
|
383
|
+
"name": "auto"
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"name": "none"
|
|
387
|
+
}
|
|
388
|
+
]
|
|
389
|
+
},
|
|
390
|
+
{
|
|
391
|
+
"name": "selected",
|
|
392
|
+
"description": "Selected state of the caption. Used inside Choice component."
|
|
393
|
+
},
|
|
394
|
+
{
|
|
395
|
+
"name": "size",
|
|
396
|
+
"description": "Controls the size of the caption.",
|
|
397
|
+
"values": [
|
|
398
|
+
{
|
|
399
|
+
"name": "medium"
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"name": "small"
|
|
403
|
+
}
|
|
404
|
+
]
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"name": "theme",
|
|
408
|
+
"description": "Theme of the caption.",
|
|
409
|
+
"values": [
|
|
410
|
+
{
|
|
411
|
+
"name": "default"
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"name": "turva"
|
|
415
|
+
}
|
|
416
|
+
]
|
|
417
|
+
}
|
|
418
|
+
],
|
|
419
|
+
"references": [
|
|
420
|
+
{
|
|
421
|
+
"name": "Source code",
|
|
422
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-caption/duet-caption.tsx"
|
|
423
|
+
}
|
|
424
|
+
]
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
"name": "duet-card",
|
|
428
|
+
"description": {
|
|
429
|
+
"kind": "markdown",
|
|
430
|
+
"value": "---\ntitle: Card\nname: duet-card\nstatus: ready\nreleased: 1.4.1\ninternationalization: Supported\nssr: Supported\ncategory: Structure\nintro: Cards are shadowed surfaces that display content and actions on a single\n topic. They should be easy to scan for relevant and actionable information.\ndescription: The optional heading property gives the Card a top level heading.\n This can help with readability and provide structure to screen reader users.\n This component also allows you to customize it’s padding and includes an\n expand and collapse functionality.\nplatforms: Web only\ntags:\n - docs-components\nexample_height: 380px\nexamples:\n - name: card\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Card with a heading\n file: fixtures/duet-card_card_with_a_heading.html\n - name: Card without a heading\n file: fixtures/duet-card_card_without_a_heading.html\n - name: Card with an image\n file: fixtures/duet-card_card_with_an_image.html\n - name: Collapsible cards\n file: fixtures/duet-card_collapsible_cards.html\n - name: Card with secondary heading\n file: fixtures/duet-card_card_with_secondary_heading.html\n - name: Card using info variation\n file: fixtures/duet-card_card_using_info_variation.html\n - name: Card using color token as background\n file: fixtures/duet-card_card_using_color_token_as_background.html\n - name: Cards with footer\n file: fixtures/duet-card_cards_with_footer.html\n - name: Card with large padding and icon\n file: fixtures/duet-card_card_with_large_padding_and_icon.html\n - name: Card with h1 level heading\n file: fixtures/duet-card_card_with_h1_level_heading.html\n - name: Cards with x-small padding\n file: fixtures/duet-card_cards_with_x-small_padding.html\n - name: Promotional card\n file: fixtures/duet-card_promotional_card.html\n - name: Promotional card 2\n file: fixtures/duet-card_promotional_card_2.html\n - name: Promotional card with empty grid item on right\n file: fixtures/duet-card_promotional_card_with_empty_grid_item_on_right.html\n - name: Insurance offer card\n file: fixtures/duet-card_insurance_offer_card.html \n - name: Insurance offer card with secondary heading\n file: fixtures/duet-card_insurance_offer_card_with_secondary_headline.html\n - name: Card with list inside\n file: fixtures/duet-card_card_with_list_inside.html\n\n---\n<!-- usage -->"
|
|
431
|
+
},
|
|
432
|
+
"attributes": [
|
|
433
|
+
{
|
|
434
|
+
"name": "accessible-label",
|
|
435
|
+
"description": "Adds accessible label for the card that is only shown for screen readers.\nTypically, this label text is used when the whole card is made clickable to\ncreate a label text for users who use assistive technology."
|
|
436
|
+
},
|
|
437
|
+
{
|
|
438
|
+
"name": "background",
|
|
439
|
+
"description": "Custom color to be used for the card background, as a design token entered in\ncamelCase or kebab-case. Example: \"primary\"."
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"name": "collapsible",
|
|
443
|
+
"description": "Makes the card expand and collapse when the collapse/expand arrow in the\nheading is clicked or tapped. This option only works together with the\nheading option, meaning that you also need to set the heading for this\nfunctionality to show up."
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"name": "heading",
|
|
447
|
+
"description": "The content for the card heading. If empty, both heading and collapse\nfunctionality will be hidden."
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "heading-level",
|
|
451
|
+
"description": "The actual heading level used for the heading in html markup. This setting\nexists for accessibility reasons. It doesn’t change the style visually.",
|
|
452
|
+
"values": [
|
|
453
|
+
{
|
|
454
|
+
"name": "h1"
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"name": "h2"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"name": "h3"
|
|
461
|
+
},
|
|
462
|
+
{
|
|
463
|
+
"name": "h4"
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"name": "h5"
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
"name": "h6"
|
|
470
|
+
}
|
|
471
|
+
]
|
|
472
|
+
},
|
|
473
|
+
{
|
|
474
|
+
"name": "icon",
|
|
475
|
+
"description": "Icon to display on the left side of heading. Example: \"form-location\""
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"name": "image",
|
|
479
|
+
"description": "Image to display in the card. The image aspect ratio can be anything as\nimages are resized to fit 100% width of the card. Example:\n\"https://cdn.duetds.com/api/assets/illustrations/placeholder-image.jpg\""
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
"name": "margin",
|
|
483
|
+
"description": "Controls the margin of the component.",
|
|
484
|
+
"values": [
|
|
485
|
+
{
|
|
486
|
+
"name": "auto"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"name": "none"
|
|
490
|
+
}
|
|
491
|
+
]
|
|
492
|
+
},
|
|
493
|
+
{
|
|
494
|
+
"name": "open",
|
|
495
|
+
"description": "If the card is collapsible, this property controls whether the card is open or closed."
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"name": "padding",
|
|
499
|
+
"description": "The padding for the card. Please note that the card padding values don’t directly\ntranslate to similar space token names, but instead the card uses it’s own\nderived defaults.",
|
|
500
|
+
"values": [
|
|
501
|
+
{
|
|
502
|
+
"name": "large"
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"name": "medium"
|
|
506
|
+
},
|
|
507
|
+
{
|
|
508
|
+
"name": "none"
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"name": "small"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"name": "x-large"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"name": "x-small"
|
|
518
|
+
}
|
|
519
|
+
]
|
|
520
|
+
},
|
|
521
|
+
{
|
|
522
|
+
"name": "secondary-heading",
|
|
523
|
+
"description": "Additional content for the card heading. If empty, both heading and collapse\nfunctionality will be hidden."
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "theme",
|
|
527
|
+
"description": "Theme of the card.",
|
|
528
|
+
"values": [
|
|
529
|
+
{
|
|
530
|
+
"name": "default"
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"name": "turva"
|
|
534
|
+
}
|
|
535
|
+
]
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"name": "url",
|
|
539
|
+
"description": "A destination to link to, rendered in the href attribute of a link."
|
|
540
|
+
},
|
|
541
|
+
{
|
|
542
|
+
"name": "variation",
|
|
543
|
+
"description": "Style variation of the card.",
|
|
544
|
+
"values": [
|
|
545
|
+
{
|
|
546
|
+
"name": "default"
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"name": "info"
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"name": "plain"
|
|
553
|
+
}
|
|
554
|
+
]
|
|
555
|
+
}
|
|
556
|
+
],
|
|
557
|
+
"references": [
|
|
558
|
+
{
|
|
559
|
+
"name": "Source code",
|
|
560
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-card/duet-card.tsx"
|
|
561
|
+
}
|
|
562
|
+
]
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "duet-checkbox",
|
|
566
|
+
"description": {
|
|
567
|
+
"kind": "markdown",
|
|
568
|
+
"value": "---\ntitle: Checkbox\nname: duet-checkbox\nstatus: ready\nreleased: 1.3.0\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\ncategory: Forms\nssr: Supported\nintro: Checkboxes are used to let a user choose one or more options from a\n limited number of options.\nexamples:\n - name: checkbox\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Checked checkbox\n file: fixtures/duet-checkbox_checked_checkbox.html\n - name: Unchecked checkbox\n file: fixtures/duet-checkbox_unchecked_checkbox.html\n - name: Disabled checkbox\n file: fixtures/duet-checkbox_disabled_checkbox.html\n - name: Multiple checkboxes\n file: fixtures/duet-checkbox_multiple_checkboxes.html\n - name: Responsive checkbox layout\n file: fixtures/duet-checkbox_responsive_checkbox_layout.html\n - name: Checkbox and label with links inside\n file: fixtures/duet-checkbox_checkbox_and_label_with_links_inside.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
569
|
+
},
|
|
570
|
+
"attributes": [
|
|
571
|
+
{
|
|
572
|
+
"name": "accessible-active-descendant",
|
|
573
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"name": "accessible-controls",
|
|
577
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to indicate\nthe id of a component controlled by this component."
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"name": "accessible-described-by",
|
|
581
|
+
"description": "Indicates the id of a component that describes the checkbox."
|
|
582
|
+
},
|
|
583
|
+
{
|
|
584
|
+
"name": "accessible-index",
|
|
585
|
+
"description": "Control the tabindex of checkbox. In most cases this should never be used! It\nexists only for Duet’s internal needs."
|
|
586
|
+
},
|
|
587
|
+
{
|
|
588
|
+
"name": "accessible-owns",
|
|
589
|
+
"description": "Indicates the id of a component owned by the checkbox."
|
|
590
|
+
},
|
|
591
|
+
{
|
|
592
|
+
"name": "checked",
|
|
593
|
+
"description": "Check state of the checkbox."
|
|
594
|
+
},
|
|
595
|
+
{
|
|
596
|
+
"name": "disabled",
|
|
597
|
+
"description": "Makes the checkbox component disabled. This prevents users from being able to\ninteract with the checkbox, and conveys its inactive state to assistive technologies."
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "identifier",
|
|
601
|
+
"description": "Adds a unique identifier for the checkbox."
|
|
602
|
+
},
|
|
603
|
+
{
|
|
604
|
+
"name": "label",
|
|
605
|
+
"description": "Label for the checkbox"
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
"name": "label-hidden",
|
|
609
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
610
|
+
},
|
|
611
|
+
{
|
|
612
|
+
"name": "margin",
|
|
613
|
+
"description": "Controls the margin of the component.",
|
|
614
|
+
"values": [
|
|
615
|
+
{
|
|
616
|
+
"name": "auto"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"name": "none"
|
|
620
|
+
}
|
|
621
|
+
]
|
|
622
|
+
},
|
|
623
|
+
{
|
|
624
|
+
"name": "name",
|
|
625
|
+
"description": "Name of the checkbox."
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"name": "required",
|
|
629
|
+
"description": "Set whether the input is required or not. Please note that this is required for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
630
|
+
},
|
|
631
|
+
{
|
|
632
|
+
"name": "role",
|
|
633
|
+
"description": "Defines a specific role attribute for the input."
|
|
634
|
+
},
|
|
635
|
+
{
|
|
636
|
+
"name": "theme",
|
|
637
|
+
"description": "Theme of the checkbox.",
|
|
638
|
+
"values": [
|
|
639
|
+
{
|
|
640
|
+
"name": "default"
|
|
641
|
+
},
|
|
642
|
+
{
|
|
643
|
+
"name": "turva"
|
|
644
|
+
}
|
|
645
|
+
]
|
|
646
|
+
},
|
|
647
|
+
{
|
|
648
|
+
"name": "value",
|
|
649
|
+
"description": "The value of the checkbox does not mean if it's checked or not, use the checked\nproperty for that."
|
|
650
|
+
}
|
|
651
|
+
],
|
|
652
|
+
"references": [
|
|
653
|
+
{
|
|
654
|
+
"name": "Source code",
|
|
655
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-checkbox/duet-checkbox.tsx"
|
|
656
|
+
}
|
|
657
|
+
]
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "duet-choice",
|
|
661
|
+
"description": {
|
|
662
|
+
"kind": "markdown",
|
|
663
|
+
"value": "---\ntitle: Choice\nname: duet-choice\nstatus: ready\nreleased: 2.6.11\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Forms\nintro: Choice buttons allow selection of a single or multiple options from a set\n of predefined options. They are a good alternative to radio buttons,\n checkboxes, and select menus.\ndescription: You can set the type of the choice to be either a radio or a\n checkbox. Using radio type allows you to use Choice component inside Duet’s <a\n href=\"/components/choice-group/\">Choice Group</a>.\nplatforms: Web only\ntags:\n - docs-components\nexample_height: 350px\nexamples:\n - name: choice\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Radio button style choices\n file: fixtures/duet-choice_radio_button_style_choices.html\n - name: Checkbox style choices\n file: fixtures/duet-choice_checkbox_style_choices.html\n - name: Vertical choices list\n file: fixtures/duet-choice_vertical_choices_list.html\n - name: Collapsible choices\n file: fixtures/duet-choice_collapsible_choices.html\n - name: Disabled choices\n file: fixtures/duet-choice_disabled_choices.html\n - name: Choices with captions\n file: fixtures/duet-choice_choices_with_captions.html\n - name: Choices with info\n file: fixtures/duet-choice_choices_with_info.html\n - name: Choices with additional content\n file: fixtures/duet-choice_choices_with_additional_content.html\n - name: Choices with external tooltips\n file: fixtures/duet-choice_choices_with_external_tooltips.html\n - name: Marking choices as required\n file: fixtures/duet-choice_marking_choices_as_required.html\n\n---\n\n<!-- usage -->"
|
|
664
|
+
},
|
|
665
|
+
"attributes": [
|
|
666
|
+
{
|
|
667
|
+
"name": "accessible-active-descendant",
|
|
668
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"name": "accessible-controls",
|
|
672
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
673
|
+
},
|
|
674
|
+
{
|
|
675
|
+
"name": "accessible-described-by",
|
|
676
|
+
"description": "Indicates the id of a component that describes the choice."
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
"name": "accessible-label-info-button",
|
|
680
|
+
"description": "Accessible label that is read for screen reader users in the info toggle trigger button.\nNot visible for normal users."
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"name": "accessible-label-info-default",
|
|
684
|
+
"description": "Property to change accessibleLabelInfoButton defaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabelInfoButton when needed"
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "accessible-owns",
|
|
688
|
+
"description": "Indicates the id of a component owned by the choice."
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "caption",
|
|
692
|
+
"description": "Additional caption to show inside the label of the choice button."
|
|
693
|
+
},
|
|
694
|
+
{
|
|
695
|
+
"name": "checked",
|
|
696
|
+
"description": "Checked state of the choice button."
|
|
697
|
+
},
|
|
698
|
+
{
|
|
699
|
+
"name": "collapsible",
|
|
700
|
+
"description": "Makes the choice button open a new section underneath it when clicked or\ntapped. This new section can be used to show more options related to this\nchoice. Please note that this feature can’t be used together with the \"info\"\nfunctionality and that it only accepts plain dom nodes (no shadow dom elements\nsuch as duet-paragraph can be used as this will break accessibility)"
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
"name": "disabled",
|
|
704
|
+
"description": "Makes the choice component disabled. This prevents users from being able to\ninteract with the choice, and conveys its inactive state to assistive technologies."
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"name": "expand",
|
|
708
|
+
"description": "Expands the choice button to fill 100% of the container width."
|
|
709
|
+
},
|
|
710
|
+
{
|
|
711
|
+
"name": "icon",
|
|
712
|
+
"description": "Icon to display to the left of the choice button label."
|
|
713
|
+
},
|
|
714
|
+
{
|
|
715
|
+
"name": "identifier",
|
|
716
|
+
"description": "Adds a unique identifier for the choice button."
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"name": "label",
|
|
720
|
+
"description": "Label for the choice button."
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
"name": "margin",
|
|
724
|
+
"description": "Controls the margin of the component.",
|
|
725
|
+
"values": [
|
|
726
|
+
{
|
|
727
|
+
"name": "auto"
|
|
728
|
+
},
|
|
729
|
+
{
|
|
730
|
+
"name": "none"
|
|
731
|
+
}
|
|
732
|
+
]
|
|
733
|
+
},
|
|
734
|
+
{
|
|
735
|
+
"name": "name",
|
|
736
|
+
"description": "Name attribute of the html input that the Choice component controls."
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "padding",
|
|
740
|
+
"description": "Controls the padding of the component.",
|
|
741
|
+
"values": [
|
|
742
|
+
{
|
|
743
|
+
"name": "auto"
|
|
744
|
+
},
|
|
745
|
+
{
|
|
746
|
+
"name": "none"
|
|
747
|
+
}
|
|
748
|
+
]
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"name": "required",
|
|
752
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"name": "theme",
|
|
756
|
+
"description": "Theme of the choice.",
|
|
757
|
+
"values": [
|
|
758
|
+
{
|
|
759
|
+
"name": "default"
|
|
760
|
+
},
|
|
761
|
+
{
|
|
762
|
+
"name": "turva"
|
|
763
|
+
}
|
|
764
|
+
]
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "type",
|
|
768
|
+
"description": "Type of the choice button. You can set the type of the choice to be either\n“radio” or “checkbox”. Depending on this selection we convey the selection\ntype to assistive technologies as well. When type “radio” is chosen it is\nrequired to place the choices inside Choice Group component.",
|
|
769
|
+
"values": [
|
|
770
|
+
{
|
|
771
|
+
"name": "checkbox"
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
"name": "radio"
|
|
775
|
+
}
|
|
776
|
+
]
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "value",
|
|
780
|
+
"description": "The value of the html input that the Choice component controls."
|
|
781
|
+
}
|
|
782
|
+
],
|
|
783
|
+
"references": [
|
|
784
|
+
{
|
|
785
|
+
"name": "Source code",
|
|
786
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-choice/duet-choice.tsx"
|
|
787
|
+
}
|
|
788
|
+
]
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "duet-choice-group",
|
|
792
|
+
"description": {
|
|
793
|
+
"kind": "markdown",
|
|
794
|
+
"value": "---\ntitle: Choice Group\nname: duet-choice-group\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 2.8.1\nssr: Supported\ncategory: Forms\nintro: Choice group allows user to select one choice from a set of choices. Use\n value on group to set the selected choice. For more usage examples, please see\n <a href=\"/components/choice/\">Choice component</a>.\ndescription: Choice Group provides the exact same API and properties as <a\n href=\"/components/radio-group/\">Radio Group</a>, but optimized for Choice\n component usage.\nexample_height: 360px\ntags:\n - docs-components\nexamples:\n - name: choice group\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Horizontal choice group\n file: fixtures/duet-choice-group_horizontal_choice_group.html\n - name: Vertical choice group\n file: fixtures/duet-choice-group_vertical_choice_group.html\n - name: Nested choice and radio groups\n file: fixtures/duet-choice-group_nested_choice_and_radio_groups.html\n - name: Disabled choice group\n file: fixtures/duet-choice-group_disabled_choice_group.html\n - name: Choice group with a tooltip\n file: fixtures/duet-choice-group_choice_group_with_a_tooltip.html\n - name: Choice group with a caption and a tooltip\n file: fixtures/duet-choice-group_choice_group_with_a_caption_and_a_tooltip.html\n\n---\n\n<!-- usage -->"
|
|
795
|
+
},
|
|
796
|
+
"attributes": [
|
|
797
|
+
{
|
|
798
|
+
"name": "caption",
|
|
799
|
+
"description": "Additional caption to show inside the label of the choice group."
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"name": "direction",
|
|
803
|
+
"description": "Direction of the choice group.",
|
|
804
|
+
"values": [
|
|
805
|
+
{
|
|
806
|
+
"name": "horizontal"
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
"name": "vertical"
|
|
810
|
+
}
|
|
811
|
+
]
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"name": "disabled",
|
|
815
|
+
"description": "Determines, whether the control is disabled or not."
|
|
816
|
+
},
|
|
817
|
+
{
|
|
818
|
+
"name": "error",
|
|
819
|
+
"description": "Display choice group in error state along with an error message."
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"name": "label",
|
|
823
|
+
"description": "Legend displayed for the choice buttons in this group."
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"name": "label-hidden",
|
|
827
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"name": "margin",
|
|
831
|
+
"description": "Controls the margin of the component.",
|
|
832
|
+
"values": [
|
|
833
|
+
{
|
|
834
|
+
"name": "auto"
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "none"
|
|
838
|
+
}
|
|
839
|
+
]
|
|
840
|
+
},
|
|
841
|
+
{
|
|
842
|
+
"name": "name",
|
|
843
|
+
"description": "Name for the choice buttons within this group. **This must be unique amongst all other inputs.**"
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
"name": "responsive",
|
|
847
|
+
"description": "Enable or disable the automatic responsive behaviour of the choice group\ncomponent when horizontal setting is used. Setting this option to \"true\"\nmakes sure that contents are stacked vertically on mobile."
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
"name": "theme",
|
|
851
|
+
"description": "Theme of the choice group.",
|
|
852
|
+
"values": [
|
|
853
|
+
{
|
|
854
|
+
"name": "default"
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "turva"
|
|
858
|
+
}
|
|
859
|
+
]
|
|
860
|
+
},
|
|
861
|
+
{
|
|
862
|
+
"name": "tooltip",
|
|
863
|
+
"description": "Tooltip to display next to the label of the choice group."
|
|
864
|
+
},
|
|
865
|
+
{
|
|
866
|
+
"name": "tooltip-direction",
|
|
867
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
868
|
+
"values": [
|
|
869
|
+
{
|
|
870
|
+
"name": "auto"
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"name": "left"
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"name": "right"
|
|
877
|
+
}
|
|
878
|
+
]
|
|
879
|
+
},
|
|
880
|
+
{
|
|
881
|
+
"name": "value",
|
|
882
|
+
"description": "The value of the selected choice button."
|
|
883
|
+
}
|
|
884
|
+
],
|
|
885
|
+
"references": [
|
|
886
|
+
{
|
|
887
|
+
"name": "Source code",
|
|
888
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-choice-group/duet-choice-group.tsx"
|
|
889
|
+
}
|
|
890
|
+
]
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
"name": "duet-collapsible",
|
|
894
|
+
"description": {
|
|
895
|
+
"kind": "markdown",
|
|
896
|
+
"value": "---\ntitle: Collapsible\nname: duet-collapsible\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.4.13\nssr: Supported\nintro: Collapsible is a disclosure component used to reveal additional content.\n It should contain a heading, followed by any additional content that is\n revealed on click.\ntags:\n - docs-components\nexamples:\n - name: collapsible\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic collapsible usage\n file: fixtures/duet-collapsible_basic_collapsible_usage.html\n - name: Multiple collapsible elements\n file: fixtures/duet-collapsible_multiple_collapsible_elements.html\n - name: Collapsible that is initially open\n file: fixtures/duet-collapsible_collapsible_that_is_initially_open.html\n - name: Collapsible using normal font-weight for heading\n file: fixtures/duet-collapsible_collapsible_using_normal_font-weight_for_heading.html\n - name: Collapsible using sizes\n file: fixtures/duet-collapsible_collapsible_using_sizes.html\n\n---\n\n<!-- usage -->"
|
|
897
|
+
},
|
|
898
|
+
"attributes": [
|
|
899
|
+
{
|
|
900
|
+
"name": "heading",
|
|
901
|
+
"description": "The content for the collapsible heading."
|
|
902
|
+
},
|
|
903
|
+
{
|
|
904
|
+
"name": "heading-level",
|
|
905
|
+
"description": "The actual heading level used for the heading in html markup. This setting\nexists for accessibility reasons. It doesn’t change the style visually.\nonly variations of h1-h6 area accepted",
|
|
906
|
+
"values": [
|
|
907
|
+
{
|
|
908
|
+
"name": "h1"
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"name": "h2"
|
|
912
|
+
},
|
|
913
|
+
{
|
|
914
|
+
"name": "h3"
|
|
915
|
+
},
|
|
916
|
+
{
|
|
917
|
+
"name": "h4"
|
|
918
|
+
},
|
|
919
|
+
{
|
|
920
|
+
"name": "h5"
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"name": "h6"
|
|
924
|
+
}
|
|
925
|
+
]
|
|
926
|
+
},
|
|
927
|
+
{
|
|
928
|
+
"name": "heading-size",
|
|
929
|
+
"description": "Custom headingSize to be used for font size of heading, as a design token entered\nin kebab-case x-small -> font-size-x-small.\nExample:\n# 12px (0.75rem) ------ +2px (x-small)\n# 14px (0.875rem) ------ +2px (small)\n# 16px (1rem) ------ +2px (medium)\n# 20px (1.25rem) ------ +4px (large)\n# 24px (1.5rem) ------ +4px (x-large)\n# 36px (2.25rem) ------ +12px (xx-large)\n# 48px (3rem) ------ +12px (xxx-large)\n# 72px (4.5rem) ------ +24px (xxxx-large)",
|
|
930
|
+
"values": [
|
|
931
|
+
{
|
|
932
|
+
"name": "large"
|
|
933
|
+
},
|
|
934
|
+
{
|
|
935
|
+
"name": "medium"
|
|
936
|
+
},
|
|
937
|
+
{
|
|
938
|
+
"name": "small"
|
|
939
|
+
},
|
|
940
|
+
{
|
|
941
|
+
"name": "x-large"
|
|
942
|
+
},
|
|
943
|
+
{
|
|
944
|
+
"name": "x-small"
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
"name": "xx-large"
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
"name": "xxx-large"
|
|
951
|
+
},
|
|
952
|
+
{
|
|
953
|
+
"name": "xxxx-large"
|
|
954
|
+
}
|
|
955
|
+
]
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"name": "heading-weight",
|
|
959
|
+
"description": "The font weight of the heading",
|
|
960
|
+
"values": [
|
|
961
|
+
{
|
|
962
|
+
"name": "normal"
|
|
963
|
+
},
|
|
964
|
+
{
|
|
965
|
+
"name": "semibold"
|
|
966
|
+
}
|
|
967
|
+
]
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"name": "margin",
|
|
971
|
+
"description": "Controls the margin of the component.",
|
|
972
|
+
"values": [
|
|
973
|
+
{
|
|
974
|
+
"name": "auto"
|
|
975
|
+
},
|
|
976
|
+
{
|
|
977
|
+
"name": "none"
|
|
978
|
+
}
|
|
979
|
+
]
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"name": "open",
|
|
983
|
+
"description": "Is the component expanded or collapsed."
|
|
984
|
+
},
|
|
985
|
+
{
|
|
986
|
+
"name": "theme",
|
|
987
|
+
"description": "Theme of the collapsible.",
|
|
988
|
+
"values": [
|
|
989
|
+
{
|
|
990
|
+
"name": "default"
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
"name": "turva"
|
|
994
|
+
}
|
|
995
|
+
]
|
|
996
|
+
}
|
|
997
|
+
],
|
|
998
|
+
"references": [
|
|
999
|
+
{
|
|
1000
|
+
"name": "Source code",
|
|
1001
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-collapsible/duet-collapsible.tsx"
|
|
1002
|
+
}
|
|
1003
|
+
]
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"name": "duet-cookie-consent",
|
|
1007
|
+
"description": {
|
|
1008
|
+
"kind": "markdown",
|
|
1009
|
+
"value": "---\ntitle: Cookie Consent\nname: duet-cookie-consent\nstatus: ready\nreleased: 4.2.0\ncategory: Messaging\naccessibility: Keyboard, Screen Reader\ninternationalization: Supported\nintro: Cookie consent component informs users about cookie usage. This banner is\n shown when they visit a website or an application for the first time.\nplatforms: Web only\nssr: Supported\nexamples:\n - name: cookie consent\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default cookie consent\n file: fixtures/duet-cookie-consent_default_cookie_consent.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1010
|
+
},
|
|
1011
|
+
"attributes": [
|
|
1012
|
+
{
|
|
1013
|
+
"name": "accessible-label",
|
|
1014
|
+
"description": "Adds accessible label for the cookie consent ok button."
|
|
1015
|
+
},
|
|
1016
|
+
{
|
|
1017
|
+
"name": "theme",
|
|
1018
|
+
"description": "Theme of the cookie consent banner.",
|
|
1019
|
+
"values": [
|
|
1020
|
+
{
|
|
1021
|
+
"name": "default"
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
"name": "turva"
|
|
1025
|
+
}
|
|
1026
|
+
]
|
|
1027
|
+
}
|
|
1028
|
+
],
|
|
1029
|
+
"references": [
|
|
1030
|
+
{
|
|
1031
|
+
"name": "Source code",
|
|
1032
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-cookie-consent/duet-cookie-consent.tsx"
|
|
1033
|
+
}
|
|
1034
|
+
]
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"name": "duet-date-picker",
|
|
1038
|
+
"description": {
|
|
1039
|
+
"kind": "markdown",
|
|
1040
|
+
"value": "---\ntitle: Date Picker\nname: duet-date-picker\nstatus: ready\nplatforms: Web only\nssr: Supported\nreleased: 4.4.2\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nintro: Date Picker component lets user pick a single date or a date range using\n a special calendar like date picker interface. There’s also <a\n href=\"https://github.com/duetds/date-picker\">open source version</a> of this\n component available.\ndescription: \"Date Picker allows you to set a minimum and a maximum allowed\n date. These settings can be combined or used alone, depending on the need.\n Please note that the date values must be passed in IS0-8601 format:\n <code>YYYY-MM-DD</code>.\"\nexample_height: 540px\nexamples:\n - name: date-picker\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic date picker usage\n file: fixtures/duet-date-picker_basic_date_picker_usage.html\n - name: Date picker using min and max values\n file: fixtures/duet-date-picker_date_picker_using_min_and_max_values.html\n - name: Date picker with validation error messages\n file: fixtures/duet-date-picker_date_picker_with_validation_error_messages.html\n - name: Date range using date picker\n file: fixtures/duet-date-picker_date_range_using_date_picker.html\n - name: Date picker using expand property\n file: fixtures/duet-date-picker_date_picker_using_expand_property.html\n - name: Disabled date picker\n file: fixtures/duet-date-picker_disabled_date_picker.html\n - name: Date picker with an error\n file: fixtures/duet-date-picker_date_picker_with_an_error.html\n - name: Date picker with a tooltip\n file: fixtures/duet-date-picker_date_picker_with_a_tooltip.html\n - name: Date picker using english\n file: fixtures/duet-date-picker_date_picker_using_english.html\n - name: Date picker using swedish\n file: fixtures/duet-date-picker_date_picker_using_swedish.html\n - name: Showing the date picker using the provided method\n file: fixtures/duet-date-picker_showing_the_date_picker_using_the_provided_method.html\n - name: Showing the date picker with caption and echoing placeholder\n file: fixtures/duet-date-picker_caption_and_echoing_placeholder.html \ntags:\n - docs-components\n---\n\n<!-- usage -->"
|
|
1041
|
+
},
|
|
1042
|
+
"attributes": [
|
|
1043
|
+
{
|
|
1044
|
+
"name": "accessible-active-descendant",
|
|
1045
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "accessible-controls",
|
|
1049
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
"name": "accessible-described-by",
|
|
1053
|
+
"description": "Indicates the id of a component that describes the input."
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
"name": "accessible-owns",
|
|
1057
|
+
"description": "Indicates the id of a component owned by the input."
|
|
1058
|
+
},
|
|
1059
|
+
{
|
|
1060
|
+
"name": "caption",
|
|
1061
|
+
"description": "Caption (underneath label) that can be set as a way of adding extra information"
|
|
1062
|
+
},
|
|
1063
|
+
{
|
|
1064
|
+
"name": "direction",
|
|
1065
|
+
"description": "Forces the opening direction of the calendar modal to be always left or right.\nThis setting can be useful when the input is smaller than the opening date picker\nwould be as by default the picker always opens towards right.",
|
|
1066
|
+
"values": [
|
|
1067
|
+
{
|
|
1068
|
+
"name": "left"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "right"
|
|
1072
|
+
}
|
|
1073
|
+
]
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
"name": "disabled",
|
|
1077
|
+
"description": "Makes the date picker input component disabled. This prevents users from being able to\ninteract with the input, and conveys its inactive state to assistive technologies."
|
|
1078
|
+
},
|
|
1079
|
+
{
|
|
1080
|
+
"name": "echo-placeholder",
|
|
1081
|
+
"description": "If form input field has a placeholder text, and user types anything (causing the text to dissapear),\nsettings this to true will \"echo\" it into the caption slot - this option will be false by default for the next few versions, but will eventually be true by default (scheduled for 4.30.0)"
|
|
1082
|
+
},
|
|
1083
|
+
{
|
|
1084
|
+
"name": "error",
|
|
1085
|
+
"description": "Display the date picker input in error state along with an error message."
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"name": "expand",
|
|
1089
|
+
"description": "Expands the date picker input to fill 100% of the container width."
|
|
1090
|
+
},
|
|
1091
|
+
{
|
|
1092
|
+
"name": "identifier",
|
|
1093
|
+
"description": "Adds a unique identifier for the date picker input."
|
|
1094
|
+
},
|
|
1095
|
+
{
|
|
1096
|
+
"name": "label",
|
|
1097
|
+
"description": "Label for the date picker input."
|
|
1098
|
+
},
|
|
1099
|
+
{
|
|
1100
|
+
"name": "label-hidden",
|
|
1101
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
1102
|
+
},
|
|
1103
|
+
{
|
|
1104
|
+
"name": "language",
|
|
1105
|
+
"description": "The currently active language. This setting changes the month/year/day\nnames and button labels as well as all screen reader labels.",
|
|
1106
|
+
"values": [
|
|
1107
|
+
{
|
|
1108
|
+
"name": "en"
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"name": "fi"
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"name": "sv"
|
|
1115
|
+
}
|
|
1116
|
+
]
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
"name": "margin",
|
|
1120
|
+
"description": "Controls the margin of the component.",
|
|
1121
|
+
"values": [
|
|
1122
|
+
{
|
|
1123
|
+
"name": "auto"
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"name": "none"
|
|
1127
|
+
}
|
|
1128
|
+
]
|
|
1129
|
+
},
|
|
1130
|
+
{
|
|
1131
|
+
"name": "max",
|
|
1132
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD\nThis setting can be used alone or together with the min property."
|
|
1133
|
+
},
|
|
1134
|
+
{
|
|
1135
|
+
"name": "min",
|
|
1136
|
+
"description": "Minimum date allowed to be picked. Must be in IS0-8601 format: YYYY-MM-DD.\nThis setting can be used alone or together with the max property."
|
|
1137
|
+
},
|
|
1138
|
+
{
|
|
1139
|
+
"name": "name",
|
|
1140
|
+
"description": "Name of the date picker input."
|
|
1141
|
+
},
|
|
1142
|
+
{
|
|
1143
|
+
"name": "placeholder",
|
|
1144
|
+
"description": "Hint text to display before the user types into the date picker input."
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
"name": "placeholder-default",
|
|
1148
|
+
"description": "Placeholder defaults"
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"name": "required",
|
|
1152
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
1153
|
+
},
|
|
1154
|
+
{
|
|
1155
|
+
"name": "role",
|
|
1156
|
+
"description": "Defines a specific role attribute for the date picker input."
|
|
1157
|
+
},
|
|
1158
|
+
{
|
|
1159
|
+
"name": "theme",
|
|
1160
|
+
"description": "Theme of the component.",
|
|
1161
|
+
"values": [
|
|
1162
|
+
{
|
|
1163
|
+
"name": "default"
|
|
1164
|
+
},
|
|
1165
|
+
{
|
|
1166
|
+
"name": "turva"
|
|
1167
|
+
}
|
|
1168
|
+
]
|
|
1169
|
+
},
|
|
1170
|
+
{
|
|
1171
|
+
"name": "tooltip",
|
|
1172
|
+
"description": "Tooltip to display next to the label of the date picker input."
|
|
1173
|
+
},
|
|
1174
|
+
{
|
|
1175
|
+
"name": "tooltip-direction",
|
|
1176
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
1177
|
+
"values": [
|
|
1178
|
+
{
|
|
1179
|
+
"name": "auto"
|
|
1180
|
+
},
|
|
1181
|
+
{
|
|
1182
|
+
"name": "left"
|
|
1183
|
+
},
|
|
1184
|
+
{
|
|
1185
|
+
"name": "right"
|
|
1186
|
+
}
|
|
1187
|
+
]
|
|
1188
|
+
},
|
|
1189
|
+
{
|
|
1190
|
+
"name": "value",
|
|
1191
|
+
"description": "Date value. Must be in IS0-8601 format: YYYY-MM-DD"
|
|
1192
|
+
}
|
|
1193
|
+
],
|
|
1194
|
+
"references": [
|
|
1195
|
+
{
|
|
1196
|
+
"name": "Source code",
|
|
1197
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-date-picker/duet-date-picker.tsx"
|
|
1198
|
+
}
|
|
1199
|
+
]
|
|
1200
|
+
},
|
|
1201
|
+
{
|
|
1202
|
+
"name": "duet-divider",
|
|
1203
|
+
"description": {
|
|
1204
|
+
"kind": "markdown",
|
|
1205
|
+
"value": "---\ntitle: Divider\nname: duet-divider\nstatus: ready\nreleased: 1.0.49\ncategory: Structure\nintro: Dividers are used to represent thematic breaks between paragraph-level\n elements. Visually, they look like horizontal rules or lines.\nplatforms: Web only\nssr: Supported\nexamples:\n - name: divider\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default divider\n file: fixtures/duet-divider_default_divider.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1206
|
+
},
|
|
1207
|
+
"attributes": [
|
|
1208
|
+
{
|
|
1209
|
+
"name": "margin",
|
|
1210
|
+
"description": "Controls the margin of the component.",
|
|
1211
|
+
"values": [
|
|
1212
|
+
{
|
|
1213
|
+
"name": "auto"
|
|
1214
|
+
},
|
|
1215
|
+
{
|
|
1216
|
+
"name": "none"
|
|
1217
|
+
},
|
|
1218
|
+
{
|
|
1219
|
+
"name": "small"
|
|
1220
|
+
}
|
|
1221
|
+
]
|
|
1222
|
+
},
|
|
1223
|
+
{
|
|
1224
|
+
"name": "theme",
|
|
1225
|
+
"description": "Theme of the divider.",
|
|
1226
|
+
"values": [
|
|
1227
|
+
{
|
|
1228
|
+
"name": "default"
|
|
1229
|
+
},
|
|
1230
|
+
{
|
|
1231
|
+
"name": "turva"
|
|
1232
|
+
}
|
|
1233
|
+
]
|
|
1234
|
+
}
|
|
1235
|
+
],
|
|
1236
|
+
"references": [
|
|
1237
|
+
{
|
|
1238
|
+
"name": "Source code",
|
|
1239
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-divider/duet-divider.tsx"
|
|
1240
|
+
}
|
|
1241
|
+
]
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "duet-empty-state",
|
|
1245
|
+
"description": {
|
|
1246
|
+
"kind": "markdown",
|
|
1247
|
+
"value": "---\ntitle: Empty State\nname: duet-empty-state\nstatus: new\nreleased: 4.6.2\ncategory: Structure\nintro: Empty state component is used when another component has no items or data\n to show. Empty state provides explanation or guidance to help user progress.\nexample_height: 350px\nplatforms: Web only\nssr: Supported\nexamples:\n - name: empty state\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default empty state\n file: fixtures/duet-empty-state_default_empty_state.html\n - name: Empty state with guidance\n file: fixtures/duet-empty-state_empty_state_with_guidance.html\n - name: Empty state with only icon and text\n file: fixtures/duet-empty-state_empty_state_with_only_icon_and_text.html\n - name: Empty state with paragraph and button\n file: fixtures/duet-empty-state_empty_state_with_paragraph_and_button.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1248
|
+
},
|
|
1249
|
+
"attributes": [
|
|
1250
|
+
{
|
|
1251
|
+
"name": "icon",
|
|
1252
|
+
"description": "Icon shown in the empty state component."
|
|
1253
|
+
},
|
|
1254
|
+
{
|
|
1255
|
+
"name": "size",
|
|
1256
|
+
"description": "The size of the empty state message.",
|
|
1257
|
+
"values": [
|
|
1258
|
+
{
|
|
1259
|
+
"name": "medium"
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"name": "small"
|
|
1263
|
+
}
|
|
1264
|
+
]
|
|
1265
|
+
},
|
|
1266
|
+
{
|
|
1267
|
+
"name": "theme",
|
|
1268
|
+
"description": "Theme of the empty state component.",
|
|
1269
|
+
"values": [
|
|
1270
|
+
{
|
|
1271
|
+
"name": "default"
|
|
1272
|
+
},
|
|
1273
|
+
{
|
|
1274
|
+
"name": "turva"
|
|
1275
|
+
}
|
|
1276
|
+
]
|
|
1277
|
+
}
|
|
1278
|
+
],
|
|
1279
|
+
"references": [
|
|
1280
|
+
{
|
|
1281
|
+
"name": "Source code",
|
|
1282
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-empty-state/duet-empty-state.tsx"
|
|
1283
|
+
}
|
|
1284
|
+
]
|
|
1285
|
+
},
|
|
1286
|
+
{
|
|
1287
|
+
"name": "duet-fieldset",
|
|
1288
|
+
"description": {
|
|
1289
|
+
"kind": "markdown",
|
|
1290
|
+
"value": "---\ntitle: Fieldset\nname: duet-fieldset\nstatus: new\nplatforms: Web only\naccessibility: Keyboard, Screen Reader\nreleased: 4.17.0\nexample_height: 360px\ninternationalization: Supported\nssr: Supported\ncategory: Forms\nintro: Fieldset is used to group together several related form components and a\n label. The usage of this component helps to make these groups accessible for\n assistive technologies.\ndescription: Fieldset consists of a mandatory label, and optionally a caption,\n tooltip, and error. It can be used to group together buttons, form fields,\n checkboxes, and similar components.\nexamples:\n - name: fieldset\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic fieldset\n file: fixtures/duet-fieldset_basic_fieldset.html\n - name: Fieldset with caption and tooltip\n file: fixtures/duet-fieldset_fieldset_with_caption_and_tooltip.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1291
|
+
},
|
|
1292
|
+
"attributes": [
|
|
1293
|
+
{
|
|
1294
|
+
"name": "caption",
|
|
1295
|
+
"description": "Additional caption to show next to the label."
|
|
1296
|
+
},
|
|
1297
|
+
{
|
|
1298
|
+
"name": "error",
|
|
1299
|
+
"description": "An error message to be shown next to the label."
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"name": "label",
|
|
1303
|
+
"description": "Label/legend displayed for the fieldset."
|
|
1304
|
+
},
|
|
1305
|
+
{
|
|
1306
|
+
"name": "label-hidden",
|
|
1307
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
1308
|
+
},
|
|
1309
|
+
{
|
|
1310
|
+
"name": "margin",
|
|
1311
|
+
"description": "Controls the margin of the component.",
|
|
1312
|
+
"values": [
|
|
1313
|
+
{
|
|
1314
|
+
"name": "auto"
|
|
1315
|
+
},
|
|
1316
|
+
{
|
|
1317
|
+
"name": "none"
|
|
1318
|
+
}
|
|
1319
|
+
]
|
|
1320
|
+
},
|
|
1321
|
+
{
|
|
1322
|
+
"name": "theme",
|
|
1323
|
+
"description": "Theme of the fieldset.",
|
|
1324
|
+
"values": [
|
|
1325
|
+
{
|
|
1326
|
+
"name": "default"
|
|
1327
|
+
},
|
|
1328
|
+
{
|
|
1329
|
+
"name": "turva"
|
|
1330
|
+
}
|
|
1331
|
+
]
|
|
1332
|
+
}
|
|
1333
|
+
],
|
|
1334
|
+
"references": [
|
|
1335
|
+
{
|
|
1336
|
+
"name": "Source code",
|
|
1337
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-fieldset/duet-fieldset.tsx"
|
|
1338
|
+
}
|
|
1339
|
+
]
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"name": "duet-footer",
|
|
1343
|
+
"description": {
|
|
1344
|
+
"kind": "markdown",
|
|
1345
|
+
"value": "---\ntitle: Footer\nname: duet-footer\nstatus: ready\nplatforms: Web only\naccessibility: Keyboard, Screen Reader\nreleased: 2.4.6\nexample_height: 360px\ninternationalization: Supported\nssr: Supported\ncategory: Navigation\nintro: Footer component is used as the global footer for all views. Contains\n copyright data and links to related documents.\ndescription: Footer contains your application’s secondary menu items that\n perform an action when clicked. Each action in the footer should navigate to a\n href or trigger another action like a <a href=\"/components/modal/\">Modal\n overlay</a>.\nexamples:\n - name: footer\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default footer\n file: fixtures/duet-footer_default_footer.html\n - name: Footer with just logo and menu\n file: fixtures/duet-footer_footer_with_just_logo_and_menu.html\n - name: Footer using simple variation\n file: fixtures/duet-footer_footer_using_simple_variation.html\n - name: Footer with links that open to a new tab\n file: fixtures/duet-footer_footer_with_links_that_open_to_a_new_tab.html\n - name: Passing arrays and objects to Footer as JSON via attributes for SSR support\n file: fixtures/duet-footer_passing_arrays_and_objects_to_footer_as_json_via_attributes_for_ssr_support.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1346
|
+
},
|
|
1347
|
+
"attributes": [
|
|
1348
|
+
{
|
|
1349
|
+
"name": "accessible-label-external",
|
|
1350
|
+
"description": "Adds accessible label for tooltip that is shown in external link (url & external have both been set)"
|
|
1351
|
+
},
|
|
1352
|
+
{
|
|
1353
|
+
"name": "accessible-label-external-default",
|
|
1354
|
+
"description": "Property to change accessibleLabelExternal defaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabelExternal when needed"
|
|
1355
|
+
},
|
|
1356
|
+
{
|
|
1357
|
+
"name": "items",
|
|
1358
|
+
"description": "An array of items for the main footer links. Items have to include mandatory\n\"label\", \"href\" and \"icon\" fields to work. Additionally, you can pass an \"id\"\nthat is added as an HTML identifier for the anchor tag."
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
"name": "language",
|
|
1362
|
+
"description": "The currently active language. This setting changes the logo to match the\nchosen language.",
|
|
1363
|
+
"values": [
|
|
1364
|
+
{
|
|
1365
|
+
"name": "en"
|
|
1366
|
+
},
|
|
1367
|
+
{
|
|
1368
|
+
"name": "fi"
|
|
1369
|
+
},
|
|
1370
|
+
{
|
|
1371
|
+
"name": "sv"
|
|
1372
|
+
}
|
|
1373
|
+
]
|
|
1374
|
+
},
|
|
1375
|
+
{
|
|
1376
|
+
"name": "logo-href",
|
|
1377
|
+
"description": "URL that the logo link points to."
|
|
1378
|
+
},
|
|
1379
|
+
{
|
|
1380
|
+
"name": "margin",
|
|
1381
|
+
"description": "Controls the margin of the component.",
|
|
1382
|
+
"values": [
|
|
1383
|
+
{
|
|
1384
|
+
"name": "auto"
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
"name": "none"
|
|
1388
|
+
}
|
|
1389
|
+
]
|
|
1390
|
+
},
|
|
1391
|
+
{
|
|
1392
|
+
"name": "menu",
|
|
1393
|
+
"description": "An array of items for the small footer menu. Items have to include mandatory\n\"label\" and \"href\" fields to work. Additionally, you can pass an \"id\" that is\nadded as an HTML identifier for the anchor tag."
|
|
1394
|
+
},
|
|
1395
|
+
{
|
|
1396
|
+
"name": "theme",
|
|
1397
|
+
"description": "Theme of the navigation.",
|
|
1398
|
+
"values": [
|
|
1399
|
+
{
|
|
1400
|
+
"name": "default"
|
|
1401
|
+
},
|
|
1402
|
+
{
|
|
1403
|
+
"name": "turva"
|
|
1404
|
+
}
|
|
1405
|
+
]
|
|
1406
|
+
},
|
|
1407
|
+
{
|
|
1408
|
+
"name": "variation",
|
|
1409
|
+
"description": "Style variation of the footer.",
|
|
1410
|
+
"values": [
|
|
1411
|
+
{
|
|
1412
|
+
"name": "default"
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"name": "simple"
|
|
1416
|
+
}
|
|
1417
|
+
]
|
|
1418
|
+
}
|
|
1419
|
+
],
|
|
1420
|
+
"references": [
|
|
1421
|
+
{
|
|
1422
|
+
"name": "Source code",
|
|
1423
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-footer/duet-footer.tsx"
|
|
1424
|
+
}
|
|
1425
|
+
]
|
|
1426
|
+
},
|
|
1427
|
+
{
|
|
1428
|
+
"name": "duet-grid",
|
|
1429
|
+
"description": {
|
|
1430
|
+
"kind": "markdown",
|
|
1431
|
+
"value": "---\ntitle: Grid\nname: duet-grid\nstatus: ready\nreleased: 2.7.0\nplatforms: Web only\naccessibility: N/A\nssr: Supported\ncategory: Structure\nintro: Grid component provides structure for other components using Flexbox\n based layout system. Grid allows nesting and defining the direction of the\n content.\ndescription: While the <a href=\"/components/grid-item/\">Grid Item</a> component\n makes it possible set additional parameters for Grid’s cells, this component\n can be used without <code><duet-grid-item/></code> as well. In that case\n the direct child elements of Grid will be considered as Grid cells.\nexample_height: 300px\nexamples:\n - name: grid\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default grid behaviour\n file: fixtures/duet-grid_default_grid_behaviour.html\n - name: Grid using center distribution\n file: fixtures/duet-grid_grid_using_center_distribution.html\n - name: Grid using right distribution\n file: fixtures/duet-grid_grid_using_right_distribution.html\n - name: Grid using space-between distribution\n file: fixtures/duet-grid_grid_using_space-between_distribution.html\n - name: Grid using space-around distribution\n file: fixtures/duet-grid_grid_using_space-around_distribution.html\n - name: Grid using space-evenly distribution\n file: fixtures/duet-grid_grid_using_space-evenly_distribution.html\n - name: Grid using top alignment\n file: fixtures/duet-grid_grid_using_top_alignment.html\n - name: Grid using center alignment\n file: fixtures/duet-grid_grid_using_center_alignment.html\n - name: Grid using bottom alignment\n file: fixtures/duet-grid_grid_using_bottom_alignment.html\n - name: Grid using stretch alignment\n file: fixtures/duet-grid_grid_using_stretch_alignment.html\n - name: Grid using baseline alignment\n file: fixtures/duet-grid_grid_using_baseline_alignment.html\n - name: Grid where one item takes the remaining space\n file: fixtures/duet-grid_grid_where_one_item_takes_the_remaining_space.html\n - name: Grid where one item has fixed side\n file: fixtures/duet-grid_grid_where_one_item_has_fixed_side.html\n - name: Grid with same sized responsive items\n file: fixtures/duet-grid_grid_with_same_sized_responsive_items.html\n - name: Vertical grid\n file: fixtures/duet-grid_vertical_grid.html\n - name: Nested grids\n file: fixtures/duet-grid_nested_grids.html\n - name: Splitting form into columns with grid\n file: fixtures/duet-grid_splitting_form_into_columns_with_grid.html\n - name: Grids using different breakpoints\n file: fixtures/duet-grid_grids_using_different_breakpoints.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1432
|
+
},
|
|
1433
|
+
"attributes": [
|
|
1434
|
+
{
|
|
1435
|
+
"name": "alignment",
|
|
1436
|
+
"description": "Adjusts the vertical alignment of the grid items.",
|
|
1437
|
+
"values": [
|
|
1438
|
+
{
|
|
1439
|
+
"name": "baseline"
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
1442
|
+
"name": "bottom"
|
|
1443
|
+
},
|
|
1444
|
+
{
|
|
1445
|
+
"name": "center"
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
"name": "stretch"
|
|
1449
|
+
},
|
|
1450
|
+
{
|
|
1451
|
+
"name": "top"
|
|
1452
|
+
}
|
|
1453
|
+
]
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "breakpoint",
|
|
1457
|
+
"description": "Switch the breakpoint used to trigger the content stacking. These match to\nsimilar media query tokens: $media-query-small and $media-query-medium.",
|
|
1458
|
+
"values": [
|
|
1459
|
+
{
|
|
1460
|
+
"name": "medium"
|
|
1461
|
+
},
|
|
1462
|
+
{
|
|
1463
|
+
"name": "small"
|
|
1464
|
+
},
|
|
1465
|
+
{
|
|
1466
|
+
"name": "x-large"
|
|
1467
|
+
}
|
|
1468
|
+
]
|
|
1469
|
+
},
|
|
1470
|
+
{
|
|
1471
|
+
"name": "direction",
|
|
1472
|
+
"description": "Direction of the grid items.",
|
|
1473
|
+
"values": [
|
|
1474
|
+
{
|
|
1475
|
+
"name": "horizontal"
|
|
1476
|
+
},
|
|
1477
|
+
{
|
|
1478
|
+
"name": "vertical"
|
|
1479
|
+
}
|
|
1480
|
+
]
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
"name": "distribution",
|
|
1484
|
+
"description": "Adjusts the horizontal distribution of the grid items.",
|
|
1485
|
+
"values": [
|
|
1486
|
+
{
|
|
1487
|
+
"name": "center"
|
|
1488
|
+
},
|
|
1489
|
+
{
|
|
1490
|
+
"name": "default"
|
|
1491
|
+
},
|
|
1492
|
+
{
|
|
1493
|
+
"name": "left"
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"name": "right"
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"name": "space-around"
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"name": "space-between"
|
|
1503
|
+
},
|
|
1504
|
+
{
|
|
1505
|
+
"name": "space-evenly"
|
|
1506
|
+
}
|
|
1507
|
+
]
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"name": "mobile",
|
|
1511
|
+
"description": "Adjusts the horizontal alignment of the grid items on mobile (575px and under).",
|
|
1512
|
+
"values": [
|
|
1513
|
+
{
|
|
1514
|
+
"name": "auto"
|
|
1515
|
+
},
|
|
1516
|
+
{
|
|
1517
|
+
"name": "center"
|
|
1518
|
+
},
|
|
1519
|
+
{
|
|
1520
|
+
"name": "left"
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "right"
|
|
1524
|
+
}
|
|
1525
|
+
]
|
|
1526
|
+
},
|
|
1527
|
+
{
|
|
1528
|
+
"name": "responsive",
|
|
1529
|
+
"description": "Enable or disable the automatic responsive behaviour of the grid component.\nSetting this option to \"true\" makes sure that contents are stacked vertically\non mobile (575px and under)."
|
|
1530
|
+
}
|
|
1531
|
+
],
|
|
1532
|
+
"references": [
|
|
1533
|
+
{
|
|
1534
|
+
"name": "Source code",
|
|
1535
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-grid/duet-grid.tsx"
|
|
1536
|
+
}
|
|
1537
|
+
]
|
|
1538
|
+
},
|
|
1539
|
+
{
|
|
1540
|
+
"name": "duet-grid-item",
|
|
1541
|
+
"description": {
|
|
1542
|
+
"kind": "markdown",
|
|
1543
|
+
"value": "---\ntitle: Grid Item\nname: duet-grid-item\nstatus: ready\nreleased: 2.7.0\nplatforms: Web only\naccessibility: N/A\nssr: Supported\ncategory: Structure\nintro: Grid Item is a component used inside the Grid that makes it possible set\n additional parameters for items. For concrete usage examples, please see <a\n href=\"/components/grid/\">Grid component</a>.\nexample_height: 300px\nexamples:\n - name: grid item\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1544
|
+
},
|
|
1545
|
+
"attributes": [
|
|
1546
|
+
{
|
|
1547
|
+
"name": "fill",
|
|
1548
|
+
"description": "Make the grid item fill the remaining available grid space."
|
|
1549
|
+
},
|
|
1550
|
+
{
|
|
1551
|
+
"name": "margin",
|
|
1552
|
+
"description": "Controls the margin of the component.",
|
|
1553
|
+
"values": [
|
|
1554
|
+
{
|
|
1555
|
+
"name": "auto"
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
"name": "none"
|
|
1559
|
+
}
|
|
1560
|
+
]
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "max-width",
|
|
1564
|
+
"description": "Sets the maximum width for the grid item using any valid numeric CSS\nvalue. E.g. \"300px\"."
|
|
1565
|
+
},
|
|
1566
|
+
{
|
|
1567
|
+
"name": "min-width",
|
|
1568
|
+
"description": "Sets the minimum width for the grid item using any valid numeric CSS\nvalue. E.g. \"33.333%\"."
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "theme",
|
|
1572
|
+
"description": "Theme of the grid item.",
|
|
1573
|
+
"values": [
|
|
1574
|
+
{
|
|
1575
|
+
"name": "default"
|
|
1576
|
+
},
|
|
1577
|
+
{
|
|
1578
|
+
"name": "turva"
|
|
1579
|
+
}
|
|
1580
|
+
]
|
|
1581
|
+
}
|
|
1582
|
+
],
|
|
1583
|
+
"references": [
|
|
1584
|
+
{
|
|
1585
|
+
"name": "Source code",
|
|
1586
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-grid-item/duet-grid-item.tsx"
|
|
1587
|
+
}
|
|
1588
|
+
]
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
"name": "duet-header",
|
|
1592
|
+
"description": {
|
|
1593
|
+
"kind": "markdown",
|
|
1594
|
+
"value": "---\ntitle: Header\nname: duet-header\nstatus: ready\nreleased: 3.0.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Navigation\nintro: Header is used to display the logo, primary navigation and utility menus.\n It’s always visible at the top of the interface and can be configured to show\n just the logo and a back link.\ndescription: Header contains your application’s primary navigation items that\n perform an action when clicked. Each action in the header should navigate to a\n href or trigger another action like a <a href=\"/components/modal/\">Modal\n overlay</a>.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: header\n code: This first example creates the actual href and DOCS, hence it needs to be\n here.\n - name: Basic header with different options\n file: fixtures/duet-header_basic_header_with_different_options.html\n - name: Header in English without region and contact menu\n file: fixtures/duet-header_header_in_english_without_region_and_contact_menu.html\n - name: In Swedish with just the main navigation and logout link\n file: fixtures/duet-header_in_swedish_with_just_the_main_navigation_and_logout_link.html\n - name: Header showing only the logo and a back button\n file: fixtures/duet-header_header_showing_only_the_logo_and_a_back_button.html\n - name: Logged out version that only shows the logo and a login link\n file: fixtures/duet-header_logged_out_version_that_only_shows_the_logo_and_a_login_link.html\n - name: Passing arrays and objects to Header as JSON via attributes for SSR support\n file: fixtures/duet-header_passing_arrays_and_objects_to_header_as_json_via_attributes_for_ssr_support.html\n - name: Using the logo-utility slot\n file: fixtures/duet-header_using_the_logo-utility_slot.html\n\n---\n\n<!-- usage -->"
|
|
1595
|
+
},
|
|
1596
|
+
"attributes": [
|
|
1597
|
+
{
|
|
1598
|
+
"name": "accessible-labels-default",
|
|
1599
|
+
"description": "Default strings for accessibleI18nLabels"
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"name": "accessible-label",
|
|
1603
|
+
"description": "Accessible label that is shown for screen reader users in the mobile\nnavigation toggle. Not visible for normal users."
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"name": "accessible-label-default",
|
|
1607
|
+
"description": "Property to change accessibleLabel defaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabel when needed"
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
"name": "accessible-label-external",
|
|
1611
|
+
"description": "Adds accessible label for tooltip that is shown in external link (url & external have both been set)"
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "accessible-label-external-default",
|
|
1615
|
+
"description": "Property to change accessibleLabelExternal defaults on the component.\nnormally you would handle these strings on an application level and override @accessibleLabelExternal when needed"
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
"name": "back",
|
|
1619
|
+
"description": "An object that includes mandatory \"label\" and \"href\" fields for the back link.\nAdditionally, you can pass an \"id\" that is added as an HTML identifier for the\nelement. If nothing is passed, back link won’t be shown. **NOTE: The back link\nshould be ONLY used in combination with language and logoHref props.**"
|
|
1620
|
+
},
|
|
1621
|
+
{
|
|
1622
|
+
"name": "contact",
|
|
1623
|
+
"description": "Label of the contact menu. If empty, contact menu will be hidden."
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"name": "contact-items",
|
|
1627
|
+
"description": "An array of items for the contact menu. \"label\" and \"href\" are mandatory.\nAdditionally, you can pass an \"id\" that is added as an HTML identifier for\nthe element, and pass an \"external\" flag if the link is to open in a new window."
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
"name": "current-href",
|
|
1631
|
+
"description": "The href of the current page item that is shown as “active”."
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
"name": "items",
|
|
1635
|
+
"description": "An array of items for the main navigation. Items have to include mandatory\n\"label\" and \"href\" fields to work. Additionally, you can pass an \"id\" that is\nadded as an HTML identifier for the element."
|
|
1636
|
+
},
|
|
1637
|
+
{
|
|
1638
|
+
"name": "language",
|
|
1639
|
+
"description": "The currently active language. This setting also changes the logo to match\nthe chosen language.",
|
|
1640
|
+
"values": [
|
|
1641
|
+
{
|
|
1642
|
+
"name": "en"
|
|
1643
|
+
},
|
|
1644
|
+
{
|
|
1645
|
+
"name": "fi"
|
|
1646
|
+
},
|
|
1647
|
+
{
|
|
1648
|
+
"name": "sv"
|
|
1649
|
+
}
|
|
1650
|
+
]
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "language-items",
|
|
1654
|
+
"description": "An array of items for the language menu. If empty, the language menu will\nbe hidden. \"label\", \"country\" and \"href\" are mandatory. Additionally you\ncan pass an \"id\" that is added as an HTML identifier for the element."
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"name": "logo-href",
|
|
1658
|
+
"description": "URL that the logo link points to."
|
|
1659
|
+
},
|
|
1660
|
+
{
|
|
1661
|
+
"name": "region",
|
|
1662
|
+
"description": "Region that is shown next to the logo. If empty, region will be hidden."
|
|
1663
|
+
},
|
|
1664
|
+
{
|
|
1665
|
+
"name": "session",
|
|
1666
|
+
"description": "An object that includes mandatory \"label\", \"href\" and \"type\" fields for the\nsession login/logout link. Additionally, you can pass an \"id\" that is added\nas an HTML identifier for the element. If nothing is passed, this link won’t\nbe shown."
|
|
1667
|
+
},
|
|
1668
|
+
{
|
|
1669
|
+
"name": "skip-to-id",
|
|
1670
|
+
"description": "The ID of the element where \"skip to content\" link should take the user.\nIf empty, the functionality won’t be rendered in the DOM."
|
|
1671
|
+
},
|
|
1672
|
+
{
|
|
1673
|
+
"name": "theme",
|
|
1674
|
+
"description": "Theme of the header.",
|
|
1675
|
+
"values": [
|
|
1676
|
+
{
|
|
1677
|
+
"name": "default"
|
|
1678
|
+
},
|
|
1679
|
+
{
|
|
1680
|
+
"name": "turva"
|
|
1681
|
+
}
|
|
1682
|
+
]
|
|
1683
|
+
},
|
|
1684
|
+
{
|
|
1685
|
+
"name": "user",
|
|
1686
|
+
"description": "An object that includes mandatory \"label\" and \"href\" fields for the user\nprofile link. Additionally, you can pass an \"id\" that is added as an HTML\nidentifier for the element. If nothing is passed, user won’t be shown."
|
|
1687
|
+
}
|
|
1688
|
+
],
|
|
1689
|
+
"references": [
|
|
1690
|
+
{
|
|
1691
|
+
"name": "Source code",
|
|
1692
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-header/duet-header.tsx"
|
|
1693
|
+
}
|
|
1694
|
+
]
|
|
1695
|
+
},
|
|
1696
|
+
{
|
|
1697
|
+
"name": "duet-heading",
|
|
1698
|
+
"description": {
|
|
1699
|
+
"kind": "markdown",
|
|
1700
|
+
"value": "---\ntitle: Heading\nname: duet-heading\nstatus: ready\nreleased: 1.5.4\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Text\nintro: Headings are used as the titles of each major section of a page in the\n interface. For example, templates generally use headings as their title.\ndescription: Heading element provides an option to change the level of the\n heading. Heading also includes an option that allows you to make e.g. h1\n visually look like h3, but still keep it h1 in the HTML markup.\nplatforms: Web only\nexample_height: 400px\ntags:\n - docs-components\nexamples:\n - name: heading\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default headings\n file: fixtures/duet-heading_default_headings.html\n - name: Headings with border\n file: fixtures/duet-heading_headings_with_border.html\n - name: Headings that visually looks like h3\n file: fixtures/duet-heading_headings_that_visually_looks_like_h3.html\n - name: Headings without margins\n file: fixtures/duet-heading_headings_without_margins.html\n - name: Headings using color tokens\n file: fixtures/duet-heading_headings_using_color_tokens.html\n - name: Using semibold for headings\n file: fixtures/duet-heading_using_semibold_for_headings.html\n - name: Heading with hyphenation\n file: fixtures/duet-heading_heading_with_hyphenation.html\n\n---\n\n<!-- usage -->"
|
|
1701
|
+
},
|
|
1702
|
+
"attributes": [
|
|
1703
|
+
{
|
|
1704
|
+
"name": "border",
|
|
1705
|
+
"description": "Enable or disable the border underneath the heading."
|
|
1706
|
+
},
|
|
1707
|
+
{
|
|
1708
|
+
"name": "color",
|
|
1709
|
+
"description": "Custom color for the heading as a design token entered in camelCase or\nkebab-case. Example: \"color-primary\"."
|
|
1710
|
+
},
|
|
1711
|
+
{
|
|
1712
|
+
"name": "hyphenate",
|
|
1713
|
+
"description": "Enable hyphenation for long titles. Useful when there is no control over content e.g. user-generated content."
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
"name": "level",
|
|
1717
|
+
"description": "The actual heading level used in the HTML markup.",
|
|
1718
|
+
"values": [
|
|
1719
|
+
{
|
|
1720
|
+
"name": "h1"
|
|
1721
|
+
},
|
|
1722
|
+
{
|
|
1723
|
+
"name": "h2"
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"name": "h3"
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
"name": "h4"
|
|
1730
|
+
},
|
|
1731
|
+
{
|
|
1732
|
+
"name": "h5"
|
|
1733
|
+
},
|
|
1734
|
+
{
|
|
1735
|
+
"name": "h6"
|
|
1736
|
+
}
|
|
1737
|
+
]
|
|
1738
|
+
},
|
|
1739
|
+
{
|
|
1740
|
+
"name": "margin",
|
|
1741
|
+
"description": "Controls the margin of the component.",
|
|
1742
|
+
"values": [
|
|
1743
|
+
{
|
|
1744
|
+
"name": "auto"
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"name": "none"
|
|
1748
|
+
}
|
|
1749
|
+
]
|
|
1750
|
+
},
|
|
1751
|
+
{
|
|
1752
|
+
"name": "theme",
|
|
1753
|
+
"description": "Theme of the heading.",
|
|
1754
|
+
"values": [
|
|
1755
|
+
{
|
|
1756
|
+
"name": "default"
|
|
1757
|
+
},
|
|
1758
|
+
{
|
|
1759
|
+
"name": "turva"
|
|
1760
|
+
}
|
|
1761
|
+
]
|
|
1762
|
+
},
|
|
1763
|
+
{
|
|
1764
|
+
"name": "visual-level",
|
|
1765
|
+
"description": "Make the visual style mimic a specific heading level. This option allows\nyou to make e.g. h1 visually look like h3, but still keep it h1 in the\nmarkup.",
|
|
1766
|
+
"values": [
|
|
1767
|
+
{
|
|
1768
|
+
"name": "h0"
|
|
1769
|
+
},
|
|
1770
|
+
{
|
|
1771
|
+
"name": "h1"
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"name": "h2"
|
|
1775
|
+
},
|
|
1776
|
+
{
|
|
1777
|
+
"name": "h3"
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"name": "h4"
|
|
1781
|
+
},
|
|
1782
|
+
{
|
|
1783
|
+
"name": "h5"
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"name": "h6"
|
|
1787
|
+
}
|
|
1788
|
+
]
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
"name": "weight",
|
|
1792
|
+
"description": "This property allows you to set semibold font weight for all sizes\nwhen needed.",
|
|
1793
|
+
"values": [
|
|
1794
|
+
{
|
|
1795
|
+
"name": "auto"
|
|
1796
|
+
},
|
|
1797
|
+
{
|
|
1798
|
+
"name": "semibold"
|
|
1799
|
+
}
|
|
1800
|
+
]
|
|
1801
|
+
}
|
|
1802
|
+
],
|
|
1803
|
+
"references": [
|
|
1804
|
+
{
|
|
1805
|
+
"name": "Source code",
|
|
1806
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-heading/duet-heading.tsx"
|
|
1807
|
+
}
|
|
1808
|
+
]
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
"name": "duet-hero",
|
|
1812
|
+
"description": {
|
|
1813
|
+
"kind": "markdown",
|
|
1814
|
+
"value": "---\ntitle: Hero Area\nname: duet-hero\nstatus: ready\nreleased: 1.1.6\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Structure\nintro: When placed at the top of the page hero areas are often the first thing\n user sees, making them a great place to catch user’s attention with catchy\n content.\ndescription: Hero areas can include an illustration in addition to a title, a\n description, and an action button. Please note that this component takes care\n of its top and bottom spacing so there should be no need to write custom CSS.\nexample_height: 500px\nexamples:\n - name: hero\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default hero\n file: fixtures/duet-hero_default_hero.html\n - name: Hero area using light variation\n file: fixtures/duet-hero_hero_area_using_light_variation.html\n - name: Hero area using gray variation\n file: fixtures/duet-hero_hero_area_using_gray_variation.html\n - name: Gray hero area with meta data and actions\n file: fixtures/duet-hero_gray_hero_area_with_meta_data_and_actions.html\n - name: Gray hero area utilizing pre-heading\n file: fixtures/duet-hero_gray_hero_area_utilizing_pre-heading.html\n - name: Gray hero area with meta data but without back button\n file: fixtures/duet-hero_gray_hero_area_with_meta_data_but_without_back_button.html\n - name: Gray hero area with meta data but without actions\n file: fixtures/duet-hero_gray_hero_area_with_meta_data_but_without_actions.html\n - name: Hero area with a badge\n file: fixtures/duet-hero_hero_area_with_a_badge.html\n - name: Hero area using image variation\n file: fixtures/duet-hero_hero_area_using_image_variation.html\n - name: Hero without illustration and centered text\n file: fixtures/duet-hero_hero_without_illustration_and_centered_text.html\n - name: Passing arrays and objects to Hero as JSON via attributes for SSR support\n file: fixtures/duet-hero_passing_arrays_and_objects_to_hero_as_json_via_attributes_for_ssr_support.html\n - name: Minimal variation with slot\n file: fixtures/duet-hero_hero_area_using_minimal_variation_and_slot.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1815
|
+
},
|
|
1816
|
+
"attributes": [
|
|
1817
|
+
{
|
|
1818
|
+
"name": "accessible-label-external",
|
|
1819
|
+
"description": "Adds accessible label for tooltip that is shown in external link (url & external have both been set)"
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"name": "accessible-label-external-default",
|
|
1823
|
+
"description": "Defaults for accessibleLabelExternal"
|
|
1824
|
+
},
|
|
1825
|
+
{
|
|
1826
|
+
"name": "actions",
|
|
1827
|
+
"description": "An array of items for the main actions. Items have to include mandatory\n\"label\", \"href\" and \"icon\" fields to work. Additionally, you can pass an \"id\"\nthat is added as an HTML identifier for the anchor tag."
|
|
1828
|
+
},
|
|
1829
|
+
{
|
|
1830
|
+
"name": "back",
|
|
1831
|
+
"description": "An object that includes mandatory \"label\" and \"href\" fields for the back link.\nAdditionally, you can pass an \"id\" that is added as an HTML identifier for the\nelement. If nothing is passed, back link won’t be shown. **NOTE: The back link\ncan be ONLY used in combination with \"gray\" style variation.**"
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"name": "button-id",
|
|
1835
|
+
"description": "ID for the button."
|
|
1836
|
+
},
|
|
1837
|
+
{
|
|
1838
|
+
"name": "button-label",
|
|
1839
|
+
"description": "Text label shown inside the button. If empty, button will be hidden."
|
|
1840
|
+
},
|
|
1841
|
+
{
|
|
1842
|
+
"name": "button-url",
|
|
1843
|
+
"description": "URL that the button links to."
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"name": "category-icon",
|
|
1847
|
+
"description": "Icon to display to the left of the heading in gray hero area variation. If empty, icon will be hidden."
|
|
1848
|
+
},
|
|
1849
|
+
{
|
|
1850
|
+
"name": "category-icon-color",
|
|
1851
|
+
"description": "Icon color to use for the category icon that can be used in gray hero area variation."
|
|
1852
|
+
},
|
|
1853
|
+
{
|
|
1854
|
+
"name": "description",
|
|
1855
|
+
"description": "The description of the hero area, rendered in a P tag. If empty, description\nwill be hidden."
|
|
1856
|
+
},
|
|
1857
|
+
{
|
|
1858
|
+
"name": "heading",
|
|
1859
|
+
"description": "The heading of the hero area, rendered in an H1 tag. P.S. you can control\nthe level of the HTML heading by using “level” prop. If empty, heading\nwill be hidden."
|
|
1860
|
+
},
|
|
1861
|
+
{
|
|
1862
|
+
"name": "icon",
|
|
1863
|
+
"description": "Icon to display to the left of the button content. If empty, icon will be hidden."
|
|
1864
|
+
},
|
|
1865
|
+
{
|
|
1866
|
+
"name": "icon-right",
|
|
1867
|
+
"description": "Show icon on the right side of the button content."
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"name": "icon-size",
|
|
1871
|
+
"description": "Icon size for the button.",
|
|
1872
|
+
"values": [
|
|
1873
|
+
{
|
|
1874
|
+
"name": "large"
|
|
1875
|
+
},
|
|
1876
|
+
{
|
|
1877
|
+
"name": "medium"
|
|
1878
|
+
}
|
|
1879
|
+
]
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"name": "image",
|
|
1883
|
+
"description": "URL of the image shown inside the hero area. The width of the displayed image\nshould be 800px. Optimal aspect ratio is 3:2. When using “image” variation of\nHero Area the required image size is 1200x1200px (1:1 ratio). If this\nproperty is left empty, image will be hidden."
|
|
1884
|
+
},
|
|
1885
|
+
{
|
|
1886
|
+
"name": "language",
|
|
1887
|
+
"description": "The currently active language. This setting changes the accessible labels to match the\nchosen language.",
|
|
1888
|
+
"values": [
|
|
1889
|
+
{
|
|
1890
|
+
"name": "en"
|
|
1891
|
+
},
|
|
1892
|
+
{
|
|
1893
|
+
"name": "fi"
|
|
1894
|
+
},
|
|
1895
|
+
{
|
|
1896
|
+
"name": "sv"
|
|
1897
|
+
}
|
|
1898
|
+
]
|
|
1899
|
+
},
|
|
1900
|
+
{
|
|
1901
|
+
"name": "left-align",
|
|
1902
|
+
"description": "Forces all items in the header to be leftAligned\nThis can be used on mobiles to create leftAligned hero areas that either are only leftaligned on smaller devices\nor allways leftAligned (you must manually switch this parameter if you need special breakpoints)\nthis nullifies textCenter prop"
|
|
1903
|
+
},
|
|
1904
|
+
{
|
|
1905
|
+
"name": "level",
|
|
1906
|
+
"description": "The level of the heading.",
|
|
1907
|
+
"values": [
|
|
1908
|
+
{
|
|
1909
|
+
"name": "h1"
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"name": "h2"
|
|
1913
|
+
},
|
|
1914
|
+
{
|
|
1915
|
+
"name": "h3"
|
|
1916
|
+
},
|
|
1917
|
+
{
|
|
1918
|
+
"name": "h4"
|
|
1919
|
+
},
|
|
1920
|
+
{
|
|
1921
|
+
"name": "h5"
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
"name": "h6"
|
|
1925
|
+
}
|
|
1926
|
+
]
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
"name": "list-items",
|
|
1930
|
+
"description": "An array of items for the definition list inside hero. Items have to\ninclude mandatory \"label\" and \"value\" fields to work."
|
|
1931
|
+
},
|
|
1932
|
+
{
|
|
1933
|
+
"name": "pre-heading",
|
|
1934
|
+
"description": "The headline shown before heading."
|
|
1935
|
+
},
|
|
1936
|
+
{
|
|
1937
|
+
"name": "text-center",
|
|
1938
|
+
"description": "Centers the text in hero area."
|
|
1939
|
+
},
|
|
1940
|
+
{
|
|
1941
|
+
"name": "theme",
|
|
1942
|
+
"description": "Theme of the hero area.",
|
|
1943
|
+
"values": [
|
|
1944
|
+
{
|
|
1945
|
+
"name": "default"
|
|
1946
|
+
},
|
|
1947
|
+
{
|
|
1948
|
+
"name": "turva"
|
|
1949
|
+
}
|
|
1950
|
+
]
|
|
1951
|
+
},
|
|
1952
|
+
{
|
|
1953
|
+
"name": "variation",
|
|
1954
|
+
"description": "Style variation of the hero area.",
|
|
1955
|
+
"values": [
|
|
1956
|
+
{
|
|
1957
|
+
"name": "default"
|
|
1958
|
+
},
|
|
1959
|
+
{
|
|
1960
|
+
"name": "gray"
|
|
1961
|
+
},
|
|
1962
|
+
{
|
|
1963
|
+
"name": "image"
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"name": "light"
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "minimal"
|
|
1970
|
+
}
|
|
1971
|
+
]
|
|
1972
|
+
}
|
|
1973
|
+
],
|
|
1974
|
+
"references": [
|
|
1975
|
+
{
|
|
1976
|
+
"name": "Source code",
|
|
1977
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-hero/duet-hero.tsx"
|
|
1978
|
+
}
|
|
1979
|
+
]
|
|
1980
|
+
},
|
|
1981
|
+
{
|
|
1982
|
+
"name": "duet-icon",
|
|
1983
|
+
"description": {
|
|
1984
|
+
"kind": "markdown",
|
|
1985
|
+
"value": "---\ntitle: Icon\nname: duet-icon\nstatus: ready\nreleased: 2.7.0\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Images and icons\nintro: Icons are used to provide additional meaning or in places where text\n label doesn’t fit. Icon component allows you to customize the size and color\n of the icon.\ndescription: You can use any of the icons listed under <a\n href=\"/iconography/\">Iconography section</a>. By default the icon will inherit\n the text color from the parent element, but you can use the color property to\n override this behaviour.\nplatforms: Web only\nexamples:\n - name: icon\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Circular icons\n file: fixtures/duet-icon_circular_icons.html\n - name: Circular outline icons\n file: fixtures/duet-icon_circular_outline_icons.html\n - name: Basic icons in different sizes\n file: fixtures/duet-icon_basic_icons_in_different_sizes.html\n - name: Outline and filled icons in different sizes\n file: fixtures/duet-icon_outline_and_filled_icons_in_different_sizes.html\n - name: Combining background and color properties\n file: fixtures/duet-icon_combining_background_and_color_properties.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
1986
|
+
},
|
|
1987
|
+
"attributes": [
|
|
1988
|
+
{
|
|
1989
|
+
"name": "background",
|
|
1990
|
+
"description": "Custom color to be used for a circular background, as a design token entered\nin camelCase or kebab-case. Using this option the icon will always be resized\nto $size-icon-medium on mobile viewports. Example: \"color-primary\"."
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "color",
|
|
1994
|
+
"description": "Custom color to be used for the icon, as a design token entered in camelCase\nor kebab-case. Example: \"color-primary\". This property can also be set to\n\"currentColor\" which forces the icon to use the CSS text color of parent\nelement instead. Useful when you want to control the color in stylesheet\ninstead."
|
|
1995
|
+
},
|
|
1996
|
+
{
|
|
1997
|
+
"name": "icon",
|
|
1998
|
+
"description": "A raw SVG string."
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"name": "margin",
|
|
2002
|
+
"description": "Controls the margin of the component.",
|
|
2003
|
+
"values": [
|
|
2004
|
+
{
|
|
2005
|
+
"name": "auto"
|
|
2006
|
+
},
|
|
2007
|
+
{
|
|
2008
|
+
"name": "none"
|
|
2009
|
+
}
|
|
2010
|
+
]
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"name": "name",
|
|
2014
|
+
"description": "Icon name from Duet to display."
|
|
2015
|
+
},
|
|
2016
|
+
{
|
|
2017
|
+
"name": "outline",
|
|
2018
|
+
"description": "Custom color to be used for a circular border and icon outline, as a design\ntoken entered in camelCase or kebab-case. Using this option the icon will\nalways be resized to $size-icon-medium on mobile viewports.\nExample: \"color-primary\"."
|
|
2019
|
+
},
|
|
2020
|
+
{
|
|
2021
|
+
"name": "responsive",
|
|
2022
|
+
"description": "Whether the icon changes its size responsively or not."
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
"name": "size",
|
|
2026
|
+
"description": "Icon size. Entered as one of the icon size design tokens.",
|
|
2027
|
+
"values": [
|
|
2028
|
+
{
|
|
2029
|
+
"name": "auto"
|
|
2030
|
+
},
|
|
2031
|
+
{
|
|
2032
|
+
"name": "large"
|
|
2033
|
+
},
|
|
2034
|
+
{
|
|
2035
|
+
"name": "medium"
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
"name": "small"
|
|
2039
|
+
},
|
|
2040
|
+
{
|
|
2041
|
+
"name": "x-large"
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"name": "x-small"
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"name": "xx-large"
|
|
2048
|
+
},
|
|
2049
|
+
{
|
|
2050
|
+
"name": "xx-small"
|
|
2051
|
+
},
|
|
2052
|
+
{
|
|
2053
|
+
"name": "xxx-large"
|
|
2054
|
+
},
|
|
2055
|
+
{
|
|
2056
|
+
"name": "xxx-small"
|
|
2057
|
+
}
|
|
2058
|
+
]
|
|
2059
|
+
},
|
|
2060
|
+
{
|
|
2061
|
+
"name": "src",
|
|
2062
|
+
"description": "A URL from which to load an icon."
|
|
2063
|
+
},
|
|
2064
|
+
{
|
|
2065
|
+
"name": "theme",
|
|
2066
|
+
"description": "Theme of the icon. This setting will be overridden when you set the color\nproperty",
|
|
2067
|
+
"values": [
|
|
2068
|
+
{
|
|
2069
|
+
"name": "default"
|
|
2070
|
+
},
|
|
2071
|
+
{
|
|
2072
|
+
"name": "turva"
|
|
2073
|
+
}
|
|
2074
|
+
]
|
|
2075
|
+
}
|
|
2076
|
+
],
|
|
2077
|
+
"references": [
|
|
2078
|
+
{
|
|
2079
|
+
"name": "Source code",
|
|
2080
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-icon/duet-icon.tsx"
|
|
2081
|
+
}
|
|
2082
|
+
]
|
|
2083
|
+
},
|
|
2084
|
+
{
|
|
2085
|
+
"name": "duet-input",
|
|
2086
|
+
"description": {
|
|
2087
|
+
"kind": "markdown",
|
|
2088
|
+
"value": "---\ntitle: Input\nname: duet-input\nstatus: ready\nreleased: 1.3.0\nplatforms: Web only\ninternationalization: Supported\nssr: Supported\ncategory: Forms\naccessibility: Keyboard, Screen Reader\nintro: Inputs are used to allow users to provide text input when the expected\n input is short. Input component has a range of options and supports several\n text formats including numbers.\ndescription: You can use native HTML5 validation with Input component via\n validation properties. This allows you to specify rules like whether a value\n needs to be filled in, the minimum and maximum length of the data, whether it\n needs to be a number, and a pattern that it must match.\nexamples:\n - name: input\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Text input\n file: fixtures/duet-input_text_input.html\n - name: Input using expand property\n file: fixtures/duet-input_input_using_expand_property.html\n - name: Text input that only allows numbers and commas\n file: fixtures/duet-input_text_input_that_only_allows_numbers_and_commas.html\n - name: Tel input\n file: fixtures/duet-input_tel_input.html\n - name: Email input\n file: fixtures/duet-input_email_input.html\n - name: Search input\n file: fixtures/duet-input_search_input.html\n - name: Password input\n file: fixtures/duet-input_password_input.html\n - name: Disabled input\n file: fixtures/duet-input_disabled_input.html\n - name: Disabled input with a custom icon\n file: fixtures/duet-input_disabled_input_with_a_custom_icon.html\n - name: Input with an error\n file: fixtures/duet-input_input_with_an_error.html\n - name: Input with a tooltip\n file: fixtures/duet-input_input_with_a_tooltip.html\n - name: Input with a top caption and echoing of placeholders\n file: fixtures/duet-input_text_input_caption_and_echoing_placeholders.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2089
|
+
},
|
|
2090
|
+
"attributes": [
|
|
2091
|
+
{
|
|
2092
|
+
"name": "accessible-active-descendant",
|
|
2093
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
2094
|
+
},
|
|
2095
|
+
{
|
|
2096
|
+
"name": "accessible-autocomplete",
|
|
2097
|
+
"description": "Indicates what kind of user input completion suggestions are provided."
|
|
2098
|
+
},
|
|
2099
|
+
{
|
|
2100
|
+
"name": "accessible-controls",
|
|
2101
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
2102
|
+
},
|
|
2103
|
+
{
|
|
2104
|
+
"name": "accessible-described-by",
|
|
2105
|
+
"description": "Indicates the id of a component that describes the input."
|
|
2106
|
+
},
|
|
2107
|
+
{
|
|
2108
|
+
"name": "accessible-owns",
|
|
2109
|
+
"description": "Indicates the id of a component owned by the input."
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
"name": "auto-complete",
|
|
2113
|
+
"description": "Enable or disable automatic completion by the browser"
|
|
2114
|
+
},
|
|
2115
|
+
{
|
|
2116
|
+
"name": "caption",
|
|
2117
|
+
"description": "Caption (underneath label) that can be set as a way of adding extra information"
|
|
2118
|
+
},
|
|
2119
|
+
{
|
|
2120
|
+
"name": "component",
|
|
2121
|
+
"description": "Used internally in Duet to adjust whether this component acts as e.g. number input.",
|
|
2122
|
+
"values": [
|
|
2123
|
+
{
|
|
2124
|
+
"name": "date"
|
|
2125
|
+
},
|
|
2126
|
+
{
|
|
2127
|
+
"name": "input"
|
|
2128
|
+
},
|
|
2129
|
+
{
|
|
2130
|
+
"name": "number"
|
|
2131
|
+
}
|
|
2132
|
+
]
|
|
2133
|
+
},
|
|
2134
|
+
{
|
|
2135
|
+
"name": "debounce",
|
|
2136
|
+
"description": "Set the amount of time, in milliseconds, to wait to trigger the duetChange\nevent after each keystroke."
|
|
2137
|
+
},
|
|
2138
|
+
{
|
|
2139
|
+
"name": "disabled",
|
|
2140
|
+
"description": "Makes the input component disabled. This prevents users from being able to\ninteract with the input, and conveys its inactive state to assistive technologies."
|
|
2141
|
+
},
|
|
2142
|
+
{
|
|
2143
|
+
"name": "disallow-pattern",
|
|
2144
|
+
"description": "A regular expression that matches any characters which should be *disallowed*.\nThis differs from `pattern`, as it actively prevents users entering any characters which match the regular expression.\ne.g. the following will disallow any non-numeric characters `[^0-9]`"
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"name": "echo-placeholder",
|
|
2148
|
+
"description": "If form input field has a placeholder text, and user types anything (causing the placeholder text to disappear),\nsettings this to true will \"echo\" it into the caption slot - this option will be false by default for the next few versions, but will eventually be true by default (scheduled for 4.30.0)"
|
|
2149
|
+
},
|
|
2150
|
+
{
|
|
2151
|
+
"name": "error",
|
|
2152
|
+
"description": "Display the input in error state along with an error message."
|
|
2153
|
+
},
|
|
2154
|
+
{
|
|
2155
|
+
"name": "expand",
|
|
2156
|
+
"description": "Expands the input to fill 100% of the container width."
|
|
2157
|
+
},
|
|
2158
|
+
{
|
|
2159
|
+
"name": "icon",
|
|
2160
|
+
"description": "Icon to display on the right side (from Duet’s icons). Example: \"form-location\""
|
|
2161
|
+
},
|
|
2162
|
+
{
|
|
2163
|
+
"name": "identifier",
|
|
2164
|
+
"description": "Adds a unique identifier for the input."
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"name": "label",
|
|
2168
|
+
"description": "Label for the input."
|
|
2169
|
+
},
|
|
2170
|
+
{
|
|
2171
|
+
"name": "label-hidden",
|
|
2172
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"name": "margin",
|
|
2176
|
+
"description": "Controls the margin of the component.",
|
|
2177
|
+
"values": [
|
|
2178
|
+
{
|
|
2179
|
+
"name": "auto"
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"name": "none"
|
|
2183
|
+
}
|
|
2184
|
+
]
|
|
2185
|
+
},
|
|
2186
|
+
{
|
|
2187
|
+
"name": "maxlength",
|
|
2188
|
+
"description": "Use maxlength to specify the maximum length of the value that can be entered.\nPlease note that this uses native HTML5 pattern validation."
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"name": "minlength",
|
|
2192
|
+
"description": "Use minlength to specify the minimum length of the value that can be entered.\nPlease note that this uses native HTML5 pattern validation."
|
|
2193
|
+
},
|
|
2194
|
+
{
|
|
2195
|
+
"name": "name",
|
|
2196
|
+
"description": "Name of the input."
|
|
2197
|
+
},
|
|
2198
|
+
{
|
|
2199
|
+
"name": "numeric-keyboard",
|
|
2200
|
+
"description": "Enable numeric keyboard for the input."
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
"name": "pattern",
|
|
2204
|
+
"description": "A regular expression to check the value against. Please note that this\nuses native HTML5 pattern validation."
|
|
2205
|
+
},
|
|
2206
|
+
{
|
|
2207
|
+
"name": "placeholder",
|
|
2208
|
+
"description": "Hint text to display."
|
|
2209
|
+
},
|
|
2210
|
+
{
|
|
2211
|
+
"name": "required",
|
|
2212
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
2213
|
+
},
|
|
2214
|
+
{
|
|
2215
|
+
"name": "role",
|
|
2216
|
+
"description": "Defines a specific role attribute for the input."
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
"name": "theme",
|
|
2220
|
+
"description": "Theme of the input.",
|
|
2221
|
+
"values": [
|
|
2222
|
+
{
|
|
2223
|
+
"name": "default"
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
"name": "turva"
|
|
2227
|
+
}
|
|
2228
|
+
]
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"name": "tooltip",
|
|
2232
|
+
"description": "Tooltip to display next to the label of the input."
|
|
2233
|
+
},
|
|
2234
|
+
{
|
|
2235
|
+
"name": "tooltip-direction",
|
|
2236
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
2237
|
+
"values": [
|
|
2238
|
+
{
|
|
2239
|
+
"name": "auto"
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"name": "left"
|
|
2243
|
+
},
|
|
2244
|
+
{
|
|
2245
|
+
"name": "right"
|
|
2246
|
+
}
|
|
2247
|
+
]
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"name": "type",
|
|
2251
|
+
"description": "Type of the input.",
|
|
2252
|
+
"values": [
|
|
2253
|
+
{
|
|
2254
|
+
"name": "email"
|
|
2255
|
+
},
|
|
2256
|
+
{
|
|
2257
|
+
"name": "password"
|
|
2258
|
+
},
|
|
2259
|
+
{
|
|
2260
|
+
"name": "search"
|
|
2261
|
+
},
|
|
2262
|
+
{
|
|
2263
|
+
"name": "tel"
|
|
2264
|
+
},
|
|
2265
|
+
{
|
|
2266
|
+
"name": "text"
|
|
2267
|
+
}
|
|
2268
|
+
]
|
|
2269
|
+
},
|
|
2270
|
+
{
|
|
2271
|
+
"name": "value",
|
|
2272
|
+
"description": "Value of the input."
|
|
2273
|
+
}
|
|
2274
|
+
],
|
|
2275
|
+
"references": [
|
|
2276
|
+
{
|
|
2277
|
+
"name": "Source code",
|
|
2278
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-input/duet-input.tsx"
|
|
2279
|
+
}
|
|
2280
|
+
]
|
|
2281
|
+
},
|
|
2282
|
+
{
|
|
2283
|
+
"name": "duet-label",
|
|
2284
|
+
"description": {
|
|
2285
|
+
"kind": "markdown",
|
|
2286
|
+
"value": "---\ntitle: Label\nname: duet-label\nstatus: ready\nreleased: 1.0.14\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Forms\nintro: Labels are used to create text labels for items in an interface. Most\n commonly used inside other form components.\nexamples:\n - name: label\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default label\n file: fixtures/duet-label_default_label.html\n - name: Small label\n file: fixtures/duet-label_small_label.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2287
|
+
},
|
|
2288
|
+
"attributes": [
|
|
2289
|
+
{
|
|
2290
|
+
"name": "for",
|
|
2291
|
+
"description": "ID of the component that the label is labelling."
|
|
2292
|
+
},
|
|
2293
|
+
{
|
|
2294
|
+
"name": "margin",
|
|
2295
|
+
"description": "Controls the margin of the component.",
|
|
2296
|
+
"values": [
|
|
2297
|
+
{
|
|
2298
|
+
"name": "auto"
|
|
2299
|
+
},
|
|
2300
|
+
{
|
|
2301
|
+
"name": "none"
|
|
2302
|
+
},
|
|
2303
|
+
{
|
|
2304
|
+
"name": "small"
|
|
2305
|
+
}
|
|
2306
|
+
]
|
|
2307
|
+
},
|
|
2308
|
+
{
|
|
2309
|
+
"name": "size",
|
|
2310
|
+
"description": "Controls the size of the label.",
|
|
2311
|
+
"values": [
|
|
2312
|
+
{
|
|
2313
|
+
"name": "medium"
|
|
2314
|
+
},
|
|
2315
|
+
{
|
|
2316
|
+
"name": "small"
|
|
2317
|
+
}
|
|
2318
|
+
]
|
|
2319
|
+
},
|
|
2320
|
+
{
|
|
2321
|
+
"name": "theme",
|
|
2322
|
+
"description": "Theme of the label.",
|
|
2323
|
+
"values": [
|
|
2324
|
+
{
|
|
2325
|
+
"name": "default"
|
|
2326
|
+
},
|
|
2327
|
+
{
|
|
2328
|
+
"name": "turva"
|
|
2329
|
+
}
|
|
2330
|
+
]
|
|
2331
|
+
}
|
|
2332
|
+
],
|
|
2333
|
+
"references": [
|
|
2334
|
+
{
|
|
2335
|
+
"name": "Source code",
|
|
2336
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-label/duet-label.tsx"
|
|
2337
|
+
}
|
|
2338
|
+
]
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
"name": "duet-layout",
|
|
2342
|
+
"description": {
|
|
2343
|
+
"kind": "markdown",
|
|
2344
|
+
"value": "---\ntitle: Layout\nname: duet-layout\nstatus: ready\nreleased: 1.4.0\nplatforms: Web only\nexample_height: 380px\nssr: Supported\ncategory: Structure\nintro: Layout component, while not visible in the user interface itself,\n provides a structure for other components using a one or two column layout\n system.\nexamples:\n - name: layout\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Full-width layout\n file: fixtures/duet-layout_full-width_layout.html\n - name: Full-width layout with top section\n file: fixtures/duet-layout_full-width_layout_with_top_section.html\n - name: Full-width layout with sidebar\n file: fixtures/duet-layout_full-width_layout_with_sidebar.html\n - name: Full-width layout with sidebar and top section\n file: fixtures/duet-layout_full-width_layout_with_sidebar_and_top_section.html\n - name: Narrow layout\n file: fixtures/duet-layout_narrow_layout.html\n - name: Narrow layout with top section\n file: fixtures/duet-layout_narrow_layout_with_top_section.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2345
|
+
},
|
|
2346
|
+
"attributes": [
|
|
2347
|
+
{
|
|
2348
|
+
"name": "center",
|
|
2349
|
+
"description": "Center align all direct children of this component."
|
|
2350
|
+
},
|
|
2351
|
+
{
|
|
2352
|
+
"name": "margin",
|
|
2353
|
+
"description": "Controls the margin of the component.",
|
|
2354
|
+
"values": [
|
|
2355
|
+
{
|
|
2356
|
+
"name": "auto"
|
|
2357
|
+
},
|
|
2358
|
+
{
|
|
2359
|
+
"name": "none"
|
|
2360
|
+
}
|
|
2361
|
+
]
|
|
2362
|
+
},
|
|
2363
|
+
{
|
|
2364
|
+
"name": "middle",
|
|
2365
|
+
"description": "Align container vertically in the middle when the space allows it."
|
|
2366
|
+
},
|
|
2367
|
+
{
|
|
2368
|
+
"name": "sticky",
|
|
2369
|
+
"description": "Makes the sidebar stick to the top of the window when scrolling down."
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
"name": "sticky-distance",
|
|
2373
|
+
"description": "Adjust sticky sidebar’s distance to duet navigation component using this property.",
|
|
2374
|
+
"values": [
|
|
2375
|
+
{
|
|
2376
|
+
"name": "with-links"
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
"name": "without-links"
|
|
2380
|
+
}
|
|
2381
|
+
]
|
|
2382
|
+
},
|
|
2383
|
+
{
|
|
2384
|
+
"name": "tabs",
|
|
2385
|
+
"description": "If set to true, the sidebar position will be adjusted to take tabs inside main content\narea into account."
|
|
2386
|
+
}
|
|
2387
|
+
],
|
|
2388
|
+
"references": [
|
|
2389
|
+
{
|
|
2390
|
+
"name": "Source code",
|
|
2391
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-layout/duet-layout.tsx"
|
|
2392
|
+
}
|
|
2393
|
+
]
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"name": "duet-link",
|
|
2397
|
+
"description": {
|
|
2398
|
+
"kind": "markdown",
|
|
2399
|
+
"value": "---\ntitle: Link\nname: duet-link\nstatus: ready\nreleased: 1.0.21\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Navigation\nintro: Links are used in content paragraphs to create pathways from one page to\n another. If you need a link with semi bold font-weight and/or icon, please use\n <a href=\"/components/button/\">Button component</a> instead.\nexamples:\n - name: link\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default link\n file: fixtures/duet-link_default_link.html\n - name: Link that opens into new window\n file: fixtures/duet-link_link_that_opens_into_new_window.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2400
|
+
},
|
|
2401
|
+
"attributes": [
|
|
2402
|
+
{
|
|
2403
|
+
"name": "accessible-label",
|
|
2404
|
+
"description": "Adds accessible label for the link that is only shown for screen readers.\nTypically, this label text replaces the visible text on the link for users\nwho use assistive technology."
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
"name": "accessible-label-external",
|
|
2408
|
+
"description": "Adds accessible label for tooltip that is shown in external link (url & external have both been set)"
|
|
2409
|
+
},
|
|
2410
|
+
{
|
|
2411
|
+
"name": "accessible-label-external-default",
|
|
2412
|
+
"description": "Defaults for accessibleLabelExternal"
|
|
2413
|
+
},
|
|
2414
|
+
{
|
|
2415
|
+
"name": "external",
|
|
2416
|
+
"description": "Forces URL to open in a new browser tab. Used together with URL prop."
|
|
2417
|
+
},
|
|
2418
|
+
{
|
|
2419
|
+
"name": "identifier",
|
|
2420
|
+
"description": "Adds a unique identifier for the link. Please note that with this particular\ncomponent this id is added inside Shadow DOM. If you need an id on the html\nelement, use regular id attribute instead."
|
|
2421
|
+
},
|
|
2422
|
+
{
|
|
2423
|
+
"name": "language",
|
|
2424
|
+
"description": "The currently active language. This setting changes the external link\naccessible label to match the chosen language.",
|
|
2425
|
+
"values": [
|
|
2426
|
+
{
|
|
2427
|
+
"name": "en"
|
|
2428
|
+
},
|
|
2429
|
+
{
|
|
2430
|
+
"name": "fi"
|
|
2431
|
+
},
|
|
2432
|
+
{
|
|
2433
|
+
"name": "sv"
|
|
2434
|
+
}
|
|
2435
|
+
]
|
|
2436
|
+
},
|
|
2437
|
+
{
|
|
2438
|
+
"name": "theme",
|
|
2439
|
+
"description": "Theme of the button.",
|
|
2440
|
+
"values": [
|
|
2441
|
+
{
|
|
2442
|
+
"name": "default"
|
|
2443
|
+
},
|
|
2444
|
+
{
|
|
2445
|
+
"name": "turva"
|
|
2446
|
+
}
|
|
2447
|
+
]
|
|
2448
|
+
},
|
|
2449
|
+
{
|
|
2450
|
+
"name": "url",
|
|
2451
|
+
"description": "A destination to link to, rendered in the href attribute of a link."
|
|
2452
|
+
}
|
|
2453
|
+
],
|
|
2454
|
+
"references": [
|
|
2455
|
+
{
|
|
2456
|
+
"name": "Source code",
|
|
2457
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-link/duet-link.tsx"
|
|
2458
|
+
}
|
|
2459
|
+
]
|
|
2460
|
+
},
|
|
2461
|
+
{
|
|
2462
|
+
"name": "duet-list",
|
|
2463
|
+
"description": {
|
|
2464
|
+
"kind": "markdown",
|
|
2465
|
+
"value": "---\ntitle: List\nname: duet-list\nstatus: ready\nreleased: 3.3.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\ncategory: Lists and tables\nssr: Supported\nintro: Lists are used to display name/value pairs such as terms and definitions.\n Particularly useful for glossaries.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: list\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Striped list\n file: fixtures/duet-list_striped_list.html\n - name: Basic list\n file: fixtures/duet-list_basic_list.html\n - name: Lists with alternative column widths\n file: fixtures/duet-list_lists_with_alternative_column_widths.html\n - name: List inside a card\n file: fixtures/duet-list_list_inside_a_card.html\n - name: List using large breakpoint and centered text on mobile\n file: fixtures/duet-list_list_using_large_breakpoint_and_centered_text_on_mobile.html\n\n---\n\n<!-- usage -->"
|
|
2466
|
+
},
|
|
2467
|
+
"attributes": [
|
|
2468
|
+
{
|
|
2469
|
+
"name": "breakpoint",
|
|
2470
|
+
"description": "Switch the breakpoint used to trigger the content stacking. These match to\nsimilar media query tokens: $media-query-small and $media-query-large.",
|
|
2471
|
+
"values": [
|
|
2472
|
+
{
|
|
2473
|
+
"name": "large"
|
|
2474
|
+
},
|
|
2475
|
+
{
|
|
2476
|
+
"name": "small"
|
|
2477
|
+
}
|
|
2478
|
+
]
|
|
2479
|
+
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "label-width",
|
|
2482
|
+
"description": "Set the column width of the first column in percentages.",
|
|
2483
|
+
"values": [
|
|
2484
|
+
{
|
|
2485
|
+
"name": "30"
|
|
2486
|
+
},
|
|
2487
|
+
{
|
|
2488
|
+
"name": "50"
|
|
2489
|
+
},
|
|
2490
|
+
{
|
|
2491
|
+
"name": "70"
|
|
2492
|
+
}
|
|
2493
|
+
]
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"name": "margin",
|
|
2497
|
+
"description": "Controls the margin of the component.",
|
|
2498
|
+
"values": [
|
|
2499
|
+
{
|
|
2500
|
+
"name": "auto"
|
|
2501
|
+
},
|
|
2502
|
+
{
|
|
2503
|
+
"name": "none"
|
|
2504
|
+
}
|
|
2505
|
+
]
|
|
2506
|
+
},
|
|
2507
|
+
{
|
|
2508
|
+
"name": "mobile",
|
|
2509
|
+
"description": "Adjusts the alignment of the list items on mobile breakpoint.",
|
|
2510
|
+
"values": [
|
|
2511
|
+
{
|
|
2512
|
+
"name": "center"
|
|
2513
|
+
},
|
|
2514
|
+
{
|
|
2515
|
+
"name": "left"
|
|
2516
|
+
}
|
|
2517
|
+
]
|
|
2518
|
+
},
|
|
2519
|
+
{
|
|
2520
|
+
"name": "padding",
|
|
2521
|
+
"description": "Controls the padding of the component.",
|
|
2522
|
+
"values": [
|
|
2523
|
+
{
|
|
2524
|
+
"name": "auto"
|
|
2525
|
+
},
|
|
2526
|
+
{
|
|
2527
|
+
"name": "none"
|
|
2528
|
+
}
|
|
2529
|
+
]
|
|
2530
|
+
},
|
|
2531
|
+
{
|
|
2532
|
+
"name": "theme",
|
|
2533
|
+
"description": "Theme of the list.",
|
|
2534
|
+
"values": [
|
|
2535
|
+
{
|
|
2536
|
+
"name": "default"
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
"name": "turva"
|
|
2540
|
+
}
|
|
2541
|
+
]
|
|
2542
|
+
},
|
|
2543
|
+
{
|
|
2544
|
+
"name": "variation",
|
|
2545
|
+
"description": "Style variation of the list.",
|
|
2546
|
+
"values": [
|
|
2547
|
+
{
|
|
2548
|
+
"name": "default"
|
|
2549
|
+
},
|
|
2550
|
+
{
|
|
2551
|
+
"name": "striped"
|
|
2552
|
+
}
|
|
2553
|
+
]
|
|
2554
|
+
}
|
|
2555
|
+
],
|
|
2556
|
+
"references": [
|
|
2557
|
+
{
|
|
2558
|
+
"name": "Source code",
|
|
2559
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-list/duet-list.tsx"
|
|
2560
|
+
}
|
|
2561
|
+
]
|
|
2562
|
+
},
|
|
2563
|
+
{
|
|
2564
|
+
"name": "duet-list-item",
|
|
2565
|
+
"description": {
|
|
2566
|
+
"kind": "markdown",
|
|
2567
|
+
"value": "---\ntitle: List Item\nname: duet-list-item\nstatus: ready\nreleased: 3.3.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\ncategory: Lists and tables\nssr: Supported\nintro: List Item is a component used inside List. For concrete usage examples,\n please see the <a href=\"/components/list/\">List component</a>.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: list item\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n\n---\n\n<!-- usage -->"
|
|
2568
|
+
},
|
|
2569
|
+
"attributes": [],
|
|
2570
|
+
"references": [
|
|
2571
|
+
{
|
|
2572
|
+
"name": "Source code",
|
|
2573
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-list-item/duet-list-item.tsx"
|
|
2574
|
+
}
|
|
2575
|
+
]
|
|
2576
|
+
},
|
|
2577
|
+
{
|
|
2578
|
+
"name": "duet-logo",
|
|
2579
|
+
"description": {
|
|
2580
|
+
"kind": "markdown",
|
|
2581
|
+
"value": "---\ntitle: Logo\nname: duet-logo\nstatus: ready\nreleased: 1.0.49\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Images and icons\nintro: Logo is a component used inside the <a\n href=\"/components/hader/\">Header</a> and <a\n href=\"/components/footer/\">Footer</a> components. Logo prodives options to\n customize the language and appearance in addition to theme.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: logo\n code: This first example creates the actual href and DOCS, hence it needs to be\n here.\n - name: LähiTapiola logo\n file: fixtures/duet-logo_lahitapiola_logo.html\n\n---\n\n<!-- usage -->"
|
|
2582
|
+
},
|
|
2583
|
+
"attributes": [
|
|
2584
|
+
{
|
|
2585
|
+
"name": "href",
|
|
2586
|
+
"description": "Where the logo links to."
|
|
2587
|
+
},
|
|
2588
|
+
{
|
|
2589
|
+
"name": "inverse",
|
|
2590
|
+
"description": "Use inverse version of the logo (white logo on dark background)."
|
|
2591
|
+
},
|
|
2592
|
+
{
|
|
2593
|
+
"name": "language",
|
|
2594
|
+
"description": "The language of the logo.",
|
|
2595
|
+
"values": [
|
|
2596
|
+
{
|
|
2597
|
+
"name": "en"
|
|
2598
|
+
},
|
|
2599
|
+
{
|
|
2600
|
+
"name": "fi"
|
|
2601
|
+
},
|
|
2602
|
+
{
|
|
2603
|
+
"name": "sv"
|
|
2604
|
+
}
|
|
2605
|
+
]
|
|
2606
|
+
},
|
|
2607
|
+
{
|
|
2608
|
+
"name": "margin",
|
|
2609
|
+
"description": "Controls the margin of the component.",
|
|
2610
|
+
"values": [
|
|
2611
|
+
{
|
|
2612
|
+
"name": "auto"
|
|
2613
|
+
},
|
|
2614
|
+
{
|
|
2615
|
+
"name": "none"
|
|
2616
|
+
}
|
|
2617
|
+
]
|
|
2618
|
+
},
|
|
2619
|
+
{
|
|
2620
|
+
"name": "size",
|
|
2621
|
+
"description": "Size variation of the logo.",
|
|
2622
|
+
"values": [
|
|
2623
|
+
{
|
|
2624
|
+
"name": "large"
|
|
2625
|
+
},
|
|
2626
|
+
{
|
|
2627
|
+
"name": "medium"
|
|
2628
|
+
}
|
|
2629
|
+
]
|
|
2630
|
+
},
|
|
2631
|
+
{
|
|
2632
|
+
"name": "theme",
|
|
2633
|
+
"description": "Theme of the logo.",
|
|
2634
|
+
"values": [
|
|
2635
|
+
{
|
|
2636
|
+
"name": "default"
|
|
2637
|
+
},
|
|
2638
|
+
{
|
|
2639
|
+
"name": "turva"
|
|
2640
|
+
}
|
|
2641
|
+
]
|
|
2642
|
+
}
|
|
2643
|
+
],
|
|
2644
|
+
"references": [
|
|
2645
|
+
{
|
|
2646
|
+
"name": "Source code",
|
|
2647
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-logo/duet-logo.tsx"
|
|
2648
|
+
}
|
|
2649
|
+
]
|
|
2650
|
+
},
|
|
2651
|
+
{
|
|
2652
|
+
"name": "duet-modal",
|
|
2653
|
+
"description": {
|
|
2654
|
+
"kind": "markdown",
|
|
2655
|
+
"value": "---\ntitle: Modal\nname: duet-modal\nstatus: ready\nreleased: 3.1.3\ncategory: Overlays\naccessibility: Keyboard, Screen Reader\ninternationalization: Supported\nssr: Supported\nintro: Modals are used to display content that temporarily blocks interactions\n with the main view of an application. Modals should be used sparingly only\n when necessary.\ndescription: Modal component is positioned over everything else in the\n application preventing scrolling of the main document, making only the modal’s\n content scrollable. Duet only supports one modal dialog at a time as nested\n modals are often a sign of bad user experience.\nplatforms: Web only\nexample_height: 600px\ntags:\n - docs-components\nexamples:\n - name: modal\n code: This first example creates the actual href and DOCS, hence it needs to be\n here.\n - name: Small modal dialog\n file: fixtures/duet-modal_small_modal_dialog.html\n - name: Small modal dialog confirmation\n file: fixtures/duet-modal_small_modal_dialog_confirmation.html\n - name: Medium modal dialog with form\n file: fixtures/duet-modal_medium_modal_dialog_with_form.html\n - name: Medium modal dialog with text content\n file: fixtures/duet-modal_medium_modal_dialog_with_text_content.html\n - name: Large modal dialog with text content\n file: fixtures/duet-modal_large_modal_dialog_with_text_content.html\n - name: Small modal dialog with Top Slot in use and Small gutter\n file: fixtures/duet-modal_large_top_slot_small_gutter.html\n - name: Medium modal dialog with Top Slot in use and Medium gutter\n file: fixtures/duet-modal_large_top_slot_medium_gutter.html\n - name: Large modal dialog with Top Slot in use and large gutter\n file: fixtures/duet-modal_large_top_slot_large_gutter.html\n\n---\n\n<!-- usage -->"
|
|
2656
|
+
},
|
|
2657
|
+
"attributes": [
|
|
2658
|
+
{
|
|
2659
|
+
"name": "accessible-close-label",
|
|
2660
|
+
"description": "Adds accessible label for the close icon that is only shown for screen\nreaders. This property is always required to create an accessibly interface!\nSwedish translation for this property is “Stäng fönstret”."
|
|
2661
|
+
},
|
|
2662
|
+
{
|
|
2663
|
+
"name": "accessible-close-label-default",
|
|
2664
|
+
"description": "Defaults for accessibleCloseLabel"
|
|
2665
|
+
},
|
|
2666
|
+
{
|
|
2667
|
+
"name": "active",
|
|
2668
|
+
"description": "Use this property when you need to have the modal dialog initially active."
|
|
2669
|
+
},
|
|
2670
|
+
{
|
|
2671
|
+
"name": "color",
|
|
2672
|
+
"description": "Custom color to be used for the icon, as a design token entered in camelCase\nor kebab-case. Example: \"primary\"."
|
|
2673
|
+
},
|
|
2674
|
+
{
|
|
2675
|
+
"name": "gutter-size",
|
|
2676
|
+
"description": "Size of the modal window.",
|
|
2677
|
+
"values": [
|
|
2678
|
+
{
|
|
2679
|
+
"name": "large"
|
|
2680
|
+
},
|
|
2681
|
+
{
|
|
2682
|
+
"name": "medium"
|
|
2683
|
+
},
|
|
2684
|
+
{
|
|
2685
|
+
"name": "small"
|
|
2686
|
+
}
|
|
2687
|
+
]
|
|
2688
|
+
},
|
|
2689
|
+
{
|
|
2690
|
+
"name": "heading",
|
|
2691
|
+
"description": "Accessible heading displayed in the modal. The modal marks this as the\nlabel of the modal when used. This helps screen reader users which is\nwhy this is a required property."
|
|
2692
|
+
},
|
|
2693
|
+
{
|
|
2694
|
+
"name": "heading-level",
|
|
2695
|
+
"description": "Accessible heading size",
|
|
2696
|
+
"values": [
|
|
2697
|
+
{
|
|
2698
|
+
"name": "h1"
|
|
2699
|
+
},
|
|
2700
|
+
{
|
|
2701
|
+
"name": "h2"
|
|
2702
|
+
},
|
|
2703
|
+
{
|
|
2704
|
+
"name": "h3"
|
|
2705
|
+
},
|
|
2706
|
+
{
|
|
2707
|
+
"name": "h4"
|
|
2708
|
+
},
|
|
2709
|
+
{
|
|
2710
|
+
"name": "h5"
|
|
2711
|
+
},
|
|
2712
|
+
{
|
|
2713
|
+
"name": "h6"
|
|
2714
|
+
}
|
|
2715
|
+
]
|
|
2716
|
+
},
|
|
2717
|
+
{
|
|
2718
|
+
"name": "icon",
|
|
2719
|
+
"description": "Icon to display above the heading (from Duet’s icons). Example:\n\"form-location\""
|
|
2720
|
+
},
|
|
2721
|
+
{
|
|
2722
|
+
"name": "language",
|
|
2723
|
+
"description": "The currently active language. This setting also changes the logo to match\nthe chosen language.",
|
|
2724
|
+
"values": [
|
|
2725
|
+
{
|
|
2726
|
+
"name": "en"
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"name": "fi"
|
|
2730
|
+
},
|
|
2731
|
+
{
|
|
2732
|
+
"name": "sv"
|
|
2733
|
+
}
|
|
2734
|
+
]
|
|
2735
|
+
},
|
|
2736
|
+
{
|
|
2737
|
+
"name": "size",
|
|
2738
|
+
"description": "Size of the modal window.",
|
|
2739
|
+
"values": [
|
|
2740
|
+
{
|
|
2741
|
+
"name": "large"
|
|
2742
|
+
},
|
|
2743
|
+
{
|
|
2744
|
+
"name": "medium"
|
|
2745
|
+
},
|
|
2746
|
+
{
|
|
2747
|
+
"name": "small"
|
|
2748
|
+
}
|
|
2749
|
+
]
|
|
2750
|
+
},
|
|
2751
|
+
{
|
|
2752
|
+
"name": "theme",
|
|
2753
|
+
"description": "Theme of the modal.",
|
|
2754
|
+
"values": [
|
|
2755
|
+
{
|
|
2756
|
+
"name": "default"
|
|
2757
|
+
},
|
|
2758
|
+
{
|
|
2759
|
+
"name": "turva"
|
|
2760
|
+
}
|
|
2761
|
+
]
|
|
2762
|
+
}
|
|
2763
|
+
],
|
|
2764
|
+
"references": [
|
|
2765
|
+
{
|
|
2766
|
+
"name": "Source code",
|
|
2767
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-modal/duet-modal.tsx"
|
|
2768
|
+
}
|
|
2769
|
+
]
|
|
2770
|
+
},
|
|
2771
|
+
{
|
|
2772
|
+
"name": "duet-notification",
|
|
2773
|
+
"description": {
|
|
2774
|
+
"kind": "markdown",
|
|
2775
|
+
"value": "---\ntitle: Notification\nname: duet-notification\nstatus: new\nreleased: 4.12.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Navigation\nexample_height: 365px\nintro: Notifications encourage users to take an action related to a recent\n update or an opportunity. They are most commonly displayed inside <a\n href=\"/components/notification-drawer/\">Notification Drawer</a>.\ndescription: Notification is a component intended for use inside Notification\n Drawer. A notification consists of a link, a date, and content. For more\n usage examples, please see the <a\n href=\"/components/notification-drawer/\">Notification Drawer</a> component.\nplatforms: Web only\nexamples:\n - name: notification\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Multiple notifications\n file: fixtures/duet-notification_multiple_notifications.html\n - name: Single notification\n file: fixtures/duet-notification_single_notification.html\n - name: Notifications without paragraph\n file: fixtures/duet-notification_notifications_without_paragraph.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2776
|
+
},
|
|
2777
|
+
"attributes": [
|
|
2778
|
+
{
|
|
2779
|
+
"name": "accessible-label-unread",
|
|
2780
|
+
"description": "Adds accessible label for tooltip that is shown over unread counter"
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"name": "date",
|
|
2784
|
+
"description": "The date of the notification."
|
|
2785
|
+
},
|
|
2786
|
+
{
|
|
2787
|
+
"name": "external",
|
|
2788
|
+
"description": "Should the link open in a new window?"
|
|
2789
|
+
},
|
|
2790
|
+
{
|
|
2791
|
+
"name": "highlight",
|
|
2792
|
+
"description": "Should the notification be visually highlighted?"
|
|
2793
|
+
},
|
|
2794
|
+
{
|
|
2795
|
+
"name": "language",
|
|
2796
|
+
"description": "The currently active language.\nUsed for announcing unread notifications to screen readers.",
|
|
2797
|
+
"values": [
|
|
2798
|
+
{
|
|
2799
|
+
"name": "en"
|
|
2800
|
+
},
|
|
2801
|
+
{
|
|
2802
|
+
"name": "fi"
|
|
2803
|
+
},
|
|
2804
|
+
{
|
|
2805
|
+
"name": "sv"
|
|
2806
|
+
}
|
|
2807
|
+
]
|
|
2808
|
+
},
|
|
2809
|
+
{
|
|
2810
|
+
"name": "theme",
|
|
2811
|
+
"description": "Theme of the notification.",
|
|
2812
|
+
"values": [
|
|
2813
|
+
{
|
|
2814
|
+
"name": "default"
|
|
2815
|
+
},
|
|
2816
|
+
{
|
|
2817
|
+
"name": "turva"
|
|
2818
|
+
}
|
|
2819
|
+
]
|
|
2820
|
+
},
|
|
2821
|
+
{
|
|
2822
|
+
"name": "url",
|
|
2823
|
+
"description": "The url to open on notification click."
|
|
2824
|
+
}
|
|
2825
|
+
],
|
|
2826
|
+
"references": [
|
|
2827
|
+
{
|
|
2828
|
+
"name": "Source code",
|
|
2829
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-notification/duet-notification.tsx"
|
|
2830
|
+
}
|
|
2831
|
+
]
|
|
2832
|
+
},
|
|
2833
|
+
{
|
|
2834
|
+
"name": "duet-notification-drawer",
|
|
2835
|
+
"description": {
|
|
2836
|
+
"kind": "markdown",
|
|
2837
|
+
"value": "---\ntitle: Notification Drawer\nname: duet-notification-drawer\nstatus: new\nreleased: 4.12.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Navigation\nintro: Notification Drawer informs users about recent notification messages.\n Notification Drawer can be used to display up to 20 notification messages.\ndescription: Notification Drawer is most commonly used inside the <a\n href=\"/components/header/\">Header component</a>. Notification Drawer consists\n of a toggle button and dropdown list of notifications. Please see the <a\n href=\"/components/notification/\">Notification</a> component for additional\n info.\nplatforms: Web only\nexample_height: 550px\ntags:\n - docs-components\nexamples:\n - name: notification-drawer\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic notification drawer usage\n file: fixtures/duet-notification-drawer_basic_notification_drawer_usage.html\n - name: Using notification drawer inside header\n file: fixtures/duet-notification-drawer_using_notification_drawer_inside_header.html\n - name: Notification drawer with only headings\n file: fixtures/duet-notification-drawer_notification_drawer_with_only_headings.html\n - name: Empty notification drawer\n file: fixtures/duet-notification-drawer_empty_notification_drawer.html\n\n---\n\n<!-- usage -->"
|
|
2838
|
+
},
|
|
2839
|
+
"attributes": [
|
|
2840
|
+
{
|
|
2841
|
+
"name": "accessible-label-notifications",
|
|
2842
|
+
"description": "Adds accessible label for tooltip that is shown for notifications"
|
|
2843
|
+
},
|
|
2844
|
+
{
|
|
2845
|
+
"name": "accessible-label-notification-default",
|
|
2846
|
+
"description": "Defaults for accessibleLabelNotifications"
|
|
2847
|
+
},
|
|
2848
|
+
{
|
|
2849
|
+
"name": "badge",
|
|
2850
|
+
"description": "Show a badge that indicates something has changed."
|
|
2851
|
+
},
|
|
2852
|
+
{
|
|
2853
|
+
"name": "direction",
|
|
2854
|
+
"description": "Which direction should the drawer open in?",
|
|
2855
|
+
"values": [
|
|
2856
|
+
{
|
|
2857
|
+
"name": "left"
|
|
2858
|
+
},
|
|
2859
|
+
{
|
|
2860
|
+
"name": "right"
|
|
2861
|
+
}
|
|
2862
|
+
]
|
|
2863
|
+
},
|
|
2864
|
+
{
|
|
2865
|
+
"name": "icon",
|
|
2866
|
+
"description": "Icon to display to the left of the drawer button."
|
|
2867
|
+
},
|
|
2868
|
+
{
|
|
2869
|
+
"name": "label",
|
|
2870
|
+
"description": "Label for the drawer button."
|
|
2871
|
+
},
|
|
2872
|
+
{
|
|
2873
|
+
"name": "language",
|
|
2874
|
+
"description": "The currently active language.\nUsed to determine the message displayed when there are no notifications.",
|
|
2875
|
+
"values": [
|
|
2876
|
+
{
|
|
2877
|
+
"name": "en"
|
|
2878
|
+
},
|
|
2879
|
+
{
|
|
2880
|
+
"name": "fi"
|
|
2881
|
+
},
|
|
2882
|
+
{
|
|
2883
|
+
"name": "sv"
|
|
2884
|
+
}
|
|
2885
|
+
]
|
|
2886
|
+
},
|
|
2887
|
+
{
|
|
2888
|
+
"name": "theme",
|
|
2889
|
+
"description": "Theme of the notification drawer.",
|
|
2890
|
+
"values": [
|
|
2891
|
+
{
|
|
2892
|
+
"name": "default"
|
|
2893
|
+
},
|
|
2894
|
+
{
|
|
2895
|
+
"name": "turva"
|
|
2896
|
+
}
|
|
2897
|
+
]
|
|
2898
|
+
}
|
|
2899
|
+
],
|
|
2900
|
+
"references": [
|
|
2901
|
+
{
|
|
2902
|
+
"name": "Source code",
|
|
2903
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-notification-drawer/duet-notification-drawer.tsx"
|
|
2904
|
+
}
|
|
2905
|
+
]
|
|
2906
|
+
},
|
|
2907
|
+
{
|
|
2908
|
+
"name": "duet-number-input",
|
|
2909
|
+
"description": {
|
|
2910
|
+
"kind": "markdown",
|
|
2911
|
+
"value": "---\ntitle: Number Input\nname: duet-number-input\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\ncategory: Forms\nssr: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.4.8\nintro: Number input lets user specify a numeric value using plus and minus\n buttons which must be no less than a given value, and no more than another\n given value.\ndescription: Number Input allows you to listen for duetChange event that is\n triggered whenever the user presses the plus and minus buttons, or exits the\n input after editing the number manually.\nexamples:\n - name: number input\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default number input\n file: fixtures/duet-number-input_default_number_input.html\n - name: Number input without initial value\n file: fixtures/duet-number-input_number_input_without_initial_value.html\n - name: Number input with output field and custom aria-live messaging\n file: fixtures/duet-number-input_number_input_with_output_field_and_custom_aria-live_messaging.html\n - name: Number input using expand property\n file: fixtures/duet-number-input_number_input_using_expand_property.html\n - name: Number input with an error\n file: fixtures/duet-number-input_number_input_with_an_error.html\n - name: Number input with a tooltip\n file: fixtures/duet-number-input_number_input_with_a_tooltip.html\n - name: Number input using different locale\n file: fixtures/duet-number-input_number_input_using_different_locale.html\n - name: Number input with step dependent on value\n file: fixtures/duet-number-input_number_input_with_step_dependent_on_value.html\n - name: Number input where min value is not a multiple of the step\n file: fixtures/duet-number-input_number_input_where_min_value_is_not_a_multiple_of_the_step.html\n - name: Number input that does not round to a multiple of the step\n file: fixtures/duet-number-input_number_input_that_does_not_round_to_a_multiple_of_the_step.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
2912
|
+
},
|
|
2913
|
+
"attributes": [
|
|
2914
|
+
{
|
|
2915
|
+
"name": "accessible-active-descendant",
|
|
2916
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
2917
|
+
},
|
|
2918
|
+
{
|
|
2919
|
+
"name": "accessible-add",
|
|
2920
|
+
"description": "Accessible label for the add button that is read for screen reader users."
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
"name": "accessible-add-default",
|
|
2924
|
+
"description": "Defaults for accessibleAdd"
|
|
2925
|
+
},
|
|
2926
|
+
{
|
|
2927
|
+
"name": "accessible-controls",
|
|
2928
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
2929
|
+
},
|
|
2930
|
+
{
|
|
2931
|
+
"name": "accessible-described-by",
|
|
2932
|
+
"description": "Indicates the id of a component that describes the input."
|
|
2933
|
+
},
|
|
2934
|
+
{
|
|
2935
|
+
"name": "accessible-live",
|
|
2936
|
+
"description": "Format of message used to announce current amount when switching between amounts.\nThe string {current} is replaced with the current amount."
|
|
2937
|
+
},
|
|
2938
|
+
{
|
|
2939
|
+
"name": "accessible-live-default",
|
|
2940
|
+
"description": "Defaults for accessibleLive"
|
|
2941
|
+
},
|
|
2942
|
+
{
|
|
2943
|
+
"name": "accessible-live-enabled",
|
|
2944
|
+
"description": "Disables the aria-live messaging used internally in this component. This could be useful when you want to use custom aria-live messages instead."
|
|
2945
|
+
},
|
|
2946
|
+
{
|
|
2947
|
+
"name": "accessible-owns",
|
|
2948
|
+
"description": "Indicates the id of a component owned by the input."
|
|
2949
|
+
},
|
|
2950
|
+
{
|
|
2951
|
+
"name": "accessible-subtract",
|
|
2952
|
+
"description": "Accessible label for the subtract button that is read for screen reader users."
|
|
2953
|
+
},
|
|
2954
|
+
{
|
|
2955
|
+
"name": "accessible-subtract-defaults",
|
|
2956
|
+
"description": "Defaults for accessibleSubtract"
|
|
2957
|
+
},
|
|
2958
|
+
{
|
|
2959
|
+
"name": "disabled",
|
|
2960
|
+
"description": "Makes the number input component disabled. This prevents users from being able to\ninteract with the input, and conveys its inactive state to assistive technologies."
|
|
2961
|
+
},
|
|
2962
|
+
{
|
|
2963
|
+
"name": "error",
|
|
2964
|
+
"description": "Display the input in error state along with an error message."
|
|
2965
|
+
},
|
|
2966
|
+
{
|
|
2967
|
+
"name": "expand",
|
|
2968
|
+
"description": "Expands the input to fill 100% of the container width."
|
|
2969
|
+
},
|
|
2970
|
+
{
|
|
2971
|
+
"name": "identifier",
|
|
2972
|
+
"description": "Adds a unique identifier for the input."
|
|
2973
|
+
},
|
|
2974
|
+
{
|
|
2975
|
+
"name": "label",
|
|
2976
|
+
"description": "Label for the number input."
|
|
2977
|
+
},
|
|
2978
|
+
{
|
|
2979
|
+
"name": "label-default",
|
|
2980
|
+
"description": "Defaults for Label"
|
|
2981
|
+
},
|
|
2982
|
+
{
|
|
2983
|
+
"name": "label-hidden",
|
|
2984
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
2985
|
+
},
|
|
2986
|
+
{
|
|
2987
|
+
"name": "language",
|
|
2988
|
+
"description": "The currently active language. This setting changes the accessible labels to match the\nchosen language.",
|
|
2989
|
+
"values": [
|
|
2990
|
+
{
|
|
2991
|
+
"name": "en"
|
|
2992
|
+
},
|
|
2993
|
+
{
|
|
2994
|
+
"name": "fi"
|
|
2995
|
+
},
|
|
2996
|
+
{
|
|
2997
|
+
"name": "sv"
|
|
2998
|
+
}
|
|
2999
|
+
]
|
|
3000
|
+
},
|
|
3001
|
+
{
|
|
3002
|
+
"name": "locale",
|
|
3003
|
+
"description": "Locale used to format the entered value.",
|
|
3004
|
+
"values": [
|
|
3005
|
+
{
|
|
3006
|
+
"name": "en-GB"
|
|
3007
|
+
},
|
|
3008
|
+
{
|
|
3009
|
+
"name": "en-US"
|
|
3010
|
+
},
|
|
3011
|
+
{
|
|
3012
|
+
"name": "fi-FI"
|
|
3013
|
+
},
|
|
3014
|
+
{
|
|
3015
|
+
"name": "sv-SE"
|
|
3016
|
+
}
|
|
3017
|
+
]
|
|
3018
|
+
},
|
|
3019
|
+
{
|
|
3020
|
+
"name": "margin",
|
|
3021
|
+
"description": "Controls the margin of the component.",
|
|
3022
|
+
"values": [
|
|
3023
|
+
{
|
|
3024
|
+
"name": "auto"
|
|
3025
|
+
},
|
|
3026
|
+
{
|
|
3027
|
+
"name": "none"
|
|
3028
|
+
}
|
|
3029
|
+
]
|
|
3030
|
+
},
|
|
3031
|
+
{
|
|
3032
|
+
"name": "max",
|
|
3033
|
+
"description": "Maximum value."
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
"name": "min",
|
|
3037
|
+
"description": "Minimum value."
|
|
3038
|
+
},
|
|
3039
|
+
{
|
|
3040
|
+
"name": "name",
|
|
3041
|
+
"description": "Name of the input."
|
|
3042
|
+
},
|
|
3043
|
+
{
|
|
3044
|
+
"name": "required",
|
|
3045
|
+
"description": "Set whether the input is required or not. Please note that this is required for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
3046
|
+
},
|
|
3047
|
+
{
|
|
3048
|
+
"name": "role",
|
|
3049
|
+
"description": "Defines a specific role attribute for the input."
|
|
3050
|
+
},
|
|
3051
|
+
{
|
|
3052
|
+
"name": "rounding",
|
|
3053
|
+
"description": "Controls whether or not value gets rounded to the nearest\nmultiple of a step on blur. Set to \"false\" to disable this behaviour."
|
|
3054
|
+
},
|
|
3055
|
+
{
|
|
3056
|
+
"name": "step",
|
|
3057
|
+
"description": "Step amount."
|
|
3058
|
+
},
|
|
3059
|
+
{
|
|
3060
|
+
"name": "theme",
|
|
3061
|
+
"description": "Theme of the input.",
|
|
3062
|
+
"values": [
|
|
3063
|
+
{
|
|
3064
|
+
"name": "default"
|
|
3065
|
+
},
|
|
3066
|
+
{
|
|
3067
|
+
"name": "turva"
|
|
3068
|
+
}
|
|
3069
|
+
]
|
|
3070
|
+
},
|
|
3071
|
+
{
|
|
3072
|
+
"name": "tooltip",
|
|
3073
|
+
"description": "Tooltip to display next to the label of the input."
|
|
3074
|
+
},
|
|
3075
|
+
{
|
|
3076
|
+
"name": "unit",
|
|
3077
|
+
"description": "Unit for the number input."
|
|
3078
|
+
},
|
|
3079
|
+
{
|
|
3080
|
+
"name": "value",
|
|
3081
|
+
"description": "Value of the input. This is passed as a string since Number Input uses Duet’s Input component internally and we need the value to support spaces and the unit as well."
|
|
3082
|
+
}
|
|
3083
|
+
],
|
|
3084
|
+
"references": [
|
|
3085
|
+
{
|
|
3086
|
+
"name": "Source code",
|
|
3087
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-number-input/duet-number-input.tsx"
|
|
3088
|
+
}
|
|
3089
|
+
]
|
|
3090
|
+
},
|
|
3091
|
+
{
|
|
3092
|
+
"name": "duet-paragraph",
|
|
3093
|
+
"description": {
|
|
3094
|
+
"kind": "markdown",
|
|
3095
|
+
"value": "---\ntitle: Paragraph\nname: duet-paragraph\nstatus: ready\nreleased: 1.3.0\ninternationalization: Supported\nssr: Supported\naccessibility: Keyboard, Screen Reader\ncategory: Text\nintro: Paragraphs are blocks of text separated from adjacent blocks by blank lines.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: paragraph\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default paragraph\n file: fixtures/duet-paragraph_default_paragraph.html\n - name: Intro paragraph\n file: fixtures/duet-paragraph_intro_paragraph.html\n - name: Small paragraph\n file: fixtures/duet-paragraph_small_paragraph.html\n - name: Paragraph using color token\n file: fixtures/duet-paragraph_paragraph_using_color_token.html\n\n---\n\n<!-- usage -->"
|
|
3096
|
+
},
|
|
3097
|
+
"attributes": [
|
|
3098
|
+
{
|
|
3099
|
+
"name": "color",
|
|
3100
|
+
"description": "Custom color to be used for text, as a design token entered in camelCase or kebab-case.\nExample: \"color-primary\"."
|
|
3101
|
+
},
|
|
3102
|
+
{
|
|
3103
|
+
"name": "margin",
|
|
3104
|
+
"description": "Controls the margin of the component.",
|
|
3105
|
+
"values": [
|
|
3106
|
+
{
|
|
3107
|
+
"name": "auto"
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
"name": "none"
|
|
3111
|
+
}
|
|
3112
|
+
]
|
|
3113
|
+
},
|
|
3114
|
+
{
|
|
3115
|
+
"name": "size",
|
|
3116
|
+
"description": "Controls the size of the paragraph.",
|
|
3117
|
+
"values": [
|
|
3118
|
+
{
|
|
3119
|
+
"name": "medium"
|
|
3120
|
+
},
|
|
3121
|
+
{
|
|
3122
|
+
"name": "small"
|
|
3123
|
+
}
|
|
3124
|
+
]
|
|
3125
|
+
},
|
|
3126
|
+
{
|
|
3127
|
+
"name": "theme",
|
|
3128
|
+
"description": "Theme of the card.",
|
|
3129
|
+
"values": [
|
|
3130
|
+
{
|
|
3131
|
+
"name": "default"
|
|
3132
|
+
},
|
|
3133
|
+
{
|
|
3134
|
+
"name": "turva"
|
|
3135
|
+
}
|
|
3136
|
+
]
|
|
3137
|
+
},
|
|
3138
|
+
{
|
|
3139
|
+
"name": "variation",
|
|
3140
|
+
"description": "Style variation of the paragraph.",
|
|
3141
|
+
"values": [
|
|
3142
|
+
{
|
|
3143
|
+
"name": "default"
|
|
3144
|
+
},
|
|
3145
|
+
{
|
|
3146
|
+
"name": "intro"
|
|
3147
|
+
}
|
|
3148
|
+
]
|
|
3149
|
+
}
|
|
3150
|
+
],
|
|
3151
|
+
"references": [
|
|
3152
|
+
{
|
|
3153
|
+
"name": "Source code",
|
|
3154
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-paragraph/duet-paragraph.tsx"
|
|
3155
|
+
}
|
|
3156
|
+
]
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
"name": "duet-radio",
|
|
3160
|
+
"description": {
|
|
3161
|
+
"kind": "markdown",
|
|
3162
|
+
"value": "---\ntitle: Radio\nname: duet-radio\nstatus: ready\nreleased: 1.3.0\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Forms\nintro: Radio Buttons are graphical interface elements that allow user to choose\n only one of a predefined set of mutually exclusive options.\nexamples:\n - name: radio\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Checked radio\n file: fixtures/duet-radio_checked_radio.html\n - name: Unchecked radio\n file: fixtures/duet-radio_unchecked_radio.html\n - name: Disabled radio\n file: fixtures/duet-radio_disabled_radio.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3163
|
+
},
|
|
3164
|
+
"attributes": [
|
|
3165
|
+
{
|
|
3166
|
+
"name": "accessible-active-descendant",
|
|
3167
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
3168
|
+
},
|
|
3169
|
+
{
|
|
3170
|
+
"name": "accessible-controls",
|
|
3171
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
3172
|
+
},
|
|
3173
|
+
{
|
|
3174
|
+
"name": "accessible-described-by",
|
|
3175
|
+
"description": "Indicates the id of a component that describes the radio."
|
|
3176
|
+
},
|
|
3177
|
+
{
|
|
3178
|
+
"name": "accessible-index",
|
|
3179
|
+
"description": "Control the tabindex of checkbox. In most cases this should never be used!\nIt exists only for Duet’s internal needs."
|
|
3180
|
+
},
|
|
3181
|
+
{
|
|
3182
|
+
"name": "accessible-owns",
|
|
3183
|
+
"description": "Indicates the id of a component owned by the radio."
|
|
3184
|
+
},
|
|
3185
|
+
{
|
|
3186
|
+
"name": "block-events",
|
|
3187
|
+
"description": "Stops the components from emitting events"
|
|
3188
|
+
},
|
|
3189
|
+
{
|
|
3190
|
+
"name": "checked",
|
|
3191
|
+
"description": "Check state of the radio."
|
|
3192
|
+
},
|
|
3193
|
+
{
|
|
3194
|
+
"name": "disabled",
|
|
3195
|
+
"description": "Makes the radio component disabled. This prevents users from being able to\ninteract with the radio, and conveys its inactive state to assistive technologies."
|
|
3196
|
+
},
|
|
3197
|
+
{
|
|
3198
|
+
"name": "identifier",
|
|
3199
|
+
"description": "Adds a unique identifier for the radio."
|
|
3200
|
+
},
|
|
3201
|
+
{
|
|
3202
|
+
"name": "label",
|
|
3203
|
+
"description": "Label for the radio."
|
|
3204
|
+
},
|
|
3205
|
+
{
|
|
3206
|
+
"name": "margin",
|
|
3207
|
+
"description": "Controls the margin of the component.",
|
|
3208
|
+
"values": [
|
|
3209
|
+
{
|
|
3210
|
+
"name": "auto"
|
|
3211
|
+
},
|
|
3212
|
+
{
|
|
3213
|
+
"name": "none"
|
|
3214
|
+
}
|
|
3215
|
+
]
|
|
3216
|
+
},
|
|
3217
|
+
{
|
|
3218
|
+
"name": "name",
|
|
3219
|
+
"description": "Name of the radio."
|
|
3220
|
+
},
|
|
3221
|
+
{
|
|
3222
|
+
"name": "required",
|
|
3223
|
+
"description": "Set whether the input is required or not. Please note that this is required for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
3224
|
+
},
|
|
3225
|
+
{
|
|
3226
|
+
"name": "role",
|
|
3227
|
+
"description": "Defines a specific role attribute for the input."
|
|
3228
|
+
},
|
|
3229
|
+
{
|
|
3230
|
+
"name": "theme",
|
|
3231
|
+
"description": "Theme of the radio.",
|
|
3232
|
+
"values": [
|
|
3233
|
+
{
|
|
3234
|
+
"name": "default"
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
"name": "turva"
|
|
3238
|
+
}
|
|
3239
|
+
]
|
|
3240
|
+
},
|
|
3241
|
+
{
|
|
3242
|
+
"name": "value",
|
|
3243
|
+
"description": "The value of the radio input does not mean if it's checked or not, use the checked\nproperty for that."
|
|
3244
|
+
}
|
|
3245
|
+
],
|
|
3246
|
+
"references": [
|
|
3247
|
+
{
|
|
3248
|
+
"name": "Source code",
|
|
3249
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-radio/duet-radio.tsx"
|
|
3250
|
+
}
|
|
3251
|
+
]
|
|
3252
|
+
},
|
|
3253
|
+
{
|
|
3254
|
+
"name": "duet-radio-group",
|
|
3255
|
+
"description": {
|
|
3256
|
+
"kind": "markdown",
|
|
3257
|
+
"value": "---\ntitle: Radio Group\nname: duet-radio-group\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\nreleased: 1.3.0\ncategory: Forms\nintro: Radio group allows user to select one option from a set of options. Use\n value on group to set the selected option.\nexamples:\n - name: radio group\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Vertical radio group\n file: fixtures/duet-radio-group_vertical_radio_group.html\n - name: Horizontal radio group\n file: fixtures/duet-radio-group_horizontal_radio_group.html\n - name: Disabled radio group\n file: fixtures/duet-radio-group_disabled_radio_group.html\n - name: Radio group with tooltip\n file: fixtures/duet-radio-group_radio_group_with_tooltip.html\n - name: Radio group with tooltip and caption\n file: fixtures/duet-radio-group_radio_group_with_tooltip_and_caption.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3258
|
+
},
|
|
3259
|
+
"attributes": [
|
|
3260
|
+
{
|
|
3261
|
+
"name": "caption",
|
|
3262
|
+
"description": "Additional caption to show inside the label of the radio group."
|
|
3263
|
+
},
|
|
3264
|
+
{
|
|
3265
|
+
"name": "direction",
|
|
3266
|
+
"description": "Direction of the radio group.",
|
|
3267
|
+
"values": [
|
|
3268
|
+
{
|
|
3269
|
+
"name": "horizontal"
|
|
3270
|
+
},
|
|
3271
|
+
{
|
|
3272
|
+
"name": "vertical"
|
|
3273
|
+
}
|
|
3274
|
+
]
|
|
3275
|
+
},
|
|
3276
|
+
{
|
|
3277
|
+
"name": "disabled",
|
|
3278
|
+
"description": "Determines, whether the control is disabled or not."
|
|
3279
|
+
},
|
|
3280
|
+
{
|
|
3281
|
+
"name": "error",
|
|
3282
|
+
"description": "Display radio group in error state along with an error message."
|
|
3283
|
+
},
|
|
3284
|
+
{
|
|
3285
|
+
"name": "label",
|
|
3286
|
+
"description": "Legend displayed for the radio buttons in this group."
|
|
3287
|
+
},
|
|
3288
|
+
{
|
|
3289
|
+
"name": "label-hidden",
|
|
3290
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
3291
|
+
},
|
|
3292
|
+
{
|
|
3293
|
+
"name": "margin",
|
|
3294
|
+
"description": "Controls the margin of the component.",
|
|
3295
|
+
"values": [
|
|
3296
|
+
{
|
|
3297
|
+
"name": "auto"
|
|
3298
|
+
},
|
|
3299
|
+
{
|
|
3300
|
+
"name": "none"
|
|
3301
|
+
}
|
|
3302
|
+
]
|
|
3303
|
+
},
|
|
3304
|
+
{
|
|
3305
|
+
"name": "name",
|
|
3306
|
+
"description": "Name for the radio buttons within this group. **This must be unique amongst all other inputs.**"
|
|
3307
|
+
},
|
|
3308
|
+
{
|
|
3309
|
+
"name": "responsive",
|
|
3310
|
+
"description": "Enable or disable the automatic responsive behaviour of the radio group\ncomponent when horizontal setting is used. Setting this option to \"true\"\nmakes sure that contents are stacked vertically on mobile."
|
|
3311
|
+
},
|
|
3312
|
+
{
|
|
3313
|
+
"name": "theme",
|
|
3314
|
+
"description": "Theme of the radio group.",
|
|
3315
|
+
"values": [
|
|
3316
|
+
{
|
|
3317
|
+
"name": "default"
|
|
3318
|
+
},
|
|
3319
|
+
{
|
|
3320
|
+
"name": "turva"
|
|
3321
|
+
}
|
|
3322
|
+
]
|
|
3323
|
+
},
|
|
3324
|
+
{
|
|
3325
|
+
"name": "tooltip",
|
|
3326
|
+
"description": "Tooltip to display next to the label of the radio group."
|
|
3327
|
+
},
|
|
3328
|
+
{
|
|
3329
|
+
"name": "tooltip-direction",
|
|
3330
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
3331
|
+
"values": [
|
|
3332
|
+
{
|
|
3333
|
+
"name": "auto"
|
|
3334
|
+
},
|
|
3335
|
+
{
|
|
3336
|
+
"name": "left"
|
|
3337
|
+
},
|
|
3338
|
+
{
|
|
3339
|
+
"name": "right"
|
|
3340
|
+
}
|
|
3341
|
+
]
|
|
3342
|
+
},
|
|
3343
|
+
{
|
|
3344
|
+
"name": "value",
|
|
3345
|
+
"description": "The value of the selected radio button."
|
|
3346
|
+
}
|
|
3347
|
+
],
|
|
3348
|
+
"references": [
|
|
3349
|
+
{
|
|
3350
|
+
"name": "Source code",
|
|
3351
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-radio-group/duet-radio-group.tsx"
|
|
3352
|
+
}
|
|
3353
|
+
]
|
|
3354
|
+
},
|
|
3355
|
+
{
|
|
3356
|
+
"name": "duet-range-slider",
|
|
3357
|
+
"description": {
|
|
3358
|
+
"kind": "markdown",
|
|
3359
|
+
"value": "---\ntitle: Range Slider\nname: duet-range-slider\nstatus: ready\nreleased: 1.3.2\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Forms\nintro: Range Slider lets user specify a numeric value using a slider which must\n be no less than a given value, and no more than another given value.\nexamples:\n - name: range slider\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default range slider\n file: fixtures/duet-range-slider_default_range_slider.html\n - name: Range slider using expand property\n file: fixtures/duet-range-slider_range_slider_using_expand_property.html\n - name: Range slider using hidden label\n file: fixtures/duet-range-slider_range_slider_using_hidden_label.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3360
|
+
},
|
|
3361
|
+
"attributes": [
|
|
3362
|
+
{
|
|
3363
|
+
"name": "accessible-active-descendant",
|
|
3364
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
3365
|
+
},
|
|
3366
|
+
{
|
|
3367
|
+
"name": "accessible-controls",
|
|
3368
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
3369
|
+
},
|
|
3370
|
+
{
|
|
3371
|
+
"name": "accessible-described-by",
|
|
3372
|
+
"description": "Indicates the id of a component that describes the input."
|
|
3373
|
+
},
|
|
3374
|
+
{
|
|
3375
|
+
"name": "accessible-owns",
|
|
3376
|
+
"description": "Indicates the id of a component owned by the input."
|
|
3377
|
+
},
|
|
3378
|
+
{
|
|
3379
|
+
"name": "debounce",
|
|
3380
|
+
"description": "Set the amount of time, in milliseconds, to wait to trigger the duetChange\nevent after each keystroke."
|
|
3381
|
+
},
|
|
3382
|
+
{
|
|
3383
|
+
"name": "disabled",
|
|
3384
|
+
"description": "Makes the input component disabled. This prevents users from being able to\ninteract with the input, and conveys its inactive state to assistive technologies."
|
|
3385
|
+
},
|
|
3386
|
+
{
|
|
3387
|
+
"name": "expand",
|
|
3388
|
+
"description": "Expands the input to fill 100% of the container width."
|
|
3389
|
+
},
|
|
3390
|
+
{
|
|
3391
|
+
"name": "identifier",
|
|
3392
|
+
"description": "Adds a unique identifier for the input."
|
|
3393
|
+
},
|
|
3394
|
+
{
|
|
3395
|
+
"name": "label",
|
|
3396
|
+
"description": "Label for the range slider."
|
|
3397
|
+
},
|
|
3398
|
+
{
|
|
3399
|
+
"name": "label-hidden",
|
|
3400
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
"name": "locale",
|
|
3404
|
+
"description": "Locale used to format the entered value.",
|
|
3405
|
+
"values": [
|
|
3406
|
+
{
|
|
3407
|
+
"name": "en-GB"
|
|
3408
|
+
},
|
|
3409
|
+
{
|
|
3410
|
+
"name": "en-US"
|
|
3411
|
+
},
|
|
3412
|
+
{
|
|
3413
|
+
"name": "fi-FI"
|
|
3414
|
+
},
|
|
3415
|
+
{
|
|
3416
|
+
"name": "sv-SE"
|
|
3417
|
+
}
|
|
3418
|
+
]
|
|
3419
|
+
},
|
|
3420
|
+
{
|
|
3421
|
+
"name": "margin",
|
|
3422
|
+
"description": "Controls the margin of the component.",
|
|
3423
|
+
"values": [
|
|
3424
|
+
{
|
|
3425
|
+
"name": "auto"
|
|
3426
|
+
},
|
|
3427
|
+
{
|
|
3428
|
+
"name": "none"
|
|
3429
|
+
}
|
|
3430
|
+
]
|
|
3431
|
+
},
|
|
3432
|
+
{
|
|
3433
|
+
"name": "max",
|
|
3434
|
+
"description": "Maximum value."
|
|
3435
|
+
},
|
|
3436
|
+
{
|
|
3437
|
+
"name": "min",
|
|
3438
|
+
"description": "Minimum value."
|
|
3439
|
+
},
|
|
3440
|
+
{
|
|
3441
|
+
"name": "name",
|
|
3442
|
+
"description": "Name of the input."
|
|
3443
|
+
},
|
|
3444
|
+
{
|
|
3445
|
+
"name": "required",
|
|
3446
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
3447
|
+
},
|
|
3448
|
+
{
|
|
3449
|
+
"name": "step",
|
|
3450
|
+
"description": "Step amount."
|
|
3451
|
+
},
|
|
3452
|
+
{
|
|
3453
|
+
"name": "theme",
|
|
3454
|
+
"description": "Theme of the input.",
|
|
3455
|
+
"values": [
|
|
3456
|
+
{
|
|
3457
|
+
"name": "default"
|
|
3458
|
+
},
|
|
3459
|
+
{
|
|
3460
|
+
"name": "turva"
|
|
3461
|
+
}
|
|
3462
|
+
]
|
|
3463
|
+
},
|
|
3464
|
+
{
|
|
3465
|
+
"name": "unit",
|
|
3466
|
+
"description": "Unit for the range slider."
|
|
3467
|
+
},
|
|
3468
|
+
{
|
|
3469
|
+
"name": "value",
|
|
3470
|
+
"description": "Value of the input."
|
|
3471
|
+
}
|
|
3472
|
+
],
|
|
3473
|
+
"references": [
|
|
3474
|
+
{
|
|
3475
|
+
"name": "Source code",
|
|
3476
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-range-slider/duet-range-slider.tsx"
|
|
3477
|
+
}
|
|
3478
|
+
]
|
|
3479
|
+
},
|
|
3480
|
+
{
|
|
3481
|
+
"name": "duet-select",
|
|
3482
|
+
"description": {
|
|
3483
|
+
"kind": "markdown",
|
|
3484
|
+
"value": "---\ntitle: Select\nname: duet-select\nstatus: ready\nreleased: 1.3.0\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Forms\nintro: Select lets user choose one option from an options menu. Consider using\n select when you have 6 or more options. Select component supports any content\n type.\nexamples:\n - name: select\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default select\n file: fixtures/duet-select_default_select.html\n - name: Select using expand property\n file: fixtures/duet-select_select_using_expand_property.html\n - name: Preselected value in select\n file: fixtures/duet-select_preselected_value_in_select.html\n - name: Disabled select\n file: fixtures/duet-select_disabled_select.html\n - name: Passing items to select as JSON via attribute for SSR support\n file: fixtures/duet-select_passing_items_to_select_as_json_via_attribute_for_ssr_support.html\n - name: Grouping options\n file: fixtures/duet-select_grouping_options.html\n - name: Disabled options\n file: fixtures/duet-select_disabled_options.html\n - name: Grouping options with echoing placeholder\n file: fixtures/duet-select_grouping_echo_placeholder_caption.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3485
|
+
},
|
|
3486
|
+
"attributes": [
|
|
3487
|
+
{
|
|
3488
|
+
"name": "accessible-active-descendant",
|
|
3489
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
3490
|
+
},
|
|
3491
|
+
{
|
|
3492
|
+
"name": "accessible-controls",
|
|
3493
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to indicate\nthe id of a component controlled by this component."
|
|
3494
|
+
},
|
|
3495
|
+
{
|
|
3496
|
+
"name": "accessible-described-by",
|
|
3497
|
+
"description": "Indicates the id of a component that describes the input."
|
|
3498
|
+
},
|
|
3499
|
+
{
|
|
3500
|
+
"name": "accessible-owns",
|
|
3501
|
+
"description": "Indicates the id of a component owned by the select."
|
|
3502
|
+
},
|
|
3503
|
+
{
|
|
3504
|
+
"name": "caption",
|
|
3505
|
+
"description": "Caption (underneath label) that can be set as a way of adding extra information"
|
|
3506
|
+
},
|
|
3507
|
+
{
|
|
3508
|
+
"name": "disabled",
|
|
3509
|
+
"description": "Makes the select component disabled. This prevents users from being able\nto interact with the select, and conveys its inactive state to assistive\ntechnologies."
|
|
3510
|
+
},
|
|
3511
|
+
{
|
|
3512
|
+
"name": "echo-placeholder",
|
|
3513
|
+
"description": "If form input field has a placeholder text, and user types anything (causing the placeholder text to disappear),\nsettings this to true will \"echo\" it into the caption slot - this option will be false by default for the next few versions, but will eventually be true by default (scheduled for 4.30.0)"
|
|
3514
|
+
},
|
|
3515
|
+
{
|
|
3516
|
+
"name": "error",
|
|
3517
|
+
"description": "Display the select in error state along with an error message."
|
|
3518
|
+
},
|
|
3519
|
+
{
|
|
3520
|
+
"name": "expand",
|
|
3521
|
+
"description": "Expands the input to fill 100% of the container width."
|
|
3522
|
+
},
|
|
3523
|
+
{
|
|
3524
|
+
"name": "identifier",
|
|
3525
|
+
"description": "Adds a unique identifier for the select."
|
|
3526
|
+
},
|
|
3527
|
+
{
|
|
3528
|
+
"name": "items",
|
|
3529
|
+
"description": "An array of items to choose from"
|
|
3530
|
+
},
|
|
3531
|
+
{
|
|
3532
|
+
"name": "label",
|
|
3533
|
+
"description": "Label for the select."
|
|
3534
|
+
},
|
|
3535
|
+
{
|
|
3536
|
+
"name": "label-hidden",
|
|
3537
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
3538
|
+
},
|
|
3539
|
+
{
|
|
3540
|
+
"name": "margin",
|
|
3541
|
+
"description": "Controls the margin of the component.",
|
|
3542
|
+
"values": [
|
|
3543
|
+
{
|
|
3544
|
+
"name": "auto"
|
|
3545
|
+
},
|
|
3546
|
+
{
|
|
3547
|
+
"name": "none"
|
|
3548
|
+
}
|
|
3549
|
+
]
|
|
3550
|
+
},
|
|
3551
|
+
{
|
|
3552
|
+
"name": "name",
|
|
3553
|
+
"description": "Name of the select."
|
|
3554
|
+
},
|
|
3555
|
+
{
|
|
3556
|
+
"name": "placeholder",
|
|
3557
|
+
"description": "Hint text to display."
|
|
3558
|
+
},
|
|
3559
|
+
{
|
|
3560
|
+
"name": "required",
|
|
3561
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
3562
|
+
},
|
|
3563
|
+
{
|
|
3564
|
+
"name": "role",
|
|
3565
|
+
"description": "Defines a specific role attribute for the select."
|
|
3566
|
+
},
|
|
3567
|
+
{
|
|
3568
|
+
"name": "theme",
|
|
3569
|
+
"description": "Theme of the select.",
|
|
3570
|
+
"values": [
|
|
3571
|
+
{
|
|
3572
|
+
"name": "default"
|
|
3573
|
+
},
|
|
3574
|
+
{
|
|
3575
|
+
"name": "turva"
|
|
3576
|
+
}
|
|
3577
|
+
]
|
|
3578
|
+
},
|
|
3579
|
+
{
|
|
3580
|
+
"name": "tooltip",
|
|
3581
|
+
"description": "Tooltip to display next to the label of the input."
|
|
3582
|
+
},
|
|
3583
|
+
{
|
|
3584
|
+
"name": "tooltip-direction",
|
|
3585
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
3586
|
+
"values": [
|
|
3587
|
+
{
|
|
3588
|
+
"name": "auto"
|
|
3589
|
+
},
|
|
3590
|
+
{
|
|
3591
|
+
"name": "left"
|
|
3592
|
+
},
|
|
3593
|
+
{
|
|
3594
|
+
"name": "right"
|
|
3595
|
+
}
|
|
3596
|
+
]
|
|
3597
|
+
},
|
|
3598
|
+
{
|
|
3599
|
+
"name": "value",
|
|
3600
|
+
"description": "The selected value of the select"
|
|
3601
|
+
}
|
|
3602
|
+
],
|
|
3603
|
+
"references": [
|
|
3604
|
+
{
|
|
3605
|
+
"name": "Source code",
|
|
3606
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-select/duet-select.tsx"
|
|
3607
|
+
}
|
|
3608
|
+
]
|
|
3609
|
+
},
|
|
3610
|
+
{
|
|
3611
|
+
"name": "duet-spacer",
|
|
3612
|
+
"description": {
|
|
3613
|
+
"kind": "markdown",
|
|
3614
|
+
"value": "---\ntitle: Spacer\nname: duet-spacer\nstatus: ready\nreleased: 1.0.19\nssr: Supported\ncategory: Structure\nintro: Spacer component is used to give additional white space between two\n components in an interface. You can customize the size and direction with the\n provided properties.\nplatforms: Web only\nexample_height: 300px\nexamples:\n - name: spacer\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Vertical spacers\n file: fixtures/duet-spacer_vertical_spacers.html\n - name: Horizontal spacers\n file: fixtures/duet-spacer_horizontal_spacers.html\n - name: Spacers using responsive breakpoints\n file: fixtures/duet-spacer_spacers_using_responsive_breakpoints.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3615
|
+
},
|
|
3616
|
+
"attributes": [
|
|
3617
|
+
{
|
|
3618
|
+
"name": "breakpoint",
|
|
3619
|
+
"description": "Adjusts the breakpoint where the spacer is shown in. The functionality\nfollows 1:1 the media queries defined in design tokens.",
|
|
3620
|
+
"values": [
|
|
3621
|
+
{
|
|
3622
|
+
"name": "large"
|
|
3623
|
+
},
|
|
3624
|
+
{
|
|
3625
|
+
"name": "medium"
|
|
3626
|
+
},
|
|
3627
|
+
{
|
|
3628
|
+
"name": "small"
|
|
3629
|
+
},
|
|
3630
|
+
{
|
|
3631
|
+
"name": "x-large"
|
|
3632
|
+
},
|
|
3633
|
+
{
|
|
3634
|
+
"name": "x-small"
|
|
3635
|
+
},
|
|
3636
|
+
{
|
|
3637
|
+
"name": "xx-large"
|
|
3638
|
+
},
|
|
3639
|
+
{
|
|
3640
|
+
"name": "xx-small"
|
|
3641
|
+
}
|
|
3642
|
+
]
|
|
3643
|
+
},
|
|
3644
|
+
{
|
|
3645
|
+
"name": "direction",
|
|
3646
|
+
"description": "Direction of the space added.",
|
|
3647
|
+
"values": [
|
|
3648
|
+
{
|
|
3649
|
+
"name": "horizontal"
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
"name": "vertical"
|
|
3653
|
+
}
|
|
3654
|
+
]
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
"name": "size",
|
|
3658
|
+
"description": "Size variation of the spacer. Can be any of the spacing tokens.",
|
|
3659
|
+
"values": [
|
|
3660
|
+
{
|
|
3661
|
+
"name": "large"
|
|
3662
|
+
},
|
|
3663
|
+
{
|
|
3664
|
+
"name": "medium"
|
|
3665
|
+
},
|
|
3666
|
+
{
|
|
3667
|
+
"name": "small"
|
|
3668
|
+
},
|
|
3669
|
+
{
|
|
3670
|
+
"name": "x-large"
|
|
3671
|
+
},
|
|
3672
|
+
{
|
|
3673
|
+
"name": "x-small"
|
|
3674
|
+
},
|
|
3675
|
+
{
|
|
3676
|
+
"name": "xx-large"
|
|
3677
|
+
},
|
|
3678
|
+
{
|
|
3679
|
+
"name": "xx-small"
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"name": "xxx-large"
|
|
3683
|
+
},
|
|
3684
|
+
{
|
|
3685
|
+
"name": "xxxx-large"
|
|
3686
|
+
}
|
|
3687
|
+
]
|
|
3688
|
+
}
|
|
3689
|
+
],
|
|
3690
|
+
"references": [
|
|
3691
|
+
{
|
|
3692
|
+
"name": "Source code",
|
|
3693
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-spacer/duet-spacer.tsx"
|
|
3694
|
+
}
|
|
3695
|
+
]
|
|
3696
|
+
},
|
|
3697
|
+
{
|
|
3698
|
+
"name": "duet-spinner",
|
|
3699
|
+
"description": {
|
|
3700
|
+
"kind": "markdown",
|
|
3701
|
+
"value": "---\ntitle: Spinner\nname: duet-spinner\nstatus: ready\nreleased: 1.0.15\ninternationalization: Supported\nssr: Supported\ncategory: Messaging\nintro: Spinners are used to indicate users that their action is being processed.\n Duet’s spinner is built entirely with HTML and CSS, and doesn’t rely on\n JavaScript.\ndescription: \"You can customize the size and color of the spinner with the\n provided properties. Spinner comes in three sizes: small, medium and large.\"\nplatforms: Web only\nappearance: negative\nexamples:\n - name: spinner\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Small spinner\n file: fixtures/duet-spinner_small_spinner.html\n - name: Medium spinner\n file: fixtures/duet-spinner_medium_spinner.html\n - name: Large spinner\n file: fixtures/duet-spinner_large_spinner.html\n - name: Spinner using text color\n file: fixtures/duet-spinner_spinner_using_text_color.html\n - name: Spinner using color token\n file: fixtures/duet-spinner_spinner_using_color_token.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3702
|
+
},
|
|
3703
|
+
"attributes": [
|
|
3704
|
+
{
|
|
3705
|
+
"name": "accessible-label",
|
|
3706
|
+
"description": "Adds accessible label for the spinner that is only shown for screen readers."
|
|
3707
|
+
},
|
|
3708
|
+
{
|
|
3709
|
+
"name": "color",
|
|
3710
|
+
"description": "Color of the spinner, as a design token entered in camelCase or kebab-case.\nExample: \"color-primary\". This property can also be set to \"currentColor\"\nwhich forces the icon to use the CSS text color of parent element instead.\nUseful when you want to control the color in stylesheet instead."
|
|
3711
|
+
},
|
|
3712
|
+
{
|
|
3713
|
+
"name": "size",
|
|
3714
|
+
"description": "Size variation of the spinner.",
|
|
3715
|
+
"values": [
|
|
3716
|
+
{
|
|
3717
|
+
"name": "large"
|
|
3718
|
+
},
|
|
3719
|
+
{
|
|
3720
|
+
"name": "medium"
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"name": "small"
|
|
3724
|
+
}
|
|
3725
|
+
]
|
|
3726
|
+
},
|
|
3727
|
+
{
|
|
3728
|
+
"name": "theme",
|
|
3729
|
+
"description": "Theme of the spinner. When used this will override the color setting and\nuse \"primary\" or \"primary-turva\" as the color depending on which theme\nis chosen.",
|
|
3730
|
+
"values": [
|
|
3731
|
+
{
|
|
3732
|
+
"name": "default"
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
"name": "turva"
|
|
3736
|
+
}
|
|
3737
|
+
]
|
|
3738
|
+
}
|
|
3739
|
+
],
|
|
3740
|
+
"references": [
|
|
3741
|
+
{
|
|
3742
|
+
"name": "Source code",
|
|
3743
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-spinner/duet-spinner.tsx"
|
|
3744
|
+
}
|
|
3745
|
+
]
|
|
3746
|
+
},
|
|
3747
|
+
{
|
|
3748
|
+
"name": "duet-step",
|
|
3749
|
+
"description": {
|
|
3750
|
+
"kind": "markdown",
|
|
3751
|
+
"value": "---\ntitle: Step\nname: duet-step\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.2.0\nssr: Supported\nintro: Step is a component used inside Stepper. A step consists of a numbered\n heading and content. For concrete usage examples, please see the <a\n href=\"/components/stepper/\">Stepper component</a>.\nexamples:\n - name: step\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3752
|
+
},
|
|
3753
|
+
"attributes": [
|
|
3754
|
+
{
|
|
3755
|
+
"name": "heading",
|
|
3756
|
+
"description": "Set the heading for the step."
|
|
3757
|
+
},
|
|
3758
|
+
{
|
|
3759
|
+
"name": "heading-level",
|
|
3760
|
+
"description": "Set the heading level used in the HTML markup.",
|
|
3761
|
+
"values": [
|
|
3762
|
+
{
|
|
3763
|
+
"name": "h1"
|
|
3764
|
+
},
|
|
3765
|
+
{
|
|
3766
|
+
"name": "h2"
|
|
3767
|
+
},
|
|
3768
|
+
{
|
|
3769
|
+
"name": "h3"
|
|
3770
|
+
},
|
|
3771
|
+
{
|
|
3772
|
+
"name": "h4"
|
|
3773
|
+
},
|
|
3774
|
+
{
|
|
3775
|
+
"name": "h5"
|
|
3776
|
+
},
|
|
3777
|
+
{
|
|
3778
|
+
"name": "h6"
|
|
3779
|
+
}
|
|
3780
|
+
]
|
|
3781
|
+
},
|
|
3782
|
+
{
|
|
3783
|
+
"name": "theme",
|
|
3784
|
+
"description": "Theme of the component.",
|
|
3785
|
+
"values": [
|
|
3786
|
+
{
|
|
3787
|
+
"name": "default"
|
|
3788
|
+
},
|
|
3789
|
+
{
|
|
3790
|
+
"name": "turva"
|
|
3791
|
+
}
|
|
3792
|
+
]
|
|
3793
|
+
}
|
|
3794
|
+
],
|
|
3795
|
+
"references": [
|
|
3796
|
+
{
|
|
3797
|
+
"name": "Source code",
|
|
3798
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-step/duet-step.tsx"
|
|
3799
|
+
}
|
|
3800
|
+
]
|
|
3801
|
+
},
|
|
3802
|
+
{
|
|
3803
|
+
"name": "duet-stepper",
|
|
3804
|
+
"description": {
|
|
3805
|
+
"kind": "markdown",
|
|
3806
|
+
"value": "---\ntitle: Stepper\nname: duet-stepper\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.2.0\nssr: Supported\nintro: Stepper is used to create wizard-like workflows by dividing content into\n logical steps. The user can navigate backwards by clicking on the header of a\n completed step.\nexample_height: 580px\nexamples:\n - name: stepper\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic stepper usage\n file: fixtures/duet-stepper_basic_stepper_usage.html\n - name: Steps with additional content in heading\n file: fixtures/duet-stepper_steps_with_additional_content_in_heading.html\n - name: Using events to prevent navigation to previous steps\n file: fixtures/duet-stepper_using_events_to_prevent_navigation_to_previous_steps.html\n - name: Creating additional custom steps using CSS Framework and Design Tokens\n file: fixtures/duet-stepper_creating_additional_custom_steps_using_css_framework_and_design_tokens.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3807
|
+
},
|
|
3808
|
+
"attributes": [
|
|
3809
|
+
{
|
|
3810
|
+
"name": "accessible-live",
|
|
3811
|
+
"description": "Format of message used to announce current step when navigating between steps.\nThe string {current} is replaced with current the step number.\nThe string {total} is replaced with the total number of steps."
|
|
3812
|
+
},
|
|
3813
|
+
{
|
|
3814
|
+
"name": "back-disabled",
|
|
3815
|
+
"description": "Controls whether navigation back to previous steps is allowed or not."
|
|
3816
|
+
},
|
|
3817
|
+
{
|
|
3818
|
+
"name": "margin",
|
|
3819
|
+
"description": "Controls the margin of the component.",
|
|
3820
|
+
"values": [
|
|
3821
|
+
{
|
|
3822
|
+
"name": "auto"
|
|
3823
|
+
},
|
|
3824
|
+
{
|
|
3825
|
+
"name": "none"
|
|
3826
|
+
}
|
|
3827
|
+
]
|
|
3828
|
+
},
|
|
3829
|
+
{
|
|
3830
|
+
"name": "selected",
|
|
3831
|
+
"description": "The index of the current step."
|
|
3832
|
+
},
|
|
3833
|
+
{
|
|
3834
|
+
"name": "theme",
|
|
3835
|
+
"description": "Theme of the component.",
|
|
3836
|
+
"values": [
|
|
3837
|
+
{
|
|
3838
|
+
"name": "default"
|
|
3839
|
+
},
|
|
3840
|
+
{
|
|
3841
|
+
"name": "turva"
|
|
3842
|
+
}
|
|
3843
|
+
]
|
|
3844
|
+
}
|
|
3845
|
+
],
|
|
3846
|
+
"references": [
|
|
3847
|
+
{
|
|
3848
|
+
"name": "Source code",
|
|
3849
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-stepper/duet-stepper.tsx"
|
|
3850
|
+
}
|
|
3851
|
+
]
|
|
3852
|
+
},
|
|
3853
|
+
{
|
|
3854
|
+
"name": "duet-tab",
|
|
3855
|
+
"description": {
|
|
3856
|
+
"kind": "markdown",
|
|
3857
|
+
"value": "---\ntitle: Tab\nname: duet-tab\nstatus: ready\nreleased: 2.6.8\naccessibility: Keyboard, Screen Reader\ninternationalization: Supported\nssr: Supported\ncategory: Navigation\nintro: Tab is a component used inside the Tab Group to generate panels that can\n be navigated using tabs. For concrete usage examples, please see <a\n href=\"/components/tab-group/\">Tab Group component</a>.\nplatforms: Web only\nexamples:\n - name: tab\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3858
|
+
},
|
|
3859
|
+
"attributes": [
|
|
3860
|
+
{
|
|
3861
|
+
"name": "label",
|
|
3862
|
+
"description": "Label for the tab."
|
|
3863
|
+
},
|
|
3864
|
+
{
|
|
3865
|
+
"name": "selected",
|
|
3866
|
+
"description": "Selected state of the tab."
|
|
3867
|
+
}
|
|
3868
|
+
],
|
|
3869
|
+
"references": [
|
|
3870
|
+
{
|
|
3871
|
+
"name": "Source code",
|
|
3872
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-tab/duet-tab.tsx"
|
|
3873
|
+
}
|
|
3874
|
+
]
|
|
3875
|
+
},
|
|
3876
|
+
{
|
|
3877
|
+
"name": "duet-tab-group",
|
|
3878
|
+
"description": {
|
|
3879
|
+
"kind": "markdown",
|
|
3880
|
+
"value": "---\ntitle: Tab Group\nname: duet-tab-group\nstatus: ready\nreleased: 2.6.8\naccessibility: Keyboard, Screen Reader\ninternationalization: Supported\nssr: Supported\ncategory: Navigation\nintro: Tab Group is used as a graphical interface element that allows multiple\n panels to be contained within a single window, using tabs as a navigational\n element.\ndescription: When there are 4 or more navigation items in the Tab Group it’s\n automatically converted to a select menu on small viewports.\nplatforms: Web only\nexamples:\n - name: tab group\n code: This first example creates the actual URL and DOCS, hence it needs to be here.\n - name: Simple tab group\n file: fixtures/duet-tab-group_simple_tab_group.html\n - name: Tabs that switch between cards\n file: fixtures/duet-tab-group_tabs_that_switch_between_cards.html\n - name: Nested tab groups\n file: fixtures/duet-tab-group_nested_tab_groups.html\n - name: Tabs with a visible label on mobile\n file: fixtures/duet-tab-group_visible_label_on_mobile.html\n - name: Plain tab variation\n file: fixtures/duet-tab-group_plain_tab_variation.html\n - name: Plain tab variation with centered tabs\n file: fixtures/duet-tab-group_plain_tab_variation_with_centered_tabs.html\n - name: Plain tab variation with background color for tab content\n file: fixtures/duet-tab-group_plain_tab_variation_with_background_color_for_tab_content.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3881
|
+
},
|
|
3882
|
+
"attributes": [
|
|
3883
|
+
{
|
|
3884
|
+
"name": "label",
|
|
3885
|
+
"description": "Label for the select element which gets shown on mobile."
|
|
3886
|
+
},
|
|
3887
|
+
{
|
|
3888
|
+
"name": "label-default",
|
|
3889
|
+
"description": "Defaults for Label"
|
|
3890
|
+
},
|
|
3891
|
+
{
|
|
3892
|
+
"name": "label-hidden",
|
|
3893
|
+
"description": "Determines whether the label for the select element shown on mobile is visually hidden."
|
|
3894
|
+
},
|
|
3895
|
+
{
|
|
3896
|
+
"name": "language",
|
|
3897
|
+
"description": "The currently active language. This setting changes the accessible labels to match the\nchosen language.",
|
|
3898
|
+
"values": [
|
|
3899
|
+
{
|
|
3900
|
+
"name": "en"
|
|
3901
|
+
},
|
|
3902
|
+
{
|
|
3903
|
+
"name": "fi"
|
|
3904
|
+
},
|
|
3905
|
+
{
|
|
3906
|
+
"name": "sv"
|
|
3907
|
+
}
|
|
3908
|
+
]
|
|
3909
|
+
},
|
|
3910
|
+
{
|
|
3911
|
+
"name": "margin",
|
|
3912
|
+
"description": "Controls the margin of the component.",
|
|
3913
|
+
"values": [
|
|
3914
|
+
{
|
|
3915
|
+
"name": "auto"
|
|
3916
|
+
},
|
|
3917
|
+
{
|
|
3918
|
+
"name": "none"
|
|
3919
|
+
}
|
|
3920
|
+
]
|
|
3921
|
+
},
|
|
3922
|
+
{
|
|
3923
|
+
"name": "padding",
|
|
3924
|
+
"description": "Controls the padding of the component.",
|
|
3925
|
+
"values": [
|
|
3926
|
+
{
|
|
3927
|
+
"name": "auto"
|
|
3928
|
+
},
|
|
3929
|
+
{
|
|
3930
|
+
"name": "none"
|
|
3931
|
+
}
|
|
3932
|
+
]
|
|
3933
|
+
},
|
|
3934
|
+
{
|
|
3935
|
+
"name": "theme",
|
|
3936
|
+
"description": "Theme of the component.",
|
|
3937
|
+
"values": [
|
|
3938
|
+
{
|
|
3939
|
+
"name": "default"
|
|
3940
|
+
},
|
|
3941
|
+
{
|
|
3942
|
+
"name": "turva"
|
|
3943
|
+
}
|
|
3944
|
+
]
|
|
3945
|
+
},
|
|
3946
|
+
{
|
|
3947
|
+
"name": "variation",
|
|
3948
|
+
"description": "Style variation of the tab group.",
|
|
3949
|
+
"values": [
|
|
3950
|
+
{
|
|
3951
|
+
"name": "default"
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
"name": "plain"
|
|
3955
|
+
}
|
|
3956
|
+
]
|
|
3957
|
+
}
|
|
3958
|
+
],
|
|
3959
|
+
"references": [
|
|
3960
|
+
{
|
|
3961
|
+
"name": "Source code",
|
|
3962
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-tab-group/duet-tab-group.tsx"
|
|
3963
|
+
}
|
|
3964
|
+
]
|
|
3965
|
+
},
|
|
3966
|
+
{
|
|
3967
|
+
"name": "duet-table",
|
|
3968
|
+
"description": {
|
|
3969
|
+
"kind": "markdown",
|
|
3970
|
+
"value": "---\ntitle: Table\nname: duet-table\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 3.4.0\nssr: Supported\nintro: Table is a lightweight and un-opinionated component for enhancing tabular\n data. It offers features like sticky headers, support for narrow viewport\n widths, and table styles.\ndescription: It’s important to pay close attention to semantics when authoring\n tables with Duet Table component. The markup in the examples below can be used\n as a starting point for most tables. However, be aware that HTML tables have a\n large feature set, which cannot be covered exhaustively here.\nexample_height: 400px\nexamples:\n - name: table\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Basic table usage\n file: fixtures/duet-table_basic_table_usage.html\n - name: Plain table variation\n file: fixtures/duet-table_plain_table_variation.html\n - name: Table with right-aligned final column\n file: fixtures/duet-table_table_with_right-aligned_final_column.html\n - name: Table with a custom breakpoint\n file: fixtures/duet-table_table_with_a_custom_breakpoint.html\n - name: Table with a footer\n file: fixtures/duet-table_table_with_a_footer.html\n - name: Table with a sticky header\n file: fixtures/duet-table_table_with_a_sticky_header.html\n - name: Table with multiple bodies and sub-headings\n file: fixtures/duet-table_table_with_multiple_bodies_and_sub-headings.html\n - name: Comparison table\n file: fixtures/duet-table_comparison_table.html\n - name: Table with inline actions\n file: fixtures/duet-table_table_with_inline_actions.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
3971
|
+
},
|
|
3972
|
+
"attributes": [
|
|
3973
|
+
{
|
|
3974
|
+
"name": "breakpoint",
|
|
3975
|
+
"description": "By default the table is responsive - it will be flattened at narrow viewport widths.\nThis prop controls the breakpoint at which the table should be rendered as a _regular_ table.\nSet to \"none\" to disable the responsive functionality.\nSet to \"none-scrollable\" to disable responsive functionality _and_ allow horizontal scrolling -\nthis is useful for comparison tables where it's important to maintain column and row layout.",
|
|
3976
|
+
"values": [
|
|
3977
|
+
{
|
|
3978
|
+
"name": "large"
|
|
3979
|
+
},
|
|
3980
|
+
{
|
|
3981
|
+
"name": "medium"
|
|
3982
|
+
},
|
|
3983
|
+
{
|
|
3984
|
+
"name": "none"
|
|
3985
|
+
},
|
|
3986
|
+
{
|
|
3987
|
+
"name": "none-scrollable"
|
|
3988
|
+
},
|
|
3989
|
+
{
|
|
3990
|
+
"name": "small"
|
|
3991
|
+
},
|
|
3992
|
+
{
|
|
3993
|
+
"name": "x-large"
|
|
3994
|
+
},
|
|
3995
|
+
{
|
|
3996
|
+
"name": "xx-large"
|
|
3997
|
+
},
|
|
3998
|
+
{
|
|
3999
|
+
"name": "xxx-large"
|
|
4000
|
+
}
|
|
4001
|
+
]
|
|
4002
|
+
},
|
|
4003
|
+
{
|
|
4004
|
+
"name": "margin",
|
|
4005
|
+
"description": "Controls the margin of the component.",
|
|
4006
|
+
"values": [
|
|
4007
|
+
{
|
|
4008
|
+
"name": "auto"
|
|
4009
|
+
},
|
|
4010
|
+
{
|
|
4011
|
+
"name": "none"
|
|
4012
|
+
}
|
|
4013
|
+
]
|
|
4014
|
+
},
|
|
4015
|
+
{
|
|
4016
|
+
"name": "sticky",
|
|
4017
|
+
"description": "Controls whether the table has a sticky header.\nSticky headers are not compatible with breakpoint=\"none-scrollable\"."
|
|
4018
|
+
},
|
|
4019
|
+
{
|
|
4020
|
+
"name": "sticky-distance",
|
|
4021
|
+
"description": "Adjust the distance from top of the viewport (in pixels) when the\ntable header becomes sticky.",
|
|
4022
|
+
"values": [
|
|
4023
|
+
{
|
|
4024
|
+
"name": "none"
|
|
4025
|
+
},
|
|
4026
|
+
{
|
|
4027
|
+
"name": "with-links"
|
|
4028
|
+
},
|
|
4029
|
+
{
|
|
4030
|
+
"name": "without-links"
|
|
4031
|
+
}
|
|
4032
|
+
]
|
|
4033
|
+
},
|
|
4034
|
+
{
|
|
4035
|
+
"name": "theme",
|
|
4036
|
+
"description": "Theme of the table.",
|
|
4037
|
+
"values": [
|
|
4038
|
+
{
|
|
4039
|
+
"name": "default"
|
|
4040
|
+
},
|
|
4041
|
+
{
|
|
4042
|
+
"name": "turva"
|
|
4043
|
+
}
|
|
4044
|
+
]
|
|
4045
|
+
},
|
|
4046
|
+
{
|
|
4047
|
+
"name": "variation",
|
|
4048
|
+
"description": "Style variation of the table.",
|
|
4049
|
+
"values": [
|
|
4050
|
+
{
|
|
4051
|
+
"name": "plain"
|
|
4052
|
+
},
|
|
4053
|
+
{
|
|
4054
|
+
"name": "striped"
|
|
4055
|
+
}
|
|
4056
|
+
]
|
|
4057
|
+
}
|
|
4058
|
+
],
|
|
4059
|
+
"references": [
|
|
4060
|
+
{
|
|
4061
|
+
"name": "Source code",
|
|
4062
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-table/duet-table.tsx"
|
|
4063
|
+
}
|
|
4064
|
+
]
|
|
4065
|
+
},
|
|
4066
|
+
{
|
|
4067
|
+
"name": "duet-textarea",
|
|
4068
|
+
"description": {
|
|
4069
|
+
"kind": "markdown",
|
|
4070
|
+
"value": "---\ntitle: Textarea\nname: duet-textarea\nstatus: ready\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nreleased: 1.3.0\nssr: Supported\ncategory: Forms\nexample_height: 320px\nintro: Textarea specifies a control that allows user to write text over multiple\n rows. Used when the expected user input is long. For shorter input, use the\n Input component.\ndescription: You can use native HTML5 validation with Textarea component via\n validation properties. This allows you to specify rules like whether a value\n needs to be filled in and the minimum and maximum length of the data.\nexamples:\n - name: textarea\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default textarea\n file: fixtures/duet-textarea_default_textarea.html\n - name: Textarea without expand property\n file: fixtures/duet-textarea_textarea_without_expand_property.html\n - name: Disabled textarea\n file: fixtures/duet-textarea_disabled_textarea.html\n - name: Textarea with error\n file: fixtures/duet-textarea_textarea_with_error.html\n - name: Textarea with character counter\n file: fixtures/duet-textarea_textarea_with_character_counter.html\n - name: Textarea with character counter and error\n file: fixtures/duet-textarea_textarea_with_character_counter_and_error.html\n - name: Textarea that only allows numbers and commas\n file: fixtures/duet-textarea_textarea_that_only_allows_numbers_and_commas.html\n - name: Textarea that has caption and echoing placeholder\n file: fixtures/duet-textarea_caption_and_echoing_placeholder.html\ntags:\n - docs-components\n---\n\n<!-- usage -->"
|
|
4071
|
+
},
|
|
4072
|
+
"attributes": [
|
|
4073
|
+
{
|
|
4074
|
+
"name": "accessible-active-descendant",
|
|
4075
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
4076
|
+
},
|
|
4077
|
+
{
|
|
4078
|
+
"name": "accessible-autocomplete",
|
|
4079
|
+
"description": "Indicates what kind of user input completion suggestions are provided."
|
|
4080
|
+
},
|
|
4081
|
+
{
|
|
4082
|
+
"name": "accessible-controls",
|
|
4083
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to\nindicate the id of a component controlled by this component."
|
|
4084
|
+
},
|
|
4085
|
+
{
|
|
4086
|
+
"name": "accessible-described-by",
|
|
4087
|
+
"description": "Indicates the id of a component that describes the input."
|
|
4088
|
+
},
|
|
4089
|
+
{
|
|
4090
|
+
"name": "accessible-owns",
|
|
4091
|
+
"description": "Indicates the id of a component owned by the textarea."
|
|
4092
|
+
},
|
|
4093
|
+
{
|
|
4094
|
+
"name": "caption",
|
|
4095
|
+
"description": "Caption (underneath label) that can be set as a way of adding extra information"
|
|
4096
|
+
},
|
|
4097
|
+
{
|
|
4098
|
+
"name": "counter",
|
|
4099
|
+
"description": "Display character counter. Must be used in conjunction with\n**maxlength** and **counterLabel** properties."
|
|
4100
|
+
},
|
|
4101
|
+
{
|
|
4102
|
+
"name": "counter-label",
|
|
4103
|
+
"description": "Accessible label for character counter. Must be used in conjunction with\n**counter** property."
|
|
4104
|
+
},
|
|
4105
|
+
{
|
|
4106
|
+
"name": "disabled",
|
|
4107
|
+
"description": "Makes the textarea component disabled. This prevents users from being able\nto interact with the textarea, and conveys its inactive state to assistive\ntechnologies."
|
|
4108
|
+
},
|
|
4109
|
+
{
|
|
4110
|
+
"name": "disallow-pattern",
|
|
4111
|
+
"description": "A regular expression that matches any characters which should be *disallowed*.\nThis differs from `pattern`, as it actively prevents users entering any characters which match the regular expression.\ne.g. the following will disallow any non-numeric characters `[^0-9]`"
|
|
4112
|
+
},
|
|
4113
|
+
{
|
|
4114
|
+
"name": "echo-placeholder",
|
|
4115
|
+
"description": "If form input field has a placeholder text, and user types anything (causing the text to dissapear),\nsettings this to true will \"echo\" it into the caption slot - this option will be false by default for the next few versions, but will eventually be true by default (scheduled for 4.30.0)"
|
|
4116
|
+
},
|
|
4117
|
+
{
|
|
4118
|
+
"name": "error",
|
|
4119
|
+
"description": "Display the textarea in error state along with an error message."
|
|
4120
|
+
},
|
|
4121
|
+
{
|
|
4122
|
+
"name": "expand",
|
|
4123
|
+
"description": "Expands the textarea to fill 100% of the container width."
|
|
4124
|
+
},
|
|
4125
|
+
{
|
|
4126
|
+
"name": "identifier",
|
|
4127
|
+
"description": "Adds a unique identifier for the textarea."
|
|
4128
|
+
},
|
|
4129
|
+
{
|
|
4130
|
+
"name": "label",
|
|
4131
|
+
"description": "Label for the textarea."
|
|
4132
|
+
},
|
|
4133
|
+
{
|
|
4134
|
+
"name": "label-hidden",
|
|
4135
|
+
"description": "Visually hide the label, but still show it to screen readers."
|
|
4136
|
+
},
|
|
4137
|
+
{
|
|
4138
|
+
"name": "margin",
|
|
4139
|
+
"description": "Controls the margin of the component.",
|
|
4140
|
+
"values": [
|
|
4141
|
+
{
|
|
4142
|
+
"name": "auto"
|
|
4143
|
+
},
|
|
4144
|
+
{
|
|
4145
|
+
"name": "none"
|
|
4146
|
+
}
|
|
4147
|
+
]
|
|
4148
|
+
},
|
|
4149
|
+
{
|
|
4150
|
+
"name": "maxlength",
|
|
4151
|
+
"description": "Use maxlength to specify the maximum length of the value that can be entered.\nPlease note that this uses native HTML5 pattern validation."
|
|
4152
|
+
},
|
|
4153
|
+
{
|
|
4154
|
+
"name": "minlength",
|
|
4155
|
+
"description": "Use minlength to specify the minimum length of the value that can be entered.\nPlease note that this uses native HTML5 pattern validation."
|
|
4156
|
+
},
|
|
4157
|
+
{
|
|
4158
|
+
"name": "name",
|
|
4159
|
+
"description": "Name of the textarea."
|
|
4160
|
+
},
|
|
4161
|
+
{
|
|
4162
|
+
"name": "placeholder",
|
|
4163
|
+
"description": "Hint text to display."
|
|
4164
|
+
},
|
|
4165
|
+
{
|
|
4166
|
+
"name": "required",
|
|
4167
|
+
"description": "Set whether the textarea is required or not. Please note that this is required for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
4168
|
+
},
|
|
4169
|
+
{
|
|
4170
|
+
"name": "role",
|
|
4171
|
+
"description": "Defines a specific role attribute for the input."
|
|
4172
|
+
},
|
|
4173
|
+
{
|
|
4174
|
+
"name": "theme",
|
|
4175
|
+
"description": "Theme of the textarea.",
|
|
4176
|
+
"values": [
|
|
4177
|
+
{
|
|
4178
|
+
"name": "default"
|
|
4179
|
+
},
|
|
4180
|
+
{
|
|
4181
|
+
"name": "turva"
|
|
4182
|
+
}
|
|
4183
|
+
]
|
|
4184
|
+
},
|
|
4185
|
+
{
|
|
4186
|
+
"name": "tooltip",
|
|
4187
|
+
"description": "Tooltip to display next to the label of the input."
|
|
4188
|
+
},
|
|
4189
|
+
{
|
|
4190
|
+
"name": "tooltip-direction",
|
|
4191
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
4192
|
+
"values": [
|
|
4193
|
+
{
|
|
4194
|
+
"name": "auto"
|
|
4195
|
+
},
|
|
4196
|
+
{
|
|
4197
|
+
"name": "left"
|
|
4198
|
+
},
|
|
4199
|
+
{
|
|
4200
|
+
"name": "right"
|
|
4201
|
+
}
|
|
4202
|
+
]
|
|
4203
|
+
},
|
|
4204
|
+
{
|
|
4205
|
+
"name": "value",
|
|
4206
|
+
"description": "Value of the textarea."
|
|
4207
|
+
}
|
|
4208
|
+
],
|
|
4209
|
+
"references": [
|
|
4210
|
+
{
|
|
4211
|
+
"name": "Source code",
|
|
4212
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-textarea/duet-textarea.tsx"
|
|
4213
|
+
}
|
|
4214
|
+
]
|
|
4215
|
+
},
|
|
4216
|
+
{
|
|
4217
|
+
"name": "duet-toggle",
|
|
4218
|
+
"description": {
|
|
4219
|
+
"kind": "markdown",
|
|
4220
|
+
"value": "---\ntitle: Toggle\nname: duet-toggle\nstatus: ready\nreleased: 1.3.0\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Actions\nintro: Toggles are graphical interface switches that give user control over a\n feature or option that can be turned on or off.\nplatforms: Web only\nexamples:\n - name: toggle\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Checked toggle\n file: fixtures/duet-toggle_checked_toggle.html\n - name: Unchecked toggle\n file: fixtures/duet-toggle_unchecked_toggle.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
4221
|
+
},
|
|
4222
|
+
"attributes": [
|
|
4223
|
+
{
|
|
4224
|
+
"name": "accessible-active-descendant",
|
|
4225
|
+
"description": "Indicates the id of a related component’s visually focused element."
|
|
4226
|
+
},
|
|
4227
|
+
{
|
|
4228
|
+
"name": "accessible-controls",
|
|
4229
|
+
"description": "Use this prop to add an aria-controls attribute. Use the attribute to indicate\nthe id of a component controlled by this component."
|
|
4230
|
+
},
|
|
4231
|
+
{
|
|
4232
|
+
"name": "accessible-described-by",
|
|
4233
|
+
"description": "Indicates the id of a component that describes the toggle."
|
|
4234
|
+
},
|
|
4235
|
+
{
|
|
4236
|
+
"name": "accessible-owns",
|
|
4237
|
+
"description": "Indicates the id of a component owned by the toggle."
|
|
4238
|
+
},
|
|
4239
|
+
{
|
|
4240
|
+
"name": "checked",
|
|
4241
|
+
"description": "Check state of the checkbox."
|
|
4242
|
+
},
|
|
4243
|
+
{
|
|
4244
|
+
"name": "disabled",
|
|
4245
|
+
"description": "Makes the input component disabled. This prevents users from being able to\ninteract with the input, and conveys its inactive state to assistive technologies."
|
|
4246
|
+
},
|
|
4247
|
+
{
|
|
4248
|
+
"name": "identifier",
|
|
4249
|
+
"description": "Adds a unique identifier for the checkbox."
|
|
4250
|
+
},
|
|
4251
|
+
{
|
|
4252
|
+
"name": "label",
|
|
4253
|
+
"description": "Label for the toggle."
|
|
4254
|
+
},
|
|
4255
|
+
{
|
|
4256
|
+
"name": "margin",
|
|
4257
|
+
"description": "Controls the margin of the component.",
|
|
4258
|
+
"values": [
|
|
4259
|
+
{
|
|
4260
|
+
"name": "auto"
|
|
4261
|
+
},
|
|
4262
|
+
{
|
|
4263
|
+
"name": "none"
|
|
4264
|
+
}
|
|
4265
|
+
]
|
|
4266
|
+
},
|
|
4267
|
+
{
|
|
4268
|
+
"name": "name",
|
|
4269
|
+
"description": "Name of the checkbox."
|
|
4270
|
+
},
|
|
4271
|
+
{
|
|
4272
|
+
"name": "required",
|
|
4273
|
+
"description": "Set whether the input is required or not. Please note that this is necessary for\naccessible inputs when the user is required to fill them. When using this property\nyou need to also set “novalidate” attribute to your form element to prevent\nbrowser from displaying its own validation errors."
|
|
4274
|
+
},
|
|
4275
|
+
{
|
|
4276
|
+
"name": "role",
|
|
4277
|
+
"description": "Defines a specific role attribute for the input."
|
|
4278
|
+
},
|
|
4279
|
+
{
|
|
4280
|
+
"name": "theme",
|
|
4281
|
+
"description": "Theme of the card.",
|
|
4282
|
+
"values": [
|
|
4283
|
+
{
|
|
4284
|
+
"name": "default"
|
|
4285
|
+
},
|
|
4286
|
+
{
|
|
4287
|
+
"name": "turva"
|
|
4288
|
+
}
|
|
4289
|
+
]
|
|
4290
|
+
},
|
|
4291
|
+
{
|
|
4292
|
+
"name": "value",
|
|
4293
|
+
"description": "The value of the checkbox does not mean if it's checked or not, use the checked\nproperty for that."
|
|
4294
|
+
}
|
|
4295
|
+
],
|
|
4296
|
+
"references": [
|
|
4297
|
+
{
|
|
4298
|
+
"name": "Source code",
|
|
4299
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-toggle/duet-toggle.tsx"
|
|
4300
|
+
}
|
|
4301
|
+
]
|
|
4302
|
+
},
|
|
4303
|
+
{
|
|
4304
|
+
"name": "duet-tooltip",
|
|
4305
|
+
"description": {
|
|
4306
|
+
"kind": "markdown",
|
|
4307
|
+
"value": "---\ntitle: Tooltip\nname: duet-tooltip\nstatus: ready\nreleased: 1.5.0\ninternationalization: Supported\nplatforms: Web only\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Messaging\nintro: Tooltips are floating labels that briefly explain the function of a user\n interface element. They can be triggered when user clicks or navigates to it\n via keyboard.\ndescription: Please keep in mind that when the screen width is under 768px this\n component should always be positioned on the right side of the screen as it’s\n going to open towards left.\nexample_height: 400px\nexamples:\n - name: tooltip\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default tooltip\n file: fixtures/duet-tooltip_default_tooltip.html\n - name: Tooltip with a label\n file: fixtures/duet-tooltip_tooltip_with_a_label.html\n - name: Tooltip in input\n file: fixtures/duet-tooltip_tooltip_in_input.html\n - name: Tooltip using large breakpoint\n file: fixtures/duet-tooltip_tooltip_using_large_breakpoint.html\n - name: Tooltip that always opens to right\n file: fixtures/duet-tooltip_tooltip_that_always_opens_to_right.html\n - name: Tooltip that always opens to left\n file: fixtures/duet-tooltip_tooltip_that_always_opens_to_left.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
4308
|
+
},
|
|
4309
|
+
"attributes": [
|
|
4310
|
+
{
|
|
4311
|
+
"name": "accessible-close-label",
|
|
4312
|
+
"description": "Adds accessible label for the close icon that is only shown for screen\nreaders. This property is always required to create an accessibly interface!"
|
|
4313
|
+
},
|
|
4314
|
+
{
|
|
4315
|
+
"name": "accessible-close-label-default",
|
|
4316
|
+
"description": "Default language strings for the accessibleCloseLabel"
|
|
4317
|
+
},
|
|
4318
|
+
{
|
|
4319
|
+
"name": "accessible-label",
|
|
4320
|
+
"description": "Adds accessible label for the info icon that is only shown for screen\nreaders. This property is always required to create an accessible interface!"
|
|
4321
|
+
},
|
|
4322
|
+
{
|
|
4323
|
+
"name": "accessible-label-default",
|
|
4324
|
+
"description": "Default language strings for the accessibleLabel"
|
|
4325
|
+
},
|
|
4326
|
+
{
|
|
4327
|
+
"name": "active",
|
|
4328
|
+
"description": "Toggle whether the tooltip is initially visible or not. This property should\nnot be used in production in most cases."
|
|
4329
|
+
},
|
|
4330
|
+
{
|
|
4331
|
+
"name": "breakpoint",
|
|
4332
|
+
"description": "Adjust the responsive breakpoint where tooltip starts opening towards left.",
|
|
4333
|
+
"values": [
|
|
4334
|
+
{
|
|
4335
|
+
"name": "large"
|
|
4336
|
+
},
|
|
4337
|
+
{
|
|
4338
|
+
"name": "medium"
|
|
4339
|
+
}
|
|
4340
|
+
]
|
|
4341
|
+
},
|
|
4342
|
+
{
|
|
4343
|
+
"name": "direction",
|
|
4344
|
+
"description": "With direction setting you can force the tooltip to always open towards left\nor right instead of automatically determining the direction.",
|
|
4345
|
+
"values": [
|
|
4346
|
+
{
|
|
4347
|
+
"name": "auto"
|
|
4348
|
+
},
|
|
4349
|
+
{
|
|
4350
|
+
"name": "left"
|
|
4351
|
+
},
|
|
4352
|
+
{
|
|
4353
|
+
"name": "right"
|
|
4354
|
+
}
|
|
4355
|
+
]
|
|
4356
|
+
},
|
|
4357
|
+
{
|
|
4358
|
+
"name": "label",
|
|
4359
|
+
"description": "Label of the tooltip. If used, replaces the accessibleLabel option."
|
|
4360
|
+
},
|
|
4361
|
+
{
|
|
4362
|
+
"name": "language",
|
|
4363
|
+
"description": "The currently active language. This setting changes the accessible labels to match the\nchosen language.",
|
|
4364
|
+
"values": [
|
|
4365
|
+
{
|
|
4366
|
+
"name": "en"
|
|
4367
|
+
},
|
|
4368
|
+
{
|
|
4369
|
+
"name": "fi"
|
|
4370
|
+
},
|
|
4371
|
+
{
|
|
4372
|
+
"name": "sv"
|
|
4373
|
+
}
|
|
4374
|
+
]
|
|
4375
|
+
},
|
|
4376
|
+
{
|
|
4377
|
+
"name": "position-horizontal",
|
|
4378
|
+
"description": "Adjust the horizontal positioning of the tooltip toggle in pixels. Can be a\nnegative value as well. E.g. \"-13px\"."
|
|
4379
|
+
},
|
|
4380
|
+
{
|
|
4381
|
+
"name": "position-vertical",
|
|
4382
|
+
"description": "Adjust the vertical positioning of the tooltip toggle in pixels. Can be a\nnegative value as well. E.g. \"-13px\"."
|
|
4383
|
+
},
|
|
4384
|
+
{
|
|
4385
|
+
"name": "theme",
|
|
4386
|
+
"description": "Theme of the tooltip.",
|
|
4387
|
+
"values": [
|
|
4388
|
+
{
|
|
4389
|
+
"name": "default"
|
|
4390
|
+
},
|
|
4391
|
+
{
|
|
4392
|
+
"name": "turva"
|
|
4393
|
+
}
|
|
4394
|
+
]
|
|
4395
|
+
}
|
|
4396
|
+
],
|
|
4397
|
+
"references": [
|
|
4398
|
+
{
|
|
4399
|
+
"name": "Source code",
|
|
4400
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-tooltip/duet-tooltip.tsx"
|
|
4401
|
+
}
|
|
4402
|
+
]
|
|
4403
|
+
},
|
|
4404
|
+
{
|
|
4405
|
+
"name": "duet-tray",
|
|
4406
|
+
"description": {
|
|
4407
|
+
"kind": "markdown",
|
|
4408
|
+
"value": "---\ntitle: Tray\nname: duet-tray\nstatus: ready\nreleased: 4.2.0\nplatforms: Web only\ninternationalization: Supported\naccessibility: Keyboard, Screen Reader\nssr: Supported\nexample_height: 450px\ncategory: Forms\nintro: Tray component is used to reveal additional information on a small\n viewport, that would normally be shown in the sticky sidebar of the <a\n href=\"/components/layout/\">Layout</a> component.\ndescription: While many of the below examples show Tray on desktop viewports,\n this component is primarily meant to be used on mobile viewports where the\n main navigation bar isn’t visible. For more usage examples in real context,\n please see <a href=\"/templates/stepper-components/\">Stepper template</a>.\nexamples:\n - name: tray\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Tray that shows on all viewports\n file: fixtures/duet-tray_tray_that_shows_on_all_viewports.html\n - name: Tray that only shows on small viewports\n file: fixtures/duet-tray_tray_that_only_shows_on_small_viewports.html\n - name: Dismissible tray\n file: fixtures/duet-tray_dismissible_tray.html\n - name: Tray with expandable section\n file: fixtures/duet-tray_tray_with_expandable_section.html\n - name: Scroll to element on tray click\n file: fixtures/duet-tray_scroll_to_element_on_tray_click.html\ntags:\n - docs-components\n\n---\n\n<!-- usage -->"
|
|
4409
|
+
},
|
|
4410
|
+
"attributes": [
|
|
4411
|
+
{
|
|
4412
|
+
"name": "accessible-close-label",
|
|
4413
|
+
"description": "Accessible label that is shown for screen reader users in the expandable\nclose toggle. Not visible for normal users."
|
|
4414
|
+
},
|
|
4415
|
+
{
|
|
4416
|
+
"name": "accessible-close-label-default",
|
|
4417
|
+
"description": "Defaults for accessibleCloseLabel"
|
|
4418
|
+
},
|
|
4419
|
+
{
|
|
4420
|
+
"name": "accessible-open-label",
|
|
4421
|
+
"description": "Accessible label that is shown for screen reader users in the expandable\nopen toggle. Not visible for normal users."
|
|
4422
|
+
},
|
|
4423
|
+
{
|
|
4424
|
+
"name": "accessible-open-label-default",
|
|
4425
|
+
"description": "Defaults for accessibleOpenLabel"
|
|
4426
|
+
},
|
|
4427
|
+
{
|
|
4428
|
+
"name": "active",
|
|
4429
|
+
"description": "Toggle whether the info panel is visible or not. You can use this\nproperty e.g. when pricing information is revealed to the user."
|
|
4430
|
+
},
|
|
4431
|
+
{
|
|
4432
|
+
"name": "auto-hide",
|
|
4433
|
+
"description": "Hide the info panel when user scrolls back to the top of the viewport."
|
|
4434
|
+
},
|
|
4435
|
+
{
|
|
4436
|
+
"name": "language",
|
|
4437
|
+
"description": "The currently active language. This setting changes the accessible labels to match the\nchosen language.",
|
|
4438
|
+
"values": [
|
|
4439
|
+
{
|
|
4440
|
+
"name": "en"
|
|
4441
|
+
},
|
|
4442
|
+
{
|
|
4443
|
+
"name": "fi"
|
|
4444
|
+
},
|
|
4445
|
+
{
|
|
4446
|
+
"name": "sv"
|
|
4447
|
+
}
|
|
4448
|
+
]
|
|
4449
|
+
},
|
|
4450
|
+
{
|
|
4451
|
+
"name": "responsive",
|
|
4452
|
+
"description": "Enable or disable the automatic responsive behaviour which\nmakes the info panel hide on larger viewports. Settings this to\n\"false\" means that the header panel is visible on all device sizes."
|
|
4453
|
+
},
|
|
4454
|
+
{
|
|
4455
|
+
"name": "theme",
|
|
4456
|
+
"description": "Theme of the info panel.",
|
|
4457
|
+
"values": [
|
|
4458
|
+
{
|
|
4459
|
+
"name": "default"
|
|
4460
|
+
},
|
|
4461
|
+
{
|
|
4462
|
+
"name": "turva"
|
|
4463
|
+
}
|
|
4464
|
+
]
|
|
4465
|
+
}
|
|
4466
|
+
],
|
|
4467
|
+
"references": [
|
|
4468
|
+
{
|
|
4469
|
+
"name": "Source code",
|
|
4470
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-tray/duet-tray.tsx"
|
|
4471
|
+
}
|
|
4472
|
+
]
|
|
4473
|
+
},
|
|
4474
|
+
{
|
|
4475
|
+
"name": "duet-visually-hidden",
|
|
4476
|
+
"description": {
|
|
4477
|
+
"kind": "markdown",
|
|
4478
|
+
"value": "---\ntitle: Visually Hidden\nname: duet-visually-hidden\nstatus: ready\nreleased: 1.0.28\naccessibility: Keyboard, Screen Reader\nssr: Supported\ncategory: Text\nintro: Visually Hidden is used when an element needs to be available to\n assistive technology, but otherwise hidden.\ndescription: The visually hidden component hides text visually from screen, but\n keeps it available to assistive technologies, such as screen readers. The\n component shouldn’t be used to hide interactive content.\nplatforms: Web only\ntags:\n - docs-components\nexamples:\n - name: visually hidden\n code: This first example creates the actual URL and DOCS, hence it needs to be\n here.\n - name: Default visually hidden\n file: fixtures/duet-visually-hidden_default_visually_hidden.html\n\n---\n\n<!-- usage -->"
|
|
4479
|
+
},
|
|
4480
|
+
"attributes": [],
|
|
4481
|
+
"references": [
|
|
4482
|
+
{
|
|
4483
|
+
"name": "Source code",
|
|
4484
|
+
"url": "./https:/lt-devtool.visualstudio.com/_git/Duet%20Design%20System?path=/packages/components/src/components/duet-visually-hidden/duet-visually-hidden.tsx"
|
|
4485
|
+
}
|
|
4486
|
+
]
|
|
4487
|
+
}
|
|
4488
|
+
]
|
|
4489
|
+
}
|