editDesign()
IMPORTANT: Deprecation Warning
We are no longer approving integrations using v1 or v2 of the SDK - both versions will be deprecated in 2024.
This API is used for editing an existing project in the embedded full editor.
Copied to your clipboardeditDesign: (editDesignParams: EditDesignParams): void
EditDesignParams
All the properties in this object are optional.
| Property | Type | Description |
|---|---|---|
callbacks | Callback methods | |
modalParams | Parameters to configure editor/modal UI | |
inputParams | Input parameters when editing a design. | |
outputParams | Desired output options when exporting assets from the editor. |
EditInputParams
EditInputParams is where you pass the associated projectId to launch in an editor component.
| Property | Type | Description |
|---|---|---|
projectId | string | Project ID of the asset returned from onPublish callback when createDesign was invoked. |
editorPanelView | Determines which panel view to open by default. | |
exportOptions | Export options for the asset that is created. If no export options are specified, the editor falls back to the default layout options. | |
panelSearchText | string | Search text to pass in the editor for selected panel. |
When a user completes their workflow in the editor, the associated projectId is sent back in publishParams from the onPublish callback.
