Ref
Interface#
interface RefData extends FieldData {
/**
* Collection to query for search
* @required
*/
collection: string;
/**
* Save value of provided key to database
* @default 'id'
*/
valueKey?: string;
/**
* Set to provided value on 'Clear' action
* @default null
*/
clearValue?: string | null;
/**
* Max number of rows to show per search
* @default 5
*/
limit?: number;
/**
* Search key for querying database
* Label for showing next to 'Search by...'
* @default {
* key: '/name',
* label: 'Name'
* }
*/
search?: {
key?: string;
label?: string;
};
/**
* Display provided key to user and its label
* @default {
* key: '/name',
* label: 'Name'
* }
*/
display?: {
key?: string;
label?: string;
};
/**
* Table columns for displaying search table
* @required
* @default {
* tableColumns: [
* {key: '/id', label: 'ID'}
* ]
* }
*/
table?: {
tableColumns?: {
key: string;
label: string;
}[];
}
/**
* Additional Filters for provided collection
* @default []
*/
filters?: Array<WhereFilter | ((options) => WhereFilter)>;
/**
* Close search dialog after selecting item
* @default true, false for multiple selection
*/
closeOnSelect?: boolean;
/**
* Allow multiple selection
* @default false
*/
multiple?: boolean;
/**
* Hide "Apply Value" button
* @default false
*/
hideApplyValue?: boolean;
}