Skip to main content

Interface: StringProperty

Hierarchy​

  • BaseProperty

    ↳ StringProperty

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/properties.ts:96


config​

• Optional config: StringFieldConfig

Configure how this field is displayed

Defined in​

models/properties.ts:265


dataType​

• dataType: "string"

Overrides​

BaseProperty.dataType

Defined in​

models/properties.ts:260


description​

• Optional description: string

Property description, always displayed under the field

Inherited from​

BaseProperty.description

Defined in​

models/properties.ts:85


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/properties.ts:109


longDescription​

• Optional longDescription: string

Longer description of a field, displayed under a popover

Inherited from​

BaseProperty.longDescription

Defined in​

models/properties.ts:90


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/properties.ts:102


title​

• Optional title: string

Property title (e.g. Product)

Inherited from​

BaseProperty.title

Defined in​

models/properties.ts:80


validation​

• Optional validation: StringPropertyValidationSchema

Rules for validating this property

Overrides​

BaseProperty.validation

Defined in​

models/properties.ts:270