Create extension point to connect the touring panel/Refactor LineupSidePanel

src/extensions.ts

@@ -6,9 +6,10 @@ import {IEventHandler} from 'phovea_core/src/event';
 import {IAdditionalColumnDesc} from './lineup';
 import {RangeLike} from 'phovea_core/src/range';
 import {IDType} from 'phovea_core/src/idtype';
-import {IColumnDesc, Column} from 'lineupjs';
+import {IColumnDesc, Column, LocalDataProvider} from 'lineupjs';
 import {EViewMode} from './views/interfaces';
 import {AppHeader} from 'phovea_ui/src/header';
+import {PanelTabEvents} from './lineup/internal/panel/PanelTab';
 
 export * from './tour/extensions';
 
@@ -23,6 +24,16 @@ export const EXTENSION_POINT_TDP_APP_EXTENSION = 'tdpAppExtension';
 export const EXTENSION_POINT_TDP_LIST_FILTERS = 'tdpListFilters';
 export const EXTENSION_POINT_TDP_VIEW_GROUPS = 'tdpViewGroups';
 
+/**
+ * Register a new tab to the LineupSidePanel.
+ * Consists of a button/header to open the tab content and the tab content itself
+ * @factoryParam {HTMLElement} parent The node of the tab content created through the extension point
+ * @factoryParam {LocalDataProvider} provider The data of the current ranking
+ * @factoryParam {IPanelTabExtensionDesc} desc The phovea extension point description
+ * @factoryParam {PanelTabEvents} events Listen when the tab closes or opens
+ */
+export const EP_TDP_CORE_LINEUP_PANEL_TAB = 'epTdpCoreLineupPanelTab';
+
 /**
  * Register new form elements for the form builder. Form elements must implement the `IFormElement`.
  *
@@ -136,6 +147,40 @@ export interface IScoreColumnPatcherExtensionDesc extends IPluginDesc {
   load(): Promise<IPlugin & IScoreColumnPatcherExtension>;
 }
 
+export interface IPanelTabExtension {
+  desc: IPanelTabExtensionDesc;
+  factory(parent: HTMLElement, provider: LocalDataProvider, desc: IRankingButtonExtensionDesc, events: PanelTabEvents, extraArgs?: object): Promise<IScoreParam>;
+}
+
+export interface IPanelTabExtensionDesc extends IPluginDesc {
+  /**
+   * CSS class for the PanelNavButton of the PanelTab
+   */
+  cssClass: string;
+
+  /**
+   * Title attribute PanelNavButton
+   */
+  title: string;
+
+  /**
+   * Customize the PanelNavButtons' position (recommended to use multiples of 10)
+   */
+  order: number;
+
+  /**
+   * Width of the PanelTab
+   */
+  width: string;
+
+  /**
+   * If true a shortcut button is appended to the SidePanel header in collapsed mode
+   * @default false
+   */
+  shortcut?: boolean;
+
+  load(): Promise<IPlugin & IPanelTabExtension>;
+}
 export interface IRankingButtonExtension {
   desc: IRankingButtonExtensionDesc;
   factory(desc: IRankingButtonExtensionDesc, idType: IDType, extraArgs: object): Promise<IScoreParam>;
@@ -302,7 +347,7 @@ export interface IViewPluginDesc extends IPluginDesc {
   /**
    * optional security check to show only certain views
    */
-  security?: string|((user: IUser)=>boolean);
+  security?: string|((user: IUser) => boolean);
 
   /**
    * a lot of topics/tags describing this view
@@ -312,7 +357,7 @@ export interface IViewPluginDesc extends IPluginDesc {
   /**
    * a link to an external help page
    */
-  helpUrl?: string | { url: string, linkText: string, title: string };
+  helpUrl?: string | {url: string, linkText: string, title: string};
   /**
    * as an alternative an help text shown as pop up
    */