Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

History: withNewBatch #5747

Merged
merged 4 commits into from
Oct 21, 2024
Merged

History: withNewBatch #5747

merged 4 commits into from
Oct 21, 2024

Conversation

zbeyens
Copy link
Contributor

@zbeyens zbeyens commented Oct 19, 2024

Description
Add a new method withNewBatch to HistoryEditor. This method allows users to explicitly start a new batch in the history for the first operation, while merging subsequent operations as usual. This provides more fine-grained control over history management, particularly useful for complex editing operations that should be treated as a single unit in the undo/redo history.

Example

HistoryEditor.withNewBatch(editor, () => {
  // The first operation here will start a new batch in the history
  editor.insertText('Hello')
  
  // These operations will be merged into the new batch
  editor.insertText(' ')
  editor.insertText('World')
})

Checks

  • The new code matches the existing patterns and styles.
  • The tests pass with yarn test.
  • The linter passes with yarn lint. (Fix errors with yarn fix.)
  • The relevant examples still work. (Run examples with yarn start.)
  • You've added a changeset if changing functionality. (Add one with yarn changeset add.)

Disclaimer: AI generated

Copy link

changeset-bot bot commented Oct 19, 2024

🦋 Changeset detected

Latest commit: cfb0296

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
slate-history Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Collaborator

@dylans dylans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine. It would be good to add something to the docs as well, but that can happen in a separate PR.

@dylans dylans merged commit 0e1e4b4 into ianstormtaylor:main Oct 21, 2024
11 checks passed
@github-actions github-actions bot mentioned this pull request Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants