@nextcloud/files
    Preparing search index...

    Interface ISidebarTab

    Implementation of a custom sidebar tab within the files app.

    interface ISidebarTab {
        displayName: string;
        enabled: (context: ISidebarContext) => boolean;
        iconSvgInline: string;
        id: string;
        order: number;
        tagName: string;
    }
    Index

    Properties

    displayName enabled iconSvgInline id order tagName

    Properties

    displayName: string

    The localized name of the sidebar tab.

    enabled: (context: ISidebarContext) => boolean

    Callback to check if the sidebar tab should be shown for the selected node.

    Type Declaration

    iconSvgInline: string

    The icon, as SVG, of the sidebar tab.

    id: string

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

    order: number

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

    tagName: string

    The tag name of the web component. The web component must already be registered under that tag name with CustomElementRegistry.define().

    To avoid name clashes the name has to start with your appid (e.g. your_app). So in addition with the web component naming rules a good name would be your_app-files-sidebar-tab.

    Settings

    Member Visibility

    On This Page

    Properties