JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 522
  • Score
    100M100P100Q112173F
  • License https://raw.githubusercontent.com/vaadin/vaadin-incubator-element/master/LICENSE

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

Package Exports

  • @vaadin-component-factory/vcf-tooltip
  • @vaadin-component-factory/vcf-tooltip/src/vcf-tooltip.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vaadin-component-factory/vcf-tooltip) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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