Tooltip for Angular 2

Basic usage

Installation

Install the npm package.

npm i ng2-tooltip-directive

Import module:

						import {TooltipModule} from 'ng2-tooltip-directive';

@NgModule({
    imports: [TooltipModule]
})
					

Usage

Options can be set in the directive tag, so they have the highest priority.

						<span tooltip="Tooltip" placement="top" show-delay="500">Tooltip on top</span>
					

You may pass as an object:

						<span tooltip="Tooltip" [options]="myOptions">Tooltip on left</span>
					

						myOptions = {
    'placement': 'left',
    'show-delay': 500
}
					

Properties

placement: "top" \| "bottom" \| "left" \| "right" = "top" The position of the tooltip.
show-delay: number = 0 The delay in ms before showing the tooltip.
hide-delay: number = 300 The delay in ms before removing the tooltip.
hide-delay-mobile: number = 1500 Delay in milliseconds before hiding the tooltip (for mobile devices).
display: boolean = true Tooltip availability for display.
display-mobile: boolean = true Display the tooltip on mobile devices.
z-index: number = 0 Z-index of the tooltip.
trigger: "hover" \| "click" = "hover" Specifies how the tooltip is triggered. Control the closing time with "hide-delay".
tooltip-class: string Classes to be passed to the tooltip.
animation-duration: number = 300 The duration controls how long the animation takes to run from start to finish.

Style

Try it theme: "dark" \| "light" = "dark" Theme of tooltip background and text.
Try it shadow: boolean = true Shadow of the tooltip.
Try it offset: number = 8 Offset the tooltip relative to the item.

Events

When you call events, the delays that are specified in the options in the directive are taken into account. Default delay before tooltip hiding is 300 milliseconds.

Try it show The event is called before the tooltip appears.
Try it shown The event is called after the animation of the appearance of the tooltip.
Try it hide The event is called before the tooltip is hidden.
Try it hidden The event is called after the animation of the tooltip is hidden.

Methods

If you specified the directive options, they will be taken into account when calling methods. Including the delay before the appearance and hiding of the tooltip.

Try it show() Shows the tooltip.
Try it hide() Hides the tooltip.

Browser support

Chrome / Chrome for Android	50+ / partial support
FireFox	36+
Opera	44+
Safari / iOS Safari	10.1, 11.1 / partial support
Internet Explorer	Edge 15+