GridStack Vue Library - v13.0.0
    Preparing search index...

    Interface GridStackWidget

    interface GridStackWidget {
        x?: number;
        y?: number;
        w?: number;
        h?: number;
        autoPosition?: boolean;
        minW?: number;
        maxW?: number;
        minH?: number;
        maxH?: number;
        noResize?: boolean;
        noMove?: boolean;
        locked?: boolean;
        id?: string;
        content?: string;
        lazyLoad?: boolean;
        sizeToContent?: number | boolean;
        resizeToContentParent?: string;
        component?: string;
        props?: GridStackWidgetProps;
        class?: string;
        el?: HTMLElement;
        subGridOpts?: GridStackOptions;
    }

    Hierarchy

    • Omit<CoreGridStackWidget, "subGridOpts">
      • GridStackWidget
    Index

    Properties

    x? y? w? h? autoPosition? minW? maxW? minH? maxH? noResize? noMove? locked? id? content? lazyLoad? sizeToContent? resizeToContentParent? component? props? class? el? subGridOpts?

    Properties

    x?: number

    widget position x (default?: 0)

    y?: number

    widget position y (default?: 0)

    w?: number

    widget dimension width (default?: 1)

    h?: number

    widget dimension height (default?: 1)

    autoPosition?: boolean

    if true then x, y parameters will be ignored and widget will be places on the first available position (default?: false)

    minW?: number

    minimum width allowed during resize/creation (default?: undefined = un-constrained)

    maxW?: number

    maximum width allowed during resize/creation (default?: undefined = un-constrained)

    minH?: number

    minimum height allowed during resize/creation (default?: undefined = un-constrained)

    maxH?: number

    maximum height allowed during resize/creation (default?: undefined = un-constrained)

    noResize?: boolean

    prevent direct resizing by the user (default?: undefined = un-constrained)

    noMove?: boolean

    prevents direct moving by the user (default?: undefined = un-constrained)

    locked?: boolean

    prevents being pushed by other widgets or api (default?: undefined = un-constrained), which is different from noMove (user action only)

    id?: string

    value for gs-id stored on the widget (default?: undefined)

    Optionalcontent

    content?: string

    html to append inside as content

    lazyLoad?: boolean

    true when widgets are only created when they scroll into view (visible)

    sizeToContent?: number | boolean

    local (vs grid) override - see GridStackOptions. Note: This also allow you to set a maximum h value (but user changeable during normal resizing) to prevent unlimited content from taking too much space (get scrollbar)

    resizeToContentParent?: string

    local override of GridStack.resizeToContentParent that specify the class to use for the parent (actual) vs child (wanted) height

    component?: string

    Key in the components map passed to <GridStack :components="...">

    props?: GridStackWidgetProps
    class?: string

    Extra CSS classes on the widget root.

    el?: HTMLElement

    Runtime DOM node when removing via addRemoveCB (not serialized).

    subGridOpts?: GridStackOptions

    Nested grid options (recursive; uses Vue-extended widget children).

    Settings

    Member Visibility

    On This Page

    Properties