/vaadin-yasqe

Vaadin bindings for Yasqe

Primary LanguageJavaApache License 2.0Apache-2.0

vaadin-yasqe

Vaadin bindings for Yasqe

Vaadin Directory: https://vaadin.com/directory/component/yasqe-for-vaadin

Features

  • Execute Button (aka Query Button), Short Link and Curl Buttons configurable.
  • HTTP Request Parameters configurable (RequestConfig)
  • Prefix API URL configurable

Limitations

  • Prefix lookups should actually go to Vaadin first, rather than directly to a third party remote API - this is future work.

Maven

<dependency>
    <groupId>org.aksw.vaadin.yasqe</groupId>
    <artifactId>vaadin-yasqe-flow</artifactId>
</dependency>

Click here to see all published versions.

Versions

vaadin-yasqe-flow based on
0.5.0 @zazuko/yasqe:4.2.34

Source Code Repositories:

Usage

Vaadin Configuration

If you are using whitelists to improve Vaadin's startup time by limiting the amount of packages that need to be scanned for annotations, you may need to add org/aksw/vaadin/yasqe to the list.

Examples:

# src/main/resources/application.properties
vaadin.whitelisted-packages = com/vaadin/flow,org/aksw/vaadin/yasqe

# src/main/resources/application.yml
vaadin:
  whitelisted-packages: com/vaadin/flow,org/aksw/vaadin/yasqe

Java Code

See the demo for details.

public class MyComponent extends VerticalLayout {
    public MyComponent() {
        setSizeFull();
        YasqeConfig config = new YasqeConfig();
        config.setResizeable(false);
        Yasqe yasqe = new Yasqe(config);
        yasqe.setSizeFull();
        this.add(yasqe);

        yasqe.addQueryButtonListener(ev -> {
            new Notification("Is abort? " + ev.isAbort() + " - " + ev.getValue(), 5000)
                .open();
            ev.getSource().updateQueryButton(!ev.isAbort(), null);
        });
    }
}

Run the demo

  • Clone this repository
  • Run mvn install && mvn -f vaadin-yasqe-demo spring-boot:run
  • Open http://localhost:8080

Credits