Skip to content
KeystoneJS LogoKeystoneJSv5

Fields

KeystoneJS contains a set of primitive fields types that can be imported from @keystonejs/fields. These include:

In addition to these are some other complex types that have their own package such as Markdown and Wysiwyg.

Need more? See our guide on Custom field types.

Usage

Fields definitions are provided when creating a list. Field definitions should be an object where the key is the field name and the value is an object containing the fields config:

keystone.createList('Post', {
  fields: {
    title: { type: Text },
  },
});

Config

Fields share some standard configuration options.

OptionTypeDefaultDescription
typeFieldType(required)
schemaDocBooleanfalseA description for the field used in the AdminUI.
defaultValueBoolean | FunctionundefinedA default value of the field.
isUniqueBooleanfalseWhether or not the field should be unique.
isRequiredBooleanfalseWhether or not the field should be mandatory.
accessBoolean | Function | ObjecttrueSee: (Access control)[https://keystonejs.com/guides/access-control] options for fields.
labelStringLabel for the field.

Note: Many field types have additional config options. See the documentation for individual field types for more detail.

type

A valid Keystone field type.

label

Sets the label for the field in the AdminUI

schemaDoc

A description of the field used in the AdminUI.

defaultValue

Sets the value when no data is provided.

Usage

keystone.createList('Post', {
  fields: {
    title: {
      type: Text,
      defaultValue: ({ existingItem, context, originalInput, actions }) => {
        /**/
      },
    },
    description: { type: Text, defaultValue: 'Lorem ipsum...' },
  },
});

For a 'nullable' field, set defaultValue: null.

The defaultValue can be a String or Function. Functions should returns the value, or a Promise for the value.

isUnique

Specifies whether the value should be unique or not. Will return an error is a user tries to create a field with a non-unique value.

isRequired

Specifies whether the field is required or not. Will return an error if mutations do not contain data.

access

Access control options for fields.

Options for create, read, update and delete - can be a function or Boolean. See the access control API documentation for more details.

Note: Field level access control does not accept graphQL where clauses.

cacheHint

HTTP cache hint for field.

Only static hints are supported for fields.

Have you found a mistake, something that is missing, or could be improved on this page? Please edit the Markdown file on GitHub and submit a PR with your changes.

Edit Page