Nightly Perpetrated Mischief

    This package has been deprecated

    Author message:

    All packages in the @keystone-alpha namespace are now available in the @keystonejs namespace, starting at version 5.0.0. To upgrade, update package.json to point to "@keystonejs/fields": "^5.0.0" and update any require/import statements in your code.

    @keystone-alpha/fields

    15.0.0 • Public • Published

    Fields

    KeystoneJS contains a set of primitive fields types that can be imported from @keystone-alpha/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.

    Option Type Default Description
    type FieldType (required)
    schemaDoc Boolean false A description for the field used in the AdminUI.
    defaultValue Boolean | Function undefined A default value of the field.
    isUnique Boolean false Whether or not the field should be unique.
    isRequired Boolean false Whether or not the field should be mandatory.
    access Boolean | Function | Object true See: (Access control)[/guides/access-control] options for fields.
    label String Label 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.

    Keywords

    none

    Install

    npm i @keystone-alpha/fields

    DownloadsWeekly Downloads

    82

    Version

    15.0.0

    License

    MIT

    Unpacked Size

    970 kB

    Total Files

    327

    Last publish

    Collaborators

    • dominikwilkowski
    • jedwatson
    • jesstelford
    • mitchellhamilton
    • molomby
    • timl