|
| 1 | +/** |
| 2 | + * SPDX-FileCopyrightText: 2023 Amir Hossein Hashemi |
| 3 | + * SPDX-License-Identifier: MIT |
| 4 | + */ |
| 5 | + |
| 6 | +import { Extension } from '@tiptap/core' |
| 7 | +import { Plugin, PluginKey } from '@tiptap/pm/state' |
| 8 | + |
| 9 | +const RTL = '\u0591-\u07FF\uFB1D-\uFDFD\uFE70-\uFEFC' |
| 10 | +const LTR = |
| 11 | + 'A-Za-z\u00C0-\u00D6\u00D8-\u00F6' |
| 12 | + + '\u00F8-\u02B8\u0300-\u0590\u0800-\u1FFF\u200E\u2C00-\uFB1C' |
| 13 | + + '\uFE00-\uFE6F\uFEFD-\uFFFF' |
| 14 | + |
| 15 | +/* eslint-disable no-misleading-character-class */ |
| 16 | +const RTL_REGEX = new RegExp('^[^' + LTR + ']*[' + RTL + ']') |
| 17 | +const LTR_REGEX = new RegExp('^[^' + RTL + ']*[' + LTR + ']') |
| 18 | + |
| 19 | +/** |
| 20 | + * @param text Text string |
| 21 | + * |
| 22 | + *Source: https://github.com/facebook/lexical/blob/429e3eb5b5a244026fa4776650aabe3c8e17536b/packages/lexical/src/LexicalUtils.ts#L163 |
| 23 | + */ |
| 24 | +export function getTextDirection(text: string): 'ltr' | 'rtl' | null { |
| 25 | + if (text.length === 0) { |
| 26 | + return null |
| 27 | + } |
| 28 | + if (RTL_REGEX.test(text)) { |
| 29 | + return 'rtl' |
| 30 | + } |
| 31 | + if (LTR_REGEX.test(text)) { |
| 32 | + return 'ltr' |
| 33 | + } |
| 34 | + return null |
| 35 | +} |
| 36 | + |
| 37 | +const validDirections = ['ltr', 'rtl', 'auto'] as const |
| 38 | + |
| 39 | +type Direction = (typeof validDirections)[number] |
| 40 | + |
| 41 | +/** |
| 42 | + * @param object Property object |
| 43 | + * @param object.types List of node types to consider |
| 44 | + */ |
| 45 | +function TextDirectionPlugin({ types }: { types: string[] }) { |
| 46 | + return new Plugin({ |
| 47 | + key: new PluginKey('textDirection'), |
| 48 | + appendTransaction: (transactions, oldState, newState) => { |
| 49 | + const docChanges = transactions.some( |
| 50 | + (transaction) => transaction.docChanged, |
| 51 | + ) |
| 52 | + if (!docChanges) { |
| 53 | + return |
| 54 | + } |
| 55 | + |
| 56 | + let modified = false |
| 57 | + const tr = newState.tr |
| 58 | + tr.setMeta('addToHistory', false) |
| 59 | + |
| 60 | + newState.doc.descendants((node, pos) => { |
| 61 | + if (types.includes(node.type.name)) { |
| 62 | + if (node.attrs.dir !== null && node.textContent.length > 0) { |
| 63 | + return |
| 64 | + } |
| 65 | + const newTextDirection = getTextDirection(node.textContent) |
| 66 | + if (node.attrs.dir === newTextDirection) { |
| 67 | + return |
| 68 | + } |
| 69 | + |
| 70 | + const marks = tr.storedMarks || [] |
| 71 | + tr.setNodeAttribute(pos, 'dir', newTextDirection) |
| 72 | + // `tr.setNodeAttribute` resets the stored marks so we'll restore them |
| 73 | + for (const mark of marks) { |
| 74 | + tr.addStoredMark(mark) |
| 75 | + } |
| 76 | + modified = true |
| 77 | + } |
| 78 | + }) |
| 79 | + |
| 80 | + return modified ? tr : null |
| 81 | + }, |
| 82 | + }) |
| 83 | +} |
| 84 | + |
| 85 | +declare module '@tiptap/core' { |
| 86 | + interface Commands<ReturnType> { |
| 87 | + textDirection: { |
| 88 | + /** |
| 89 | + * Set the text direction attribute |
| 90 | + */ |
| 91 | + setTextDirection: (direction: Direction) => ReturnType |
| 92 | + /** |
| 93 | + * Unset the text direction attribute |
| 94 | + */ |
| 95 | + unsetTextDirection: () => ReturnType |
| 96 | + } |
| 97 | + } |
| 98 | +} |
| 99 | + |
| 100 | +export interface TextDirectionOptions { |
| 101 | + types: string[] |
| 102 | + defaultDirection: Direction | null |
| 103 | +} |
| 104 | + |
| 105 | +export const TextDirection = Extension.create<TextDirectionOptions>({ |
| 106 | + name: 'textDirection', |
| 107 | + |
| 108 | + addOptions() { |
| 109 | + return { |
| 110 | + types: [], |
| 111 | + defaultDirection: null, |
| 112 | + } |
| 113 | + }, |
| 114 | + |
| 115 | + addGlobalAttributes() { |
| 116 | + return [ |
| 117 | + { |
| 118 | + types: this.options.types, |
| 119 | + attributes: { |
| 120 | + dir: { |
| 121 | + default: null, |
| 122 | + parseHTML: (element) => |
| 123 | + element.dir || this.options.defaultDirection, |
| 124 | + renderHTML: (attributes) => { |
| 125 | + if (attributes.dir === this.options.defaultDirection) { |
| 126 | + return {} |
| 127 | + } |
| 128 | + return { dir: attributes.dir } |
| 129 | + }, |
| 130 | + }, |
| 131 | + }, |
| 132 | + }, |
| 133 | + ] |
| 134 | + }, |
| 135 | + |
| 136 | + addCommands() { |
| 137 | + return { |
| 138 | + setTextDirection: |
| 139 | + (direction: Direction) => |
| 140 | + ({ commands }) => { |
| 141 | + if (!validDirections.includes(direction)) { |
| 142 | + return false |
| 143 | + } |
| 144 | + |
| 145 | + return this.options.types.every((type) => |
| 146 | + commands.updateAttributes(type, { dir: direction }), |
| 147 | + ) |
| 148 | + }, |
| 149 | + |
| 150 | + unsetTextDirection: |
| 151 | + () => |
| 152 | + ({ commands }) => { |
| 153 | + return this.options.types.every((type) => |
| 154 | + commands.resetAttributes(type, 'dir'), |
| 155 | + ) |
| 156 | + }, |
| 157 | + } |
| 158 | + }, |
| 159 | + |
| 160 | + addKeyboardShortcuts() { |
| 161 | + return { |
| 162 | + 'Mod-Alt-l': () => this.editor.commands.setTextDirection('ltr'), |
| 163 | + 'Mod-Alt-r': () => this.editor.commands.setTextDirection('rtl'), |
| 164 | + } |
| 165 | + }, |
| 166 | + |
| 167 | + addProseMirrorPlugins() { |
| 168 | + return [ |
| 169 | + TextDirectionPlugin({ |
| 170 | + types: this.options.types, |
| 171 | + }), |
| 172 | + ] |
| 173 | + }, |
| 174 | +}) |
| 175 | + |
| 176 | +export default TextDirection |
0 commit comments