https://github.com/vaadin-component-factory/tooltip
Java API for vcf-tooltip
https://github.com/vaadin-component-factory/tooltip
Last synced: 24 days ago
JSON representation
Java API for vcf-tooltip
- Host: GitHub
- URL: https://github.com/vaadin-component-factory/tooltip
- Owner: vaadin-component-factory
- License: apache-2.0
- Created: 2019-05-02T09:38:38.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-29T11:26:30.000Z (over 1 year ago)
- Last Synced: 2024-04-17T10:09:41.499Z (about 1 year ago)
- Language: Java
- Homepage: https://incubator.app.fi/tooltip-demo/tooltip
- Size: 85.9 KB
- Stars: 3
- Watchers: 8
- Forks: 3
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Component Factory Tooltip for Vaadin 10+
This is server-side component of [<vcf-tooltip>](https://github.com/vaadin-component-factory/vcf-tooltip) Web Component.
Tooltip is a component that can be used in conjunction with any component to display contextual information.
When the attached component is hovered, the tooltip displays the contextual information.
[Live Demo ↗](https://incubator.app.fi/tooltip-demo/tooltip)
[
](https://vaadin.com/components/vcf-tooltip)
## Usage
A simple use of the tooltip component would be the following: create `Tooltip` and add some elements inside, then attach it to target component
by calling `attachToComponent` method on tooltip object. It's important to add a tooltip to layout.
```java
Button button = new Button("Click me");
Tooltip tooltip = new Tooltip();
// Tooltip should be added to layout as well
add(button, tooltip);
tooltip.attachToComponent(button);
tooltip.setPosition(TooltipPosition.RIGHT);
tooltip.setAlignment(TooltipAlignment.LEFT);
tooltip.add(new H5("Hello"));
tooltip.add(new Paragraph("This is an example of how to use it"));
```
It is possible to open and close the tooltip manually:
```java
Button open = new Button("Open tooltip", event -> {
tooltip.open();
});
Button close = new Button("Close tooltip", event -> {
tooltip.close();
});
button.addClickListener(event -> {
tooltip.setEnabled(!tooltip.isEnabled());
});
```
Click listeners can be added to the tooltip:
```java
tooltip.addClickListener(event -> {
Notification notification = new Notification(
"You clicked on the avatar", 3000, Notification.Position.TOP_CENTER);
notification.open();
});
```
## Setting up for development:
Clone the project in GitHub (or fork it if you plan on contributing)
```
git clone [email protected]/vaadin/vcf-tooltip-flow.git
```
in the root directory. `-DskipITs` will skip the integration tests, which require a TestBench license. If you want to run all tests as part of the build, run
```mvn install```
## Demo
The Demo can be run going to the project vcf-tooltip-flow-vaadincom-demo and executing the maven goal:
```mvn jetty:run```
# License & Author
Apache License 2.0