Function useGridStack

Returns {
    get grid(): GridStack;
    get layoutVersion(): number;
    addWidget(w: GridStackWidget): GridItemHTMLElement;
    removeWidget(
        el: GridStackElement,
        removeDOM?: boolean,
        triggerEvent?: boolean,
    ): GridStack;
    removeAll(removeDOM?: boolean): GridStack;
    save(
        saveContent?: boolean,
        saveGridOpt?: boolean,
    ): GridStackOptions | GridStackWidget[];
    load(items: GridStackWidget[]): GridStack;
}

• get grid(): GridStack

  Raw GridStack instance (not a Vue ref — never proxy it).

• get layoutVersion(): number

  Bumps whenever the layout changes — use as a reactive dependency.

• addWidget: function

  • addWidget(w: GridStackWidget): GridItemHTMLElement

    Parameters

    • w: GridStackWidget

    Returns GridItemHTMLElement

• removeWidget: function

  • removeWidget(
        el: GridStackElement,
        removeDOM?: boolean,
        triggerEvent?: boolean,
    ): GridStack

    Parameters

    • el: GridStackElement
    • OptionalremoveDOM: boolean
    • OptionaltriggerEvent: boolean

    Returns GridStack

• removeAll: function

  • removeAll(removeDOM?: boolean): GridStack

    Parameters

    • removeDOM: boolean = true

    Returns GridStack

• save: function

  • save(
        saveContent?: boolean,
        saveGridOpt?: boolean,
    ): GridStackOptions | GridStackWidget[]

    Parameters

    • saveContent: boolean = true
    • saveGridOpt: boolean = false

    Returns GridStackOptions | GridStackWidget[]

• load: function

  • load(items: GridStackWidget[]): GridStack

    Parameters

    • items: GridStackWidget[]

    Returns GridStack