@portabletext/plugin-typeahead-picker 6.0.20 → 6.0.22

package/README.md

@@ -1,8 +1,14 @@
 # `@portabletext/plugin-typeahead-picker`
 
-> Generic typeahead picker infrastructure for the Portable Text Editor
+> Build typeahead pickers (emoji, mentions, slash commands) for the Portable Text Editor
 
-## Quick Start
+## Installation
+
+```sh
+npm install @portabletext/plugin-typeahead-picker
+```
+
+## Quick start
 
 The `useTypeaheadPicker` hook provides the state and logic needed to build typeahead pickers (emoji pickers, mention pickers, slash commands, etc.) for the Portable Text Editor. It manages keyword matching, keyboard navigation, and triggering of actions, but is not concerned with the UI, how the picker is rendered, or how it's positioned in the document.
 
@@ -93,7 +99,7 @@ function MyEditor() {
 
 The picker component must be rendered inside `EditorProvider` to access the editor context. Position it as a sibling to `PortableTextEditable` - you'll handle the visual positioning (popover, dropdown, etc.) separately with CSS or a positioning library.
 
-## How It Works
+## How it works
 
 The picker activates when users type the `trigger` pattern (e.g., `:` or `@`). The `keyword` pattern then matches characters typed after the trigger.
 
@@ -218,7 +224,7 @@ The guard is useful for:
 - Avoiding conflicts when another picker or dialog is already open
 - Checking editor state or mode before allowing the picker
 
-## API Reference
+## API reference
 
 ### `defineTypeaheadPicker(config)`
 
@@ -289,11 +295,11 @@ React hook that activates a picker and returns its state.
 | `send(event)`                    | Dispatch events: `{type: 'select'}`, `{type: 'dismiss'}`, `{type: 'navigate to', index}`                     |
 | `snapshot.context.error`         | Error from `getMatches` if it threw/rejected, otherwise `undefined`                                          |
 
-## Async Mode
+## Async mode
 
 When `mode: 'async'` is configured, the picker handles asynchronous `getMatches` functions with loading states and race condition protection.
 
-### Loading States
+### Loading states
 
 Use `snapshot.matches()` to check nested loading states:
 
@@ -325,11 +331,11 @@ function MentionPicker() {
 }
 ```
 
-### Race Condition Handling
+### Race condition handling
 
 When users type quickly, earlier slow requests may complete after later fast requests. The picker automatically ignores stale results to prevent them from overwriting fresh data.
 
-## Error Handling
+## Error handling
 
 If `getMatches` throws or rejects, the error is captured in `snapshot.context.error`. The picker transitions to `'no matches'` state and continues to function.
 
@@ -404,9 +410,9 @@ const commandPicker = defineTypeaheadPicker<CommandMatch>({
 | `event`    | The select event with `match`, `keyword`, and `patternSelection`              |
 | `snapshot` | Current editor snapshot with `context.schema`, `context.keyGenerator()`, etc. |
 
-## Performance Guidelines
+## Performance guidelines
 
-### Match List Size
+### Match list size
 
 Keep your match lists reasonably sized for smooth keyboard navigation:
 
@@ -421,7 +427,7 @@ getMatches: async ({keyword}) => {
 }
 ```
 
-### Debounce Timing
+### Debounce timing
 
 Choose debounce values based on your data source:
 
@@ -452,7 +458,7 @@ const mentionPicker = defineTypeaheadPicker({
 })
 ```
 
-### Memory Considerations
+### Memory considerations
 
 - Avoid storing large datasets in component state
 - For emoji pickers, consider lazy-loading the emoji database
@@ -462,7 +468,7 @@ const mentionPicker = defineTypeaheadPicker({
 
 The picker manages keyboard navigation and selection internally, but you're responsible for the UI semantics.
 
-### Recommended ARIA Attributes
+### Recommended ARIA attributes
 
 ```tsx
 function PickerUI() {
@@ -487,7 +493,7 @@ function PickerUI() {
 }
 ```
 
-### Keyboard Handling
+### Keyboard handling
 
 The following keyboard shortcuts are handled automatically by the picker:
 
@@ -499,7 +505,7 @@ The following keyboard shortcuts are handled automatically by the picker:
 | `Escape`  | Dismiss picker                |
 | `Space`   | Dismiss picker (configurable) |
 
-### Screen Reader Considerations
+### Screen reader considerations
 
 - Announce match count changes with live regions if desired
 - Ensure selected item is visible (scroll into view)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@portabletext/plugin-typeahead-picker",
-  "version": "6.0.20",
-  "description": "Generic typeahead picker infrastructure for the Portable Text Editor",
+  "version": "6.0.22",
+  "description": "Build typeahead pickers (emoji, mentions, slash commands) for the Portable Text Editor",
   "keywords": [
     "portabletext",
     "plugin",
@@ -35,7 +35,7 @@
     "@xstate/react": "^6.1.0",
     "xstate": "^5.32.1",
     "@portabletext/keyboard-shortcuts": "^2.1.2",
-    "@portabletext/plugin-input-rule": "^5.0.20"
+    "@portabletext/plugin-input-rule": "^5.0.22"
   },
   "devDependencies": {
     "@sanity/pkg-utils": "^10.2.1",
@@ -52,12 +52,12 @@
     "typescript": "5.9.3",
     "typescript-eslint": "^8.48.0",
     "vitest": "^4.1.8",
-    "@portabletext/editor": "^7.6.1",
+    "@portabletext/editor": "^7.7.0",
     "@portabletext/schema": "2.2.1",
     "racejar": "2.0.8"
   },
   "peerDependencies": {
-    "@portabletext/editor": "^7.6.1",
+    "@portabletext/editor": "^7.7.0",
     "react": "^19.2"
   },
   "engines": {