feature: add subscript and superscript extensions, docs and tests

packages/extension-superscript/src/superscript.ts

@@ -0,0 +1,69 @@
+import { Command, Mark, mergeAttributes } from '@tiptap/core'
+
+export interface SuperscriptExtensionOptions {
+  HTMLAttributes: Object,
+}
+
+declare module '@tiptap/core' {
+  interface Commands {
+    superscript: {
+      /**
+       * Set a superscript mark
+       */
+      setSuperscript: () => Command,
+      /**
+       * Toggle a superscript mark
+       */
+      toggleSuperscript: () => Command,
+      /**
+       * Unset a superscript mark
+       */
+      unsetSuperscript: () => Command,
+    }
+  }
+}
+
+export const Superscript = Mark.create<SuperscriptExtensionOptions>({
+  name: 'superscript',
+
+  defaultOptions: {
+    HTMLAttributes: {},
+  },
+
+  parseHTML() {
+    return [
+      {
+        tag: 'sup',
+      },
+      {
+        style: 'vertical-align',
+        getAttrs(value) {
+          // Don’t match this rule if the vertical align isn’t super.
+          if (value !== 'super') {
+            return false
+          }
+
+          // If it falls through we’ll match, and this mark will be applied.
+        },
+      },
+    ]
+  },
+
+  renderHTML({ HTMLAttributes }) {
+    return ['sup', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]
+  },
+
+  addCommands() {
+    return {
+      setSuperscript: () => ({ commands }) => {
+        return commands.setMark('superscript')
+      },
+      toggleSuperscript: () => ({ commands }) => {
+        return commands.toggleMark('superscript')
+      },
+      unsetSuperscript: () => ({ commands }) => {
+        return commands.unsetMark('superscript')
+      },
+    }
+  },
+})