Add useStateWithHistory hook and use to show a block editor with undo/redo #54377
Conversation
This file contains 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
youknowriad
added
Framework
youknowriad
commented
Sep 12, 2023
25 tasks
|
Size Change: +2.36 kB (0%) Total Size: 1.52 MB
ℹ️ View Unchanged
|
|
This PR should be ready for final review now. |
ellatrix
reviewed
Sep 14, 2023
| // eslint-disable-next-line jsx-a11y/no-static-element-interactions | ||
| <div | ||
| className="editor-box" | ||
| onKeyDown={ ( event ) => event.stopPropagation() } |
There was a problem hiding this comment.
Because we have some global keyboard shortcuts that conflict playground's shortcuts (try typing in the editor). Feels like we may want to call "preventDefault" when typing random characters in the editor but it's out of scope here.
There was a problem hiding this comment.
Adding this to the code example doesn't feel right. Should maybe move to a general playground template
There was a problem hiding this comment.
I think there's a real bug in our components, I'm not sure where though because when you type within regular inputs the events are ignored by playwright but when you type in the block editor, the events reach the playground. So I'd rather not hide it for now.
ellatrix
reviewed
Sep 14, 2023
ellatrix
reviewed
Sep 14, 2023
| */ | ||
| export default function useStateWithHistory< T >( initialValue: T ) { | ||
| const manager = useRef( createUndoManager() ); | ||
| const [ value, setValue ] = useState( initialValue ); |
There was a problem hiding this comment.
Why can't the internal state be equal to that of the under manager?
There was a problem hiding this comment.
I don't understand?
There was a problem hiding this comment.
Sorry, I thought the state was exposed, but I guess not
There was a problem hiding this comment.
Why no give access to the state though, if it's a low level thing? Then you don't need an intermediate state.
There was a problem hiding this comment.
I'm not sure, it feels like an internal representation of a history. I think regardless of whether we expose it or not, we need an intermediate state, in some occasions we don't record undo/redo steps. (undoIgnore option)
jsnajdr
reviewed
Sep 14, 2023
|
Flaky tests detected in cd69c61. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6184988253
|
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.
Related to #53874
What?
Undo/Redo has been a common struggle for folks implementing a custom block editor. This PR introduces a
useStateWithHistoryto the compose package.Also, I'm adding a new "playground" story to Storybook to show a small block editor using this hook to implement undo/redo.
Testing Instructions
1- Run storybook
npm run storybook:dev.2- Open the "Playground with undo/redo" story.
3- Check that you can use the editor and click undo/redo buttons