How to embed Brandgility's configurator into an iframe:
- get the id of template to be configured from Brandgility application
- To open an asset for customization, copy and paste below code into your page/component, replace
:id
insrc
attribute with your template's id:
<iframe src="<BRANDGILITY_ENDPOINT>/embedded-template-configure/{new|edit}/:id?action=DRAFT_TEMPLATE_CONFIGURATION_START&eid=:id&embedded=true" />
- To configure an already saved template customization, copy and paste below code into your page/component, replace
:id
insrc
attribute with your saved template customization id:
<iframe src="<BRANDGILITY_ENDPOINT>/embedded-template-configure/{new|edit}/:id?action=DRAFT_TEMPLATE_CONFIGURATION_EDIT&eid=:id&embedded=true" />
API library
Brandgility embedded api library allows you to issue commands to Brandgility configurator in embedded mode
Methods
method | description | parameters |
---|---|---|
on |
subscribes to event | eventName: <string >, argument: <function > |
emit |
triggers an event | eventName: <string >, argument: <serializable, see The structured clone algorithm> |
Events to listen
on
method:
To subscribe on event use brandgilityEmbeddedApi.on('load', () => console.info('loaded'));
event | description | arguments |
---|---|---|
load |
load event | entity { type : <string > , id: <string > } |
save |
success save event | id of saved item <string > |
error |
error event | error { message : <string > } |
Events to trigger
emit
method:
To trigger an event use brandgilityEmbeddedApi.emit('save');
event | description | parameters |
---|---|---|
save |
saves a current version of template | - |
saveAs |
creates a new saved customization from an existing saved customization | new item { name : <string >, comments : <string > } |