Interface ISidebarAction

Implementation of a custom sidebar tab within the files app.

interface ISidebarAction {
    id: string;
    order: number;
    displayName(context: ISidebarContext): string;
    enabled(context: ISidebarContext): boolean;
    iconSvgInline(context: ISidebarContext): string;
    onClick(context: ISidebarContext): void;
}

Index

Properties

Methods

displayName enabled iconSvgInline onClick

Properties

id

id: string

Unique id of the sidebar tab. This has to conform to the HTML id attribute specification.

order

order: number

The order of this tab. Use a low number to make this tab ordered in front.

Methods

displayName

displayName(context: ISidebarContext): string
The localized name of the sidebar tab.
Parameters
- context: ISidebarContext
  The current context of the files app
Returns string
- Defined in sidebar/SidebarAction.ts:31

enabled

enabled(context: ISidebarContext): boolean
Callback to check if the sidebar tab should be shown for the selected node.
Parameters
- context: ISidebarContext
  The current context of the files app
Returns boolean
- Defined in sidebar/SidebarAction.ts:45

iconSvgInline

iconSvgInline(context: ISidebarContext): string
The icon, as SVG, of the sidebar tab.
Parameters
- context: ISidebarContext
  The current context of the files app
Returns string
- Defined in sidebar/SidebarAction.ts:38

onClick

onClick(context: ISidebarContext): void
Handle the sidebar action.
Parameters
- context: ISidebarContext
  The current context of the files app
Returns void
- Defined in sidebar/SidebarAction.ts:52