Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ytiurin/html5tooltipsjs

Tooltips with smooth 3D animation
https://github.com/ytiurin/html5tooltipsjs

css javascript tooltip tooltips

Last synced: 13 days ago
JSON representation

Tooltips with smooth 3D animation

Host: GitHub
URL: https://github.com/ytiurin/html5tooltipsjs
Owner: ytiurin
License: mit
Created: 2014-04-01T08:43:45.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2018-07-07T21:47:09.000Z (over 6 years ago)
Last Synced: 2024-10-01T00:55:43.214Z (about 1 month ago)
Topics: css, javascript, tooltip, tooltips
Language: JavaScript
Homepage: http://ytiurin.github.io/html5tooltipsjs
Size: 8.66 MB
Stars: 884
Watchers: 27
Forks: 83
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

[![npm](https://img.shields.io/npm/v/html5tooltipsjs.svg?maxAge=2592000)](https://www.npmjs.com/package/html5tooltipsjs)
[![npm](https://img.shields.io/npm/dm/html5tooltipsjs.svg?maxAge=2592000)](https://www.npmjs.com/package/html5tooltipsjs)

html5tooltips.js
===============
Tooltips, written in pure JavaScript, with smooth 3D animation implemented in CSS. No framework required. [http://ytiurin.github.io/html5tooltipsjs](http://ytiurin.github.io/html5tooltipsjs)

## Install
```
npm install html5tooltipsjs
```
or
```
bower install html5tooltipsjs
```

## Simple usage

The simplest way to tie a tooltip to a specific UI element is to add a `data-*` attribute to an element's HTML code.

```html

```

Add extra attributes to customize a tooltip.

```html

```

### Customization inheritance

To customize multiple tooltips with less of code, add a `data-*` attribute to their shared parent element (or document body).

```html

```

## Advanced usage

You may use a JavaScript constructor to abstract from your view layer.

```javascript
html5tooltips({
animateFunction: "spin",
color: "bamboo",
contentText: "Refresh",
stickTo: "right",
targetSelector: "#refresh"
});
```

There is an extra feature in html5tooltips.js that allows to show extended text in the tooltip, when user focuses on input field and editable element. You can use plain text or HTML formatting.

```javascript
html5tooltips({
contentText: "Not less then 8 symbols",
contentMore: "Use lower and UPPER case letters, num6ers and spec!al symbols to make password safe and secure.",
maxWidth: "180px",
targetSelector: "#password"
});
```

Define multiple tooltips by passing an array of tooltip objects to the Javascript constructor.

```javascript
html5tooltips([
{
animateFunction: "spin",
color: "#FF0000",
contentText: "Refresh",
stickTo: "right",
targetSelector: "#refresh"
},
{
contentText: "Simple to remember",
contentMore: "Check that your login name is not used by anyone else.",
stickTo: "left",
maxWidth: "180px",
targetSelector: "#username"
}
]);
```

## Styling

To modify tooltip presentation, simply apply styling to it's root element `.html5tooltip-box`. Properties `background-color`, `color`, `border-radius`, `box-shadow`, `font-family` and `font-size` will propogate to the tooltip text container and pointer.

```css
.html5tooltip-box
{
background-color: #2A2A2A;
border-radius: 2px;
box-shadow: 0 0 0 1px rgba(255,255,255,.15), 0 0 10px rgba(255,255,255,.15);
color: #F7F7F7;
font-family: arial,sans-serif;
font-size: 11px;
font-weight: bold;
}
```

## For Single Page Applications

Refresh tooltips when you update declarative announcement of tooltips or when DOM change, affecting tooltips target elements.

```javascript
html5tooltips.refresh();
```

## HTML5Tooltip UI Component

```javascript
var tooltip = new HTML5TooltipUIComponent;
var target = document.getElementById("refresh");

tooltip.set({
animateFunction: "spin",
color: "bamboo",
contentText: "Refresh",
stickTo: "right",
target: target
});

target.addEventListener('mouseenter',function(){
tooltip.show();
});

target.addEventListener('mouseleave',function(){
tooltip.hide();
});

tooltip.mount();
```

## Get a tooltip by the target element

```javascript
var tooltip = html5tooltips.getTooltipByTarget(document.getElementById('myElement'));

tooltip.destroy();
```

## List of possible parameters

- **animateFunction** - Choose one of the available animate functions: ``fadein``, ``foldin``, ``foldout``, ``roll``, ``scalein``, ``slidein``, ``spin``. Default value ``fadein``.
- **color** - Any CSS color or one of the predefined colors: ``daffodil``, ``daisy``, ``mustard``, ``citrus-zest``, ``pumpkin``, ``tangerine``, ``salmon``, ``persimmon``, ``rouge``, ``scarlet``, ``hot-pink``, ``princess``, ``petal``, ``lilac``, ``lavender``, ``violet``, ``cloud``, ``dream``, ``gulf``, ``turquoise``, ``indigo``, ``navy``, ``sea-foam``, ``teal``, ``peacock``, ``ceadon``, ``olive``, ``bamboo``, ``grass``, ``kelly``, ``forrest``, ``chocolate``, ``terra-cotta``, ``camel``, ``linen``, ``stone``, ``smoke``, ``steel``, ``slate``, ``charcoal``, ``black``, ``white``, ``metalic-silver``, ``metalic-gold``, ``metalic-copper``.
- **contentText** - Text for a tooltip; HTML may be applied.
- **contentMore** - Text for the expanded version of a tooltip which shows up when focused on a target element; HTML may be applied.
- **delay** - Delay the tooltip show up in milliseconds. Default value is ``500``.
- **hideDelay** - Delay the tooltip hide in milliseconds, if the tooltip is persistent. Default value is ``300``.
- **disableAnimation** - Disable the animation: ``true`` or ``false``. Default value is ``false``.
- **maxWidth** - The maximum width of the expanded version of the tooltip.
- **persistent** - If set to true, the tooltip will wait for `hideDelay` number of milliseconds before hide. Default value is `false`.
- **stickTo** - Choose one of the available stick values: ``bottom``, ``left``, ``right``, ``top``. Default value is ``bottom``.
- **stickDistance** - The ``number`` of pixels that represent the distance between the tooltip and a target element.
- **targetSelector** - A CSS selector which is used to catch a target element in the document.

## List of possible `data-*` attributes

- **data-tooltip** - Value for the `contentText` parameter.
- **data-tooltip-animate-function** - Value for the `animateFunction` parameter.
- **data-tooltip-disable-animation** - Value for the `disableAnimation` parameter.
- **data-tooltip-color** - Value for the `color` parameter.
- **data-tooltip-delay** - Value for the `delay` parameter.
- **data-tooltip-hide-delay** - Value for the `hideDelay` parameter.
- **data-tooltip-maxwidth** - Value for the `maxWidth` parameter.
- **data-tooltip-more** - Value for the `contentMore` parameter.
- **data-tooltip-persistent** - Value for the `persistent` parameter.
- **data-tooltip-stickto** - Value for the `stickTo` parameter.

## Browser compatibility

Tooltips are compatible with old browsers including IE7. Animation works in Chrome 1.0, Firefox 2.0, Internet Explorer 10, Opera 10.5, Safari 3.2.