feat(pie-checkbox-group): DSW-1937 a11y improvements

justeattakeaway · Jul 26, 2024 · 5952f4d · 5952f4d
1 parent 994ddc7
commit 5952f4d
Show file tree

Hide file tree

Showing 14 changed files with 96 additions and 26 deletions.
diff --git a/.changeset/heavy-moles-appear.md b/.changeset/heavy-moles-appear.md
@@ -0,0 +1,5 @@
+---
+"@justeattakeaway/pie-assistive-text": minor
+---
+
+[Added] - New `isVisuallyHidden` prop.
diff --git a/.changeset/hot-dingos-joke.md b/.changeset/hot-dingos-joke.md
@@ -0,0 +1,7 @@
+---
+"@justeattakeaway/pie-checkbox-group": minor
+---
+
+[Added] - New `pie-checkbox-group-error` custom event dispatcher.
+[Added] - When in error state component sets `assistiveText` prop for slotted PIE Checkboxes.
+[Changed] - Limited `_slottedChildren` query to pie-checkbox custom elements.
diff --git a/.changeset/swift-emus-wonder.md b/.changeset/swift-emus-wonder.md
@@ -0,0 +1,6 @@
+---
+"@justeattakeaway/pie-checkbox": minor
+---
+
+[Added] - `visuallyHiddenError` private state and logic to hide pie-assistive-text visually.
+[Added] - event listener for `pie-checkbox-group-error` custom event.
diff --git a/.changeset/two-lemons-appear.md b/.changeset/two-lemons-appear.md
@@ -0,0 +1,5 @@
+---
+"pie-docs": patch
+---
+
+[Updated] - PIE Assistive Text component props json
diff --git a/apps/pie-docs/src/components/assistive-text/code/props.json b/apps/pie-docs/src/components/assistive-text/code/props.json
@@ -23,6 +23,20 @@
           "default"
         ]
       }
+    ],
+    [
+      "isVisuallyHidden",
+      {
+        "type": "code",
+        "item": ["true", "false"]
+      },
+      "If true, hides the component visually but leaves it accessible for a11y technologies.",
+      {
+        "type": "code",
+        "item": [
+          false
+        ]
+      }
     ]
   ]
 }
diff --git a/apps/pie-storybook/stories/pie-checkbox.stories.ts b/apps/pie-storybook/stories/pie-checkbox.stories.ts
@@ -2,13 +2,14 @@ import { html } from 'lit';
 import { ifDefined } from 'lit/directives/if-defined.js';
 /* eslint-disable import/no-duplicates */
 import '@justeattakeaway/pie-checkbox';
-import { CheckboxProps, defaultProps, statusTypes } from '@justeattakeaway/pie-checkbox';
+import { CheckboxProps as CheckboxBaseProps, defaultProps, statusTypes } from '@justeattakeaway/pie-checkbox';
 /* eslint-enable import/no-duplicates */
 
 import { action } from '@storybook/addon-actions';
-import { type StoryMeta } from '../types';
+import { type StoryMeta, SlottedComponentProps } from '../types';
 import { createStory, type TemplateFunction, sanitizeAndRenderHTML } from '../utilities';
 
