Text Field
Config
Option | Description |
|---|---|
| To be used as the property name when stored and retrieved from the database. More |
| Text used as a field label in the Admin panel or an object with keys for each language. |
| Enforce that each entry in the Collection has a unique value for this field. |
| Used by the default validation function to ensure values are of a minimum character length. |
| Used by the default validation function to ensure values are of a maximum character length. |
| Provide a custom validation function that will be executed on both the Admin panel and the backend. More |
| Build an index for this field to produce faster queries. Set this field to |
| If this field is top-level and nested in a config supporting Authentication, include its data in the user JWT. |
| Provide field-based hooks to control logic for this field. More |
| Provide field-based access control to denote what users can see and do with this field's data. More |
| Restrict 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. |
| Provide data to be used for this field's default value. More |
| Enable localization for this field. Requires localization to be enabled in the Base config. |
| Require this field to have a value. |
| Admin-specific configuration. See below for more detail. |
| Extension point for adding custom data (e.g. for plugins) |
| Makes this field an ordered array of text instead of just a single text. |
| Minimum number of texts in the array, if |
| maxRows | Maximum number of texts in the array, if hasMany is set to true. | \* An asterisk denotes that a property is required.
Admin config
In addition to the default field admin config, the Text field type allows for the following admin properties:
placeholder
Set this property to define a placeholder string in the text input.
autoComplete
Set this property to a string that will be used for browser autocomplete.
rtl
Override the default text direction of the Admin panel for this field. Set to true to force right-to-left text direction.
Example
collections/ExampleCollection.ts