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.

Sign up for GitHub

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

Components: Ignore user completers when reaching >= 4 words after trigger char #30589

Closed
wants to merge 2 commits into from
Closed

Components: Ignore user completers when reaching >= 4 words after trigger char #30589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1949a4a
Ignore completers when reaching >= 4 words after trigger char
fullofcaffeine Apr 8, 2021
2016c4f
Adapt allowContext to be used as a completer filter that takes into a…
fullofcaffeine Apr 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions packages/components/src/autocomplete/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,17 +444,21 @@ function Autocomplete( {
return false;
}

const textWithoutTrigger = text.slice(
index + triggerPrefix.length
);

if (
allowContext &&
! allowContext( text.slice( 0, index ), textAfterSelection )
! allowContext(
text.slice( 0, index ),
textAfterSelection,
textWithoutTrigger
)
) {
return false;
}

const textWithoutTrigger = text.slice(
index + triggerPrefix.length
);

if (
/^\s/.test( textWithoutTrigger ) ||
/\s\s+$/.test( textWithoutTrigger )
Expand Down
11 changes: 11 additions & 0 deletions packages/editor/src/components/autocompleters/user.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,17 @@ export default {
</span>,
];
},
allowContext( before, after, textWithoutTrigger ) {
Copy link
Member Author

@fullofcaffeine fullofcaffeine Apr 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I took the freedom to experiment a bit by turning the allowContext callback into a more general-purpose "filter" for the completer, by also allowing the textWithoutTrigger to be passed to it as the last parameter. The previous version of this changeset was clunkier as it included the logic below in the Autocomplete component, and it'd run for all completers, which was not ideal.

I'm adding to the method signature, so I'm not sure how safe this change is. I'd bet it is relatively safe. Also, you could argue that the name allowContext still somewhat fits semantically in this context. Let me know if you think a new function would be better, or if I should fall back to 1949a4a.

Copy link
Member

Choose a reason for hiding this comment

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

See #30589 (comment) where I left some more thought. I think we need something general like the maximum number of chars that gets processed and a way to fine-tune for individual completers like you propose 👍🏻

Copy link
Contributor

Choose a reason for hiding this comment

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

TBH I don't love the idea of bending allowContext to suit our needs here 😛
OTOH, I also don't love the idea of a customizable max number of chars for individual completers -- I don't think that reflects the behavior of completion as I'd imagine it.

I'll leave a top-level comment with some more discussion.

// Escape hatch for inline completer triggers. Allows up to 3 words to
// be matched and will bail out on the 4th word onwards. An example is
// this "user" completer. Its trigger char isn't removed when completing
// is done, so it's always present on the page. Without this hatch, the
// autocompleter will keep trying to match everything from the trigger
// onwards, up to infinity, slowing down the editor.
const reachedWordLimit =
textWithoutTrigger.trim().split( /\s/ ).length >= 4;
return ! reachedWordLimit;
},
getOptionCompletion( user ) {
return `@${ user.slug }`;
},
Expand Down