@jupyterlab/running 4.2.0-alpha.1 → 4.2.0-beta.0

package/lib/index.d.ts

@@ -3,14 +3,22 @@
  * @module running
  */
 import { ITranslator } from '@jupyterlab/translation';
-import { LabIcon, SidePanel } from '@jupyterlab/ui-components';
+import { IScore, LabIcon, ReactWidget, SidePanel, Toolbar } from '@jupyterlab/ui-components';
+import { IStateDB } from '@jupyterlab/statedb';
 import { Token } from '@lumino/coreutils';
 import { IDisposable } from '@lumino/disposable';
+import { Message } from '@lumino/messaging';
 import { ISignal } from '@lumino/signaling';
+import { Panel } from '@lumino/widgets';
+import { ReactNode } from 'react';
 /**
- * The running sessions token.
+ * The running sessions managers token.
  */
 export declare const IRunningSessionManagers: Token<IRunningSessionManagers>;
+/**
+ * The running sessions token.
+ */
+export declare const IRunningSessionSidebar: Token<IRunningSessionSidebar>;
 /**
  * The running interface.
  */
@@ -50,14 +58,38 @@ export declare class RunningSessionManagers implements IRunningSessionManagers {
     private _added;
     private _managers;
 }
+interface IFilterProvider {
+    filter(item: IRunningSessions.IRunningItem): Partial<IScore> | null;
+    filterChanged: ISignal<IFilterProvider, void>;
+}
+declare class FilterWidget extends ReactWidget implements IFilterProvider {
+    constructor(translator: ITranslator);
+    get filterChanged(): ISignal<FilterWidget, void>;
+    render(): JSX.Element;
+    filter(item: IRunningSessions.IRunningItem): Partial<IScore> | null;
+    private _getTextContent;
+    private _updateFilter;
+    private _filterFn;
+    private _filterChanged;
+    private _trans;
+}
+/**
+ * The interface exposing the running sessions sidebar widget properties.
+ */
+export interface IRunningSessionSidebar {
+    /**
+     * The toolbar of the running sidebar.
+     */
+    readonly toolbar: Toolbar;
+}
 /**
  * A class that exposes the running terminal and kernel sessions.
  */
-export declare class RunningSessions extends SidePanel {
+export declare class RunningSessions extends SidePanel implements IRunningSessionSidebar {
     /**
      * Construct a new running widget.
      */
-    constructor(managers: IRunningSessionManagers, translator?: ITranslator);
+    constructor(managers: IRunningSessionManagers, translator?: ITranslator, stateDB?: IStateDB | null);
     /**
      * Dispose the resources held by the widget
      */
@@ -68,9 +100,87 @@ export declare class RunningSessions extends SidePanel {
      * @param managers Managers
      * @param manager New manager
      */
-    protected addSection(_: unknown, manager: IRunningSessions.IManager): void;
+    protected addSection(_: unknown, manager: IRunningSessions.IManager): Promise<void>;
+    /**
+     * Update state database with the new state of a given section.
+     */
+    private _updateState;
+    /**
+     * Get current state from the state database.
+     */
+    private _getState;
     protected managers: IRunningSessionManagers;
     protected translator: ITranslator;
+    private _stateDB;
+}
+/**
+ * A panel intended for use within `Dialog` to allow searching tabs and running sessions.
+ */
+export declare class SearchableSessions extends Panel {
+    constructor(managers: IRunningSessionManagers, translator?: ITranslator);
+    /**
+     * Dispose the resources held by the widget
+     */
+    dispose(): void;
+    /**
+     * Click active element when the user confirmed the choice in the dialog.
+     */
+    getValue(): void;
+    /**
+     * Handle incoming events.
+     */
+    handleEvent(event: Event): void;
+    /**
+     * A message handler invoked on an `'after-attach'` message.
+     */
+    protected onAfterAttach(_: Message): void;
+    /**
+     * A message handler invoked on an `'after-detach'` message.
+     */
+    protected onAfterDetach(_: Message): void;
+    /**
+     * Force focus on the filter input.
+     *
+     * Note: forces focus because this widget is intended to be used in `Dialog`,
+     * which does not support focusing React widget nested within a non-React
+     * widget (a limitation of `focusNodeSelector` option implementation).
+     */
+    private _forceFocusInput;
+    /**
+     * Navigate between items using up/down keys by shifting focus.
+     */
+    private _evtKeydown;
+    /**
+     * Set and mark active item relative to the current.
+     *
+     * Returns whether an active item was set.
+     */
+    private _updateActive;
+    private _translator;
+    private _filterWidget;
+    private _activeIndex;
+    private _list;
+}
+/**
+ * A panel list of searchable sessions.
+ */
+export declare class SearchableSessionsList extends Panel {
+    constructor(managers: IRunningSessionManagers, filterWidget: FilterWidget, translator?: ITranslator);
+    /**
+     * Dispose the resources held by the widget
+     */
+    dispose(): void;
+    /**
+     * Add a section for a new manager.
+     *
+     * @param managers Managers
+     * @param manager New manager
+     */
+    protected addSection(_: unknown, manager: IRunningSessions.IManager): void;
+    private _managers;
+    private _translator;
+    private _emptyIndicator;
+    private _filterWidget;
 }
 /**
  * The namespace for the `IRunningSessions` class statics.
@@ -103,7 +213,7 @@ export declare namespace IRunningSessions {
         /**
          * A string used to describe the shutdown action.
          */
-        shutdownLabel?: string;
+        shutdownLabel?: string | ((item: IRunningSessions.IRunningItem) => string);
         /**
          * A string used to describe the shutdown all action.
          */
@@ -149,7 +259,7 @@ export declare namespace IRunningSessions {
         /**
          * Called to determine the label for each item.
          */
-        label: () => string;
+        label: () => ReactNode;
         /**
          * Called to determine the `title` attribute for each item, which is
          * revealed on hover.
@@ -162,3 +272,4 @@ export declare namespace IRunningSessions {
         detail?: () => string;
     }
 }
+export {};