@justeattakeaway/pie-switch 0.29.11 → 0.30.0

package/custom-elements.json

@@ -35,7 +35,7 @@
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{\n    checked: false,\n    required: false,\n    disabled: false,\n    value: 'on',\n    labelPlacement: 'leading',\n}"
+          "default": "{\r\n    checked: false,\r\n    disabled: false,\r\n    labelPlacement: 'leading',\r\n    required: false,\r\n    value: 'on',\r\n}"
         }
       ],
       "exports": [
@@ -74,19 +74,11 @@
           "description": "",
           "name": "PieSwitch",
           "members": [
-            {
-              "kind": "field",
-              "name": "input",
-              "type": {
-                "text": "HTMLInputElement | undefined"
-              },
-              "privacy": "private"
-            },
             {
               "kind": "field",
               "name": "label",
               "type": {
-                "text": "string | undefined"
+                "text": "SwitchProps['label']"
               },
               "privacy": "public",
               "attribute": "label"
@@ -94,9 +86,6 @@
             {
               "kind": "field",
               "name": "labelPlacement",
-              "type": {
-                "text": "SwitchProps['labelPlacement']"
-              },
               "privacy": "public",
               "attribute": "labelPlacement"
             },
@@ -104,7 +93,7 @@
               "kind": "field",
               "name": "aria",
               "type": {
-                "text": "AriaProps"
+                "text": "SwitchProps['aria']"
               },
               "privacy": "public",
               "attribute": "aria"
@@ -133,7 +122,7 @@
               "kind": "field",
               "name": "name",
               "type": {
-                "text": "string | undefined"
+                "text": "SwitchProps['name']"
               },
               "privacy": "public",
               "attribute": "name"
@@ -145,6 +134,14 @@
               "attribute": "disabled",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "input",
+              "type": {
+                "text": "HTMLInputElement | undefined"
+              },
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "focusTarget",
@@ -188,7 +185,7 @@
                   "text": ""
                 }
               },
-              "description": "Returns a boolean value which indicates validity of the value of the component. If the value is invalid, this method also fires the invalid event on the component.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity"
+              "description": "Returns a boolean value which indicates validity of the value of the component. If the value is invalid, this method also fires the invalid event on the component.\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/checkValidity"
             },
             {
               "kind": "method",
@@ -199,7 +196,7 @@
                   "text": ""
                 }
               },
-              "description": "If the value is invalid, this method also fires the invalid event on the element, and (if the event isn't canceled) reports the problem to the user.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity"
+              "description": "If the value is invalid, this method also fires the invalid event on the element, and (if the event isn't canceled) reports the problem to the user.\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/reportValidity"
             },
             {
               "kind": "method",
@@ -218,7 +215,7 @@
                   }
                 }
               ],
-              "description": "Allows a consumer to set a custom validation message on the switch. An empty string counts as valid.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity"
+              "description": "Allows a consumer to set a custom validation message on the switch. An empty string counts as valid.\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity"
             },
             {
               "kind": "field",
@@ -227,7 +224,7 @@
                 "text": "ValidityState"
               },
               "privacy": "public",
-              "description": "(Read-only) returns a ValidityState with the validity states that this element is in.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validity",
+              "description": "(Read-only) returns a ValidityState with the validity states that this element is in.\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validity",
               "readonly": true
             },
             {
@@ -237,19 +234,27 @@
                 "text": "string"
               },
               "privacy": "public",
