Contact us Create app

Directory

← Back

vcf-tooltip

Web Component providing an easy way to display tooltips for any html element

Author

Rating

Links

Popularity

<100

<vcf-tooltip>

npm version Published on Vaadin Directory

Web Component providing an easy way to display tooltips for any html element.

Screenshot of vcf-tooltip

Live demo ↗ | API documentation ↗

Installation

Install vcf-tooltip:

npm i @vaadin-component-factory/vcf-tooltip --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-tooltip';

Add <vcf-tooltip> element with attribute for which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed.

<button id="element-id">Hover me</button>
<vcf-tooltip for="element-id" position="top">
  A short text describing the element.
</vcf-tooltip>

Running demo

  1. Fork the vcf-tooltip repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-tooltip directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Server-side API

This is the client-side (Polymer 3) web component. If you are looking for the server-side (Java) API for the Vaadin Platform, it can be found here: Tooltip

License

Apache License 2.0

Compatibility

(Loading compatibility data...)

Last updated: 2021-08-10

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • @polymer/polymer#^3.2.0
  • @vaadin/vaadin-element-mixin#^2.1.3
  • @vaadin/vaadin-license-checker#^2.1.2
  • @vaadin/vaadin-lumo-styles#^1.5.0
  • @vaadin/vaadin-themable-mixin#^1.5.1
Released
2021-08-10
Maturity
IMPORTED
License
Other

Compatibility

Framework
Polymer 3.0+
Polymer 2.0+ in 1.2.1
Browser
Browser Independent

vcf-tooltip - Vaadin Add-on Directory

Web Component providing an easy way to display tooltips for any html element vcf-tooltip - Vaadin Add-on Directory
# <vcf-tooltip> [![npm version](https://badgen.net/npm/v/@vaadin-component-factory/vcf-tooltip)](https://www.npmjs.com/package/@vaadin-component-factory/vcf-tooltip) [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-tooltip) Web Component providing an easy way to display tooltips for any html element. Screenshot of vcf-tooltip [Live demo ↗](https://vcf-tooltip.netlify.com) | [API documentation ↗](https://vcf-tooltip.netlify.com/api/#/elements/Vaadin.VcfTooltip) ## Installation Install `vcf-tooltip`: ```sh npm i @vaadin-component-factory/vcf-tooltip --save ``` ## Usage Once installed, import it in your application: ```js import '@vaadin-component-factory/vcf-tooltip'; ``` Add `` element with attribute `for` which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed. ```html A short text describing the element. ``` ## Running demo 1. Fork the `vcf-tooltip` repository and clone it locally. 1. Make sure you have [npm](https://www.npmjs.com/) installed. 1. When in the `vcf-tooltip` directory, run `npm install` to install dependencies. 1. Run `npm start` to open the demo. ## Server-side API This is the client-side (Polymer 3) web component. If you are looking for the server-side (Java) API for the Vaadin Platform, it can be found here: [Tooltip](https://vaadin.com/directory/component/tooltip) ## License Apache License 2.0
View on NPM
Online Demo
License
View on GitHub

vcf-tooltip version 1.2.0
### Dependencies * polymer#^2.0.0 * vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.0.0 * vaadin-license-checker#vaadin/license-checker#^2.0.1 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#^2.1.2

vcf-tooltip version 1.2.1
### Dependencies * polymer#^2.0.0 * vaadin-themable-mixin#vaadin/vaadin-themable-mixin#^1.0.0 * vaadin-license-checker#vaadin/license-checker#^2.0.1 * vaadin-lumo-styles#vaadin/vaadin-lumo-styles#^1.0.0 * vaadin-element-mixin#^2.1.2

vcf-tooltip version 1.2.2
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.0
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.1
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.2
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.3
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.4
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.5
### Dependencies * @polymer/polymer#^3.0.0 * @vaadin/vaadin-button#^2.4.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.8
### Dependencies * @polymer/polymer#3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.10
### Changes since [v1.2.1](https://github.com/vaadin-component-factory/vcf-tooltip/releases/tag/v1.2.1): - Add close button feature ([Tooltip #7](https://github.com/vaadin-component-factory/tooltip/issues/7)) - Change [LICENSE](https://github.com/vaadin-component-factory/vcf-tooltip/blob/master/LICENSE) to Apache 2.0 - Add border to tooltip to improve looks with non-dark themes - Add notify true to hidden attribute ([Tooltip #10](https://github.com/vaadin-component-factory/tooltip/issues/10)) - A11y updates ([#2](https://github.com/vaadin-component-factory/vcf-tooltip/issues/2)): - Add default `id` - Add `aria-describedby` to target element - Change `close-button` to not need `manual` mode - Add hide tooltip on Escape key press

vcf-tooltip version 1.3.9
### Dependencies * @polymer/polymer#3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.11
### Dependencies * @polymer/polymer#3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.12
### Dependencies * @polymer/polymer#3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.13
### Dependencies * @polymer/polymer#3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.14
### Dependencies * @polymer/polymer#^3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

vcf-tooltip version 1.3.15
### Dependencies * @polymer/polymer#^3.2.0 * @vaadin/vaadin-element-mixin#^2.1.3 * @vaadin/vaadin-license-checker#^2.1.2 * @vaadin/vaadin-lumo-styles#^1.5.0 * @vaadin/vaadin-themable-mixin#^1.5.1

Online