@towns-protocol/react-sdk/src/useSpace.ts

React Hooks for Towns Protocol SDK

'use client'

import { useMemo } from 'react'
import type { Space } from '@towns-protocol/sdk'
import { useSyncAgent } from './useSyncAgent'
import { type ObservableConfig, useObservable } from './useObservable'

/**
 * Hook to get data about a space.
 * You can use this hook to get space metadata and ids of channels in the space.
 * @param spaceId - The id of the space to get data about.
 * @param config - Configuration options for the observable.
 * @returns The SpaceModel data.
 * @example
 * You can use this hook to display the data about a space:
 *
 * ```tsx
 * import { useSpace } from '@towns-protocol/react-sdk'
 *
 * const Space = ({ spaceId }: { spaceId: string }) => {
 *     const { data: space } = useSpace(spaceId)
 *     return <div>{space.metadata?.name || 'Unnamed Space'}</div>
 * }
 * ```
 */
export const useSpace = (spaceId: string, config?: ObservableConfig.FromObservable<Space>) => {
    const sync = useSyncAgent()
    const observable = useMemo(() => sync.spaces.getSpace(spaceId), [sync, spaceId])
    return useObservable(observable, config)
}