diff --git a/CHANGELOG.md b/CHANGELOG.md index 85f68daf9..1ba7d72a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ The exports `ably/callbacks` and `ably/promises` have been removed. The callback ### React Hooks React hooks, exported at `ably/react`, now rely on the `ChannelProvider` component to define the channels you wish to use and the options for them. +The functionality of the `usePresence` hook has been split into two separate hooks: `usePresence`, which is now used only to enter presence, and `usePresenceListener`, which is used to listen for presence updates. ### TypeScript typings @@ -41,6 +42,7 @@ ___ ### Breaking Changes - Rename `id` field to `ablyId` in React Hooks [\#1676](https://github.com/ably/ably-js/pull/1676) +- Split `usePresence` hook into different hooks for entering presence and subscribing to presence updates [\#1674](https://github.com/ably/ably-js/pull/1674) - Remove code that's supporting older platforms [\#1641](https://github.com/ably/ably-js/pull/1641), [\#1633](https://github.com/ably/ably-js/pull/1633), [\#1629](https://github.com/ably/ably-js/pull/1629) - Fix `whenState` inconsistent behavior in `Connection` and `RealtimeChannel` [\#1640](https://github.com/ably/ably-js/pull/1640) - `ChannelProvider` implementation [\#1654](https://github.com/ably/ably-js/pull/1654), [\#1620](https://github.com/ably/ably-js/pull/1620) @@ -86,6 +88,8 @@ ___ ### Code Refactoring - Rename `id` field to `ablyId` in React Hooks [\#1676](https://github.com/ably/ably-js/pull/1676) +- Add documentation for `skip` parameter for hooks to React docs [\#1675](https://github.com/ably/ably-js/pull/1675) +- Split `usePresence` hook into different hooks for entering presence and subscribing to presence updates [\#1674](https://github.com/ably/ably-js/pull/1674) - Remove code that's supporting older platforms [\#1641](https://github.com/ably/ably-js/pull/1641), [\#1633](https://github.com/ably/ably-js/pull/1633), [\#1629](https://github.com/ably/ably-js/pull/1629) - Remove `recoveryKey` in favour of `createRecoveryKey()` on `Connection` [\#1613](https://github.com/ably/ably-js/pull/1613) - Remove duplicate type names and change public `ChannelModes` type [\#1601](https://github.com/ably/ably-js/pull/1601)