3.4 KiB
id, title, sidebar_label, sidebar_position, custom_edit_url
| id | title | sidebar_label | sidebar_position | custom_edit_url |
|---|---|---|---|---|
| mapproperty | Interface: MapProperty<T, Key> | MapProperty | 0 | null |
Type parameters
| Name | Type |
|---|---|
T |
T = any |
Key |
Key: string = Extract<keyof T, string> |
Hierarchy
-
BaseProperty↳ MapProperty
Properties
columnWidth
• Optional columnWidth: number
Width in pixels of this column in the collection view. If not set the width is inferred based on the other configurations
Inherited from
BaseProperty.columnWidth
Defined in
config
• Optional config: MapFieldConfig<T>
Configure how this property field is displayed
Defined in
dataType
• dataType: "map"
Overrides
BaseProperty.dataType
Defined in
description
• Optional description: string
Property description, always displayed under the field
Inherited from
BaseProperty.description
Defined in
disabled
• Optional disabled: boolean | PropertyDisabledConfig
Is this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties
Inherited from
BaseProperty.disabled
Defined in
longDescription
• Optional longDescription: string
Longer description of a field, displayed under a popover
Inherited from
BaseProperty.longDescription
Defined in
previewProperties
• Optional previewProperties: Key[]
Properties that are displayed when as a preview
Defined in
properties
• Optional properties: Properties<Key, any>
Record of properties included in this map.
Defined in
readOnly
• Optional readOnly: boolean
Is this a read only property. When set to true, it gets rendered as a preview.
Inherited from
BaseProperty.readOnly
Defined in
title
• Optional title: string
Property title (e.g. Product)
Inherited from
BaseProperty.title
Defined in
validation
• Optional validation: PropertyValidationSchema
Rules for validating this property
Overrides
BaseProperty.validation