@kanunilabs/datagrid-react-enterprise
@kanunilabs/datagrid-react-enterprise / LookupBoxProps
Interface: LookupBoxProps
Properties
allowCustom?
optionalallowCustom?:boolean
ariaLabel
ariaLabel:
string
The field's accessible name (its label's text).
autoCompleteSingle?
optionalautoCompleteSingle?:boolean
Pick the one item left by itself. Default true; false is the strict data-entry rule.
buttonOrder?
optionalbuttonOrder?:"drop-first"|"picker-first"
'picker-first': [box][…][▾] (B.9.14).
className?
optionalclassName?:string
dark?
optionaldark?:boolean
Dark tokens, as the grid's dark (B.9.13).
density?
optionaldensity?:GridDensity
describedBy?
optionaldescribedBy?:string
disabled?
optionaldisabled?:boolean
display?
optionaldisplay?:"code"|"name"|"both"
What a linked box shows and completes against: 'code' (default), 'name', 'both' (B.9.1).
dropButton?
optionaldropButton?:boolean
The ▾ button. Default true (a form field has no other way to show it is a list).
dropLabel?
optionaldropLabel?:string
error?
optionalerror?:string|null
A message under the box, read out (role="alert"), e.g. the search failed.
hoverHighlights?
optionalhoverHighlights?:boolean
Does the pointer move the highlight that Tab writes? Default false here (B.9.6).
id?
optionalid?:string
invalid?
optionalinvalid?:boolean
items
items: readonly
LookupItem[] |null
The list; null while it is on its way (B.9.8, same as loading).
linked?
optionallinked?:boolean
A code + name list: the box shows the code, the list both, typing matches either.
listColumns?
optionallistColumns?: readonlyLookupListColumn[]
listResizable?
optionallistResizable?:boolean
loading?
optionalloading?:boolean
The list is on its way: typing is kept and checked once it arrives; Enter picks nothing.
locale?
optionallocale?:string
"No match" and the button labels: the grid's twelve languages. Default 'en'.
matchFold?
optionalmatchFold?:LookupMatchFold
matchMode?
optionalmatchMode?:LookupMatchMode| {code?: LookupMatchMode | undefined;name?: LookupMatchMode | undefined; }
One mode, or per field ({ code: 'startsWith', name: 'contains' }). Default 'startsWith'.
messages?
optionalmessages?:Partial<GridDictionary>
name?
optionalname?:string
Form wiring, on the box itself (B.9.11). id (below) goes to the box too.
onChange
onChange: (
value,item) =>void
A pick (or a cleared / free-text value with allowCustom): the value and its item, or null.
Parameters
value
unknown
item
LookupItem | null
Returns
void
onNoMatch?
optionalonNoMatch?:"revert"|"keep-open"
Leaving with typed text that picks nothing. Default 'revert' (unlike the
grid's 'keep-open'): a form field must not hold focus hostage — the text
goes and the value stays.
onPickerOpen?
optionalonPickerOpen?: (text) =>LookupItem|Promise<LookupItem|null> |null
The "…" button and Ctrl+Enter: open your own picker with what is typed.
Parameters
text
string
Returns
LookupItem | Promise<LookupItem | null> | null
openHighlight?
optionalopenHighlight?:"none"|"current"
'current': the list opens on the current item, or the first (Tekax, 2026-11-12). Default 'none'.
openOnFocus?
optionalopenOnFocus?:boolean
Focusing or clicking the box opens the list. Default false (Tekax B.9.3).
palette?
optionalpalette?:GridPaletteName
pickerLabel?
optionalpickerLabel?:string
The buttons' accessible names (B.9.14).
pickerTabStop?
optionalpickerTabStop?:boolean
The "…" button is a Tab stop (B.9.14).
portalContainer?
optionalportalContainer?:PortalContainer
Where the list is drawn (a modal's container). Default <body>.
required?
optionalrequired?:boolean
restrictInput?
optionalrestrictInput?:boolean
style?
optionalstyle?:CSSProperties
testId?
optionaltestId?:string
theme?
optionaltheme?:GridThemeName
typeAhead?
optionaltypeAhead?:boolean
value
value:
unknown
What the field holds (an item's value), or null.