Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Skrikjo committed May 6, 2019
1 parent 0996181 commit 4a78f63
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 26 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
[![Build Status](https://travis-ci.org/vaadin/vcf-tooltip.svg?branch=master)](https://travis-ci.org/vaadin/vcf-tooltip)
# <vcf-tooltip> Web Component
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-tooltip)

# <vcf-tooltip>
<vcf-tooltip> is a Web Component providing an easy way to display tooltips on any html element.

[Live Demo ↗](https://incubator.app.fi/vcf-tooltip-demo/)
[Live Demo ↗](https://incubator.app.fi/tooltip-demo/tooltip)

<img src="https://raw.githubusercontent.com/vaadin/incubator-tooltip/master/screenshot.png" width="300" alt="Screenshot of vcf-tooltip">

## Usage
Add &lt;vcf-tooltip&gt; element with attribute `for` which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed.

[&lt;vcf-tooltip&gt;](https://vaadin.com/directory/component/vaadinvcf-tooltip) is a Web Component providing an easy way to display tooltips on any html element.

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

[<img src="https://raw.githubusercontent.com/vaadin/vcf-tooltip/master/screenshot.png" width="200" alt="Screenshot of vcf-tooltip">](https://vaadin.com/components/vcf-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.
This components is distributed as Bower packages.

### Polymer 2 and HTML Imports compatible version

Expand Down Expand Up @@ -105,8 +104,10 @@ We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can c
- [Submit a pull request](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github) with detailed title and description
- Wait for response from one of Vaadin components team members

# Vaadin Prime
This component is available in Vaadin Prime subscription. It is still open source, but you need to have a valid CVAL license in order to use it. Read more at: https://vaadin.com/pricing

## License
# License

Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.

Expand Down
17 changes: 3 additions & 14 deletions vaadin-directory-description.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,4 @@
# &lt;vcf-tooltip&gt;
## Usage
&lt;vcf-tooltip&gt; is a Web Component providing an easy way to display tooltips on any html element.

[&lt;vcf-tooltip&gt;](https://vaadin.com/directory/component/vaadinvcf-tooltip) is a Web Component providing an easy way to display tooltips on any html element.

[<img src="https://raw.githubusercontent.com/vaadin/vcf-tooltip/master/screenshot.png" width="200" alt="Screenshot of vcf-tooltip">](https://vaadin.com/directory/component/vaadinvcf-tooltip)

## Example Usage

```html
<vcf-tooltip for="element-id" position="top">
A short text describing the element.
</vcf-tooltip>
```

[Live Demo ↗](https://incubator.app.fi/vcf-tooltip-demo/)
Add &lt;vcf-tooltip&gt; element with attribute `for` which will contain id of target element, to the page. Now after hovering on target element, toltip will be displayed.

0 comments on commit 4a78f63

Please sign in to comment.