docs: add input-rules examples

wiki/content/input-rules.md

@@ -0,0 +1,92 @@
+# Input rules
+
+This module defines a plugin for attaching input rules to an editor, which can react to or transform text typed by the user.
+
+Doc: https://prosemirror.net/docs/ref/#inputrules
+
+Source: https://github.com/ProseMirror/prosemirror-example-setup/
+
+### Rules
+
+````ts
+import {
+  inputRules,
+  wrappingInputRule,
+  textblockTypeInputRule,
+  smartQuotes,
+  emDash,
+  ellipsis,
+  InputRule,
+} from 'prosemirror-inputrules';
+import { NodeType, Schema } from 'prosemirror-model';
+
+// : (NodeType) → InputRule
+// Given a blockquote node type, returns an input rule that turns `"> "`
+// at the start of a textblock into a blockquote.
+export function blockQuoteRule(nodeType: NodeType): InputRule {
+  return wrappingInputRule(/^\s*>\s$/, nodeType);
+}
+
+// : (NodeType) → InputRule
+// Given a list node type, returns an input rule that turns a number
+// followed by a dot at the start of a textblock into an ordered list.
+export function orderedListRule(nodeType: NodeType): InputRule {
+  return wrappingInputRule(
+    /^(\d+)\.\s$/,
+    nodeType,
+    (match) => ({ order: +match[1] }),
+    (match, node) => node.childCount + node.attrs.order === +match[1],
+  );
+}
+
+// : (NodeType) → InputRule
+// Given a list node type, returns an input rule that turns a bullet
+// (dash, plush, or asterisk) at the start of a textblock into a
+// bullet list.
+export function bulletListRule(nodeType: NodeType): InputRule {
+  return wrappingInputRule(/^\s*([-+*])\s$/, nodeType);
+}
+
+// : (NodeType) → InputRule
+// Given a code block node type, returns an input rule that turns a
+// textblock starting with three backticks into a code block.
+export function codeBlockRule(nodeType: NodeType): InputRule {
+  return textblockTypeInputRule(/^```$/, nodeType);
+}
+
+// : (NodeType, number) → InputRule
+// Given a node type and a maximum level, creates an input rule that
+// turns up to that number of `#` characters followed by a space at
+// the start of a textblock into a heading whose level corresponds to
+// the number of `#` signs.
+export function headingRule(nodeType: NodeType, maxLevel: number): InputRule {
+  return textblockTypeInputRule(new RegExp('^(#{1,' + maxLevel + '})\\s$'), nodeType, (match) => ({
+    level: match[1].length,
+  }));
+}
+
+// : (Schema) → Plugin
+// A set of input rules for creating the basic block quotes, lists,
+// code blocks, and heading.
+export function buildInputRules(schema: Schema) {
+  const rules = smartQuotes.concat(ellipsis, emDash);
+
+  rules.push(blockQuoteRule(schema.nodes.blockquote));
+  rules.push(orderedListRule(schema.nodes.ordered_list));
+  rules.push(bulletListRule(schema.nodes.bullet_list));
+  rules.push(codeBlockRule(schema.nodes.code_block));
+  rules.push(headingRule(schema.nodes.heading, 6));
+
+  return inputRules({ rules });
+}
+````
+
+### Config
+
+```ts
+import { NgxEditorModule, schema } from 'ngx-editor';
+
+NgxEditorModule.forRoot({
+  plugins: [buildInputRules(schema)],
+});
+```

wiki/summary.json

@@ -30,5 +30,9 @@
   {
     "title": "Inline Code Editor",
     "file": "content/inline-code-editor.md"
+  },
+  {
+    "title": "Input Rules",
+    "file": "content/input-rules.md"
   }
 ]