sebnitu / vrembem / 11810101198

93%

main: 100%

push

github

Add event emitter to core Collection and refactor lifecycle hooks (#2099)

This PR adds the new events system to the collections API. This allows users to add event listeners to lifecycle hooks of any collection (modals, drawers and popovers). This update also includes a refactor of available lifecycle hooks to help the API be more concise and intuitive.

### Events API

- `on(event: string, listener: function, ...args: any[]): void`  
  Registers a listener for an event with optional additional arguments.

- `off(event: string, listenerRef: function): void`  
  Removes a specific listener from an event.

- `emit(event: string, data: any): void`  
  Triggers all listeners associated with an event, passing `data` to each.

### Updated Lifecycle Hooks

The following are the new lifecycle hooks. All previous hooks not listed here have been removed. Each hook has a corresponding event named the same unless otherwise specified. Events and hooks that directly effect an entry are provided the entry as an argument. 

**Setup Hooks**

- `beforeMount`
- `onCreateEntry` (event: `createEntry`)
- `onRegisterEntry` (event: `registerEntry`)
- `afterMount`

**Teardown Hooks**

- `beforeUnmount`
- `onDestroyEntry` (event: `destroyEntry`)
- `onDeregisterEntry` (event: `deregisterEntry`)
- `afterUnmount`

## Additional changes

- Entry API has changed in the following ways:
  - `mount()` > `init()`
  - `unmount()` > `destroy()`
- Plugins API has changed in the following ways:
  - `mount()` > `setup()`
  - `unmount()` > `teardown()`
- `getCustomProps` helper has been renamed to `buildCustomProps`.
- New helper function for handling running hooks and emitting events: `dispatchLifecycleHook()`.
- Debug plugin has been expanded to include events output and improve the visuals of logs.
- Teleport plugin now emits `teleport` and `teleportReturn` events.
- Drawer, Modal and Popover now all emit `opened` and `closed` events.
- Collect... (continued)

683 of 683 branches covered (100.0%)

Branch coverage included in aggregate %.

318 of 318 new or added lines in 28 files covered. (100.0%)

2549 of 2549 relevant lines covered (100.0%)

140.58 hits per line