@dab-code/toolio

v1.2.6

Published

2 years ago

Toolio - Accessible tooltips in a lightweight and easy-to-use package

Downloads

0High
0Medium
0Low

dab-code

tooltip tooltips tool tip tool accessible tooltip

Toolio - A11Y accessible and lightweight tooltips

Toolio was created as a side-project with the goal to create easy-to-use and accessible tooltips.

It should be noted that Toolio should only be used to creat informative tooltips and not contain anything other than concise supplemental information, as this makes their use a lot less accessible.

It is of course up to you how you use it! 🙏

Installation

Package Manager

$ npm i -S @dab-code/toolio

<script src="https://unpkg.com/@dab-code/toolio@latest/dist/index.js"></script>

Usage

Module bundlers

You can import the Toolio constructor and initialize a new instance! Now all gyou need to do is sprinkling a couple of toolio attributes into your HTML template! 🦄

import { Toolio } from '@dab-code/toolio'

new Toolio()

CJS

Require that bad boy, initialize a new instance and go crazy! 🥳

const toolio = require('Toolio')

toolio.Toolio()

CDN

<script src="https://unpkg.com/@dab-code/toolio@latest/dist/index.js"></script>

<script>
    toolio.Toolio()
</script>

HTML

Now wasn't that easy? Now all you need to do is find something cool and smart to attach a tooltip to 🤷

All you have to do is create a span element around the word(s) you want your cool tooltip to be assigned to. The add the toolio attribute to said span and insert all the fancy explantions!

If you'd like to either change tooltips max-width og placement, you can simply use the attributes toolio-max-width (default: 250) and toolio-placement (default: top), which accepts:

top-start | top | top-end
right-start | right | right-end
bottom-start | bottom | bottom-end
left-end | left | left-start

Example:

<p>
    Aristotle was a Greek <span toolio="A very smart person">philosopher</span> and <span toolio="An even smarter person!">polymath</span>
</p>

Styling

Remember to import Toolios styling. This can be done either by importing it (if you're using a module bundler) or simply with by adding the CDN in your <head> section.

Module bundlers

@import "@dab-code/toolio/dist/index.css";

<link href="https://unpkg.com/@dab-code/toolio@latest/dist/toolio.css" rel="stylesheet">

Customizing the tooltips

As I was looking for the easiest way to get started, I chose to use css variables to style the tooltips. This means it should be quite easy to overrule the default styling. 🎂

To change the variables, create a new scoped selector name `[toolio]´ and go nuts! 🥜

[toolio] {
    --T_COLOR: white;
    --T_BACKGROUND: #252525;

    --T_BORDERRADIUS: 3px;

    --T_FONTSIZE: .9rem;
    --T_FONTWEIGHT: normal;
    --T_LINEHEIGT: var(--T_FONTSIZE);
    --T_TEXTDECORATION: underline dotted;

    --T_PADDING: .5rem .75rem .4rem;

    --T_EASING-ENTER: .25s ease .125s;
    --T_EASING-LEAVE: .25s ease .25s;
}

Roadmap

✅ More placement options.
- [top|top-start|top-end|right-start|right|right-end|bottom-start|bottom|bottom-end|left-end|left|left-start]
WCAG 2.1: dismissable, hoverable, and persistent
Pure JS tooltip ccreation on a html element.
- Toolio.createTipOnElement(elm, options)
- This way we can customize each tooltip by passing in the options object. 🎨

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme