@duetds/components 10.0.0-alpha.13 → 10.0.0-alpha.14

package/lib/collection/components/duet-toolbar-item/duet-toolbar-item.js

@@ -9,18 +9,47 @@ import { getAccessibleLinkLabel } from "../../utils/a11y-utils";
 import { connectLanguageChangeObserver, disconnectLanguageChangeObserver, getLocaleString, } from "../../utils/language-utils";
 export class DuetToolbarItem {
     constructor() {
+        /**
+         * Theme.
+         */
         this.theme = "";
+        /**
+         * Variation. Secondary is not supported for Turva theme. Negative is deprecated.
+         */
         this.variation = "default";
+        /**
+         * Active
+         */
         this.active = false;
-        this.url = undefined;
+        /**
+         * Left icon.
+         */
         this.leadingIcon = undefined;
+        /**
+         * Right icon.
+         */
         this.trailingIcon = undefined;
-        this.accessibleLabel = undefined;
-        this.accessibleExpanded = undefined;
+        /**
+         * Use this property to add an aria-haspopup attribute to a button.
+         */
         this.accessiblePopup = "false";
+        /**
+         * Defaults for accessibleLabelExternal
+         * @default {fi: "Avautuu uuteen ikkunaan",sv: "Öppnas i nytt fönster",en: "Opens in a new window"}
+         */
         this.accessibleLabelExternalDefaults = DuetStringsExternalDefaults;
+        /**
+         * Adds accessible label for tooltip that is shown in external link (url & external have both been set)
+         * @default {fi: "Avautuu uuteen ikkunaan",sv: "Öppnas i nytt fönster",en: "Opens in a new window"}
+         */
         this.accessibleLabelExternal = getLocaleString(this.accessibleLabelExternalDefaults);
+        /**
+         * Forces URL to open in a new browser tab. Used together with URL prop.
+         */
         this.external = false;
+        /**
+         * Show a badge that indicates something has changed.
+         */
         this.badge = false;
     }
     /**
@@ -85,6 +114,7 @@ export class DuetToolbarItem {
         return {
             "theme": {
                 "type": "string",
+                "attribute": "theme",
                 "mutable": true,
                 "complexType": {
                     "original": "DuetTheme",
@@ -105,12 +135,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "theme",
                 "reflect": false,
                 "defaultValue": "\"\""
             },
             "variation": {
                 "type": "string",
+                "attribute": "variation",
                 "mutable": true,
                 "complexType": {
                     "original": "\"default\" | \"primary\" | \"negative\" | \"secondary\"",
@@ -125,12 +155,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "variation",
                 "reflect": false,
                 "defaultValue": "\"default\""
             },
             "active": {
                 "type": "boolean",
+                "attribute": "active",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -145,12 +175,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "active",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "url": {
                 "type": "string",
+                "attribute": "url",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -165,11 +195,11 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "url",
                 "reflect": false
             },
             "leadingIcon": {
                 "type": "string",
+                "attribute": "leading-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "DuetIconName",
@@ -190,12 +220,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "leading-icon",
                 "reflect": false,
                 "defaultValue": "undefined"
             },
             "trailingIcon": {
                 "type": "string",
+                "attribute": "trailing-icon",
                 "mutable": false,
                 "complexType": {
                     "original": "DuetIconName",
@@ -216,12 +246,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "trailing-icon",
                 "reflect": false,
                 "defaultValue": "undefined"
             },
             "accessibleLabel": {
                 "type": "string",
+                "attribute": "accessible-label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -236,11 +266,11 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-label",
                 "reflect": false
             },
             "accessibleExpanded": {
                 "type": "boolean",
+                "attribute": "accessible-expanded",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -255,11 +285,11 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-expanded",
                 "reflect": true
             },
             "accessiblePopup": {
                 "type": "string",
+                "attribute": "accessible-popup",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -274,12 +304,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-popup",
                 "reflect": true,
                 "defaultValue": "\"false\""
             },
             "accessibleLabelExternalDefaults": {
                 "type": "string",
+                "attribute": "accessible-label-external-default",
                 "mutable": false,
                 "complexType": {
                     "original": "DuetLangObject | string",
@@ -303,12 +333,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-label-external-default",
                 "reflect": false,
                 "defaultValue": "DuetStringsExternalDefaults"
             },
             "accessibleLabelExternal": {
                 "type": "string",
+                "attribute": "accessible-label-external",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -326,12 +356,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-label-external",
                 "reflect": false,
                 "defaultValue": "getLocaleString(this.accessibleLabelExternalDefaults)"
             },
             "external": {
                 "type": "boolean",
+                "attribute": "external",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -346,12 +376,12 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "external",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "badge": {
                 "type": "boolean",
+                "attribute": "badge",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -366,7 +396,6 @@ export class DuetToolbarItem {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "badge",
                 "reflect": false,
                 "defaultValue": "false"
             }

package/lib/collection/components/duet-toolbar-link/duet-toolbar-link.js

@@ -5,12 +5,26 @@ import { h, Host } from "@stencil/core";
 import { inheritGlobalTheme } from "../../common/themeable-component";
 export class DuetToolbarLink {
     constructor() {
+        /**
+         * Theme.
+         */
         this.theme = "";
+        /**
+         * Variation.
+         */
         this.variation = "default";
+        /**
+         * Active
+         */
         this.active = false;
+        /**
+         * Href
+         */
         this.href = "#";
+        /**
+         * Icon
+         */
         this.icon = undefined;
-        this.accessibleLabel = undefined;
     }
     /**
      * Component lifecycle events.
@@ -47,6 +61,7 @@ export class DuetToolbarLink {
         return {
             "theme": {
                 "type": "string",
+                "attribute": "theme",
                 "mutable": true,
                 "complexType": {
                     "original": "DuetTheme",
@@ -67,12 +82,12 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "theme",
                 "reflect": false,
                 "defaultValue": "\"\""
             },
             "variation": {
                 "type": "string",
+                "attribute": "variation",
                 "mutable": true,
                 "complexType": {
                     "original": "\"default\" | \"negative\"",
@@ -87,12 +102,12 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "variation",
                 "reflect": false,
                 "defaultValue": "\"default\""
             },
             "active": {
                 "type": "boolean",
+                "attribute": "active",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -107,12 +122,12 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "active",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "href": {
                 "type": "string",
+                "attribute": "href",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -127,12 +142,12 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "href",
                 "reflect": false,
                 "defaultValue": "\"#\""
             },
             "icon": {
                 "type": "string",
+                "attribute": "icon",
                 "mutable": true,
                 "complexType": {
                     "original": "string",
@@ -147,12 +162,12 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "icon",
                 "reflect": true,
                 "defaultValue": "undefined"
             },
             "accessibleLabel": {
                 "type": "string",
+                "attribute": "accessible-label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -167,7 +182,6 @@ export class DuetToolbarLink {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-label",
                 "reflect": false
             }
         };

package/lib/collection/components/duet-tooltip/duet-tooltip-button.js

@@ -11,11 +11,8 @@ import { subscribeTabbingChange, unsubscribeTabbingChange } from "../../utils/ke
 export class DuetTooltipButton {
     constructor() {
         this.label = "";
-        this.accessibleLabel = undefined;
         this.theme = "";
         this.negative = false;
-        this.active = undefined;
-        this.tooltipId = undefined;
     }
     /**
      * Component lifecycle events.
@@ -63,6 +60,7 @@ export class DuetTooltipButton {
         return {
             "label": {
                 "type": "string",
+                "attribute": "label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -77,12 +75,12 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "label",
                 "reflect": false,
                 "defaultValue": "\"\""
             },
             "accessibleLabel": {
                 "type": "string",
+                "attribute": "accessible-label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -97,11 +95,11 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-label",
                 "reflect": false
             },
             "theme": {
                 "type": "string",
+                "attribute": "theme",
                 "mutable": true,
                 "complexType": {
                     "original": "DuetTheme",
@@ -122,12 +120,12 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "theme",
                 "reflect": false,
                 "defaultValue": "\"\""
             },
             "negative": {
                 "type": "boolean",
+                "attribute": "negative",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -142,12 +140,12 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "negative",
                 "reflect": false,
                 "defaultValue": "false"
             },
             "active": {
                 "type": "boolean",
+                "attribute": "active",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -162,11 +160,11 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "active",
                 "reflect": false
             },
             "tooltipId": {
                 "type": "string",
+                "attribute": "tooltip-id",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -181,7 +179,6 @@ export class DuetTooltipButton {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "tooltip-id",
                 "reflect": false
             }
         };

package/lib/collection/components/duet-tooltip/duet-tooltip-popup.js

@@ -12,15 +12,13 @@ import { Teleport } from "../../utils/teleport";
  */
 export class DuetTooltipPopup {
     constructor() {
+        /**
+         * Theme of the tooltip.
+         */
+        this.theme = "";
         this.handleCloseClick = () => {
             this.tooltipPopupClosed.emit();
         };
-        this.theme = "";
-        this.active = undefined;
-        this.tooltipId = undefined;
-        this.arrowStyles = undefined;
-        this.placement = undefined;
-        this.accessibleCloseLabel = undefined;
     }
     /**
      * Component lifecycle events.
@@ -75,6 +73,7 @@ export class DuetTooltipPopup {
         return {
             "theme": {
                 "type": "string",
+                "attribute": "theme",
                 "mutable": true,
                 "complexType": {
                     "original": "DuetTheme",
@@ -95,12 +94,12 @@ export class DuetTooltipPopup {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "theme",
                 "reflect": false,
                 "defaultValue": "\"\""
             },
             "active": {
                 "type": "boolean",
+                "attribute": "active",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -115,11 +114,11 @@ export class DuetTooltipPopup {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "active",
                 "reflect": false
             },
             "tooltipId": {
                 "type": "string",
+                "attribute": "tooltip-id",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -134,11 +133,11 @@ export class DuetTooltipPopup {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "tooltip-id",
                 "reflect": false
             },
             "arrowStyles": {
                 "type": "unknown",
+                "attribute": "arrow-styles",
                 "mutable": false,
                 "complexType": {
                     "original": "{ top: string | undefined; left: string | undefined }",
@@ -156,6 +155,7 @@ export class DuetTooltipPopup {
             },
             "placement": {
                 "type": "string",
+                "attribute": "placement",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -170,11 +170,11 @@ export class DuetTooltipPopup {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "placement",
                 "reflect": false
             },
             "accessibleCloseLabel": {
                 "type": "string",
+                "attribute": "accessible-close-label",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -189,7 +189,6 @@ export class DuetTooltipPopup {
                 },
                 "getter": false,
                 "setter": false,
-                "attribute": "accessible-close-label",
                 "reflect": false
             }
         };