Interface GridStackHostApi

Host API stamped on .grid-stack element as _gridComp for addRemoveCB dispatch.

interface GridStackHostApi {
    registerSyntheticItemId(id: string): void;
    unregisterSyntheticItemId(id: string): void;
    requestUpdate(): void;
    registerWidgetSerializer(
        id: string,
        serialize: () => Record<string, unknown>,
        deserialize?: (data: Record<string, unknown>) => void,
    ): () => void;
    mergeWidgetPropsForSave(id: string, w: GridStackWidget): void;
    deserializeWidget(id: string, w: GridStackWidget): void;
}

Index

Methods

registerSyntheticItemId unregisterSyntheticItemId requestUpdate registerWidgetSerializer mergeWidgetPropsForSave deserializeWidget

Methods

registerSyntheticItemId

registerSyntheticItemId(id: string): void
Parameters
- id: string
Returns void
- Defined in vue/projects/lib/src/types.ts:15

unregisterSyntheticItemId

unregisterSyntheticItemId(id: string): void
Parameters
- id: string
Returns void
- Defined in vue/projects/lib/src/types.ts:16

requestUpdate

requestUpdate(): void
Notify Vue to re-read node props after GS update() / updateCB.

Returns void
- Defined in vue/projects/lib/src/types.ts:18

registerWidgetSerializer

registerWidgetSerializer(
    id: string,
    serialize: () => Record<string, unknown>,
    deserialize?: (data: Record<string, unknown>) => void,
): () => void
Parameters
- id: string
- serialize: () => Record<string, unknown>
- Optionaldeserialize: (data: Record<string, unknown>) => void
Returns () => void
- Defined in vue/projects/lib/src/types.ts:19

mergeWidgetPropsForSave

mergeWidgetPropsForSave(id: string, w: GridStackWidget): void
Merge useWidgetSerializer results into w.props during grid.save().
Parameters
- id: string
- w: GridStackWidget
Returns void
- Defined in vue/projects/lib/src/types.ts:25

deserializeWidget

deserializeWidget(id: string, w: GridStackWidget): void
Call widget's deserialize callback with updated props (invoked by updateCB).
Parameters
- id: string
- w: GridStackWidget
Returns void
- Defined in vue/projects/lib/src/types.ts:27