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

fix(prosemirror): undoable inputrules #1546

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ap0nia
Copy link

@ap0nia ap0nia commented Oct 24, 2024

  • I read the contributing guide
  • I agree to follow the code of conduct

Summary

Specifying undoable for inputrules does not currently seem to work.

The upstream implementation of run from prosemirror-inputrules checks if the rule is undoable before adding the meta information. The custom implementation of the run function in Milkdown does not seem to do that here.

Not all the type information seems to be captured for the InputRule class, such as the undoable property that should be stored on it, so I have inserted a ts-expect-error comment for now...

How did you test this change?

I have not tested this yet. The testing procedure would involve creating an inputrule, such as the Markdown "replace with emoji when text surrounded by colon" and specifying it as undoable. Immediately after triggering it, the user should hit backspace and "undoInputRule" should not trigger. In my own project, this means that it would look like this.

  1. Type the emoji :smile:
  2. Triggered replacement 😄
  3. Backspace deletes entire emoji node

Currently, it will do this

  1. Type the emoji :smile:
  2. Triggered replacement 😄
  3. Backspace restores the emoji text (deletes entire emoji node) :smile:

Motivation

For this emoji node in particular, I would like :smile: sequences to be replaced with an emoji upon successful completion, and if the user immediately hits "Backspace" for the emoji to be removed entirely.

Project

Resolves #1545

Copy link

changeset-bot bot commented Oct 24, 2024

⚠️ No Changeset found

Latest commit: 4eb0faf

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Oct 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
milkdown-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 24, 2024 1:41pm

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.

[Bug] undoable input rule
1 participant