Interface SplitEditorContribution<W>

A contribution interface for handling split operations on different editor types. Implementations should handle specific editor widget types (e.g., text editors, notebook editors).

interface SplitEditorContribution<W extends Widget = Widget> {
canHandle(widget: Widget): number;
split(widget: W, splitMode: DockLayout.InsertMode): Promise<undefined | W>;
}

Type Parameters

W extends Widget = Widget
the specific widget type this contribution handles

Implemented by

Index

Methods

canHandle split

Methods

canHandle

canHandle(widget: Widget): number
Determines whether this contribution can handle the split operation for the given widget.
Parameters
- widget: Widget
  the widget to check
Returns number
a priority number (higher means higher priority), or 0 if this contribution cannot handle the widget
- Defined in packages/editor/src/browser/split-editor-contribution.ts:36

split

split(widget: W, splitMode: DockLayout.InsertMode): Promise<undefined | W>
Splits the given widget according to the specified split mode.
Parameters
- widget: W
  the widget to split
- splitMode: DockLayout.InsertMode
  the direction in which to split
Returns Promise<undefined | W>
the newly created widget, or undefined if the split operation failed
- Defined in packages/editor/src/browser/split-editor-contribution.ts:44

Interface SplitEditorContribution<W>

Type Parameters

Implemented by

Index

Methods

Methods

canHandle

Parameters

Returns number

split

Parameters

Returns Promise<undefined | W>

Settings

On This Page