feat: Allow multiple prefix characters to trigger a suggestion (#2896)

* feat: Allow multiple prefix characters to trigger a suggestion * review: Turn `allowedPrefixes` into an array instead
ueberdosis · Jun 21, 2022 · 482cb96 · 482cb96
1 parent 53e39d0
commit 482cb96
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 7 deletions.
diff --git a/docs/api/utilities/suggestion.md b/docs/api/utilities/suggestion.md
@@ -21,6 +21,11 @@ Allows or disallows spaces in suggested items.
 
 Default: `false`
 
+### allowedPrefixes
+The prefix characters that are allowed to trigger a suggestion. Set to `null` to allow any prefix character.
+
+Default: `[' ']`
+
 ### startOfLine
 Trigger the autocomplete popup at the start of a line only.
 

diff --git a/packages/suggestion/src/findSuggestionMatch.ts b/packages/suggestion/src/findSuggestionMatch.ts
@@ -4,7 +4,7 @@ import { ResolvedPos } from 'prosemirror-model'
 export interface Trigger {
   char: string,
   allowSpaces: boolean,
-  prefixSpace: boolean,
+  allowedPrefixes: string[] | null,
   startOfLine: boolean,
   $position: ResolvedPos,
 }
@@ -19,7 +19,7 @@ export function findSuggestionMatch(config: Trigger): SuggestionMatch {
   const {
     char,
     allowSpaces,
-    prefixSpace,
+    allowedPrefixes,
     startOfLine,
     $position,
   } = config
@@ -47,9 +47,9 @@ export function findSuggestionMatch(config: Trigger): SuggestionMatch {
   // JavaScript doesn't have lookbehinds. This hacks a check that first character
   // is a space or the start of the line
   const matchPrefix = match.input.slice(Math.max(0, match.index - 1), match.index)
-  const matchPrefixIsSpace = /^[\s\0]?$/.test(matchPrefix)
+  const matchPrefixIsAllowed = new RegExp(`^[${allowedPrefixes?.join('')}\0]?$`).test(matchPrefix)
 
-  if (prefixSpace && !matchPrefixIsSpace) {
+  if (allowedPrefixes !== null && !matchPrefixIsAllowed) {
     return null
   }
 

diff --git a/packages/suggestion/src/suggestion.ts b/packages/suggestion/src/suggestion.ts
@@ -9,8 +9,8 @@ export interface SuggestionOptions<I = any> {
   editor: Editor,
   char?: string,
   allowSpaces?: boolean,
+  allowedPrefixes?: string[] | null,
   startOfLine?: boolean,
-  prefixSpace?: boolean,
   decorationTag?: string,
   decorationClass?: string,
   command?: (props: {
@@ -61,7 +61,7 @@ export function Suggestion<I = any>({
   editor,
   char = '@',
   allowSpaces = false,
-  prefixSpace = true,
+  allowedPrefixes = [' '],
   startOfLine = false,
   decorationTag = 'span',
   decorationClass = 'suggestion',
@@ -218,7 +218,7 @@ export function Suggestion<I = any>({
           const match = findSuggestionMatch({
             char,
             allowSpaces,
-            prefixSpace,
+            allowedPrefixes,
             startOfLine,
             $position: selection.$from,
           })