Improved a11y for Field feedback and Secure Phrase input (#10320)

Co-authored-by: Michael Telatynski <[email protected]>
matrix-org · Mar 8, 2023 · 0c1c3f1 · 0c1c3f1
1 parent f60f7a1
commit 0c1c3f1
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 3 deletions.
diff --git a/src/components/views/dialogs/security/AccessSecretStorageDialog.tsx b/src/components/views/dialogs/security/AccessSecretStorageDialog.tsx
@@ -63,6 +63,7 @@ interface IState {
  */
 export default class AccessSecretStorageDialog extends React.PureComponent<IProps, IState> {
     private fileUpload = React.createRef<HTMLInputElement>();
+    private inputRef = React.createRef<HTMLInputElement>();
 
     public constructor(props: IProps) {
         super(props);
@@ -178,7 +179,10 @@ export default class AccessSecretStorageDialog extends React.PureComponent<IProp
     private onPassPhraseNext = async (ev: FormEvent<HTMLFormElement> | React.MouseEvent): Promise<void> => {
         ev.preventDefault();
 
-        if (this.state.passPhrase.length <= 0) return;
+        if (this.state.passPhrase.length <= 0) {
+            this.inputRef.current?.focus();
+            return;
+        }
 
         this.setState({ keyMatches: null });
         const input = { passphrase: this.state.passPhrase };
@@ -187,6 +191,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent<IProp
             this.props.onFinished(input);
         } else {
             this.setState({ keyMatches });
+            this.inputRef.current?.focus();
         }
     };
 
@@ -351,6 +356,7 @@ export default class AccessSecretStorageDialog extends React.PureComponent<IProp
 
                     <form className="mx_AccessSecretStorageDialog_primaryContainer" onSubmit={this.onPassPhraseNext}>
                         <Field
+                            inputRef={this.inputRef}
                             id="mx_passPhraseInput"
                             className="mx_AccessSecretStorageDialog_passPhraseInput"
                             type="password"

diff --git a/src/components/views/elements/Field.tsx b/src/components/views/elements/Field.tsx
@@ -289,12 +289,20 @@ export default class Field extends React.PureComponent<PropShapes, IState> {
         // Handle displaying feedback on validity
         let fieldTooltip;
         if (tooltipContent || this.state.feedback) {
+            let role: React.AriaRole;
+            if (tooltipContent) {
+                role = "tooltip";
+            } else {
+                role = this.state.valid ? "status" : "alert";
+            }
+
             fieldTooltip = (
                 <Tooltip
                     tooltipClassName={classNames("mx_Field_tooltip", "mx_Tooltip_noMargin", tooltipClassName)}
                     visible={(this.state.focused && forceTooltipVisible) || this.state.feedbackVisible}
                     label={tooltipContent || this.state.feedback}
                     alignment={Tooltip.Alignment.Right}
+                    role={role}
                 />
             );
         }

diff --git a/src/components/views/elements/Tooltip.tsx b/src/components/views/elements/Tooltip.tsx
@@ -51,6 +51,8 @@ export interface ITooltipProps {
     id?: string;
     // If the parent is over this width, act as if it is only this wide
     maxParentWidth?: number;
+    // aria-role passed to the tooltip
+    role?: React.AriaRole;
 }
 
 type State = Partial<Pick<CSSProperties, "display" | "right" | "top" | "transform" | "left">>;
@@ -186,7 +188,7 @@ export default class Tooltip extends React.PureComponent<ITooltipProps, State> {
         style.display = this.props.visible ? "block" : "none";
 
         const tooltip = (
-            <div role="tooltip" className={tooltipClasses} style={style}>
+            <div role={this.props.role || "tooltip"} className={tooltipClasses} style={style}>
                 <div className="mx_Tooltip_chevron" />
                 {this.props.label}
             </div>

diff --git a/test/components/views/dialogs/AccessSecretStorageDialog-test.tsx b/test/components/views/dialogs/AccessSecretStorageDialog-test.tsx
@@ -134,5 +134,7 @@ describe("AccessSecretStorageDialog", () => {
                 "👎 Unable to access secret storage. Please verify that you entered the correct Security Phrase.",
             ),
         ).toBeInTheDocument();
+
+        expect(screen.getByPlaceholderText("Security Phrase")).toHaveFocus();
     });
 });
diff --git a/test/components/views/elements/Field-test.tsx b/test/components/views/elements/Field-test.tsx
@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import React from "react";
-import { render, screen } from "@testing-library/react";
+import { act, fireEvent, render, screen } from "@testing-library/react";
 
 import Field from "../../../../src/components/views/elements/Field";
 
@@ -51,4 +51,61 @@ describe("Field", () => {
             expect(screen.getByRole("textbox")).not.toHaveAttribute("placeholder", "my placeholder");
         });
     });
+
+    describe("Feedback", () => {
+        it("Should mark the feedback as alert if invalid", async () => {
+            render(
+                <Field
+                    value=""
+                    validateOnFocus
+                    onValidate={() => Promise.resolve({ valid: false, feedback: "Invalid" })}
+                />,
+            );
+
+            // When invalid
+            await act(async () => {
+                fireEvent.focus(screen.getByRole("textbox"));
+            });
+
+            // Expect 'alert' role
+            expect(screen.queryByRole("alert")).toBeInTheDocument();
+        });
+
+        it("Should mark the feedback as status if valid", async () => {
+            render(
+                <Field
+                    value=""
+                    validateOnFocus
+                    onValidate={() => Promise.resolve({ valid: true, feedback: "Valid" })}
+                />,
+            );
+
+            // When valid
+            await act(async () => {
+                fireEvent.focus(screen.getByRole("textbox"));
+            });
+
+            // Expect 'status' role
+            expect(screen.queryByRole("status")).toBeInTheDocument();
+        });
+
+        it("Should mark the feedback as tooltip if custom tooltip set", async () => {
+            render(
+                <Field
+                    value=""
+                    validateOnFocus
+                    onValidate={() => Promise.resolve({ valid: true, feedback: "Valid" })}
+                    tooltipContent="Tooltip"
+                />,
+            );
+
+            // When valid or invalid and 'tooltipContent' set
+            await act(async () => {
+                fireEvent.focus(screen.getByRole("textbox"));
+            });
+
+            // Expect 'tooltip' role
+            expect(screen.queryByRole("tooltip")).toBeInTheDocument();
+        });
+    });
 });