Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Universal editor doc #78

Merged
merged 2 commits into from
May 20, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions src/pages/services/aem-universal-editor/api/events/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,23 @@ The Universal Editor sends defined events to remote applications. In case the re

### Working with Events

The Universal Editor offers a list of events that extensions can subscribe to in order to respond to changes in content or the user interface.
Refer to this [document](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/developing/universal-editor/events) for the available event list.

For instance, here's an example of how to subscribe to the `aue:ui-select` event:

```js

useEffect(() => {
(async () => {
const guestConnection = await attach({id: extensionId});
...
await guestConnection.host.remoteApp.addEventListener('aue:ui-select', console.log('event recieved!'));
...
})();
}, []);
```

If your business logic requires sending an event to the Universal Editor, you can use the `dispatchEvent` method.
Here's an example of how to dispatch the `aue:ui-select` event:
If your business logic requires sending an event to the Universal Editor, you can use the `triggerEvent` method.
Here's an example of how to dispatch the `aue:ui-viewport-change` event:

```js
useEffect(() => {
(async () => {
const guestConnection = await attach({id: extensionId});
...
await guestConnection.host.remoteApp.dispatchEvent('aue:ui-select', {data: 'some data'});
await guestConnection.host.remoteApp.triggerEvent('aue:ui-viewport-change',
'main',
{
details: {
height: 1024,
width: 768,
}
}
);
...
})();
}, []);
Expand Down
Loading