outsystems-ui - v2.30.0
    Preparing search index...

    Interface ISidebar

    Defines the interface for OutSystemsUI Sidebar Pattern

    ISidebar

    interface ISidebar {
        build(): void;
        dispose(): void;
        isOpen?: boolean;
        close(): void;
        open(isOpenedByApi?: boolean): void;
        isBuilt: boolean;
        selfElement: HTMLElement;
        uniqueId: string;
        widgetId: string;
        changeProperty(propertyName: string, propertyValue: unknown): void;
        registerCallback(eventName: string, callback: OSGeneric): void;
        equalsToID(id: string): boolean;
        clickOutsideToClose(closeOnOutSIdeClick: boolean): void;
        toggleGestures(enableSwipe: boolean): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    isOpen? isBuilt selfElement uniqueId widgetId
    build dispose close open changeProperty registerCallback equalsToID clickOutsideToClose toggleGestures
    isOpen?: boolean
    isBuilt: boolean

    Indicates if the instance of the pattern is built.

    OSFramework.Interface.IPattern

    selfElement: HTMLElement

    Pattern HTML element

    OSFramework.Interface.IPattern

    uniqueId: string

    Internal Id of the instance of the pattern.

    OSFramework.Interface.IPattern

    widgetId: string

    External Id of the instance of the pattern

    OSFramework.Interface.IPattern

    • Method signature to change the properties/configs of the pattern.

      Parameters

      • propertyName: string
      • propertyValue: unknown

      Returns void

      OSFramework.Interface.IPattern

    • Method to toggle the click on outside to close the Sidebar.

      Parameters

      • closeOnOutSIdeClick: boolean

      Returns void

      ISidebar

    Settings
    Member Visibility

    On This Page
    Properties
    Methods