@portabletext/plugin-input-rule 5.0.20 → 5.0.22

package/README.md

@@ -2,6 +2,14 @@
 
 > Easily configure Input Rules in the Portable Text Editor
 
+## Installation
+
+```sh
+npm install @portabletext/plugin-input-rule
+```
+
+## Why
+
 1. How do you implement undo functionality correctly?
 2. What about smart undo with <kbd>Backspace</kbd>?
 3. Have you considered `insert.text` events that carry more than one character? (Android, anyone?)
@@ -12,7 +20,7 @@ _This is why this plugin exists_. It brings the concept of "Input Rules" to the
 import type {EditorSchema} from '@portabletext/editor'
 import {raise} from '@portabletext/editor/behaviors'
 import {getPreviousInlineObject} from '@portabletext/editor/selectors'
-import {defineInputRule} from '@portabletext/plugin-input-rule'
+import {defineInputRule, InputRulePlugin} from '@portabletext/plugin-input-rule'
 
 const unorderedListRule = defineInputRule({
   // Listen for a RegExp pattern instead of a raw event
@@ -61,13 +69,18 @@ export function MyMarkdownPlugin() {
 }
 ```
 
-> 💡 **Tip:** The [`@portabletext/plugin-markdown-shortcuts`](../plugin-markdown-shortcuts/) package is already built using Input Rules and provides common markdown shortcuts out of the box.
+> **Tip:** The [`@portabletext/plugin-markdown-shortcuts`](../plugin-markdown-shortcuts/) package is already built using Input Rules and provides common markdown shortcuts out of the box.
 
-## Text Transformation Rules
+## Text transformation rules
 
 Text transformations are so common that the plugin provides a high-level `defineTextTransformRule` helper to configure them without any boilerplate:
 
 ```tsx
+import {
+  defineTextTransformRule,
+  InputRulePlugin,
+} from '@portabletext/plugin-input-rule'
+
 const emDashRule = defineTextTransformRule({
   on: /--/,
   transform: () => '—',
@@ -80,14 +93,14 @@ export function MyTypographyPlugin() {
 
 In fact, the production-ready [`@portabletext/plugin-typography`](../plugin-typography/) is built on top of Input Rules and comes packed with common text transformations like this.
 
-## Advanced Examples
+## Advanced examples
 
 Input Rules can handle more complex transformations. Here are two advanced examples:
 
 1. **Markdown Link**: Automatically convert `[text](url)` syntax into proper links
 2. **Stock Ticker**: Convert `{SYMBOL}` patterns into stock ticker objects
 
-### Markdown Link Rule
+### Markdown link rule
 
 This example shows how to convert markdown-style link syntax `[text](url)` into proper link annotations:
 
@@ -174,7 +187,7 @@ const markdownLinkRule = defineInputRule({
 })
 ```
 
-### Stock Ticker Rule
+### Stock ticker rule
 
 This example demonstrates how to convert text patterns like `{AAPL}` into custom inline objects:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@portabletext/plugin-input-rule",
-  "version": "5.0.20",
-  "description": "Easily configure input rules in the Portable Text Editor",
+  "version": "5.0.22",
+  "description": "Easily configure Input Rules in the Portable Text Editor",
   "keywords": [
     "portabletext",
     "plugin",
@@ -48,12 +48,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": {