The text field represents a single line text input. It should be used for content values that are short strings: for example, a page title.

Options

interface TextConfig extends FieldConfig {
  component: 'text'
  name: string
  label?: string
  description?: string
  placeholder?: string
}

This interfaces only shows the keys unique to the text field. Visit the Field Config docs for a complete list of options.

Example: Blog Post Title

Below is an example of how a text field could be used to edit the title of a blog post.

const BlogPostForm = {
  fields: [
    {
      component: 'text',
      name: 'title',
      label: 'Title',
      description: 'Enter the title of the post here',
      placeholder: '...',
    },
  ],
}