Keystone 6: Built-In Field Types

[molomby]

Many of the built-in field types have been updated in the development of Keystone 6. This table shows how many fields should be mapped between versions:

Keystone 5	Keystone 6	Notes
-	document	A highly customizable rich text editor
-	image	Represents an image file (.jpg, .png, .webp, or .gif)
-	json	Arbitrary JSON blobs
AuthedRelationship	-	Can be achieved using relationships and hooks
AutoIncrement	integer	See the { kind: 'autoincrement' } option for the integer type and system idField config
CalendarDay	-	No equivalent yet; can be stored as text
Checkbox	checkbox
CloudinaryImage	cloudinaryImage	Under development ⚠️ see also image
Color	-	No equivalent yet; can be stored as text
Content	-	See the document type for a function equivalent
DateTime	-	Should be migrated to the timestamp type
DateTimeUtc	timestamp	Datetime values surfaced using ISO 8601/RFC 3339 formats
Decimal	decimal	Largely unchanged
File	file	Under development ⚠️
Float	float	Largely unchanged
Integer	integer	Largely unchanged
LocationGoogle	-	No equivalent yet; can be stored as json
Markdown	-	No equivalent yet; can be stored as text
MongoId	-	No equivalent; can be stored as text
OEmbed	-	No equivalent yet; can be stored as json
Password	password	Largely unchanged
Relationship	relationships	Largely unchanged; new display options
Select	select	Largely unchanged
Slug	-	No equivalent yet; functionality can be emulated using text and hooks
Text	text	Largely unchanged
Unsplash	-	No equivalent yet; can be stored as json
Url	-	No equivalent yet; can be stored as text with validation for format
Uuid	-	See the { kind: 'uuid' } option for system idField config or non-primary keys can be stored as text
Virtual	virtual	Largely unchanged
Wysiwyg	-	See the document type similar functionality

Don't see exactly what you need? Well, extending Keystone is easier than ever. Have a look at the Custom Fields guide, the custom-field example project and check out the relevant upgrade discussion here on GitHub.