Extensions

Press shift + S to search API reference.

React component

FieldPicker

View source

Props

interface FieldPickerProps extends SharedFieldPickerProps
allowedTypesArray<FieldType>

An array indicating which field types can be selected.

aria-describedbyundefined | string

A space separated list of description element IDs.

aria-labelundefined | string

The aria-label attribute. Use this if the select is not referenced by a label element.

aria-labelledbyundefined | string

A space separated list of label element IDs.

autoFocusundefined | false | true

The autoFocus attribute.

classNameundefined | string

Additional class names to apply to the select.

disabledundefined | false | true

If set to true, the user cannot interact with the select.

fieldField | null

The selected field model.

idundefined | string

The id attribute.

nameundefined | string

The name attribute.

onChangeundefined | function (fieldModel: Field | null) => void

A function to be called when the selected field changes.

placeholderundefined | string

The placeholder text when no field is selected.

shouldAllowPickingNoneundefined | false | true

If set to true, the user can unset the selected field.

sizeControlSizeProp

The size of the select.

styleReact.CSSProperties

Additional styles to apply to the select.

tabIndexundefined | number

The tabindex attribute.

tableTable | null

The parent table model to select fields from. If null or undefined, the picker won't render.