UI Framework Reference › ChangeMockupCommand

Class: ChangeMockupCommand

A command that changes mockup images in the editor. A command that changes mockup images in the editor.

For details, you can refer to the ICanvasDefinitionChangeMockup.

{
  "widgets": [{
    "type": "canvas",
    "name": "editor",
    "params": {
      "inital": { ... },
      "changeMockup": {
        "data": [{
          "mockup": {
            "down": "{{$['color']._.props.mockup}}"
          },
          "previewMockups": "{{$['color']._.props.previews}}"
        }]
      }
    }
  }]
}

For details, you can refer to the IDesignEditorDefinitionChangeMockup.

{
  "widgets": [{
    "type": "design-editor",
    "name": "editor",
    "params": {
      "inital": { ... },
      "changeMockup": {
        "data": [{
          "mockup": {
            "down": "{{$['color']._.props.mockup}}"
          },
          "previewMockups": "{{$['color']._.props.previews}}"
        }]
      }
    }
  }]
}

Hierarchy

CanvasWidgetCommand
DesignEditorWidgetCommand

↳ ChangeMockupCommand

Index

Methods

execute

Methods

execute

▸ execute(params: ICanvasDefinitionChangeMockup): Promise‹any›

Overrides CanvasWidgetCommand.execute

Defined in src/widgets/au-widget-canvas/Commands/change-mockup-command.ts:34

Executes this command.

Parameters:

Name	Type	Description
`params`	ICanvasDefinitionChangeMockup	Parameters for the command.

Returns:Promise‹any›