@vaadin-component-factory/vcf-tooltip

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

Usage no npm install needed!

<script type="module">
  import vaadinComponentFactoryVcfTooltip from 'https://cdn.skypack.dev/@vaadin-component-factory/vcf-tooltip';
</script>

README

<vcf-tooltip>

Gitter npm version Published on Vaadin Directory

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