Interface: StringProperty
Hierarchy​
BaseProperty<string>↳
StringProperty
Properties​
Field​
• Optional Field: ComponentType<FieldProps<string, 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​
Defined in​
lib/src/models/properties.ts:126
Preview​
• Optional Preview: ComponentType<PropertyPreviewProps<string, 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​
Defined in​
lib/src/models/properties.ts:133
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​
Defined in​
lib/src/models/properties.ts:92
customProps​
• Optional customProps: any
Additional props that are passed to the components defined in field
or in preview.
Inherited from​
Defined in​
lib/src/models/properties.ts:139
dataType​
• dataType: "string"
Datatype of the property
Overrides​
Defined in​
lib/src/models/properties.ts:314
defaultValue​
• Optional defaultValue: string
This value will be set by default for new entities.
Inherited from​
Defined in​
lib/src/models/properties.ts:144
description​
• Optional description: string
Property description, always displayed under the field
Inherited from​
Defined in​
lib/src/models/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​
Defined in​
lib/src/models/properties.ts:112
editable​
• Optional editable: boolean
Should this property be editable in the collection editor.
If the property has been defined in code, it defaults to false otherwise,
it defaults to true.
Inherited from​
Defined in​
lib/src/models/properties.ts:151
email​
• Optional email: boolean
Does this field include an email
Defined in​
lib/src/models/properties.ts:357
enumValues​
• Optional enumValues: EnumValues
You can use the enum values providing a map of possible
exclusive values the property can take, mapped to the label that it is
displayed in the dropdown. You can use a simple object with the format
value => label, or with the format value => EnumValueConfig if you
need extra customization, (like disabling specific options or assigning
colors). If you need to ensure the order of the elements, you can pass
a Map instead of a plain object.
Defined in​
lib/src/models/properties.ts:340
hideFromCollection​
• Optional hideFromCollection: boolean
Do not show this property in the collection view
Inherited from​
BaseProperty.hideFromCollection
Defined in​
lib/src/models/properties.ts:97
longDescription​
• Optional longDescription: string
Longer description of a field, displayed under a popover
Inherited from​
Defined in​
lib/src/models/properties.ts:86
markdown​
• Optional markdown: boolean
Should this string property be displayed as a markdown field. If true, the field is rendered as a text editors that supports markdown highlight syntax. It also includes a preview of the result.
Defined in​
lib/src/models/properties.ts:328
multiline​
• Optional multiline: boolean
Is this string property long enough so it should be displayed in a multiple line field. Defaults to false. If set to true, the number of lines adapts to the content
Defined in​
lib/src/models/properties.ts:321
name​
• Optional name: string
Property name (e.g. Product)
Inherited from​
Defined in​
lib/src/models/properties.ts:76
previewAsTag​
• Optional previewAsTag: boolean
Should this string be rendered as a tag instead of just text.
Defined in​
lib/src/models/properties.ts:362
readOnly​
• Optional readOnly: boolean
Is this a read only property. When set to true, it gets rendered as a preview.
Inherited from​
Defined in​
lib/src/models/properties.ts:103
storage​
• Optional storage: StorageConfig
You can specify a Storage configuration. It is used to
indicate that this string refers to a path in Google Cloud Storage.
Defined in​
lib/src/models/properties.ts:346
url​
• Optional url: boolean
If the value of this property is a URL, you can set this flag to true to add a link, or one of the supported media types to render a preview
Defined in​
lib/src/models/properties.ts:352
validation​
• Optional validation: StringPropertyValidationSchema
Rules for validating this property