Text
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.
Properties
- Requiredtype- Value must be set to - text.
- Requiredname- Required. The field name. This will be the key in the data record. 
- rows- Controls the number of rows/lines in the rendered textarea. Default number of rows: - 10.
- title- 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.
- readOnly- 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.
- description- Short description to editors how the field is to be used. 
- initialValue- 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. 
- deprecated- Marks a field or document type as deprecated in the studio interface and displays a user-defined message defined by the single required - reasonproperty.- If you deploy a GraphQL API schema, this property will translated into the - @deprecateddirective.
Options
Validation
- required()- Ensures that this field exists. 
- min(minLength)- Minimum length of string. 
- max(maxLength)- Maximum length of string. 
- length(exactLength)- Exact length of string. 
- uppercase()- All characters must be uppercase. 
- lowercase()- All characters must be lowercase. 
- email()- Value must be a valid email-address. 
- regex(pattern[, options])- String must match the given pattern. - optionsis an optional object, currently you can set- options.nameand- options.invert.- Providing a - namewill make the message more understandable to the user ("Does not match the <name>-pattern").- Set - invertto- truein order to allow any value that does NOT match the pattern.
- custom(fn)- 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", ... }Was this page helpful?