Table of Contents
Note

This documentation describes the Lookup Vue component for native UI views, for Xml templates see lookup.

Lookup

An autocomplete field that supports typed text suggestions and modal-based entity search. Used for reference and lookup properties in forms.

Import

import { Lookup } from '@neos/app'

Props

Prop Type Default Description
isReference boolean — Required. true = reference relation (stores entity key); false = lookup (stores display value)
definition LookupDefinition — Required. Configuration for the lookup (entity, display property, etc.)
referenceEntityViewName string undefined Override the entity view used for the suggestion/search
modelValue unknown undefined Current value (v-model)
property ViewModelProperty undefined ViewModel property to bind
item Model undefined Data item owning the property
disableSuggest boolean false Disable auto-suggest on typing
suggestMinCharNumber number 1 Minimum characters before suggestions appear
validate boolean true Enable validation state rendering
multiSelectionProperty string undefined When set, allows multiple selections stored in this property
invalidValue string undefined Value shown when the current key can't be resolved

Slots

Slot Description
before Content rendered before the input (e.g. status icon)

Usage Examples

Basic reference lookup

<Lookup :is-reference="true" :definition="customerDef" v-model="selectedCustomerId" />

Bound to ViewModel property

<Lookup
  :is-reference="true"
  :definition="projectDef"
  :property="viewModel.getProperty('projectId')"
  :item="currentRecord"
/>

With minimum 3 characters to suggest

<Lookup
  :is-reference="true"
  :definition="countryDef"
  v-model="countryId"
  :suggest-min-char-number="3"
/>

Multi-selection

<Lookup
  :is-reference="false"
  :definition="tagDef"
  v-model="tagIds"
  multi-selection-property="tagIds"
/>

See Also