Interface IRunningSessionSidebar

The interface exposing the running sessions sidebar widget properties.

interface IRunningSessionSidebar {
    accordionPanel: null | AccordionPanel;
    sectionAdded: ISignal<IRunningSessionSidebar, ISectionEntry>;
    toolbar: Toolbar<Widget>;
    getSections(): readonly ISectionEntry[];
    reinsertSection(widget: Widget): void;
    removeSectionById(sectionId: string): null | Widget;
}

Hierarchy (View Summary)

Implemented by

Properties

accordionPanel sectionAdded toolbar

Methods

getSections reinsertSection removeSectionById

Properties

ReadonlyaccordionPanel

accordionPanel: null | AccordionPanel

The AccordionPanel that renders this sidebar's sections.

The move plugin reads this to set up drag-to-reorder handles after a section is moved.

ReadonlysectionAdded

sectionAdded: ISignal<IRunningSessionSidebar, ISectionEntry>

Emitted each time a new section widget is added to this panel.

Implementations should emit this signal from addWidget (or equivalent) with a fully-populated ISectionEntry for the newly added widget.

Readonlytoolbar

toolbar: Toolbar<Widget>

The toolbar of the running sidebar.

Methods

getSections

reinsertSection

  • reinsertSection(widget: Widget): void

  • Re-attach a widget that was previously removed by removeSectionById.

    Called when the user chooses "Move back to …" on a section that was originally owned by this panel. A typical implementation calls this.addWidget(widget).

    Parameters

    Returns void

removeSectionById

  • removeSectionById(sectionId: string): null | Widget

  • Detach the section identified by sectionId and return its widget so the move plugin can hand it to a target panel.

    A typical implementation sets widget.parent = null, which detaches the widget from the AccordionPanel without destroying it. Returns null if no section with the given id currently exists in this panel.

    Parameters

    Returns null | Widget

Settings

Member Visibility

On This Page

Properties
Methods