variablelab/theatre
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

r3f readme: Update with corrected API

Browse source
This commit is contained in:
Cole Lawrence 2022-07-15 12:57:09 -04:00
parent 5ca3edead8
commit a48155f8dc
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
packages/r3f/README.md
View file

@ -32,7 +32,7 @@ export default function App() {
return ( return (
<Canvas> <Canvas>
<SheetProvider <SheetProvider
getSheet={() => getProject('Playground - R3F').sheet('R3F-Canvas')} sheet={getProject('Playground - R3F').sheet('R3F-Canvas')}
> >
<ambientLight intensity={0.5} /> <ambientLight intensity={0.5} />
{/* Mark objects as editable. */} {/* Mark objects as editable. */}
@ -71,7 +71,7 @@ Use it to make objects editable. The properties on `editable` mirror the intrins
`editable` is also a function, which allows you to make your custom components editable. Your component does have to be compatible with the interface of the editable object type it is meant to represent. You need to pass it the component you want to wrap, and the object type it represents (see object types). `editable` is also a function, which allows you to make your custom components editable. Your component does have to be compatible with the interface of the editable object type it is meant to represent. You need to pass it the component you want to wrap, and the object type it represents (see object types).
```ts ```ts
import { editable } from 'react-three-editable'; import { editable } from '@theatre/r3f';
import { PerspectiveCamera } from '@react-three/drei'; import { PerspectiveCamera } from '@react-three/drei';
const EditableCamera = editable(PerspectiveCamera, 'perspectiveCamera'); const EditableCamera = editable(PerspectiveCamera, 'perspectiveCamera');
@ -81,13 +81,13 @@ const EditableCamera = editable(PerspectiveCamera, 'perspectiveCamera');
`uniqueName: string`: a unique name used to identify the object in the editor. `uniqueName: string`: a unique name used to identify the object in the editor.
### `<SheetProvider getSheet />` ### `<SheetProvider sheet={...} />`
Provider component you need to wrap any scene with that you use editable components in. Provider component you need to wrap any scene with that you use editable components in.
#### Props #### Props
`getSheet: () => TheatreSheetObject`: A function that returns the Theatre.js sheet associated with the scene. `sheet: TheatreSheetObject`: A function that returns the Theatre.js sheet associated with the scene.
## Object types ## Object types