From a48155f8dc334f8fe00edbf6557435a0cb25fcad Mon Sep 17 00:00:00 2001 From: Cole Lawrence Date: Fri, 15 Jul 2022 12:57:09 -0400 Subject: [PATCH] r3f readme: Update with corrected API --- packages/r3f/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/r3f/README.md b/packages/r3f/README.md index 9e872c8..4096f4e 100644 --- a/packages/r3f/README.md +++ b/packages/r3f/README.md @@ -32,7 +32,7 @@ export default function App() { return ( getProject('Playground - R3F').sheet('R3F-Canvas')} + sheet={getProject('Playground - R3F').sheet('R3F-Canvas')} > {/* 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). ```ts -import { editable } from 'react-three-editable'; +import { editable } from '@theatre/r3f'; import { PerspectiveCamera } from '@react-three/drei'; 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. -### `` +### `` Provider component you need to wrap any scene with that you use editable components in. #### 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