https://github.com/vaadin-component-factory/vcf-lookup-field

Vaadin Component Factory Lookup Field
https://github.com/vaadin-component-factory/vcf-lookup-field

vaadin

Last synced: 3 months ago
JSON representation

Vaadin Component Factory Lookup Field

• Host: GitHub
• URL: https://github.com/vaadin-component-factory/vcf-lookup-field
• Owner: vaadin-component-factory
• License: apache-2.0
• Created: 2020-11-24T07:58:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-11T15:56:46.000Z (6 months ago)
• Last Synced: 2025-02-01T05:19:20.614Z (4 months ago)
• Topics: vaadin
• Language: JavaScript
• Homepage: https://vcf-lookup-field.netlify.app/
• Size: 90.8 KB
• Stars: 0
• Watchers: 8
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# <vcf-lookup-field>

[![npm version](https://badgen.net/npm/v/@vaadin-component-factory/vcf-lookup-field)](https://www.npmjs.com/package/@vaadin-component-factory/vcf-lookup-field) [![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/vaadin-component-factoryvcf-lookup-field)

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

![lookup-field](https://user-images.githubusercontent.com/3392815/174095935-b001519e-3bdb-4aad-b01d-4ee8dc49f364.gif)

![lookup-field-dialog](https://user-images.githubusercontent.com/3392815/174095944-700f641d-111e-4a6d-9278-12b8793cea19.gif)

[Live demo ↗](https://vcf-lookup-field-demo.netlify.com) | [API documentation ↗](https://vcf-lookup-field-demo.netlify.com/api/#/elements/Vaadin.VcfLookupField)

## Installation

Install `vcf-lookup-field`:

```sh

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:

```js

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

```

Add `` element to the page.

```html

```

## Running demo

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

2. Make sure you have [npm](https://www.npmjs.com/) 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