PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

update readmes

Browse source
This commit is contained in:
Steve Ruiz 2021-11-16 16:46:03 +00:00
parent 699b1167bd
commit 7a148b9c35
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -48,7 +48,7 @@ function App() {
### Controlling the Component through Props
You can control the `tldraw` component through its props.
You can control the `<Tldraw/>` 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 `<Tldraw/>` 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 <Tldraw onMount={handleMount} />
}
```
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 `<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.
### 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
}, [])

4
guides/documentation.md
View file

@ -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 <Tldraw onMount={handleMount} />