Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Tooltip: close field tooltip when ESC is pressed (#12553)
Browse files Browse the repository at this point in the history
* Close field tooltip when ESC is pressed

* Use `Key.ESCAPE`
  • Loading branch information
florianduros authored May 28, 2024
1 parent e8bb241 commit 17ab522
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
24 changes: 22 additions & 2 deletions src/components/views/elements/Field.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,20 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

import React, { InputHTMLAttributes, SelectHTMLAttributes, TextareaHTMLAttributes, RefObject, createRef } from "react";
import React, {
InputHTMLAttributes,
SelectHTMLAttributes,
TextareaHTMLAttributes,
RefObject,
createRef,
KeyboardEvent,
} from "react";
import classNames from "classnames";
import { debounce } from "lodash";

import { IFieldState, IValidationResult } from "./Validation";
import Tooltip from "./Tooltip";
import { Key } from "../../../Keyboard";

// Invoke validation from user input (when typing, etc.) at most once every N ms.
const VALIDATION_THROTTLE_MS = 200;
Expand Down Expand Up @@ -232,6 +240,18 @@ export default class Field extends React.PureComponent<PropShapes, IState> {
return this.props.inputRef ?? this._inputRef;
}

private onKeyDown = (evt: KeyboardEvent<HTMLDivElement>): void => {
// If the tooltip is displayed to show a feedback and Escape is pressed
// The tooltip is hided
if (this.state.feedbackVisible && evt.key === Key.ESCAPE) {
evt.preventDefault();
evt.stopPropagation();
this.setState({
feedbackVisible: false,
});
}
};

public render(): React.ReactNode {
/* eslint @typescript-eslint/no-unused-vars: ["error", { "ignoreRestSiblings": true }] */
const {
Expand Down Expand Up @@ -318,7 +338,7 @@ export default class Field extends React.PureComponent<PropShapes, IState> {
});

return (
<div className={fieldClasses}>
<div className={fieldClasses} onKeyDown={this.onKeyDown}>
{prefixContainer}
{fieldInput}
<label htmlFor={this.id}>{this.props.label}</label>
Expand Down
12 changes: 12 additions & 0 deletions test/components/views/elements/Field-test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ describe("Field", () => {

// Expect 'alert' role
expect(screen.queryByRole("alert")).toBeInTheDocument();

// Close the feedback is Escape is pressed
fireEvent.keyDown(screen.getByRole("textbox"), { key: "Escape" });
expect(screen.queryByRole("alert")).toBeNull();
});

it("Should mark the feedback as status if valid", async () => {
Expand All @@ -87,6 +91,10 @@ describe("Field", () => {

// Expect 'status' role
expect(screen.queryByRole("status")).toBeInTheDocument();

// Close the feedback is Escape is pressed
fireEvent.keyDown(screen.getByRole("textbox"), { key: "Escape" });
expect(screen.queryByRole("status")).toBeNull();
});

it("Should mark the feedback as tooltip if custom tooltip set", async () => {
Expand All @@ -106,6 +114,10 @@ describe("Field", () => {

// Expect 'tooltip' role
expect(screen.queryByRole("tooltip")).toBeInTheDocument();

// Close the feedback is Escape is pressed
fireEvent.keyDown(screen.getByRole("textbox"), { key: "Escape" });
expect(screen.queryByRole("tooltip")).toBeNull();
});
});
});

0 comments on commit 17ab522

Please sign in to comment.