Get started - Get started with Liveblocks and Zustand

Liveblocks is a real-time collaboration infrastructure for building performant collaborative experiences. Follow the following steps to start making your Zustand store multiplayer by using the middleware from the @liveblocks/zustand package.

Quickstart

1. Install Liveblocks

   $npm install @liveblocks/client @liveblocks/zustand

2. Connect your Zustand store to Liveblocks

   Create the Liveblocks client and use the middleware in your Zustand store setup. This will add a new state called liveblocks to your store, enabling you to interact with our Presence and Storage APIs.

   store.ts

   import create from "zustand";import { createClient } from "@liveblocks/client";import { liveblocks } from "@liveblocks/zustand";import type { WithLiveblocks } from "@liveblocks/zustand";
   type State = {  // Your Zustand state type will be defined here};
   const client = createClient({  publicApiKey: "pk_prod_xxxxxxxxxxxxxxxxxxxxxxxx",});
   const useStore = create<WithLiveblocks<State>>()(  liveblocks(    (set) => ({      // Your state and actions will go here    }),    { client }  ));
   export default useStore;

3. Join a Liveblocks room

   Liveblocks uses the concept of rooms, separate virtual spaces where people collaborate. To create a real-time experience, multiple users must be connected to the same room.

   App.tsx

   import React, { useEffect } from "react";import useStore from "./store";import "./App.css";
   const App = () => {  const {    liveblocks: { enterRoom, leaveRoom },  } = useStore();
     useEffect(() => {    enterRoom("room-id");    return () => {      leaveRoom("room-id");    };  }, [enterRoom, leaveRoom]);
     return <Room />;};
   export default App;

4. Use the Liveblocks data from the store

   Now that we’re connected to a room, we can start using the Liveblocks data from the Zustand store.

   Room.tsx

   import useStore from "./store";
   export function Room() {  const others = useStore((state) => state.liveblocks.others);  const userCount = others.length;  return <div>There are {userCount} other user(s) online</div>;}

5. Bonus: set up authentication

   By default, Liveblocks is configured to work without an authentication endpoint. This approach is great for prototyping and marketing pages where defining your own security isn’t always required. If you want to implement your own security logic to define if certain users should have access to a given room, you’ll need to implement an authentication endpoint.

   Set up authentication

Next steps

Congratulations! You now have set up the foundation to start building collaborative experiences for your Zustand store.

• API Reference
• How to use Liveblocks Presence with Zustand
• How to use Liveblocks Storage with Zustand
• How to use Liveblocks multiplayer undo/redo with Zustand