Files
firecms/website/docs/api/interfaces/arrayproperty.md
2021-06-06 13:36:47 +02:00

3.3 KiB

id, title, sidebar_label, sidebar_position, custom_edit_url
id title sidebar_label sidebar_position custom_edit_url
arrayproperty Interface: ArrayProperty<T> ArrayProperty 0 null

Type parameters

Name Type
T T = any

Hierarchy

  • BaseProperty

    ArrayProperty

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

models/models.ts:446


config

Optional config: FieldConfig<T[], any>

Configure how this property field is displayed

Defined in

models/models.ts:608


dataType

dataType: "array"

Overrides

BaseProperty.dataType

Defined in

models/models.ts:591


description

Optional description: string

Property description, always displayed under the field

Inherited from

BaseProperty.description

Defined in

models/models.ts:435


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

models/models.ts:459


longDescription

Optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from

BaseProperty.longDescription

Defined in

models/models.ts:440


of

Optional of: Property<T, any>

The property of this array. You can specify any property. You can also specify an array or properties if you need the array to have a specific limited shape such as [string, number, string]

Defined in

models/models.ts:598


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

models/models.ts:452


title

Optional title: string

Property title (e.g. Product)

Inherited from

BaseProperty.title

Defined in

models/models.ts:430


validation

Optional validation: ArrayPropertyValidationSchema

Rules for validating this property

Overrides

BaseProperty.validation

Defined in

models/models.ts:603