+type CheckboxProps = SlottedComponentProps<CheckboxBaseProps>;
 type CheckboxStoryMeta = StoryMeta<CheckboxProps>;
 
 const defaultArgs: CheckboxProps = {

diff --git a/packages/components/pie-assistive-text/README.md b/packages/components/pie-assistive-text/README.md
@@ -12,11 +12,9 @@
 
 1. [Introduction](#pie-assistive-text)
 2. [Installation](#installation)
-3. [Importing the component](#importing-the-component)
-4. [Peer Dependencies](#peer-dependencies)
-5. [Props](#props)
-6. [Slots](#slots)
-6. [Contributing](#contributing)
+3. [Documentation](#documentation)
+4. [Questions](#questions)
+5. [Contributing](#contributing)
 
 ## pie-assistive-text
 

diff --git a/packages/components/pie-assistive-text/src/assistive-text.scss b/packages/components/pie-assistive-text/src/assistive-text.scss
@@ -27,3 +27,7 @@
         display: inline-flex;
     }
 }
+
+.c-assistiveText--isVisuallyHidden {
+    @include p.visually-hidden;
+}
diff --git a/packages/components/pie-assistive-text/src/defs.ts b/packages/components/pie-assistive-text/src/defs.ts
@@ -7,10 +7,16 @@ export interface AssistiveTextProps {
      * What variant the assistive text should be such as default, error or success.
      */
     variant?: typeof variants[number];
+
+     /**
+     * If true, hides the component visually but leaves it accessible for a11y technologies.
+     */
+    isVisuallyHidden?: boolean;
 }
 
 export type DefaultProps = ComponentDefaultProps<AssistiveTextProps>;
 
 export const defaultProps: DefaultProps = {
     variant: 'default',
+    isVisuallyHidden: false,
 };
diff --git a/packages/components/pie-assistive-text/src/index.ts b/packages/components/pie-assistive-text/src/index.ts
@@ -4,7 +4,7 @@ import {
 
 import { property } from 'lit/decorators.js';
 import { validPropertyValues, defineCustomElement } from '@justeattakeaway/pie-webc-core';
-import { ifDefined } from 'lit/directives/if-defined.js';
+import { classMap } from 'lit/directives/class-map.js';
 import '@justeattakeaway/pie-icons-webc/dist/IconAlertCircle.js';
 import '@justeattakeaway/pie-icons-webc/dist/IconCheckCircle.js';
 
@@ -23,12 +23,15 @@ const componentSelector = 'pie-assistive-text';
 export class PieAssistiveText extends LitElement implements AssistiveTextProps {
     @property({ type: String })
     @validPropertyValues(componentSelector, variants, defaultProps.variant)
-    public variant?: AssistiveTextProps['variant'] = defaultProps.variant;
+    public variant = defaultProps.variant;
+
+    @property({ type: Boolean })
+    public isVisuallyHidden = defaultProps.isVisuallyHidden;
 
     /**
- * Renders the assistive-text icon content.
- * @private
- */
+     * Renders the assistive-text icon content.
+     * @private
+     */
     private renderIcon (): TemplateResult {
         const { variant } = this;
         return html`
@@ -39,13 +42,19 @@ export class PieAssistiveText extends LitElement implements AssistiveTextProps {
     render () {
         const {
             variant,
+            isVisuallyHidden,
         } = this;
 
+        const classes = {
+            'c-assistiveText': true,
+            'c-assistiveText--isVisuallyHidden': isVisuallyHidden,
+        };
+
         return html`
         <p
-            class="c-assistiveText"
+            class="${classMap(classes)}"
             data-test-id="pie-assistive-text"
-            variant=${ifDefined(variant)}>
+            variant=${variant}>
             ${this.renderIcon()}
             <slot></slot>
         </p>`;

diff --git a/packages/components/pie-checkbox-group/README.md b/packages/components/pie-checkbox-group/README.md
@@ -104,6 +104,7 @@ In your markup or JSX, you can then use these to set the properties for the `pie
 | Event | Type | Description |
 |-------|------|-------------|
 | `pie-checkbox-group-disabled` | `CustomEvent` | Triggered after the disabled state of the checkbox group changes. |
+| `pie-checkbox-group-error` | `CustomEvent` | Triggered after the state of the checkbox group changes to error. |
 
 ## Contributing
 

diff --git a/packages/components/pie-checkbox-group/src/defs.ts b/packages/components/pie-checkbox-group/src/defs.ts
@@ -40,6 +40,7 @@ export interface CheckboxGroupProps {
  * @constant
  */
 export const ON_CHECKBOX_GROUP_DISABLED = 'pie-checkbox-group-disabled';
+export const ON_CHECKBOX_GROUP_ERROR = 'pie-checkbox-group-error';
 
 export type DefaultProps = ComponentDefaultProps<CheckboxGroupProps, 'status' | 'disabled' | 'isInline'>;
 

diff --git a/packages/components/pie-checkbox-group/src/index.ts b/packages/components/pie-checkbox-group/src/index.ts
@@ -13,6 +13,7 @@ import { classMap } from 'lit/directives/class-map.js';
 import styles from './checkbox-group.scss?inline';
 import {
     ON_CHECKBOX_GROUP_DISABLED,
+    ON_CHECKBOX_GROUP_ERROR,
     CheckboxGroupProps,
     defaultProps,
     statusTypes,
@@ -29,6 +30,7 @@ const assistiveTextId = 'assistive-text';
  * @tagname pie-checkbox-group
  * @slot - Default slot
  * @event {CustomEvent} pie-checkbox-group-disabled - triggered after the disabled state of the checkbox group changes.
+ * @event {CustomEvent} pie-checkbox-group-error - triggered after the state of the checkbox group changes to error.
  */
 export class PieCheckboxGroup extends FormControlMixin(RtlMixin(LitElement)) implements CheckboxGroupProps {
     @property({ type: String })
@@ -50,20 +52,23 @@ export class PieCheckboxGroup extends FormControlMixin(RtlMixin(LitElement)) imp
     @property({ type: Boolean, reflect: true })
     public disabled = defaultProps.disabled;
 
-    @queryAssignedElements({}) _slottedChildren!: Array<HTMLElement>;
+    @queryAssignedElements({ selector: 'pie-checkbox' }) _slottedChildren!: Array<HTMLElement>;
 
     private _handleDisabled () : void {
-        if (this._slottedChildren) {
-            this._slottedChildren.forEach((child) => {
-                child.dispatchEvent(new CustomEvent(ON_CHECKBOX_GROUP_DISABLED, { bubbles: false, composed: false, detail: { disabled: this.disabled } }));
-            });
-        }
+        this._slottedChildren?.forEach((child) => child.dispatchEvent(new CustomEvent(ON_CHECKBOX_GROUP_DISABLED, {
+            bubbles: false, composed: false, detail: { disabled: this.disabled },
+        })));
     }
 
     private _handleStatus () : void {
-        if (this._slottedChildren) {
-            this._slottedChildren.forEach((child) => child.setAttribute('status', this.status));
-        }
+        this._slottedChildren?.forEach((child) => {
+            child.setAttribute('status', this.status);
+
+            if (this.status === 'error' && this.assistiveText) {
+                child.setAttribute('assistiveText', this.assistiveText);
+                child.dispatchEvent(new CustomEvent(ON_CHECKBOX_GROUP_ERROR, { bubbles: false, composed: false, detail: { error: true } }));
+            }
+        });
     }
 
     protected updated (_changedProperties: PropertyValues<this>): void {

diff --git a/packages/components/pie-checkbox/src/index.ts b/packages/components/pie-checkbox/src/index.ts
@@ -21,7 +21,7 @@ import { CheckboxProps, defaultProps, statusTypes } from './defs';
 export * from './defs';
 
 const componentSelector = 'pie-checkbox';
-const assistiveTextIdValue = 'assistive-text';
+const assistiveTextId = 'assistive-text';
 
 /**
  * @tagname pie-checkbox
@@ -34,6 +34,9 @@ export class PieCheckbox extends FormControlMixin(RtlMixin(LitElement)) implemen
     @state()
     private disabledByParent = false;
 
+    @state()
+    private visuallyHiddenError = false;
+
     @property({ type: String })
     public value = defaultProps.value;
 
@@ -69,12 +72,14 @@ export class PieCheckbox extends FormControlMixin(RtlMixin(LitElement)) implemen
         super.connectedCallback();
 
         this.addEventListener('pie-checkbox-group-disabled', (e: CustomEventInit) => { this.disabledByParent = e.detail.disabled; });
+        this.addEventListener('pie-checkbox-group-error', (e: CustomEventInit) => { this.visuallyHiddenError = e.detail.error; });
     }
 
     disconnectedCallback () : void {
         super.disconnectedCallback();
 
         this.removeEventListener('pie-checkbox-group-disabled', (e: CustomEventInit) => { this.disabledByParent = e.detail.disabled; });
+        this.removeEventListener('pie-checkbox-group-error', (e: CustomEventInit) => { this.visuallyHiddenError = e.detail.error; });
     }
 
     /**
@@ -149,6 +154,7 @@ export class PieCheckbox extends FormControlMixin(RtlMixin(LitElement)) implemen
             name,
             disabled,
             disabledByParent,
+            visuallyHiddenError,
             required,
             indeterminate,
             assistiveText,
@@ -174,7 +180,8 @@ export class PieCheckbox extends FormControlMixin(RtlMixin(LitElement)) implemen
                 ?disabled=${componentDisabled}
                 ?required=${required}
                 .indeterminate=${indeterminate}
-                aria-describedby=${ifDefined(assistiveText ? assistiveTextIdValue : undefined)}
+                aria-invalid=${status === 'error' ? 'true' : 'false'}
+                aria-describedby=${ifDefined(assistiveText ? assistiveTextId : undefined)}
                 @change=${this.handleChange}
                 data-test-id="checkbox-input"
             />
@@ -192,8 +199,9 @@ export class PieCheckbox extends FormControlMixin(RtlMixin(LitElement)) implemen
             </label>
             ${assistiveText ? html`
                 <pie-assistive-text
-                    id="${assistiveTextIdValue}"
+                    id="${assistiveTextId}"
                     variant=${status}
+                    isVisuallyHidden=${visuallyHiddenError}
                     data-test-id="pie-checkbox-assistive-text">
                         ${assistiveText}
                 </pie-assistive-text>` : nothing}