Skip to main content

Overview

useLeaveSpace returns a callable function for leaving a space. The user’s membership record is removed.
When using SpaceProvider, call leaveSpace from useSpace — it handles optimistic state updates automatically.

Usage Example

import { useLeaveSpace } from "@replyke/react-js";

function LeaveButton({ spaceId }: { spaceId: string }) {
  const leaveSpace = useLeaveSpace();

  const handleLeave = async () => {
    await leaveSpace({ spaceId });
  };

  return <button onClick={handleLeave}>Leave</button>;
}

Parameters

spaceId
string
required
UUID of the space to leave.

Returns

message
string
Confirmation message.