Skip to main content
Version: 3.0.0-beta

Interface: MapProperty<T>

Extends​

Type Parameters​

• T extends Record<string, CMSType> = Record<string, CMSType>

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​

BaseProperty.Field

Defined in​

packages/firecms_core/src/types/properties.ts:134


Preview?​

optional Preview: ComponentType<PropertyPreviewProps<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​

BaseProperty.Preview

Defined in​

packages/firecms_core/src/types/properties.ts:141


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​

packages/firecms_core/src/types/properties.ts:100


customProps?​

optional customProps: any

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

Inherited from​

BaseProperty.customProps

Defined in​

packages/firecms_core/src/types/properties.ts:147


dataType​

dataType: "map"

Datatype of the property

Overrides​

BaseProperty.dataType

Defined in​

packages/firecms_core/src/types/properties.ts:479


defaultValue?​

optional defaultValue: T

This value will be set by default for new entities.

Inherited from​

BaseProperty.defaultValue

Defined in​

packages/firecms_core/src/types/properties.ts:152


description?​

optional description: string

Property description, always displayed under the field

Inherited from​

BaseProperty.description

Defined in​

packages/firecms_core/src/types/properties.ts:81


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 (including custom messages, clear value on disabled or hide the field completely)

Inherited from​

BaseProperty.disabled

Defined in​

packages/firecms_core/src/types/properties.ts:120


editable?​

optional editable: boolean

Should this property be editable. If set to true, the user will be able to modify the property and save the new config. The saved config will then become the source of truth.

Inherited from​

BaseProperty.editable

Defined in​

packages/firecms_core/src/types/properties.ts:158


expanded?​

optional expanded: boolean

Should the field be initially expanded. Defaults to true

Defined in​

packages/firecms_core/src/types/properties.ts:523


hideFromCollection?​

optional hideFromCollection: boolean

Do not show this property in the collection view

Inherited from​

BaseProperty.hideFromCollection

Defined in​

packages/firecms_core/src/types/properties.ts:105


keyValue?​

optional keyValue: boolean

Render this map as a key-value table that allows to use arbitrary keys. You don't need to define the properties in this case.

Defined in​

packages/firecms_core/src/types/properties.ts:529


longDescription?​

optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from​

BaseProperty.longDescription

Defined in​

packages/firecms_core/src/types/properties.ts:94


name?​

optional name: string

Property name (e.g. Product)

Inherited from​

BaseProperty.name

Defined in​

packages/firecms_core/src/types/properties.ts:76


pickOnlySomeKeys?​

optional pickOnlySomeKeys: boolean

Allow the user to add only some 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 sub-properties that may not be needed

Defined in​

packages/firecms_core/src/types/properties.ts:512


previewProperties?​

optional previewProperties: Partial<Extract<keyof T, string>>[]

Properties that are displayed when rendered as a preview

Defined in​

packages/firecms_core/src/types/properties.ts:503


properties?​

optional properties: PropertiesOrBuilders<T>

Record of properties included in this map.

Defined in​

packages/firecms_core/src/types/properties.ts:484


propertiesOrder?​

optional propertiesOrder: Extract<keyof T, string>[]

Order in which the properties are displayed. If you are specifying your collection as code, the order is the same as the one you define in properties, and you don't need to specify this prop.

Defined in​

packages/firecms_core/src/types/properties.ts:491


propertyConfig?​

optional propertyConfig: string

You can use this prop to reuse a property that has been defined in the top level of the CMS in the prop fields. All the configuration will be taken from the inherited config, and overwritten by the current property config.

Inherited from​

BaseProperty.propertyConfig

Defined in​

packages/firecms_core/src/types/properties.ts:89


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​

packages/firecms_core/src/types/properties.ts:111


spreadChildren?​

optional spreadChildren: boolean

Display the child properties as independent columns in the collection view

Defined in​

packages/firecms_core/src/types/properties.ts:518


validation?​

optional validation: PropertyValidationSchema

Rules for validating this property. NOTE: If you don't set required in the map property, an empty object will be considered valid, even if you set required in the properties.

Overrides​

BaseProperty.validation

Defined in​

packages/firecms_core/src/types/properties.ts:498

Sign up to our newsletter to get the latest news and updates. No spam!