@justinribeiro/toggle-tooltip
Advanced tools
Readme
A small (8KB), accessible, fast, and WCAG 2.1 compliant toggle style tooltip web component using role=status.
To see the tooltip in action within JAWS 2020, see https://www.youtube.com/watch?v=PNH0RTB9alg
Install the component:
npm i @justinribeiro/toggle-tooltip
# or
yarn add @justinribeiro/toggle-tooltip
If you want the paste-and-go version, you can simply load it via CDN:
<script type="module" src="https://cdn.jsdelivr.net/npm/@justinribeiro/toggle-tooltip@1.0.3/dist/index.js">
Fire it up:
<script type="module">
import '@justinribeiro/toggle-tooltip/index.js';
</script>
<toggle-tooltip>
ⓘ
<span slot="tooltip">
I'm a tooltip!
</span>
</toggle-tooltip>
See other uses in demo/index.html.
$ git clone git@github.com:justinribeiro/toggle-tooltip.git
$ cd toggle-tooltip
$ yarn install
$ yarn start
# run the tests
$ yarn test
| Property | Attribute | Type | Default | Description |
|---|---|---|---|---|
hover | hover | boolean | false | Setting hover as attribute on component allows for the mouseover andmouseout events to become active for this instance of the toggle-tooltipNote: this mode is complaint with WCAG SC 1.4.13 Content on Hover or Focus TODO: I suppose I could watch for the change and then add/remove the event handlers...but I don't have a use case for the at the moment |
label | label | string | "'more info'" | Define the internal button aria-label when an svg icon or other non-text is used |
show | show | boolean | "'more info'" | Define the internal button aria-label when an svg icon or other non-text is used |
| Method | Type | Description |
|---|---|---|
close | (noReFocus?: boolean): void | Close the tooltip oReFocus: Don't refocus to the button (probably because we tabbed off and are moving through the document) |
open | (): void | Open the tooltip and focus to it |
| Name | Description |
|---|---|
| Default slot injects into button value, useful for icon | |
tooltip | Any message or links you'd like in the tooltip status message |
| Property | Default |
|---|---|
--toggle-tooltip-button-background-color | "transparent" |
--toggle-tooltip-button-border | "none" |
--toggle-tooltip-button-padding | 0 |
--toggle-tooltip-status-background-color | "#fafafa" |
--toggle-tooltip-status-border | "1px solid #ccc" |
--toggle-tooltip-status-border-radius | "0.5rem" |
--toggle-tooltip-status-box-shadow | "none" |
--toggle-tooltip-status-padding | "1rem" |
FAQs
An accessible, fast, and WCAG 2.1 compliant toggle style tooltip web component using role=status.
The npm package @justinribeiro/toggle-tooltip receives a total of 3,975 weekly downloads. As such, @justinribeiro/toggle-tooltip popularity was classified as popular.
We found that @justinribeiro/toggle-tooltip demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.