Trilium Frontend API
    Preparing search index...

    Interface Options

    From T, pick a set of properties whose keys are in the union K

    interface Options {
        autoClose: boolean | "inside" | "outside";
        boundary: Boundary;
        display: "dynamic" | "static";
        offset: string | Dropdown.Offset | Dropdown.OffsetFunction;
        popperConfig: Partial<Options> | PopperConfigFunction;
        reference: Element | "toggle" | "parent" | Rect;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoClose: boolean | "inside" | "outside"

    Configure the auto close behavior of the dropdown

    true
    
    boundary: Boundary

    Overflow constraint boundary of the dropdown menu. Accepts the values of 'viewport', 'window', 'scrollParent', or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's preventOverflow docs.

    display: "dynamic" | "static"

    By default, we use Popper.js for dynamic positioning. Disable this with static.

    "dynamic"
    

    Offset of the dropdown relative to its target. You can pass a string in data attributes with comma separated values like: data-bs-offset="10,20"

    When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: [skidding, distance].

    For more information refer to Popper's offset docs.

    [0, 2]
    

    To change Bootstrap's default Popper.js config

    When a function is used to create the Popper configuration, it's called with an object that contains the Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper.

    null
    
    reference: Element | "toggle" | "parent" | Rect

    Reference element of the dropdown menu. Accepts the values of 'toggle', 'parent', an HTMLElement reference or an object providing getBoundingClientRect. For more information refer to Popper.js's referenceObject docs.