Image

The image field references a document in an upload-enabled collection, such as your media library, so editors pick a file instead of pasting a URL. Use it for images, documents, and other files. The helper is defineImageField, and the stored value is a reference to the upload document — set hasMany: true to reference several.

defineImageField({
  name: 'coverImage',
  label: 'Cover image',
  relationTo: 'media',
})

relationTo points at a collection configured with upload: true, which is what stores the file and its metadata. When you read the field, the referenced document exposes a resolved url alongside details like filename, mimeType, and image width and height — consume that url directly rather than reconstructing storage paths. On the frontend, the DyrectedImage and DyrectedMedia components render an upload value for you. See Storage Adapters for where the files actually live and how their URLs resolve.

Generated reference

The contract below is generated from the public @dyrected/core exports by @dyrected/knowledge, so it stays in sync with the package. See Fields for the shared field options every type accepts.

ImageField

A reference to one or more documents in an upload-enabled collection, stored as an ID or array of IDs. Use relationTo to name the target and hasMany for multiple.

export type ImageField = TypedField<"image", string | string[]>;