@nextcloud/sharing
    Preparing search index...

    Interface ISidebarInlineAction

    interface ISidebarInlineAction {
        iconSvg: string;
        id: string;
        order: number;
        enabled(share: IShare, node: INode): boolean;
        exec(share: IShare, node: INode): void | Promise<void>;
        label(share: IShare, node: INode): string;
    }
    Index

    Properties

    iconSvg id order

    Methods

    enabled exec label

    Properties

    iconSvg: string

    The inline svg icon to use.

    id: string

    Unique identifier for the action

    order: number

    Order of the sidebar actions. A higher value means the action will be displayed first.

    Methods

    • Check if the action is enabled for a specific share type

      Parameters

      • share: IShare

        The share

      • node: INode

        The node that share is about

      Returns boolean

    • The callback handler when the user selected this action.

      Parameters

      • share: IShare

        The share

      • node: INode

        The shared node

      Returns void | Promise<void>

    • The localized label of this action

      Parameters

      • share: IShare

        The current share (might not be created yet)

      • node: INode

        The shared node

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods