Skip to content

Adds close tooltips with esc key to meet WCAG #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zoltanszogyenyi merged 3 commits into from
Feb 15, 2023
Merged

Adds close tooltips with esc key to meet WCAG #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e16c68
adds close tooltips with esc key
daveholst Feb 10, 2023
bb6e6b9
adds close popover with esc key
daveholst Feb 11, 2023
7013d46
Add keydown functions to tooltip and popover interfaces
zoltanszogyenyi Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions src/components/popover/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ class Popover implements PopoverInterface {
_options: PopoverOptions;
_popperInstance: PopperInstance;
_clickOutsideEventListener: EventListenerOrEventListenerObject;
_keydownEventListener: EventListenerOrEventListenerObject;
_visible: boolean;

constructor(
Expand Down Expand Up @@ -111,6 +112,27 @@ class Popover implements PopoverInterface {
}
}

_setupKeydownListener() {
this._keydownEventListener = (ev: KeyboardEvent) => {
if (ev.key === 'Escape') {
this.hide();
}
};
document.body.addEventListener(
'keydown',
this._keydownEventListener,
true
);
}

_removeKeydownListener() {
document.body.removeEventListener(
'keydown',
this._keydownEventListener,
true
);
}

_setupClickOutsideListener() {
this._clickOutsideEventListener = (ev: MouseEvent) => {
this._handleClickOutside(ev, this._targetEl);
Expand Down Expand Up @@ -171,6 +193,9 @@ class Popover implements PopoverInterface {
// handle click outside
this._setupClickOutsideListener();

// handle esc keydown
this._setupKeydownListener();

// Update its position
this._popperInstance.update();

Expand All @@ -197,6 +222,9 @@ class Popover implements PopoverInterface {
// handle click outside
this._removeClickOutsideListener();

// handle esc keydown
this._removeKeydownListener();

// set visibility to false
this._visible = false;

Expand Down
3 changes: 3 additions & 0 deletions src/components/popover/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@ export declare interface PopoverInterface {
_options: PopoverOptions;
_popperInstance: PopperInstance;
_clickOutsideEventListener: EventListenerOrEventListenerObject;
_keydownEventListener: EventListenerOrEventListenerObject;

_setupEventListeners(): void;
_setupClickOutsideListener(): void;
_removeClickOutsideListener(): void;
_setupKeydownListener(): void;
_removeKeydownListener(): void;
_handleClickOutside(ev: Event, targetEl: HTMLElement): void;
_getTriggerEvents(
triggerType: PopoverTriggerType
Expand Down
28 changes: 28 additions & 0 deletions src/components/tooltip/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class Tooltip implements TooltipInterface {
_options: TooltipOptions;
_popperInstance: PopperInstance;
_clickOutsideEventListener: EventListenerOrEventListenerObject;
_keydownEventListener: EventListenerOrEventListenerObject;
_visible: boolean;

constructor(
Expand Down Expand Up @@ -95,6 +96,27 @@ class Tooltip implements TooltipInterface {
}
}

_setupKeydownListener() {
this._keydownEventListener = (ev: KeyboardEvent) => {
if (ev.key === 'Escape') {
this.hide();
}
};
document.body.addEventListener(
'keydown',
this._keydownEventListener,
true
);
}

_removeKeydownListener() {
document.body.removeEventListener(
'keydown',
this._keydownEventListener,
true
);
}

_setupClickOutsideListener() {
this._clickOutsideEventListener = (ev: MouseEvent) => {
this._handleClickOutside(ev, this._targetEl);
Expand Down Expand Up @@ -154,6 +176,9 @@ class Tooltip implements TooltipInterface {
// handle click outside
this._setupClickOutsideListener();

// handle esc keydown
this._setupKeydownListener();

// Update its position
this._popperInstance.update();

Expand All @@ -180,6 +205,9 @@ class Tooltip implements TooltipInterface {
// handle click outside
this._removeClickOutsideListener();

// handle esc keydown
this._removeKeydownListener();

// set visibility
this._visible = false;

Expand Down
3 changes: 3 additions & 0 deletions src/components/tooltip/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ export declare interface TooltipInterface {
_options: TooltipOptions;
_popperInstance: PopperInstance;
_clickOutsideEventListener: EventListenerOrEventListenerObject;
_keydownEventListener: EventListenerOrEventListenerObject;

_init(): void;
_setupEventListeners(): void;
_setupClickOutsideListener(): void;
_removeClickOutsideListener(): void;
_setupKeydownListener(): void;
_removeKeydownListener(): void;
_handleClickOutside(ev: Event, targetEl: HTMLElement): void;
_getTriggerEvents(
triggerType: TooltipTriggerType
Expand Down