Fetch space children

Fetch direct child spaces of a parent space

Overview

useFetchSpaceChildren returns a callable function that fetches the immediate child spaces of a given space. Results are paginated.

Usage Example

import { useFetchSpaceChildren } from "@sublay/react-js";

function ChildSpaceList({ spaceId }: { spaceId: string }) {
  const fetchChildren = useFetchSpaceChildren();

  const loadChildren = async () => {
    const result = await fetchChildren({ spaceId, page: 1, limit: 20 });
    // result.data: Space[]
  };
}

Parameters

spaceId · string · required

UUID of the parent space.

page · number

Page number. Defaults to 1.

limit · number

Number of results per page.

Returns

data · Space[]

Array of Space objects representing the child spaces.

pagination · object

Standard pagination metadata.

The useSpace hook also includes a childSpaces field with up to 10 previews of children, useful for navigation breadcrumbs without a separate fetch.