From 7a148b9c3512eb43fe96cae7eb0fffb9a935b25e Mon Sep 17 00:00:00 2001 From: Steve Ruiz Date: Tue, 16 Nov 2021 16:46:03 +0000 Subject: [PATCH] update readmes --- README.md | 14 +++++++------- guides/documentation.md | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5bb7c294f..606fe52d8 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ function App() { ### Controlling the Component through Props -You can control the `tldraw` component through its props. +You can control the `` component through its props. ```tsx import { Tldraw, TDDocument } from '@tldraw/tldraw' @@ -62,31 +62,31 @@ function App() { ### Controlling the Component through the tldrawApp API -You can also control the `tldraw` component imperatively through the `tldrawApp` API. +You can also control the `` component imperatively through the `TldrawApp` API. ```tsx import { Tldraw, tldrawApp } from '@tldraw/tldraw' function App() { - const handleMount = React.useCallback((state: tldrawApp) => { - state.selectAll() + const handleMount = React.useCallback((app: TldrawApp) => { + app.selectAll() }, []) return } ``` -Internally, the `tldraw` component's user interface uses this API to make changes to the component's state. See the `tldrawApp` section of the [documentation](guides/documentation) for more on this API. +Internally, the `` component's user interface uses this API to make changes to the component's state. See the `tldrawApp` section of the [documentation](guides/documentation) for more on this API. ### Responding to Changes You can respond to changes and user actions using the `onChange` callback. For more specific changes, you can also use the `onPatch`, `onCommand`, or `onPersist` callbacks. See the [documentation](guides/documentation) for more. ```tsx -import { Tldraw, tldrawApp } from '@tldraw/tldraw' +import { Tldraw, TldrawApp } from '@tldraw/tldraw' function App() { - const handleChange = React.useCallback((state: tldrawApp, reason: string) => { + const handleChange = React.useCallback((app: TldrawApp, reason: string) => { // Do something with the change }, []) diff --git a/guides/documentation.md b/guides/documentation.md index 9c60337aa..c433f34e3 100644 --- a/guides/documentation.md +++ b/guides/documentation.md @@ -206,8 +206,8 @@ You can change the `tldraw` component's state through an imperative API called ` import { Tldraw, TldrawApp } from '@tldraw/tldraw' function App() { - const handleMount = React.useCallback((state: TldrawApp) => { - state.selectAll() + const handleMount = React.useCallback((app: TldrawApp) => { + app.selectAll() }, []) return