@portabletext/plugin-typeahead-picker 3.0.2 → 3.0.3

package/README.md

@@ -355,27 +355,9 @@ The error is cleared when the picker returns to idle (e.g., via Escape or cursor
 
 ## onDismiss
 
-The optional `onDismiss` callback runs when the picker is dismissed via Escape. This is useful for cleaning up the typed trigger and keyword text.
+The optional `onDismiss` callback runs when the picker is dismissed (Escape, Enter/Tab with no matches, or programmatically). Without `onDismiss`, dismissing simply closes the picker and leaves the typed text in place.
 
-```ts
-const mentionPicker = defineTypeaheadPicker<MentionMatch>({
-  trigger: /@/,
-  keyword: /\w*/,
-  getMatches: ({keyword}) => searchUsers(keyword),
-  onSelect: [
-    ({event}) => [
-      raise({type: 'delete', at: event.patternSelection}),
-      raise({type: 'insert.text', text: `@${event.match.name}`}),
-    ],
-  ],
-  // Delete the typed text when user presses Escape
-  onDismiss: [
-    ({event}) => [raise({type: 'delete', at: event.patternSelection})],
-  ],
-})
-```
-
-Without `onDismiss`, pressing Escape leaves the typed text in place (e.g., `@john` remains in the editor). With `onDismiss` configured to delete the pattern, the text is removed.
+For most pickers, you should **not** use `onDismiss` to delete text. If a user types `@` and dismisses, they likely wanted to type a literal `@`.
 
 **onDismiss payload:**
 
@@ -384,18 +366,6 @@ Without `onDismiss`, pressing Escape leaves the typed text in place (e.g., `@joh
 | `event.patternSelection` | Selection range covering the trigger + keyword (e.g., `@john`) |
 | `snapshot`               | Current editor snapshot                                        |
 
-Note: `onDismiss` is called when the user actively dismisses the picker:
-
-- Pressing Escape
-- Pressing Enter/Tab when there are no matches
-- Programmatically via `picker.send({type: 'dismiss'})`
-
-It is NOT called when:
-
-- The user selects a match (Enter/Tab/click with a match selected)
-- The picker is dismissed due to cursor movement
-- The picker is dismissed due to invalid pattern (e.g., typing a space)
-
 ## Advanced onSelect
 
 The `onSelect` callback receives more than just the event. The full payload includes access to the editor snapshot, which is useful for generating keys, accessing the schema, or reading the current editor state.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/plugin-typeahead-picker",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Generic typeahead picker infrastructure for the Portable Text Editor",
   "keywords": [
     "portabletext",
@@ -35,7 +35,7 @@
     "@xstate/react": "^6.0.0",
     "xstate": "^5.25.0",
     "@portabletext/keyboard-shortcuts": "^2.1.2",
-    "@portabletext/plugin-input-rule": "^2.0.22"
+    "@portabletext/plugin-input-rule": "^2.0.23"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.2.1",
@@ -52,12 +52,12 @@
     "typescript": "5.9.3",
     "typescript-eslint": "^8.48.0",
     "vitest": "^4.0.16",
-    "@portabletext/editor": "^4.3.7",
+    "@portabletext/editor": "^4.3.8",
     "@portabletext/schema": "2.1.1",
     "racejar": "2.0.2"
   },
   "peerDependencies": {
-    "@portabletext/editor": "^4.3.7",
+    "@portabletext/editor": "^4.3.8",
     "react": "^19.2"
   },
   "engines": {