Skip to content

Improve types for builtin editor widget IDs #1462

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

Merged
Lisa White (whitelisab) merged 1 commit into from
Jan 31, 2025
Merged

Improve types for builtin editor widget IDs #1462

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
45 changes: 41 additions & 4 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,32 @@ export interface EditorLayoutMovement {
afterFieldGroup(groupId?: string): void
}

type BuiltinEditor =
| 'assetLinkEditor'
| 'assetLinksEditor'
| 'assetGalleryEditor'
| 'boolean'
| 'datePicker'
| 'entryLinkEditor'
| 'entryLinksEditor'
| 'entryCardEditor'
| 'entryCardsEditor'
| 'numberEditor'
| 'rating'
| 'locationEditor'
| 'objectEditor'
| 'urlEditor'
| 'slugEditor'
| 'listInput'
| 'checkbox'
| 'tagEditor'
| 'multipleLine'
| 'markdown'
| 'singleLine'
| 'dropdown'
| 'radio'
| 'richTextEditor'

type FieldType =
| 'Symbol'
| 'Text'
Expand Down Expand Up @@ -208,8 +234,8 @@ export interface IFieldGroupWidgetSettings {
}

export interface IEntryEditor {
widgetNamespace: 'editor-builtin' | 'builtin' | 'extension' | 'app',
widgetId: string,
widgetNamespace: 'editor-builtin' | 'builtin' | 'extension' | 'app'
widgetId: string
settings?: IEditorInterfaceOptions
}

Expand Down Expand Up @@ -251,7 +277,12 @@ export interface ContentType {
* @param settings Widget settings
*/
configureEntryEditor(
widgetNamespace: 'editor-builtin' | 'builtin' | 'extension' | 'app',
widgetNamespace: 'builtin',
widgetId: BuiltinEditor,
settings?: IEditorInterfaceOptions
): void
configureEntryEditor(
widgetNamespace: 'editor-builtin' | 'extension' | 'app',
widgetId: string,
settings?: IEditorInterfaceOptions
): void
Expand All @@ -273,7 +304,13 @@ export interface ContentType {
*/
changeFieldControl(
fieldId: string,
widgetNamespace: 'builtin' | 'extension' | 'app',
widgetNamespace: 'builtin',
widgetId: BuiltinEditor,
settings: IEditorInterfaceOptions
): void
changeFieldControl(
fieldId: string,
widgetNamespace: 'extension' | 'app',
widgetId: string,
settings?: IEditorInterfaceOptions
): void
Expand Down