Interface: StringProperty
Extends​
BaseProperty
<string
>
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​
packages/firecms_core/src/types/properties.ts:134
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​
packages/firecms_core/src/types/properties.ts:141
clearable?​
optional
clearable:boolean
Add an icon to clear the value and set it to null
. Defaults to false
Defined in​
packages/firecms_core/src/types/properties.ts:402
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​
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​
Defined in​
packages/firecms_core/src/types/properties.ts:147
dataType​
dataType:
"string"
Datatype of the property
Overrides​
Defined in​
packages/firecms_core/src/types/properties.ts:344
defaultValue?​
optional
defaultValue:string
This value will be set by default for new entities.
Inherited from​
Defined in​
packages/firecms_core/src/types/properties.ts:152
description?​
optional
description:string
Property description, always displayed under the field
Inherited from​
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​
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​
Defined in​
packages/firecms_core/src/types/properties.ts:158
email?​
optional
email:boolean
Does this field include an email
Defined in​
packages/firecms_core/src/types/properties.ts:387
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​
packages/firecms_core/src/types/properties.ts:370
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
longDescription?​
optional
longDescription:string
Longer description of a field, displayed under a popover
Inherited from​
Defined in​
packages/firecms_core/src/types/properties.ts:94
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​
packages/firecms_core/src/types/properties.ts:358
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​
packages/firecms_core/src/types/properties.ts:351
name?​
optional
name:string
Property name (e.g. Product)
Inherited from​
Defined in​
packages/firecms_core/src/types/properties.ts:76
previewAsTag?​
optional
previewAsTag:boolean
Should this string be rendered as a tag instead of just text.
Defined in​
packages/firecms_core/src/types/properties.ts:392
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​
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​
Defined in​
packages/firecms_core/src/types/properties.ts:111
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​
packages/firecms_core/src/types/properties.ts:376
url?​
optional
url:boolean
|PreviewType
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​
packages/firecms_core/src/types/properties.ts:382
validation?​
optional
validation:StringPropertyValidationSchema
Rules for validating this property