Skip to content

feat(schema): add relation editor option #3840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nadaamd wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −1
Open

feat(schema): add relation editor option #3840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/types/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,21 @@ export interface ContentConfig {
}

export interface EditorOptions {
input?: 'media' | 'icon' | 'textarea' // Override the default input for the field
input?: 'media' | 'icon' | 'textarea' | 'relation' // Override the default input for the field
hidden?: boolean // Do not display the field in the editor
iconLibraries?: string[] // List of icon libraries to use for the icon input
relation?: RelationOptions // Collection referenced by the field, for the relation input
label?: string // Override auto-generated label with a custom one
description?: string // When defined, set a description for the field
tooltip?: string // When defined, set a tooltip info-bubble next to the label
}

export interface RelationOptions {
collection: string // Name of the referenced collection, as declared in the content config
valueField?: 'slug' | 'path' | 'stem' | (string & {}) // Field of the referenced document written to the file, defaults to `slug` (its file name)
labelField?: string // Field of the referenced document displayed in the editor, defaults to `name` then `title`
}

export interface ContentStandardSchemaV1<Input = unknown, Output = Input> extends StandardSchemaV1<Input, Output> {
$content?: ContentConfig
}
Loading