Skip to content

vaadin-component-factory/vcf-lookup-field

Repository files navigation

<vcf-lookup-field>

npm version Published on Vaadin Directory

The Lookup field component allows you to search a specific record with either a combobox or a dialog with a grid view.

lookup-field

lookup-field-dialog

Live demo ↗ | API documentation ↗

Installation

Install vcf-lookup-field:

npm i @vaadin-component-factory/vcf-lookup-field --save

Important information about versioning

Component versions 23.x and 24.x were deprecated in order to follow Semanting Versioning practices. Please use latest version 3.x for Vaadin 23 and version 4/5.x for Vaadin 24.

Compatibility

  • Version 1.x.x -> Vaadin 14+
  • Version 3.x.x -> Vaadin 23.x
  • Version 4.x.x -> Vaadin 24.x
  • Version 5.x.x -> Vaadin 24.x (improved accessibility)

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-lookup-field';

Add <vcf-lookup-field> element to the page.

<vcf-lookup-field></vcf-lookup-field>

Running demo

  1. Fork the vcf-lookup-field repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-lookup-field directory, run npm install to install dependencies.

  4. Run npm run serve to open the demo.

Publishing

To publish a new version run: npm run publish x.x.x with a account on npm that can update this component.

License

Apache License 2.0