-
Notifications
You must be signed in to change notification settings - Fork 2k
/
TldrawEditor.tsx
365 lines (326 loc) · 9.06 KB
/
TldrawEditor.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
import { SerializedStore, Store } from '@tldraw/store'
import { TLRecord, TLStore } from '@tldraw/tlschema'
import { Required, annotateError } from '@tldraw/utils'
import React, {
memo,
useCallback,
useLayoutEffect,
useMemo,
useState,
useSyncExternalStore,
} from 'react'
import classNames from 'classnames'
import { Canvas } from './components/Canvas'
import { OptionalErrorBoundary } from './components/ErrorBoundary'
import { DefaultErrorFallback } from './components/default-components/DefaultErrorFallback'
import { TLUser, createTLUser } from './config/createTLUser'
import { TLAnyShapeUtilConstructor } from './config/defaultShapes'
import { Editor } from './editor/Editor'
import { TLStateNodeConstructor } from './editor/tools/StateNode'
import { ContainerProvider, useContainer } from './hooks/useContainer'
import { useCursor } from './hooks/useCursor'
import { useDarkMode } from './hooks/useDarkMode'
import { EditorContext } from './hooks/useEditor'
import {
EditorComponentsProvider,
TLEditorComponents,
useEditorComponents,
} from './hooks/useEditorComponents'
import { useEvent } from './hooks/useEvent'
import { useForceUpdate } from './hooks/useForceUpdate'
import { useLocalStore } from './hooks/useLocalStore'
import { useSafariFocusOutFix } from './hooks/useSafariFocusOutFix'
import { useZoomCss } from './hooks/useZoomCss'
import { TLStoreWithStatus } from './utils/sync/StoreWithStatus'
/**
* Props for the {@link @tldraw/tldraw#Tldraw} and {@link TldrawEditor} components.
*
* @public
**/
export type TldrawEditorProps = TldrawEditorBaseProps &
(
| {
store: TLStore | TLStoreWithStatus
}
| {
store?: undefined
initialData?: SerializedStore<TLRecord>
persistenceKey?: string
sessionId?: string
defaultName?: string
}
)
/**
* Base props for the {@link @tldraw/tldraw#Tldraw} and {@link TldrawEditor} components.
*
* @public
*/
export interface TldrawEditorBaseProps {
/**
* The component's children.
*/
children?: any
/**
* An array of shape utils to use in the editor.
*/
shapeUtils?: readonly TLAnyShapeUtilConstructor[]
/**
* An array of tools to add to the editor's state chart.
*/
tools?: readonly TLStateNodeConstructor[]
/**
* Whether to automatically focus the editor when it mounts.
*/
autoFocus?: boolean
/**
* Overrides for the editor's components, such as handles, collaborator cursors, etc.
*/
components?: Partial<TLEditorComponents>
/**
* Called when the editor has mounted.
*/
onMount?: TLOnMountHandler
/**
* The editor's initial state (usually the id of the first active tool).
*/
initialState?: string
/**
* A classname to pass to the editor's container.
*/
className?: string
}
/**
* Called when the editor has mounted.
* @example
* ```ts
* <Tldraw onMount={(editor) => editor.selectAll()} />
* ```
* @param editor - The editor instance.
*
* @public
*/
export type TLOnMountHandler = (editor: Editor) => (() => void) | undefined | void
declare global {
interface Window {
tldrawReady: boolean
}
}
const EMPTY_SHAPE_UTILS_ARRAY = [] as const
const EMPTY_TOOLS_ARRAY = [] as const
/** @public */
export const TldrawEditor = memo(function TldrawEditor({
store,
components,
className,
...rest
}: TldrawEditorProps) {
const [container, rContainer] = React.useState<HTMLDivElement | null>(null)
const user = useMemo(() => createTLUser(), [])
const ErrorFallback =
components?.ErrorFallback === undefined ? DefaultErrorFallback : components?.ErrorFallback
// apply defaults. if you're using the bare @tldraw/editor package, we
// default these to the "tldraw zero" configuration. We have different
// defaults applied in @tldraw/tldraw.
const withDefaults = {
...rest,
shapeUtils: rest.shapeUtils ?? EMPTY_SHAPE_UTILS_ARRAY,
tools: rest.tools ?? EMPTY_TOOLS_ARRAY,
}
return (
<div
ref={rContainer}
draggable={false}
className={classNames('tl-container tl-theme__light', className)}
tabIndex={0}
>
<OptionalErrorBoundary
fallback={ErrorFallback}
onError={(error) => annotateError(error, { tags: { origin: 'react.tldraw-before-app' } })}
>
{container && (
<ContainerProvider container={container}>
<EditorComponentsProvider overrides={components}>
{store ? (
store instanceof Store ? (
// Store is ready to go, whether externally synced or not
<TldrawEditorWithReadyStore {...withDefaults} store={store} user={user} />
) : (
// Store is a synced store, so handle syncing stages internally
<TldrawEditorWithLoadingStore {...withDefaults} store={store} user={user} />
)
) : (
// We have no store (it's undefined) so create one and possibly sync it
<TldrawEditorWithOwnStore {...withDefaults} store={store} user={user} />
)}
</EditorComponentsProvider>
</ContainerProvider>
)}
</OptionalErrorBoundary>
</div>
)
})
function TldrawEditorWithOwnStore(
props: Required<TldrawEditorProps & { store: undefined; user: TLUser }, 'shapeUtils' | 'tools'>
) {
const { defaultName, initialData, shapeUtils, persistenceKey, sessionId, user } = props
const syncedStore = useLocalStore({
shapeUtils,
initialData,
persistenceKey,
sessionId,
defaultName,
})
return <TldrawEditorWithLoadingStore {...props} store={syncedStore} user={user} />
}
const TldrawEditorWithLoadingStore = memo(function TldrawEditorBeforeLoading({
store,
user,
...rest
}: Required<
TldrawEditorProps & { store: TLStoreWithStatus; user: TLUser },
'shapeUtils' | 'tools'
>) {
const container = useContainer()
useLayoutEffect(() => {
if (user.userPreferences.value.isDarkMode) {
container.classList.remove('tl-theme__light')
container.classList.add('tl-theme__dark')
}
}, [container, user.userPreferences.value.isDarkMode])
switch (store.status) {
case 'error': {
// for error handling, we fall back to the default error boundary.
// if users want to handle this error differently, they can render
// their own error screen before the TldrawEditor component
throw store.error
}
case 'loading': {
return <LoadingScreen>Connecting...</LoadingScreen>
}
case 'not-synced': {
break
}
case 'synced-local': {
break
}
case 'synced-remote': {
break
}
}
return <TldrawEditorWithReadyStore {...rest} store={store.store} user={user} />
})
function TldrawEditorWithReadyStore({
onMount,
children,
store,
tools,
shapeUtils,
autoFocus,
user,
initialState,
}: Required<
TldrawEditorProps & {
store: TLStore
user: TLUser
},
'shapeUtils' | 'tools'
>) {
const { ErrorFallback } = useEditorComponents()
const container = useContainer()
const [editor, setEditor] = useState<Editor | null>(null)
useLayoutEffect(() => {
const editor = new Editor({
store,
shapeUtils,
tools,
getContainer: () => container,
user,
initialState,
})
;(window as any).app = editor
;(window as any).editor = editor
setEditor(editor)
return () => {
editor.dispose()
}
}, [container, shapeUtils, tools, store, user, initialState])
React.useLayoutEffect(() => {
if (editor && autoFocus) {
editor.getContainer().focus()
}
}, [editor, autoFocus])
const onMountEvent = useEvent((editor: Editor) => {
const teardown = onMount?.(editor)
editor.emit('mount')
window.tldrawReady = true
return teardown
})
React.useLayoutEffect(() => {
if (editor) return onMountEvent?.(editor)
}, [editor, onMountEvent])
const crashingError = useSyncExternalStore(
useCallback(
(onStoreChange) => {
if (editor) {
editor.on('crash', onStoreChange)
return () => editor.off('crash', onStoreChange)
}
return () => {
// noop
}
},
[editor]
),
() => editor?.crashingError ?? null
)
if (!editor) {
return null
}
return (
// the top-level tldraw component also renders an error boundary almost
// identical to this one. the reason we have two is because this one has
// access to `App`, which means that here we can enrich errors with data
// from app for reporting, and also still attempt to render the user's
// document in the event of an error to reassure them that their work is
// not lost.
<OptionalErrorBoundary
fallback={ErrorFallback as any}
onError={(error) =>
editor.annotateError(error, { origin: 'react.tldraw', willCrashApp: true })
}
>
{crashingError ? (
<Crash crashingError={crashingError} />
) : (
<EditorContext.Provider value={editor}>
<Layout>{children}</Layout>
</EditorContext.Provider>
)}
</OptionalErrorBoundary>
)
}
function Layout({ children }: { children: any }) {
useZoomCss()
useCursor()
useDarkMode()
useSafariFocusOutFix()
useForceUpdate()
return children ?? <Canvas />
}
function Crash({ crashingError }: { crashingError: unknown }): null {
throw crashingError
}
/** @public */
export function LoadingScreen({ children }: { children: any }) {
const { Spinner } = useEditorComponents()
return (
<div className="tl-loading">
{Spinner ? <Spinner /> : null}
{children}
</div>
)
}
/** @public */
export function ErrorScreen({ children }: { children: any }) {
return <div className="tl-loading">{children}</div>
}