From 8462cc2a1997f24c8c20ede120277417931cb9be Mon Sep 17 00:00:00 2001 From: "Patrick H. Lauke" Date: Tue, 2 Jan 2018 19:35:13 +0000 Subject: [PATCH] Expand keyboard advice for tooltips, clarify what `manual` trigger does in table --- docs/4.0/components/tooltips.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/4.0/components/tooltips.md b/docs/4.0/components/tooltips.md index f04c65df3d..a055d95192 100644 --- a/docs/4.0/components/tooltips.md +++ b/docs/4.0/components/tooltips.md @@ -94,6 +94,8 @@ The required markup for a tooltip is only a `data` attribute and `title` on the ##### Making tooltips work for keyboard and assistive technology users You should only add tooltips to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as ``s) can be made focusable by adding the `tabindex="0"` attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users. In addition, most assistive technologies currently do not announce the tooltip in this situation. + +Additionally, do not rely solely on `hover` as the trigger for your tooltip, as this will make your tooltips impossible to trigger for keyboard users. {% endcallout %} {% highlight html %} @@ -111,11 +113,11 @@ You should only add tooltips to HTML elements that are traditionally keyboard-fo ### Disabled elements -Elements with the `disabled` attribute aren't interactive, meaning users cannot hover or click them to trigger a tooltip (or popover). As a workaround, you'll want to trigger the tooltip from a wrapper `
` or `` and override the `pointer-events` on the disabled element. +Elements with the `disabled` attribute aren't interactive, meaning users cannot focus, hover, or click them to trigger a tooltip (or popover). As a workaround, you'll want to trigger the tooltip from a wrapper `
` or ``, ideally made keyboard-focusable using `tabindex="0"`, and override the `pointer-events` on the disabled element.
{% example html %} - + {% endexample %} @@ -192,7 +194,7 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap

Base HTML to use when creating the tooltip.

The tooltip's title will be injected into the .tooltip-inner.

.arrow will become the tooltip's arrow.

-

The outermost wrapper element should have the .tooltip class.

+

The outermost wrapper element should have the .tooltip class and role="tooltip".

@@ -208,7 +210,11 @@ Options can be passed via data attributes or JavaScript. For data attributes, ap trigger string 'hover focus' - How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger. + +

How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.

+

'manual' indicates that the tooltip will be triggered programmatically via the .tooltip('show'), .tooltip('hide') and .tooltip('toggle') methods; this value cannot be combined with any other trigger.

+

'hover' on its own will result in tooltips that cannot be triggered via the keyboard, and should only be used if alternative methods for conveying the same information for keyboard users is present.

+ offset