jQuery simple and accessible dialog tooltip window, using ARIA
Clone or download
nico3333fr Fix bug (avoid duplicate)
Sorry, I'm a dumbass.
Or too tired.
Or... <put here what you want>
Latest commit 117d93b Sep 18, 2018

README.md

jQuery Simple and Accessible Dialog Tooltip Window

This jQuery plugin provides you a shiny and accessible dialog tooltip window, using ARIA.

A presentation page and demo is here: https://a11y.nicolas-hoffmann.net/dialog-tooltip/

How it works

Basically, the scripts wraps each class="js-tooltip" into a span class="your-prefix-class-container", when you activate one, it inserts a dialog element just after the clicked element (in the container), puts the focus into it and traps focus in the dialog tooltip. When you exit it, the focus is given back to the element that opened it.

For mouse users, they can click outside the dialog tooltip to close it.

If you never activate a dialog tooltip, it won’t be anywhere in the code.

Options and attributes

Simply put class="js-tooltip" on a button to activate the script.

  • Attribute data-tooltip-prefix-class: the prefix to all style classes of the dialog tooltip.
  • Attribute data-tooltip-text: the text of your dialog tooltip (will be put into a p tag).
  • Attribute data-tooltip-content-id: the id of (hidden) content in your page that will be put into your dialog tooltip.
  • Attribute data-tooltip-title: the main title of the dialog tooltip.
  • Attribute data-tooltip-close-text: the text of the close button in your dialog tooltip.
  • Attribute data-tooltip-close-title: the title attribute of the close button in your dialog tooltip.
  • Attribute data-tooltip-close-img: a path to a valid image for the close button.

Another feature: when you click on a button that launches a modal tooltip, the class is-active is added to this button.

Enjoy.

Chuck Norris approved this

P.S: this plugin is in MIT license. It couldn't be done without the precious help of @ScreenFeedFr, @sophieschuermans, @johan_ramon, @goetsu and @romaingervois.