Skip to content

Commit 708e319

Browse files
committed
docs: update EventManager-API.md
1 parent dc22c86 commit 708e319

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/generatedApiDocs/utils/EventManager-API.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ const EventDispatcher = brackets.getModule("utils/EventDispatcher"),
1818
EventManager = brackets.getModule("utils/EventManager");
1919
EventDispatcher.makeEventDispatcher(exports);
2020

21-
EventManager.registerEventHandler("drawImageHandler", exports);
21+
EventManager.registerEventHandler("drawImage-Handler", exports);
2222
```
2323

2424
Once the event handler is registered, we can trigger events on the named handler anywhere in phoenix
2525
(inside or outside the extension) by using:
2626

2727
```js
28-
EventManager.triggerEvent("drawImageHandler", "someEventName", "param1", "param2", ...);
28+
EventManager.triggerEvent("drawImage-Handler", "someEventName", "param1", "param2", ...);
2929
```
3030

3131
## registerEventHandler
@@ -49,7 +49,10 @@ To register a close dialogue event handler in an extension:
4949
const EventDispatcher = brackets.getModule("utils/EventDispatcher"),
5050
EventDispatcher.makeEventDispatcher(exports);
5151

52-
EventManager.registerEventHandler("closeDialogueHandler", exports);
52+
// Note: for event handler names, please change the <extensionName> to your extension name
53+
// to prevent collisions. EventHandlers starting with `ph-` and `br-` are reserved as system handlers
54+
// and not available for use in extensions.
55+
EventManager.registerEventHandler("<extensionName>-closeDialogueHandler", exports);
5356
// Once the event handler is registered, see triggerEvent API on how to raise events
5457
```
5558

0 commit comments

Comments
 (0)