Skip to main content

Interface: MapFieldConfig<T>

Possible configuration fields for a string property. Note that setting one config disables the others.

Type parameters#

NameType
TT: Object

Hierarchy#

Properties#

Field#

Optional Field: ComponentType<FieldProps<T, any, any>>

If you need to render a custom field, you can create a component that takes FieldProps as props. You receive the value, a function to update the value and additional utility props such as if there is an error. You can customize it by passing custom props that are received in the component.

Inherited from#

FieldConfig.Field

Defined in#

models/properties.ts:522


Preview#

Optional Preview: ComponentType<PreviewComponentProps<T, any>>

Configure how a property is displayed as a preview, e.g. in the collection view. You can customize it by passing custom props that are received in the component.

Inherited from#

FieldConfig.Preview

Defined in#

models/properties.ts:529


customProps#

Optional customProps: any

Additional props that are passed to the components defined in field or in preview.

Inherited from#

FieldConfig.customProps

Defined in#

models/properties.ts:535


pickOnlySomeKeys#

Optional pickOnlySomeKeys: boolean

Allow the user to add only some of the keys in this map. By default all properties of the map have the corresponding field in the form view. Setting this flag to true allows to pick only some. Useful for map that can have a lot of subproperties that may not be needed

Defined in#

models/properties.ts:687