docs.md

Table of Contents

• state
• state/page
  • setPage
  • handleSavePage
• state/site
  • updateCurrentSiteID

state

The global editor state

Properties

• over Object What coordinates the mouse is over???
  • over.x number X Coordinate
  • over.y number Y Coordinate
• WrapperStyles Object The styles for the wrapper.

state/page

Page State Module

Properties

• currentLayout string The name of the layout in use for the current page.
• currentLayoutVersion int The version number of the layout in use for the current page.
• currentBlockIndex (number | null) The index of the currently selected block in the currently selected region.
• currentRegion string The name of the region containing the currently selected block.
• blockMeta Object Some meta about blocks???
  • blockMeta.blocks Object Object with keys as region names and values as Arrays of blocks.

setPage

Mutation to set the current page.

Parameters

• state
• page object Page object representing the current page.

handleSavePage

Saves a page

Parameters

• input Object
  • input.state Object the context of the action - added by VueX
  • input.commit Object added by VueX
• payload Object parameter object
  • payload.message callback function to display a message

Returns promise api - to allow other methods to wait for the save to complete

state/site

Properties

• pages Array Array of Pages in the current Site.
• site number ID of the current Site.

updateCurrentSiteID

Set the current site id stored in the store.

Parameters

• state object
• id int The id of the site to set as current site.