[prosemirror-autocomplete] add cancelOnSpace option#185
Open
benrbray wants to merge 3 commits intocurvenote:mainfrom
Open
[prosemirror-autocomplete] add cancelOnSpace option#185benrbray wants to merge 3 commits intocurvenote:mainfrom
cancelOnSpace option#185benrbray wants to merge 3 commits intocurvenote:mainfrom
Conversation
cancelOnFirstSpacecancelOnSpace option
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
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.
Thanks very much for the
prosemirror-autocompletepackage, it's great!cancelOnFirstSpaceWhat's the intended behavior of
cancelOnFirstSpace? The docs say:This could be interpreted in two different ways:
My desired behavior is the first one -- no spaces allowed, but the code behaves according to the second interpretation:
editor/packages/prosemirror-autocomplete/src/decoration.ts
Lines 143 to 153 in 8f576d7
Proposal
I propose the following, which I've implemented in this PR.
cancelOnSpace, which cancels autocompletion whenever space is pressedcancelOnSpace = true, the value ofcancelOnFirstSpaceis ignoredcancelOnSpace = false, the behavior ofcancelOnFirstSpaceis the same as beforeI also added some comments and updated the readme to document this change.
(Optional) Rename
cancelOnFirstSpace?Optionally, I suggest renaming
cancelOnFirstSpacetocancelOnInitialSpace, but I understand if you prefer to keep it the same to avoid a breaking change.Conclusion
Happy to make any changes to the PR based on your feedback. Thanks!