Home » Documentation » DataStore Actions

DataStore Actions

Table of Contents

Viewport Actions

setViewports

Description: Updates the list of all viewports.

Parameters:

  • viewports: Viewports – Object containing all viewport definitions

setViewport

Description: Sets the current active viewport.

Parameters:

  • viewport: number – Index of the viewport to activate

setViewportType

Description: Sets viewport based on type.

Parameters:

  • viewportType: 'mobile' | 'tablet' | 'desktop'

setPrevViewport

Description: Switches to the previous viewport.

Parameters:

  • viewportType: 'mobile' | 'tablet' | 'desktop' | '' (optional) – Limit previous viewport selection by type

setNextViewport

Description: Switches to the next viewport.

Parameters:

  • viewportType: 'mobile' | 'tablet' | 'desktop' | '' (optional) – Limit next viewport selection by type

setDesktop / setTablet / setMobile

Description: Stores the current viewport as the default for desktop, tablet, or mobile.

Parameters: None


setIframeSize

Description: Sets the iframe size and adjusts the viewport to fit.

Parameters:

  • size: Size – Width and height for the iframe

Status Indicator Actions

ActionDescriptionParameters
setRegistering / unsetRegisteringUpdates registering indicatorNone
setLoading / unsetLoadingUpdates loading indicatorNone
setSaving / unsetSavingUpdates saving indicatorNone
setAutoSaving / unsetAutoSavingUpdates autosaving indicatorNone
setActive / unsetActiveUpdates active stateNone

Editing & Inspecting Actions

ActionDescriptionParameters
setEditing / unsetEditing / toggleEditingUpdates editing indicatorNone
setInspecting / unsetInspecting / toggleInspectingUpdates inspecting indicatorNone
toggleActiveToggles active viewport simulationNone
setInspectorPositionUpdates inspector positionposition: string

Viewport Toggle Actions

ActionDescriptionParameters
toggleDesktopSwitches to stored desktop viewportNone
toggleTabletSwitches to stored tablet viewportNone
toggleMobileSwitches to stored mobile viewportNone

Block Management Actions

registerBlockInit

Description: Initializes a block’s state.

Parameters:

  • clientId: string – Unique block ID
  • blockName: string – Name of the block
  • attributes: BlockAttributes – Initial block attributes

updateBlockChanges

Description: Updates block changes for a specific viewport.

Parameters:

  • clientId: string
  • blockName: string
  • attributes: BlockAttributes
  • viewport: number | null (optional)

addBlockPropertyChanges

Description: Adds a style property to a block’s changes.

Parameters:

  • clientId: string
  • blockName: string
  • viewport: number
  • prop: string – Name of the property

removeBlock

Description: Removes a block entirely.

Parameters:

  • clientId: string

removeBlockSaves / restoreBlockSaves

Description: Removes or restores saved properties for a block.

Parameters:

  • clientId: string
  • blockName: string
  • props: string[] – List of properties
  • viewport: number

saveBlock

Description: Permanently saves a block.

Parameters:

  • clientId: string
  • blockName: string

clearBlocks

Description: Clears all blocks.

Parameters: None


Renderer Actions

registerRenderer

Description: Registers a custom renderer function.

Parameters:

  • prop: string – Property name
  • callback: Function – Rendering callback
  • priority: number – Priority of the renderer (default: 10)
  • groupId: string – Optional group ID
  • panelId: string – Optional panel ID
  • mapping: RendererMapping – Optional mapping for renderer