Mockup Board API Reference
kittl.design.mockupboard — create and manage mockup boards.
Scope: design:state:write
addMockupBoard(params)
Creates a new mockup board linked to one or more source boards.
| Property | Type | Required | Description |
|---|---|---|---|
inputBoardIds | string[] | Yes | IDs of the source boards whose content is warped through the template |
mockupTemplateId | number | Yes | Mockup template to use |
position | AbsolutePosition | RelativePosition | Yes | Board position |
size | { width, height } | Yes | Board dimensions |
shouldMockupColorMatchArtboard | boolean | No | Whether the mockup fill matches the linked artboard's fill (default: true) |
initialDesigns | AddMockupDesignObjectParams[] | No | Design objects to create atomically with the board |
addMockupDesignObject(params)
Adds a warped view of a source board's content to an existing mockup board.
| Property | Type | Required | Description |
|---|---|---|---|
mockupBoardId | string | Yes | ID of the mockup board to add to |
inputBoardId | string | Yes | ID of the source board to warp |
mockupTemplateId | number | Yes | Mockup template used for warping |
initialNormalizedUnwarpedRect | MockupDesignRect | Yes | Normalised, un-warped bounding rect of the design relative to the mockup board |
updateMockupBoard(params)
Modifies an existing mockup board's template, size, or color-matching behavior.
| Property | Type | Required | Description |
|---|---|---|---|
mockupBoardId | string | Yes | ID of the mockup board to update |
size | { width, height } | No | New dimensions |
mockupTemplateId | number | No | New mockup template |
shouldMockupColorMatchArtboard | boolean | No | Whether fill matches the linked artboard |