-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add Esc key support to dismiss tooltips (#5147)
- Loading branch information
Showing
10 changed files
with
313 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
packages/components/src/components/tooltip/tooltip--simple.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /** | ||
| * Copyright IBM Corp. 2016, 2018 | ||
| * | ||
| * This source code is licensed under the Apache-2.0 license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import settings from '../../globals/js/settings'; | ||
| import mixin from '../../globals/js/misc/mixin'; | ||
| import createComponent from '../../globals/js/mixins/create-component'; | ||
| import initComponentBySearch from '../../globals/js/mixins/init-component-by-search'; | ||
| import handles from '../../globals/js/mixins/handles'; | ||
| import eventMatches from '../../globals/js/misc/event-matches'; | ||
| import on from '../../globals/js/misc/on'; | ||
|
|
||
| export default class TooltipSimple extends mixin( | ||
| createComponent, | ||
| initComponentBySearch, | ||
| handles | ||
| ) { | ||
| /** | ||
| * Simple Tooltip. | ||
| * @extends CreateComponent | ||
| * @extends InitComponentBySearch | ||
| * @extends Handles | ||
| * @param {HTMLElement} element - The element functioning as a text field. | ||
| */ | ||
| constructor(element, options) { | ||
| super(element, options); | ||
| this.manage( | ||
| on(this.element.ownerDocument, 'keydown', event => { | ||
| // ESC | ||
| if (event.which === 27) { | ||
| this.allowTooltipVisibility({ visible: false }); | ||
| } | ||
| }) | ||
| ); | ||
| this.manage( | ||
| on(this.element, 'mouseenter', () => | ||
| this.allowTooltipVisibility({ visible: true }) | ||
| ) | ||
| ); | ||
| this.manage( | ||
| on(this.element, 'focus', event => { | ||
| if (eventMatches(event, this.options.selectorTriggerButton)) { | ||
| this.allowTooltipVisibility({ visible: true }); | ||
| } | ||
| }) | ||
| ); | ||
| } | ||
|
|
||
| allowTooltipVisibility = ({ visible }) => { | ||
| const tooltipTriggerButton = this.element.matches( | ||
| this.options.selectorTriggerButton | ||
| ) | ||
| ? this.element | ||
| : this.element.querySelector(this.options.selectorTriggerButton); | ||
|
|
||
| if (!tooltipTriggerButton) { | ||
| return; | ||
| } | ||
|
|
||
| if (visible) { | ||
| tooltipTriggerButton.classList.remove(this.options.classTooltipHidden); | ||
| } else { | ||
| tooltipTriggerButton.classList.add(this.options.classTooltipHidden); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * The component options. | ||
| * | ||
| * If `options` is specified in the constructor, | ||
| * {@linkcode TooltipSimple.create .create()}, | ||
| * or {@linkcode TooltipSimple.init .init()}, | ||
| * properties in this object are overriden for the instance being | ||
| * created and how {@linkcode TooltipSimple.init .init()} works. | ||
| * @property {string} selectorInit The CSS selector to find simple tooltip UIs. | ||
| */ | ||
| static get options() { | ||
| const { prefix } = settings; | ||
| return { | ||
| selectorInit: '[data-tooltip-definition],[data-tooltip-icon]', | ||
| selectorTriggerButton: `.${prefix}--tooltip__trigger.${prefix}--tooltip--a11y`, | ||
| classTooltipHidden: `${prefix}--tooltip--hidden`, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * The map associating DOM element and simple tooltip UI instance. | ||
| * @type {WeakMap} | ||
| */ | ||
| static components /* #__PURE_CLASS_PROPERTY__ */ = new WeakMap(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| import Tooltip from '../../src/components/tooltip/tooltip--simple'; | ||
| import TooltipDefinitionHTML from '../../html/tooltip/tooltip--definition.html'; | ||
| import TooltipIconHTML from '../../html/tooltip/tooltip--icon.html'; | ||
|
|
||
| describe('Test simple tooltip', function() { | ||
| describe('Constructor', function() { | ||
| it('Should throw if root element is not given', function() { | ||
| expect(() => { | ||
| new Tooltip(); | ||
| }).toThrowError( | ||
| TypeError, | ||
| 'DOM element should be given to initialize this widget.' | ||
| ); | ||
| }); | ||
|
|
||
| it('Should throw if root element is not a DOM element', function() { | ||
| expect(() => { | ||
| new Tooltip(document.createTextNode('')); | ||
| }).toThrowError( | ||
| TypeError, | ||
| 'DOM element should be given to initialize this widget.' | ||
| ); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Showing/hiding definition tooltip', function() { | ||
| const container = document.createElement('div'); | ||
| container.innerHTML = TooltipDefinitionHTML; | ||
|
|
||
| const element = container.querySelector('[data-tooltip-definition]'); | ||
| const button = container.querySelector('.bx--tooltip__trigger--definition'); | ||
| let tooltip; | ||
|
|
||
| beforeAll(function() { | ||
| document.body.appendChild(container); | ||
| tooltip = new Tooltip(element); | ||
| }); | ||
|
|
||
| it('Should not have hidden class after mouseenter', function() { | ||
| element.dispatchEvent(new CustomEvent('mouseenter', { bubbles: true })); | ||
| expect(button.classList.contains('bx--tooltip--hidden')).toBe(false); | ||
| }); | ||
|
|
||
| it('Should not have hidden class after focus', function() { | ||
| element.dispatchEvent(new CustomEvent('focus', { bubbles: true })); | ||
| expect(button.classList.contains('bx--tooltip--hidden')).toBe(false); | ||
| }); | ||
|
|
||
| it('Should have hidden class after Esc keydown', function() { | ||
| element.dispatchEvent( | ||
| Object.assign(new CustomEvent('keydown', { bubbles: true }), { | ||
| which: 27, | ||
| }) | ||
| ); | ||
| expect(button.classList.contains('bx--tooltip--hidden')).toBe(true); | ||
| }); | ||
|
|
||
| afterEach(function() { | ||
| button.classList.remove('bx--tooltip--hidden'); | ||
| }); | ||
|
|
||
| afterAll(function() { | ||
| if (document.body.contains(button)) { | ||
| button.parentNode.removeChild(button); | ||
| } | ||
| if (tooltip) { | ||
| tooltip.release(); | ||
| tooltip = null; | ||
| } | ||
| document.body.removeChild(container); | ||
| }); | ||
| }); | ||
|
|
||
| describe('Showing/hiding icon tooltip', function() { | ||
| const container = document.createElement('div'); | ||
| container.innerHTML = TooltipIconHTML; | ||
|
|
||
| const element = container.querySelector('[data-tooltip-icon]'); | ||
| let tooltip; | ||
|
|
||
| beforeAll(function() { | ||
| document.body.appendChild(container); | ||
| tooltip = new Tooltip(element); | ||
| }); | ||
|
|
||
| it('Should not have hidden class after mouseenter', function() { | ||
| element.dispatchEvent(new CustomEvent('mouseenter', { bubbles: true })); | ||
| expect(element.classList.contains('bx--tooltip--hidden')).toBe(false); | ||
| }); | ||
|
|
||
| it('Should not have hidden class after focus', function() { | ||
| element.dispatchEvent(new CustomEvent('focus', { bubbles: true })); | ||
| expect(element.classList.contains('bx--tooltip--hidden')).toBe(false); | ||
| }); | ||
|
|
||
| it('Should have hidden class after Esc keydown', function() { | ||
| element.dispatchEvent( | ||
| Object.assign(new CustomEvent('keydown', { bubbles: true }), { | ||
| which: 27, | ||
| }) | ||
| ); | ||
| expect(element.classList.contains('bx--tooltip--hidden')).toBe(true); | ||
| }); | ||
|
|
||
| afterEach(function() { | ||
| element.classList.remove('bx--tooltip--hidden'); | ||
| }); | ||
|
|
||
| afterAll(function() { | ||
| if (document.body.contains(element)) { | ||
| element.parentNode.removeChild(element); | ||
| } | ||
| if (tooltip) { | ||
| tooltip.release(); | ||
| tooltip = null; | ||
| } | ||
| document.body.removeChild(container); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.