Was this page helpful?
Schema type reference for the Text type.
A basic string expected to contain multiple lines. Typically used for a summary, short bio etc. If you need text with markup and structured data, use block text.
Value must be set to text.
Required. The field name. This will be the key in the data record.
Controls the number of rows/lines in the rendered textarea. Default number of rows: 10.
Human readable label for the field.
If set to true, this field will be hidden in the studio. You can also return a callback function to use it as a conditional field.
If set to true, this field will not be editable in the content studio. You can also return a callback function to use it as a conditional field.
Short description to editors how the field is to be used.
The initial value used when creating new values from this type. Can be either a literal string value or a resolver function that returns either a literal string value or a promise resolving to the string initial value.
Marks a field or document type as deprecated in the studio interface and displays a user-defined message defined by the single required reason property.
If you deploy a GraphQL API schema, this property will translated into the @deprecated directive.
Ensures that this field exists.
Minimum length of string.
Maximum length of string.
Exact length of string.
All characters must be uppercase.
All characters must be lowercase.
Value must be a valid email-address.
String must match the given pattern.
options is an optional object, currently you can set options.name and options.invert.
Providing a name will make the message more understandable to the user ("Does not match the <name>-pattern").
Set invert to true in order to allow any value that does NOT match the pattern.
Creates a custom validation rule.
Input
{
title: 'Description',
name: 'description',
type: 'text'
}Response
{
"_type": "movie",
"_id": "23407q-qwerqyt12",
"description": "...rather long text here....\n yes.. long",
...
}{
title: 'Description',
name: 'description',
type: 'text'
}{
"_type": "movie",
"_id": "23407q-qwerqyt12",
"description": "...rather long text here....\n yes.. long",
...
}