Textarea Field

Config

OptionDescription
name *To be used as the property name when stored and retrieved from the database.
labelUsed as a field label in the Admin panel and to name the generated GraphQL type.
uniqueEnforce that each entry in the Collection has a unique value for this field.
minLengthUsed by the default validation function to ensure values are of a minimum character length.
maxLengthUsed by the default validation function to ensure values are of a maximum character length.
validateProvide a custom validation function that will be executed on both the Admin panel and the backend. More
indexBuild a MongoDB index for this field to produce faster queries. Set this field to true if your users will perform queries on this field's data often.
saveToJWTIf this field is top-level and nested in a config supporting Authentication, include its data in the user JWT.
hooksProvide field-based hooks to control logic for this field. More
accessProvide field-based access control to denote what users can see and do with this field's data. More
hiddenRestrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.
defaultValueProvide data to be used for this field's default value.
localizedEnable localization for this field. Requires localization to be enabled in the Base config.
requiredRequire this field to have a value.
adminAdmin-specific configuration. See below for more detail.

* An asterisk denotes that a property is required.

Admin config

In addition to the default field admin config, the Textarea field type allows for the following admin properties:

placeholder

Set this property to define a placeholder string in the textarea.

autoComplete

Set this property to a string that will be used for browser autocomplete.

Example

collections/ExampleCollection.js

{
slug: 'example-collection',
fields: [
{
name: 'metaDescription', // required
type: 'textarea', // required
label: 'Page Meta Description',
required: true,
}
]
}
Next

Upload Field