Skip to content

feat(types): add custom properties on EditorOptions #3761

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
TotomInc wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −0
Open

feat(types): add custom properties on EditorOptions #3761

Show file tree
Hide file tree
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
12 changes: 12 additions & 0 deletions docs/content/changelog/studio-customisation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,15 @@ This option can be set to avoid the display of a field in the Studio editor.
::prose-tip
Studio inputs are fully extensible. We can create as many input as we want based on our users needs.
::

##### `fieldName: String`

You can set the editor input name in Studio editor.

##### `fieldDescription: String`

You can set an extra text under the field name in Studio editor.

##### `tooltip: String`

Display an info-bubble next to the field name in Studio editor.
3 changes: 3 additions & 0 deletions src/types/schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ export interface EditorOptions {
input?: 'media' | 'icon' | 'textarea' // 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
fieldName?: string // Override auto-generated field name with a custom one
fieldDescription?: string // When defined, set a description for the field
tooltip?: string // When defined, set a tooltip info-bubble next to the field name
}

export interface ContentStandardSchemaV1<Input = unknown, Output = Input> extends StandardSchemaV1<Input, Output> {
Expand Down
Loading