@liveblocks/redux

@liveblocks/redux

A store enhancer to integrate Liveblocks into Redux stores.

Installation

npm install @liveblocks/client @liveblocks/redux

Documentation

• Start with the React and Redux guide.
• Explore the API Reference.

Examples

• Browse our gallery of collaborative UI patterns. View examples gallery
• Explore and clone any of our open-source examples. View code examples

Releases

For changelog, visit https://github.com/liveblocks/liveblocks/releases.

Community

• Discord - To get involved with the Liveblocks community, ask questions and share tips.
• Twitter - To receive updates, announcements, blog posts, and general Liveblocks tips.

License

Licensed under the Apache License 2.0, Copyright © 2021-present Liveblocks.

See LICENSE for more information.

Changelog

v0.17.0

For information, please read our Upgrade Guide.

TypeScript improvements ✨

This release contains major TypeScript improvements. The recommended setup now is that you define your own Presence and Storage types at the highest level (i.e. where you set up the room). After that initial one-time setup, you will no longer need to provide any extra type annotations anywhere for your Liveblocks code! 🙌

To learn how to set that up, follow the instructions in our Upgrade Guide.

• No more any types used (in @liveblocks/client and @liveblocks/react)
• All APIs that work with Presence data will now require it to be JSON-serializable
• All APIs that work with Storage data will now require it to be LSON (= JSON + Live structures)
• All Live structures now take mandatory type params for their payloads, just like the built-in array, object, and map types do:
  • LiveMap<K, V> (like Map<K, V>)
  • LiveObject<{ a: number, b: string }> (like, for example, { a: number, b: string })
  • LiveList<T> (like Array<T>)

React Native support ✨

We now support React Native! To learn how to use Liveblocks in your React Native projects, see our API reference. It's surprisingly simple!

New APIs ✨

• In @liveblocks/react:

  • createRoomContext() is now the preferred way to initialize hooks.

• In the API:

  • New endpoint to Get Users in a Room
  • New endpoint to Get a list of all Rooms

Bug fixes 🐛

• Improved conflict resolution on LiveList
• Various minor internal bug fixes

Breaking changes

• In @liveblocks/client:

  • Removed old Room.unsubscribe() API

New deprecations

• In @liveblocks/client:

  • The defaultPresence option to client.enter() will get renamed to initialPresence
  • The defaultStorageRoot option to client.enter() will get renamed to initialStorage
  • Calling new LiveMap(null) will stop working. Please use new LiveMap(), or new LiveMap([])

• In @liveblocks/react:

  • Importing the React hooks directly is deprecated, instead use the new createRoomContext() helper. For help, read the Recommended Upgrade Steps section within our Upgrade Guide
  • The second argument to useList(), useObject(), and useMap() is deprecated
  • The RoomProvider's defaultPresence is renamed to initialPresence
  • The RoomProvider's defaultStorageRoot is renamed to initialStorage