snapshot of https://github.com/ueberdosis/tiptap.git (main, 2026-09-15; blobs > 131072B omitted)

packages/extension-typography/README.md

@@ -0,0 +1,18 @@
+# @tiptap/extension-typography
+
+[![Version](https://img.shields.io/npm/v/@tiptap/extension-typography.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-typography)
+[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-typography.svg)](https://npmcharts.com/compare/tiptap?minimal=true)
+[![License](https://img.shields.io/npm/l/@tiptap/extension-typography.svg)](https://www.npmjs.com/package/@tiptap/extension-typography)
+[![Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/ueberdosis)
+
+## Introduction
+
+Tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as _New York Times_, _The Guardian_ or _Atlassian_.
+
+## Official Documentation
+
+Documentation can be found on the [Tiptap website](https://tiptap.dev).
+
+## License
+
+Tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

packages/extension-typography/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@tiptap/extension-typography",
+  "version": "3.30.3",
+  "description": "typography extension for tiptap",
+  "keywords": [
+    "tiptap",
+    "tiptap extension"
+  ],
+  "homepage": "https://tiptap.dev",
+  "bugs": {
+    "url": "https://github.com/ueberdosis/tiptap/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ueberdosis/tiptap",
+    "directory": "packages/extension-typography"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/ueberdosis"
+  },
+  "files": [
+    "src",
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "scripts": {
+    "build": "vp pack"
+  },
+  "devDependencies": {
+    "@tiptap/core": "workspace:^"
+  },
+  "peerDependencies": {
+    "@tiptap/core": "workspace:*"
+  }
+}

packages/extension-typography/src/index.ts

@@ -0,0 +1,5 @@
+import { Typography } from './typography.js'
+
+export * from './typography.js'
+
+export default Typography

packages/extension-typography/src/typography.ts

@@ -0,0 +1,465 @@
+import { Extension, textInputRule } from '@tiptap/core'
+
+/**
+ * Configuration for directional quotes (open/close pair).
+ */
+export interface DirectionalQuotes {
+  open: string
+  close: string
+}
+
+export interface TypographyOptions {
+  /**
+   * The em dash character.
+   * @default '—'
+   */
+  emDash: false | string
+
+  /**
+   * The ellipsis character.
+   * @default '…'
+   */
+  ellipsis: false | string
+
+  /**
+   * The open double quote character.
+   * @default '“'
+   */
+  openDoubleQuote: false | string
+
+  /**
+   * The close double quote character.
+   * @default '”'
+   */
+  closeDoubleQuote: false | string
+
+  /**
+   * The open single quote character.
+   * @default '‘'
+   */
+  openSingleQuote: false | string
+
+  /**
+   * The close single quote character.
+   * @default '’'
+   */
+  closeSingleQuote: false | string
+
+  /**
+   * The left arrow character.
+   * @default '←'
+   */
+  leftArrow: false | string
+
+  /**
+   * The right arrow character.
+   * @default '→'
+   */
+  rightArrow: false | string
+
+  /**
+   * The copyright character.
+   * @default '©'
+   */
+  copyright: false | string
+
+  /**
+   * The trademark character.
+   * @default '™'
+   */
+  trademark: false | string
+
+  /**
+   * The servicemark character.
+   * @default '℠'
+   */
+  servicemark: false | string
+
+  /**
+   * The registered trademark character.
+   * @default '®'
+   */
+  registeredTrademark: false | string
+
+  /**
+   * The one half character.
+   * @default '½'
+   */
+  oneHalf: false | string
+
+  /**
+   * The plus minus character.
+   * @default '±'
+   */
+  plusMinus: false | string
+
+  /**
+   * The not equal character.
+   * @default '≠'
+   */
+  notEqual: false | string
+
+  /**
+   * The laquo character.
+   * @default '«'
+   */
+  laquo: false | string
+
+  /**
+   * The raquo character.
+   * @default '»'
+   */
+  raquo: false | string
+
+  /**
+   * The multiplication character.
+   * @default '×'
+   */
+  multiplication: false | string
+
+  /**
+   * The superscript two character.
+   * @default '²'
+   */
+  superscriptTwo: false | string
+
+  /**
+   * The superscript three character.
+   * @default '³'
+   */
+  superscriptThree: false | string
+
+  /**
+   * The one quarter character.
+   * @default '¼'
+   */
+  oneQuarter: false | string
+
+  /**
+   * The three quarters character.
+   * @default '¾'
+   */
+  threeQuarters: false | string
+
+  /**
+   * Directional double quotes configuration.
+   * Use this for explicit LTR/RTL quote control.
+   * When `rtl` is configured, RTL-specific quote rules are used instead of default LTR.
+   * @example
+   * ```ts
+   * Typography.configure({
+   *   doubleQuotes: {
+   *     rtl: { open: '\u201D', close: '\u201C' } // Swapped for RTL
+   *   }
+   * })
+   * ```
+   */
+  doubleQuotes?: {
+    rtl?: DirectionalQuotes
+  }
+
+  /**
+   * Directional single quotes configuration.
+   * Use this for explicit LTR/RTL quote control.
+   * When `rtl` is configured, RTL-specific quote rules are used instead of default LTR.
+   * @example
+   * ```ts
+   * Typography.configure({
+   *   singleQuotes: {
+   *     rtl: { open: '\u2019', close: '\u2018' } // Swapped for RTL
+   *   }
+   * })
+   * ```
+   */
+  singleQuotes?: {
+    rtl?: DirectionalQuotes
+  }
+}
+
+export const emDash = (override?: string) =>
+  textInputRule({
+    find: /--$/,
+    replace: override ?? '—',
+  })
+
+export const ellipsis = (override?: string) =>
+  textInputRule({
+    find: /\.\.\.$/,
+    replace: override ?? '…',
+  })
+
+export const openDoubleQuote = (override?: string) =>
+  textInputRule({
+    find: /(?:^|[\s{[(<'"\u2018\u201C])(")$/,
+    replace: override ?? '“',
+  })
+
+export const closeDoubleQuote = (override?: string) =>
+  textInputRule({
+    find: /"$/,
+    replace: override ?? '”',
+  })
+
+export const openSingleQuote = (override?: string) =>
+  textInputRule({
+    find: /(?:^|[\s{[(<'"\u2018\u201C])(')$/,
+    replace: override ?? '‘',
+  })
+
+export const closeSingleQuote = (override?: string) =>
+  textInputRule({
+    find: /'$/,
+    replace: override ?? '’',
+  })
+
+export const leftArrow = (override?: string) =>
+  textInputRule({
+    find: /<-$/,
+    replace: override ?? '←',
+  })
+
+export const rightArrow = (override?: string) =>
+  textInputRule({
+    find: /->$/,
+    replace: override ?? '→',
+  })
+
+export const copyright = (override?: string) =>
+  textInputRule({
+    find: /\(c\)$/,
+    replace: override ?? '©',
+  })
+
+export const trademark = (override?: string) =>
+  textInputRule({
+    find: /\(tm\)$/,
+    replace: override ?? '™',
+  })
+
+export const servicemark = (override?: string) =>
+  textInputRule({
+    find: /\(sm\)$/,
+    replace: override ?? '℠',
+  })
+
+export const registeredTrademark = (override?: string) =>
+  textInputRule({
+    find: /\(r\)$/,
+    replace: override ?? '®',
+  })
+
+export const oneHalf = (override?: string) =>
+  textInputRule({
+    find: /(?:^|\s)(1\/2)\s$/,
+    replace: override ?? '½',
+  })
+
+export const plusMinus = (override?: string) =>
+  textInputRule({
+    find: /\+\/-$/,
+    replace: override ?? '±',
+  })
+
+export const notEqual = (override?: string) =>
+  textInputRule({
+    find: /!=$/,
+    replace: override ?? '≠',
+  })
+
+export const laquo = (override?: string) =>
+  textInputRule({
+    find: /<<$/,
+    replace: override ?? '«',
+  })
+
+export const raquo = (override?: string) =>
+  textInputRule({
+    find: />>$/,
+    replace: override ?? '»',
+  })
+
+export const multiplication = (override?: string) =>
+  textInputRule({
+    find: /\d+\s?([*x])\s?\d+$/,
+    replace: override ?? '×',
+  })
+
+export const superscriptTwo = (override?: string) =>
+  textInputRule({
+    find: /\^2$/,
+    replace: override ?? '²',
+  })
+
+export const superscriptThree = (override?: string) =>
+  textInputRule({
+    find: /\^3$/,
+    replace: override ?? '³',
+  })
+
+export const oneQuarter = (override?: string) =>
+  textInputRule({
+    find: /(?:^|\s)(1\/4)\s$/,
+    replace: override ?? '¼',
+  })
+
+export const threeQuarters = (override?: string) =>
+  textInputRule({
+    find: /(?:^|\s)(3\/4)\s$/,
+    replace: override ?? '¾',
+  })
+
+/**
+ * This extension allows you to add typography replacements for specific characters.
+ * @see https://www.tiptap.dev/api/extensions/typography
+ */
+export const Typography = Extension.create<TypographyOptions>({
+  name: 'typography',
+
+  addOptions() {
+    return {
+      closeDoubleQuote: '”',
+      closeSingleQuote: '’',
+      copyright: '©',
+      ellipsis: '…',
+      emDash: '—',
+      laquo: '«',
+      leftArrow: '←',
+      multiplication: '×',
+      notEqual: '≠',
+      oneHalf: '½',
+      oneQuarter: '¼',
+      openDoubleQuote: '“',
+      openSingleQuote: '‘',
+      plusMinus: '±',
+      raquo: '»',
+      registeredTrademark: '®',
+      rightArrow: '→',
+      servicemark: '℠',
+      superscriptThree: '³',
+      superscriptTwo: '²',
+      threeQuarters: '¾',
+      trademark: '™',
+    }
+  },
+
+  addInputRules() {
+    const rules = []
+
+    if (this.options.emDash !== false) {
+      rules.push(emDash(this.options.emDash))
+    }
+
+    if (this.options.ellipsis !== false) {
+      rules.push(ellipsis(this.options.ellipsis))
+    }
+
+    // Determine if RTL mode is active based on explicit config or editor option
+    const isRTL = this.editor.options.textDirection === 'rtl'
+
+    // Double quotes: use explicit RTL config if provided, otherwise use automatic RTL detection
+    if (this.options.doubleQuotes?.rtl) {
+      const { open, close } = this.options.doubleQuotes.rtl
+
+      rules.push(openDoubleQuote(open))
+      rules.push(closeDoubleQuote(close))
+    } else if (isRTL) {
+      // Automatic RTL detection: swap open and close quotes
+      rules.push(openDoubleQuote('\u201D')) // Right double quotation mark
+      rules.push(closeDoubleQuote('\u201C')) // Left double quotation mark
+    } else {
+      if (this.options.openDoubleQuote !== false) {
+        rules.push(openDoubleQuote(this.options.openDoubleQuote))
+      }
+
+      if (this.options.closeDoubleQuote !== false) {
+        rules.push(closeDoubleQuote(this.options.closeDoubleQuote))
+      }
+    }
+
+    // Single quotes: use explicit RTL config if provided, otherwise use automatic RTL detection
+    if (this.options.singleQuotes?.rtl) {
+      const { open, close } = this.options.singleQuotes.rtl
+
+      rules.push(openSingleQuote(open))
+      rules.push(closeSingleQuote(close))
+    } else if (isRTL) {
+      // Automatic RTL detection: swap open and close quotes
+      rules.push(openSingleQuote('\u2019')) // Right single quotation mark
+      rules.push(closeSingleQuote('\u2018')) // Left single quotation mark
+    } else {
+      if (this.options.openSingleQuote !== false) {
+        rules.push(openSingleQuote(this.options.openSingleQuote))
+      }
+
+      if (this.options.closeSingleQuote !== false) {
+        rules.push(closeSingleQuote(this.options.closeSingleQuote))
+      }
+    }
+
+    if (this.options.leftArrow !== false) {
+      rules.push(leftArrow(this.options.leftArrow))
+    }
+
+    if (this.options.rightArrow !== false) {
+      rules.push(rightArrow(this.options.rightArrow))
+    }
+
+    if (this.options.copyright !== false) {
+      rules.push(copyright(this.options.copyright))
+    }
+
+    if (this.options.trademark !== false) {
+      rules.push(trademark(this.options.trademark))
+    }
+
+    if (this.options.servicemark !== false) {
+      rules.push(servicemark(this.options.servicemark))
+    }
+
+    if (this.options.registeredTrademark !== false) {
+      rules.push(registeredTrademark(this.options.registeredTrademark))
+    }
+
+    if (this.options.oneHalf !== false) {
+      rules.push(oneHalf(this.options.oneHalf))
+    }
+
+    if (this.options.plusMinus !== false) {
+      rules.push(plusMinus(this.options.plusMinus))
+    }
+
+    if (this.options.notEqual !== false) {
+      rules.push(notEqual(this.options.notEqual))
+    }
+
+    if (this.options.laquo !== false) {
+      rules.push(laquo(this.options.laquo))
+    }
+
+    if (this.options.raquo !== false) {
+      rules.push(raquo(this.options.raquo))
+    }
+
+    if (this.options.multiplication !== false) {
+      rules.push(multiplication(this.options.multiplication))
+    }
+
+    if (this.options.superscriptTwo !== false) {
+      rules.push(superscriptTwo(this.options.superscriptTwo))
+    }
+
+    if (this.options.superscriptThree !== false) {
+      rules.push(superscriptThree(this.options.superscriptThree))
+    }
+
+    if (this.options.oneQuarter !== false) {
+      rules.push(oneQuarter(this.options.oneQuarter))
+    }
+
+    if (this.options.threeQuarters !== false) {
+      rules.push(threeQuarters(this.options.threeQuarters))
+    }
+
+    return rules
+  },
+})

packages/extension-typography/vite.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vite-plus'
+import { basePackConfig } from '../../pack.config.mjs'
+
+export default defineConfig({
+  pack: {
+    entry: ['src/index.ts'],
+    ...basePackConfig(),
+  },
+})