@aponahmed/tooltip
v0.0.9
Published
A simple tooltip plugin to show hint
Downloads
9
Readme
Tooltip Class
The Tooltip class is designed to create and display tooltips on HTML elements.
Installation
npm i @aponahmed/tooltip --save-dev
Usage
<button class="tooltip" data-color="#fff" data-bg="#000" data-position="top" title="Top Tooltip">Hover me</button>
Import the Tooltip class and its associated styles:
import Tooltip from "@aponahmed/tooltip";
Create an instance of the Tooltip class:
const tooltip = new Tooltip({ item: document.getElementById('tooltip-trigger'), // HTML element triggering the tooltip position: 'right', // Tooltip position (optional, default is 'right') text: 'Tooltip Content', // Tooltip text content (optional, default is false) bg: '#1a1f30', // Tooltip background color (optional, default is '#1a1f30') color: '#fff' // Tooltip text color (optional, default is '#fff') });
Alternatively, you can use the
all
method to apply tooltips to multiple elements with a common class:import { tooltip } from "@aponahmed/tooltip" tooltip(".tooltip", { position: 'right', // Tooltip position (optional, default is 'right') text: 'Tooltip Content', // Tooltip text content (optional, default is 'Tooltip Content') bg: '#1a1f30', // Tooltip background color (optional, default is '#1a1f30') color: '#fff' // Tooltip text color (optional, default is '#fff') });
Properties
item
: HTML element triggering the tooltip.position
: Position of the tooltip relative to the triggering element ('right', 'left', 'top', 'bottom').text
: Tooltip content text.bg
: Background color of the tooltip.color
: Text color of the tooltip.extraMargin
: Extra margin applied to the tooltip position.
Methods
init()
: Initializes the tooltip and sets up event listeners.removeTooltip()
: Removes the tooltip from the DOM.positionSet(item)
: Sets the position of the tooltip based on the specified or default position.colorSet(item)
: Sets the background color of the tooltip based on the specified or default color.showTooltip(item, e)
: Displays the tooltip for the specified item and event.