Toasts and dialogs
Dialogs are especially customisable, allowing you to pass in a custom component to render
as the dialog content. Alternatively, you can use the ExampleDialog
component which is
provided by the library.
import {
TLComponents,
Tldraw,
TldrawUiButton,
TldrawUiButtonLabel,
TldrawUiDialogBody,
TldrawUiDialogCloseButton,
TldrawUiDialogFooter,
TldrawUiDialogHeader,
TldrawUiDialogTitle,
useDialogs,
useToasts,
} from 'tldraw'
import 'tldraw/tldraw.css'
// There's a guide at the bottom of this file
// [1]
function MyDialog({ onClose }: { onClose(): void }) {
return (
<>
<TldrawUiDialogHeader>
<TldrawUiDialogTitle>Title</TldrawUiDialogTitle>
<TldrawUiDialogCloseButton />
</TldrawUiDialogHeader>
<TldrawUiDialogBody style={{ maxWidth: 350 }}>Description...</TldrawUiDialogBody>
<TldrawUiDialogFooter className="tlui-dialog__footer__actions">
<TldrawUiButton type="normal" onClick={onClose}>
<TldrawUiButtonLabel>Cancel</TldrawUiButtonLabel>
</TldrawUiButton>
<TldrawUiButton type="primary" onClick={onClose}>
<TldrawUiButtonLabel>Continue</TldrawUiButtonLabel>
</TldrawUiButton>
</TldrawUiDialogFooter>
</>
)
}
// [2]
function MySimpleDialog({ onClose }: { onClose(): void }) {
return (
<div style={{ padding: 16 }}>
<h2>Title</h2>
<p>Description...</p>
<button onClick={onClose}>Okay</button>
</div>
)
}
const CustomSharePanel = () => {
const { addToast } = useToasts()
const { addDialog } = useDialogs()
return (
<div style={{ padding: 16, gap: 16, display: 'flex', pointerEvents: 'all' }}>
<button
onClick={() => {
addToast({ title: 'Hello world!', severity: 'success' })
}}
>
Show toast
</button>
<button
onClick={() => {
addDialog({
component: MyDialog,
onClose() {
// You can do something after the dialog is closed
void null
},
})
}}
>
Show dialog
</button>
<button
onClick={() => {
addDialog({
component: MySimpleDialog,
onClose() {
// You can do something after the dialog is closed
void null
},
})
}}
>
Show simple dialog
</button>
</div>
)
}
const components: TLComponents = {
SharePanel: CustomSharePanel,
}
export default function ToastsDialogsExample() {
return (
<div className="tldraw__editor">
<Tldraw components={components} persistenceKey="example" />
</div>
)
}
/*
To control toasts and dialogs your app, you can use the `useToasts` and `useDialogs` hooks.
These hooks give you access to functions which allow you to add, remove and clear toasts
and dialogs.
Dialogs are especially customisable, allowing you to pass in a custom component to render
as the dialog content. Alternatively, you can use the `ExampleDialog` component which is
provided by the library.
[1]
The tldraw library provides a set of components that you can use to build your dialogs.
The `onClose` function passed to the dialog component runs when the dialog closes or
is dismissed, but you can also call it from buttons to close the dialog.
[2]
...or you can build your own dialog component!
*/
Is this page helpful?
Prev
Tldraw image componentNext
Custom Grid Example