Keystone 6: Custom Fields

[molomby]

The API for custom field types has been redesigned and is now fully documented in the Custom Fields guide. As an app developer, you now have complete control over both the backend implementation and frontend interface that appears in the Admin UI, including:

• The relevant parts of the GraphQL API (inc. filter conditions, ordering, output and input types)
• How values are persisted in the database. As these configured using Prisma types, your field type will also get benefit from the automatic migration functionality.
• The React components used to render the create/edit interface in the Admin UI
• The list view (cell) and card views, used by relationship fields that link to items using your field type
• How values are serialized and deserialize for transport between the backend and the Admin UI

The custom-field example project shows these capabilities in context.

Custom fields can be used locally in your project or distributed (privately or publicly) as separate npm packages. If you have an existing OSS field type package, and you think would be broadly applicable for across other Keystone projects, reach out in slack to discuss whether a PR would be helpful and check out the contributor guidelines.