Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: text direction plugin #2888

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file.
36 changes: 36 additions & 0 deletions packages/extension-text-direction/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"name": "@tiptap/extension-text-direction",
"description": "text direction extension for tiptap",
"version": "2.0.0-beta.29",
"homepage": "https://tiptap.dev",
"keywords": [
"tiptap",
"tiptap extension"
],
"license": "MIT",
"funding": {
"type": "github",
"url": "https://github.com/sponsors/ueberdosis"
},
"main": "dist/tiptap-extension-text-direction.cjs.js",
"umd": "dist/tiptap-extension-text-direction.umd.js",
"module": "dist/tiptap-extension-text-direction.esm.js",
"types": "dist/packages/extension-text-direction/src/index.d.ts",
"files": [
"src",
"dist"
],
"peerDependencies": {
"@tiptap/core": "^2.0.0-beta.1"
},
"dependencies": {
"prosemirror-model": "^1.16.1",
"prosemirror-state": "^1.3.4",
"prosemirror-view": "^1.23.6"
},
"repository": {
"type": "git",
"url": "https://github.com/ueberdosis/tiptap",
"directory": "packages/extension-text-direction"
}
}
5 changes: 5 additions & 0 deletions packages/extension-text-direction/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { TextDirection } from "./text-direction";

export * from "./text-direction";

export default TextDirection;
75 changes: 75 additions & 0 deletions packages/extension-text-direction/src/text-direction-plugin.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import { findChildren } from "@tiptap/core";
import { Plugin, Transaction, EditorState, PluginKey } from "prosemirror-state";
import { Node as ProsemirrorNode } from "prosemirror-model";
import { Decoration, DecorationSet } from "prosemirror-view";

const RTL = "\u0591-\u07FF\uFB1D-\uFDFD\uFE70-\uFEFC";
const LTR =
"A-Za-z\u00C0-\u00D6\u00D8-\u00F6" +
"\u00F8-\u02B8\u0300-\u0590\u0800-\u1FFF\u200E\u2C00-\uFB1C" +
"\uFE00-\uFE6F\uFEFD-\uFFFF";

export const RTL_REGEX = new RegExp("^[^" + LTR + "]*[" + RTL + "]");
export const LTR_REGEX = new RegExp("^[^" + RTL + "]*[" + LTR + "]");

export function getTextDirection(text: string): "ltr" | "rtl" | null {
if (RTL_REGEX.test(text)) {
return "rtl";
}
if (LTR_REGEX.test(text)) {
return "ltr";
}
return null;
}

function getDecorations({ doc, types }: { doc: ProsemirrorNode; types: string[] }) {
const decorations: Decoration[] = [];

findChildren(doc, (node) => types.includes(node.type.name)).forEach((block) => {
const from = block.pos;
const to = from + block.node.nodeSize;
const direction = getTextDirection(block.node.textContent);

const decoration = Decoration.node(from, to, {
dir: direction,
});

decorations.push(decoration);
});

return DecorationSet.create(doc, decorations);
}

export function DirectionPlugin({ types }: { types: string[] }) {
return new Plugin({
key: new PluginKey("textDirection"),
state: {
init(_, { doc }) {
return getDecorations({
doc,
types,
});
},
apply(
transaction: Transaction,
decorationSet: any,
oldState: EditorState,
newState: EditorState
) {
if (transaction.docChanged) {
return getDecorations({
doc: transaction.doc,
types,
});
}

return decorationSet.map(transaction.mapping, transaction.doc);
},
},
props: {
decorations(state) {
return this.getState(state);
},
},
});
}
24 changes: 24 additions & 0 deletions packages/extension-text-direction/src/text-direction.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { Extension } from "@tiptap/core";
import { DirectionPlugin } from "./text-direction-plugin";

export interface TextDirectionOptions {
types: string[];
directions: string[];
defaultDirection: "rtl" | "ltr" | null;
}

export const TextDirection = Extension.create<TextDirectionOptions>({
name: "textDirection",

addOptions() {
return {
types: [],
directions: ["ltr", "rtl"],
defaultDirection: null,
};
},

addProseMirrorPlugins() {
return [DirectionPlugin({ types: this.options.types })];
},
});