-              "description": "(Read-only) Returns a string representing a localized message that describes the validation constraints that the control does not satisfy (if any).\nThis string is empty if the component is valid.\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validationMessage",
+              "description": "(Read-only) Returns a string representing a localized message that describes the validation constraints that the control does not satisfy (if any).\r\nThis string is empty if the component is valid.\r\nhttps://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validationMessage",
               "readonly": true
             },
             {
               "kind": "method",
               "name": "renderSwitchLabel",
               "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "TemplateResult"
+              "parameters": [
+                {
+                  "name": "placement",
+                  "type": {
+                    "text": "SwitchProps['labelPlacement']"
+                  }
                 }
-              },
-              "description": "Renders the label for a switch if provided.\nif invalid value is passed, nothing gets rendered"
+              ],
+              "description": "If a label is provided, renders it if `labelPlacement` matches the given position.\r\nIf no label is provided, or `labelPlacement` does not match the given position, nothing is rendered."
+            },
+            {
+              "kind": "method",
+              "name": "renderAriaDescription",
+              "privacy": "private"
             }
           ],
           "events": [
@@ -271,21 +276,18 @@
             {
               "name": "label",
               "type": {
-                "text": "string | undefined"
+                "text": "SwitchProps['label']"
               },
               "fieldName": "label"
             },
             {
               "name": "labelPlacement",
-              "type": {
-                "text": "SwitchProps['labelPlacement']"
-              },
               "fieldName": "labelPlacement"
             },
             {
               "name": "aria",
               "type": {
-                "text": "AriaProps"
+                "text": "SwitchProps['aria']"
               },
               "fieldName": "aria"
             },
@@ -304,7 +306,7 @@
             {
               "name": "name",
               "type": {
-                "text": "string | undefined"
+                "text": "SwitchProps['name']"
               },
               "fieldName": "name"
             },

package/dist/index.d.ts

@@ -4,11 +4,10 @@ import type { FormControlInterface } from '@justeattakeaway/pie-webc-core';
 import type { GenericConstructor } from '@justeattakeaway/pie-webc-core';
 import type { LitElement } from 'lit';
 import type { PIEInputElement } from '@justeattakeaway/pie-webc-core';
-import type { PropertyValues } from 'lit';
 import type { RTLInterface } from '@justeattakeaway/pie-webc-core';
-import type { TemplateResult } from 'lit';
+import type { TemplateResult } from 'lit-html';
 
-export declare type AriaProps = {
+declare type AriaProps = {
     label?: string;
     describedBy?: string;
 };
@@ -17,8 +16,6 @@ export declare type DefaultProps = ComponentDefaultProps<SwitchProps, keyof Omit
 
 export declare const defaultProps: DefaultProps;
 
-export declare type LabelPlacement = typeof labelPlacements[number];
-
 export declare const labelPlacements: readonly ["leading", "trailing"];
 
 /**
@@ -33,18 +30,18 @@ export declare const ON_SWITCH_CHANGED_EVENT = "change";
  * @event {CustomEvent} change - when the switch checked state is changed.
  */
 export declare class PieSwitch extends PieSwitch_base implements SwitchProps, PIEInputElement {
-    private input?;
-    protected firstUpdated(_changedProperties: PropertyValues<this>): void;
-    protected updated(_changedProperties: PropertyValues<this>): void;
-    label?: string;
-    labelPlacement: SwitchProps['labelPlacement'];
-    aria: AriaProps;
+    label: SwitchProps['label'];
+    labelPlacement: "leading" | "trailing";
+    aria: SwitchProps['aria'];
     checked: boolean;
     required: boolean;
     value: string;
-    name?: string;
+    name: SwitchProps['name'];
     disabled: boolean;
+    private input?;
     focusTarget: HTMLElement;
+    protected firstUpdated(): void;
+    protected updated(): void;
     static styles: CSSResult;
     /**
      * Ensures that the form value and validation state are in sync with the component.
@@ -84,12 +81,13 @@ export declare class PieSwitch extends PieSwitch_base implements SwitchProps, PI
      */
     get validationMessage(): string;
     /**
-     * Renders the label for a switch if provided.
-     * if invalid value is passed, nothing gets rendered
+     * If a label is provided, renders it if `labelPlacement` matches the given position.
+     * If no label is provided, or `labelPlacement` does not match the given position, nothing is rendered.
      *
      * @private
      */
     private renderSwitchLabel;
+    private renderAriaDescription;
     render(): TemplateResult<1>;
 }
 
@@ -119,7 +117,7 @@ export declare interface SwitchProps {
     /**
      * The placement of the label such as leading or trailing
      */
-    labelPlacement?: LabelPlacement;
+    labelPlacement?: typeof labelPlacements[number];
     /**
      * Same as the HTML name attribute - indicates the name of the switch (for use with forms)
      */