Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

CompositeComponent.tsx

165 lines3.7 KB

1'use client'
2​
3import { Suspense } from 'react'
4import ReactDOM from 'react-dom'
5​
6import { SlotProvider } from './SlotContext'
7import {
8 RSC_PROXY_GET_TREE,
9 RSC_PROXY_PATH,
10 SERVER_COMPONENT_CSS_HREFS,
11 SERVER_COMPONENT_JS_PRELOADS,
12 SERVER_COMPONENT_STREAM,
13} from './ServerComponentTypes'
14import type { AnyCompositeComponent } from './ServerComponentTypes'
15import type { SlotImplementations } from './types'
16​
17function splitSlotProps(props?: Record<string, unknown>): {
18 implementations: SlotImplementations
19 strict: boolean
20} {
21 const safeProps = props ?? {}
22 const { children, strict, ...slotProps } = safeProps as {
23 children?: unknown
24 strict?: unknown
25 [key: string]: unknown
26 }
27​
28 return {
29 implementations: { ...slotProps, children },
30 strict: strict === true,
31 }
33​
34function EmptyFallback() {
35 return null
37​
38function CompositeRenderInner({
39 getTree,
40 path,
41 slotProps,
42}: {
43 getTree: () => unknown
44 path: Array<string>
45 slotProps?: Record<string, unknown>
46}): React.ReactNode {
47 let tree: unknown = getTree()
48​
49 for (const key of path) {
50 if (tree === null || tree === undefined) return null
51 if (typeof tree !== 'object') return null
52 tree = (tree as Record<string, unknown>)[key]
53 }
54​
55 if (tree === null || tree === undefined) return null
56​
57 const { implementations, strict } = splitSlotProps(slotProps)
58​
59 return (
60 <SlotProvider implementations={implementations} strict={strict}>
61 {tree as React.ReactNode}
62 </SlotProvider>
63 )
65​
66function CompositeRenderComponent({
67 getTree,
68 path,
69 slotProps,
70 cssHrefs,
71 jsPreloads,
72}: {
73 getTree: () => unknown
74 path: Array<string>
75 slotProps?: Record<string, unknown>
76 cssHrefs?: ReadonlySet<string>
77 jsPreloads?: ReadonlySet<string>
78}): React.ReactNode {
79 for (const href of cssHrefs ?? []) {
80 ReactDOM.preinit(href, { as: 'style', precedence: 'high' })
81 }
82​
83 if (jsPreloads) {
84 for (const href of jsPreloads) {
85 ReactDOM.preloadModule(href)
86 }
87 }
88​
89 return (
90 <>
91 <Suspense fallback={<EmptyFallback />}>
92 <CompositeRenderInner
93 getTree={getTree}
94 path={path}
95 slotProps={slotProps}
96 />
97 </Suspense>
98 </>
99 )
101​
102/**
103 * Renders composite RSC data with slot support.
104 *
105 * Use this component to render data from `createCompositeComponent`.
106 * Pass slot implementations as props to fill in ClientSlot placeholders.
107 *
108 * @example
109 * ```tsx
110 * const src = await createCompositeComponent((props) => (
111 * <div>
112 * <header>{props.header('Dashboard')}</header>
113 * <main>{props.children}</main>
114 * </div>
115 * ))
116 *
117 * // In route component
118 * return (
119 * <CompositeComponent src={src} header={(title) => <h1>{title}</h1>}>
120 * <p>Main content</p>
121 * </CompositeComponent>
122 * )
123 * ```
124 */
125export function CompositeComponent<TComp extends AnyCompositeComponent>(
126 props: CompositeComponentProps<TComp>,
127): TComp['~types']['return'] {
128 const { src, ...slotProps } = props
129​
130 const stream = src[SERVER_COMPONENT_STREAM]
131​
132 if (!stream) {
133 throw new Error(
134 '[tanstack/start] <CompositeComponent> missing RSC stream on src',
135 )
136 }
137​
138 const cssHrefs = src[SERVER_COMPONENT_CSS_HREFS]
139 const jsPreloads = src[SERVER_COMPONENT_JS_PRELOADS]
140​
141 const path = src[RSC_PROXY_PATH] ?? []
142​
143 const getTree = src[RSC_PROXY_GET_TREE]
144​
145 if (!getTree) {
146 throw new Error(
147 '[tanstack/start] <CompositeComponent> missing getTree on RSC src. ' +
148 'Make sure src comes from createCompositeComponent().',
149 )
150 }
151​
152 return (
153 <CompositeRenderComponent
154 getTree={getTree}
155 path={path}
156 slotProps={slotProps}
157 cssHrefs={cssHrefs}
158 jsPreloads={jsPreloads}
159 />
160 )
162​
163export type CompositeComponentProps<TComp extends AnyCompositeComponent> = {
164 src: TComp
165} & TComp['~types']['props']