@justeattakeaway/pie-switch 2.4.2 → 2.5.1

package/README.md

@@ -36,6 +36,7 @@ Ideally, you should install the component using the **`@justeattakeaway/pie-webc
 | Prop            | Options                                | Description                                                                                                                       | Default     |
 |------------------|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-------------|
 | `checked`        | `true`, `false`                        | Same as the HTML `checked` attribute; indicates whether the switch is on or off.                                                 | `false`     |
+| `defaultChecked` | `true`, `false`                        | Sets the default checked state for the switch. This does not directly set the initial checked state when the page loads, use `checked` for that. If the switch is inside a form which is reset, the `checked` state will be updated to match `defaultChecked`. | `false`     |
 | `disabled`       | `true`, `false`                        | Same as the HTML `disabled` attribute; indicates whether the switch is disabled or not.                                          | `false`     |
 | `required`       | `true`, `false`                        | Same as the HTML `required` attribute; indicates whether the switch must be turned on when submitted as part of a form.          | `false`     |
 | `label`          | —                                      | The label text for the switch.                                                                                                   | —           |

package/custom-elements.json

@@ -35,7 +35,7 @@
           "type": {
             "text": "DefaultProps"
           },
-          "default": "{ checked: false, disabled: false, labelPlacement: 'leading', required: false, value: 'on', }"
+          "default": "{ checked: false, defaultChecked: false, disabled: false, labelPlacement: 'leading', required: false, value: 'on', }"
         }
       ],
       "exports": [
@@ -105,6 +105,13 @@
               "attribute": "checked",
               "reflects": true
             },
+            {
+              "kind": "field",
+              "name": "defaultChecked",
+              "privacy": "public",
+              "attribute": "defaultChecked",
+              "reflects": true
+            },
             {
               "kind": "field",
               "name": "required",
@@ -143,6 +150,14 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "field",
+              "name": "switchBody",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "private"
+            },
             {
               "kind": "field",
               "name": "focusTarget",
@@ -235,6 +250,17 @@
               ],
               "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"
             },
+            {
+              "kind": "method",
+              "name": "formResetCallback",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Called when the containing form is reset.\nResets checked state back to defaultChecked and emits a change event when needed."
+            },
             {
               "kind": "field",
               "name": "validity",
@@ -257,21 +283,12 @@
             },
             {
               "kind": "method",
-              "name": "renderSwitchLabel",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "placement",
-                  "type": {
-                    "text": "SwitchProps['labelPlacement']"
-                  }
-                }
-              ],
-              "description": "If a label is provided, renders it if `labelPlacement` matches the given position.\nIf no label is provided, or `labelPlacement` does not match the given position, nothing is rendered."
+              "name": "renderAriaDescription",
+              "privacy": "private"
             },
             {
               "kind": "method",
-              "name": "renderAriaDescription",
+              "name": "renderSwitchLabel",
               "privacy": "private"
             }
           ],
@@ -313,6 +330,10 @@
               "name": "checked",
               "fieldName": "checked"
             },
+            {
+              "name": "defaultChecked",
+              "fieldName": "defaultChecked"
+            },
             {
               "name": "required",
               "fieldName": "required"

package/dist/index.d.ts

@@ -33,11 +33,13 @@ export declare class PieSwitch extends PieSwitch_base implements SwitchProps, PI
     labelPlacement: "leading" | "trailing";
     aria: SwitchProps['aria'];
     checked: boolean;
+    defaultChecked: boolean;
     required: boolean;
     value: string;
     name: SwitchProps['name'];
     disabled: boolean;
     private input;
+    private switchBody;
     focusTarget: HTMLElement;
     private _abortController;
     private _isAnimationAllowed;
@@ -72,6 +74,11 @@ export declare class PieSwitch extends PieSwitch_base implements SwitchProps, PI
      * https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setCustomValidity
      */
     setCustomValidity(message: string): void;
+    /**
+     * Called when the containing form is reset.
+     * Resets checked state back to defaultChecked and emits a change event when needed.
+     */
+    formResetCallback(): void;
     /**
      * (Read-only) returns a ValidityState with the validity states that this element is in.
      * https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validity
@@ -83,15 +90,9 @@ export declare class PieSwitch extends PieSwitch_base implements SwitchProps, PI
      * https://developer.mozilla.org/en-US/docs/Web/API/HTMLObjectElement/validationMessage
      */
     get validationMessage(): string;
-    /**
-     * 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>;
+    private renderSwitchLabel;
+    render(): TemplateResult;
 }
 
 declare const PieSwitch_base: GenericConstructor<FormControlInterface> & typeof PieElement;
@@ -105,6 +106,11 @@ export declare interface SwitchProps {
      * Same as the HTML checked attribute - indicates whether the switch is on or off
      */
     checked?: boolean;
+    /**
+     * The default checked state of the switch (not necessarily the same as the current checked state).
+     * Used when the switch is part of a form that is reset.
+     */
+    defaultChecked?: boolean;
     /**
      * Same as the HTML required attribute - indicates whether the switch must be turned or not
      */