Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/netzo/deps/@tiptap/react.ts>wrappingInputRule

Full-stack Deno framework for building business web apps like internal tools, dashboards, admin panels and automated workflows.
Go to Latest
function wrappingInputRule
import { wrappingInputRule } from "https://deno.land/x/netzo@0.5.108/deps/@tiptap/react.ts";

Build an input rule for automatically wrapping a textblock when a given string is typed. When using a regular expresion you’ll probably want the regexp to start with ^, so that the pattern can only occur at the start of a textblock.

type is the type of node to wrap in.

By default, if there’s a node with the same type above the newly wrapped node, the rule will try to join those two nodes. You can pass a join predicate, which takes a regular expression match and the node before the wrapped node, and can return a boolean to indicate whether a join should happen.

Parameters

config: { find: InputRuleFinder; type: NodeType; keepMarks?: boolean; keepAttributes?: boolean; editor?: Editor; getAttributes?:
| Record<string, any>
| ((match: ExtendedRegExpMatchArray) => Record<string, any>)
| false
| null
; joinPredicate?: (match: ExtendedRegExpMatchArray, node: ProseMirrorNode) => boolean; }