getPagesFromFolder() — ui Function Reference

Architecture documentation for the getPagesFromFolder() function in page-tree.ts from the ui codebase.

Function typescript DocumentationAtlas Changelog calls 1

Entity Profile

DocumentationAtlas→ Changelog→ getPagesFromFolder() — ui Function Reference

Dependency Diagram

graph TD
  1af6558c_db6d_19a2_301a_3b20a13b65e0["getPagesFromFolder()"]
  447b1674_3ebd_165e_d19d_dc75a770805d["page-tree.ts"]
  1af6558c_db6d_19a2_301a_3b20a13b65e0 -->|defined in| 447b1674_3ebd_165e_d19d_dc75a770805d
  e97dd657_a150_7c55_cf6b_90e1cd4ca507["getAllPagesFromFolder()"]
  1af6558c_db6d_19a2_301a_3b20a13b65e0 -->|calls| e97dd657_a150_7c55_cf6b_90e1cd4ca507
  style 1af6558c_db6d_19a2_301a_3b20a13b65e0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/v4/lib/page-tree.ts lines 23–56

export function getPagesFromFolder(
  folder: PageTreeFolder,
  currentBase: string
): PageTreePage[] {
  // For the components folder, find the base subfolder.
  if (folder.$id === "components" || folder.name === "Components") {
    for (const child of folder.children) {
      if (child.type === "folder") {
        // Match by $id or by name.
        const isRadix = child.$id === "radix" || child.name === "Radix UI"
        const isBase = child.$id === "base" || child.name === "Base UI"

        if (
          (currentBase === "radix" && isRadix) ||
          (currentBase === "base" && isBase)
        ) {
          return child.children.filter(
            (c): c is PageTreePage => c.type === "page"
          )
        }
      }
    }

    // Fallback: return all pages from nested folders.
    return getAllPagesFromFolder(folder).filter(
      (page) => !page.url.endsWith("/components")
    )
  }

  // For other folders, return direct page children.
  return folder.children.filter(
    (child): child is PageTreePage => child.type === "page"
  )
}