Deprecated
This repository has been deprecated. Please find the latest code here: https://github.com/vaadin-component-factory/vcf-tooltip
<incubator-tooltip>
<incubator-tooltip> is a Web Component providing an easy way to display tooltips on any html element.
<incubator-tooltip for="element-id" position="top">
A short text describing the element.
</incubator-tooltip>
Installation
The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.
Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.
Polymer 2 and HTML Imports compatible version
Install incubator-tooltip
: incubator-tooltip
bower i vaadin/incubator-tooltip --save
Once installed, import it in your application:
<link rel="import" href="bower_components/incubator-tooltip/incubator-tooltip.html">
Polymer 3 and ES Modules compatible version
Install incubator-tooltip
: incubator-tooltip
npm i @vaadin/incubator-tooltip --save
Once installed, import it in your application:
import '@vaadin/incubator-tooltip/incubator-tooltip.js';
Getting Started
Vaadin components use the Lumo theme by default.
The file structure for Vaadin components
-
src/incubator-tooltip.html
incubator-tooltip Unstyled component. -
theme/lumo/incubator-tooltip.html
incubator-tooltip Component with Lumo theme. -
incubator-tooltip.html
incubator-tooltip Alias for theme/lumo/incubator-tooltip.html incubator-tooltip
Running demos and tests in browser
-
Fork the
incubator-tooltip
repository and clone it locally. incubator-tooltip -
Make sure you have npm installed.
-
When in the
incubator-tooltip
directory, runnpm install
and thenbower install
to install dependencies. incubator-tooltip -
Run
polymer serve --open
, browser will automatically open the component API documentation. -
You can also open demo or in-browser tests by adding demo or test to the URL, for example:
- http://127.0.0.1:8080/components/incubator-tooltip/demo
- http://127.0.0.1:8080/components/incubator-tooltip/test incubator-tooltip
Running tests from the command line
- When in the
incubator-tooltip
directory, runpolymer test
incubator-tooltip
Following the coding style
We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint
, which will automatically lint all .js
files as well as JavaScript snippets inside .html
files.
Contributing
- Make sure your code is compliant with our code linters:
gulp lint
- Check that tests are passing:
polymer test
- Submit a pull request with detailed title and description
- Wait for response from one of Vaadin components team members
License
Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.