@reach/tooltip

Accessible tooltips

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@reach/tooltip
5,535890.17.05 months ago3 years agoMinified + gzip package size for @reach/tooltip in KB

Readme

@reach/tooltip
Stable release MIT license
Docs | Source | WAI-ARIA
When the user's mouse or focus rests on an element, a non-interactive popup is displayed near it.
A couple notes on using tooltips:
  • Do not use tooltips for information vital to task completion. The elements they are attached to should usually make sense on their own, but a tooltip can help provide a little bit more information--especially for new users of your app.
  • Keep the content minimal, they are not intended to hide critical content.
  • If you want interactive content, you can use a Dialog.

Touch Events: Touch events are currently not supported. There's not a lot of research or examples of these types of tooltips on mobile. We have some ideas but need to validate them first before implementing. Please adjust your interfaces on mobile to account for this.
import Tooltip, { useTooltip, TooltipPopup } from "@reach/tooltip";
import VisuallyHidden from "@reach/visually-hidden";
import "@reach/tooltip/styles.css";

function Example() {
  return (
    <Tooltip label="Save">
      <button>
        <VisuallyHidden>Save</VisuallyHidden>
        <span aria-hidden>💾</span>
      </button>
    </Tooltip>
  );
}