editor: add startEditingShape/stopEditingShape; deprecate setEditingShape #7276
+191
−163
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
mimecuvalo
temporarily deployed
to
deploy-staging
GitHub Actions
Inactive
mimecuvalo
temporarily deployed
to
bemo-canary
GitHub Actions
Inactive
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
steveruizok
reviewed
Dec 5, 2025
| this.emit('select-all-text', { shapeId: shape.id }) | ||
| } | ||
|
|
||
| return true |
Collaborator
There was a problem hiding this comment.
The pattern with Editor methods is to return the Editor class instance. I'd add a canEdit method here if the user needs to check, or else check after. Its annoying but that's the pattern, I'd rather not change it.
Member
Author
There was a problem hiding this comment.
gotcha, we could still do a return this. i don't need to do the return true here
steveruizok
reviewed
Dec 5, 2025
Comment on lines
+2294
to
+2298
| this.setCurrentTool('select.editing_shape', { | ||
| ...(options.info ?? {}), | ||
| target: 'shape', | ||
| shape, | ||
| }) |
Collaborator
There was a problem hiding this comment.
select is a state that only exists at the tldraw level
Collaborator
|
Hey, let me put up a PR that shows a different way of getting to the same outcome. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This deprecates
setEditingShape, which is a bit too low-level/footgun-y in favor of astartEditingShape/stopEditingShapethat has safer usage semantics.Right now it's hard to start editing shape without doing several checks to make sure that you're safe to start editing.
It currently involves calling
setEditingShape, transitioning or setting the current tool toEditingShapeall while checking if we're in readonly mode and making sure the shape is editable (via thecanEditshape API check).Addresses #7077
Change type
bugfiximprovementfeatureapiotherTest plan
Release notes
API changes
editor: add startEditingShape to better encapsulate proper ergonomics around doing an edit. deprecate setEditingShape
Note
Adds safer editing APIs
startEditingShape/stopEditingShape(with options), deprecatessetEditingShape, updates usages across editor, tools, shapes, examples, and tests, and adjusts related types/exports.Editor.startEditingShape(shapeOrId?, { info, selectAll })that validates editability, selects the shape, and transitions toselect.editing_shape(emitsselect-all-textwhen requested).Editor.stopEditingShape()to clear editing state.Editor.setEditingShapeas@deprecatedand route to internal setter.TLStartEditingShapeOptions.TLResizeShapeOptionstotypes/misc-typesand export from index; remove duplicate definition inEditor.ts.setEditingShapewithstartEditingShape/stopEditingShapeacross select tool states, text/note/arrow/frame behaviors, and helpers (removeselectHelpers.ts).startEditingShape/stopEditingShapebehavior and update existing tests to new APIs.Written by Cursor Bugbot for commit 922d268. This will update automatically on new commits. Configure here.