Improve indicators API #6395
Open
Improve indicators API #6395
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 Git ↗︎
1 Skipped Deployment
|
steveruizok
commented
Jul 4, 2025
packages/editor/src/lib/components/default-components/DefaultShapeIndicators.tsx
Outdated
Show resolved
Hide resolved
steveruizok
temporarily deployed
to
deploy-staging
GitHub Actions
Inactive
SomeHats
approved these changes
Jul 11, 2025
| @@ -2735,6 +2735,7 @@ export abstract class StateNode implements Partial<TLEventHandlers> { | |||
| getCurrentToolIdMask(): string | undefined; | |||
| getIsActive(): boolean; | |||
| getPath(): string; | |||
| getShouldShowIndicators(): boolean; | |||
There was a problem hiding this comment.
For similar flags in e.g. shape utils we drop the get and just do canDoX() etc.
For things like this where the function name is unambiguously returning a boolean and not performing an action, I think we can drop the get and have a shorter, easier to read name
Comment on lines
+36
to
+43
| let shouldShowIndicators = false | ||
| let state: StateNode | undefined = editor.getCurrentTool() | ||
| // allow deeper state nodes to override the should show indicators value of shallower nodes | ||
| while (state) { | ||
| shouldShowIndicators = !!state.getShouldShowIndicators() | ||
| state = state.getCurrent() | ||
| if (!state) break | ||
| } |
There was a problem hiding this comment.
i'd be tempted to make this a method on editor or the root state node for easier reuse. wdyt?
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 PR solves a long-standing todo, which replaces the hard-coded list of "show indicators" to state nodes instead. As a result, we can remove the
<TldrawShapeIndicators>component that provided that logic.Change type
bugfiximprovementfeatureapiotherRelease notes
shouldShowIndicators()toStateNode, used to configure whether indicators should be shown when in the state