Skip to content

⭐️⭐️⭐️ Open-source, self-hosted alternative to Linear and Plane. Project management and issue tracking where teams and AI agents work side by side to plan and ship products.

fix(web): open description links on touch taps (#391)

Ahmad Othman Ammar Adi0110de89e6fc
diff --git a/apps/web/src/components/common/editor/MarkdownEditor.test.ts b/apps/web/src/components/common/editor/MarkdownEditor.test.ts
index 0e20cca8..13e87d7a 100644
--- a/apps/web/src/components/common/editor/MarkdownEditor.test.ts
+++ b/apps/web/src/components/common/editor/MarkdownEditor.test.ts
@@ -25,7 +25,7 @@ beforeEach(() => {
'HTMLAnchorElement',
].map((name) => [name, Object.getOwnPropertyDescriptor(globalThis, name)]),
);
- dom = new JSDOM('<!doctype html><div></div>');
+ dom = new JSDOM('<!doctype html><div></div>', { url: 'https://planner.test' });
Object.defineProperties(globalThis, {
window: { configurable: true, value: dom.window },
document: { configurable: true, value: dom.window.document },
@@ -152,6 +152,166 @@ describe('MarkdownEditor extensions', () => {
});
});
+describe('MarkdownEditor touch links', () => {
+ function setup({ editable = true, openOnTouch = true } = {}) {
+ const opened: unknown[] = [];
+ dom.window.open = (...args: Parameters<typeof window.open>) => {
+ opened.push(args);
+ return null;
+ };
+ const editor = new Editor({
+ element: dom.window.document.querySelector('div')!,
+ editable,
+ extensions: [
+ StarterKit.configure(editorStarterKitOptions),
+ Link.configure({ openOnClick: false, HTMLAttributes: { tabindex: '0' } }),
+ ],
+ content: '<p><a href="https://example.com/docs"><strong>Docs</strong></a> text</p>',
+ editorProps: {
+ handleClick: (view, _pos, event) => openLinkOnModifierClick(event, view.dom),
+ handleDOMEvents: createLinkKeyboardHandlers(openOnTouch),
+ handleScrollToSelection: () => true,
+ },
+ });
+ const link = editor.view.dom.querySelector('a')!;
+ let time = 0;
+ function dispatch(target: Element, event: MouseEvent) {
+ Object.defineProperty(event, 'timeStamp', { value: (time += 20) });
+ target.dispatchEvent(event);
+ return event;
+ }
+ function pointer(target: Element, type: string, options: PointerEventInit = {}) {
+ return dispatch(
+ target,
+ new dom.window.PointerEvent(type, {
+ bubbles: true,
+ cancelable: true,
+ pointerType: 'touch',
+ pointerId: 1,
+ isPrimary: true,
+ clientX: 10,
+ clientY: 10,
+ ...options,
+ }),
+ );
+ }
+ function click(target = link, options: MouseEventInit = {}) {
+ return dispatch(
+ target,
+ new dom.window.MouseEvent('click', { bubbles: true, cancelable: true, ...options }),
+ );
+ }
+ return { editor, opened, link, pointer, click, advance: (ms: number) => (time += ms) };
+ }
+
+ it('opens a completed touch click once without consuming pointer events or changing content', () => {
+ const { editor, opened, link, pointer } = setup();
+ const target = link.querySelector('strong')!;
+ const before = editor.getHTML();
+ assert.equal(pointer(target, 'pointerdown').defaultPrevented, false);
+ assert.equal(pointer(target, 'pointerup').defaultPrevented, false);
+ assert.equal(opened.length, 0);
+ assert.equal(pointer(target, 'click').defaultPrevented, true);
+ pointer(target, 'click');
+ assert.equal(editor.getHTML(), before);
+ assert.deepEqual(opened, [['https://example.com/docs', '_blank', 'noopener,noreferrer']]);
+ editor.destroy();
+ });
+
+ it('uses the preceding touch sequence when the browser emits a MouseEvent click', () => {
+ const { editor, opened, link, pointer, click } = setup();
+ for (const href of ['/project/EX', 'mailto:[email protected]', 'tel:+4912345']) {
+ link.href = href;
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(click().defaultPrevented, true);
+ }
+ assert.deepEqual(opened, [
+ ['https://planner.test/project/EX', '_blank', 'noopener,noreferrer'],
+ ['mailto:[email protected]', '_blank', 'noopener,noreferrer'],
+ ['tel:+4912345', '_blank', 'noopener,noreferrer'],
+ ]);
+ editor.destroy();
+ });
+
+ for (const gesture of ['move', 'release-away', 'cancel', 'hold', 'context-menu', 'multi-touch']) {
+ it(`does not open after ${gesture}`, () => {
+ const { editor, opened, link, pointer, click, advance } = setup();
+ pointer(link, 'pointerdown');
+ if (gesture === 'move') pointer(link, 'pointermove', { clientY: 30 });
+ if (gesture === 'cancel') pointer(link, 'pointercancel');
+ if (gesture === 'hold') advance(600);
+ if (gesture === 'context-menu') pointer(link, 'contextmenu');
+ if (gesture === 'multi-touch')
+ pointer(link, 'pointerdown', { pointerId: 2, isPrimary: false });
+ pointer(link, 'pointerup', gesture === 'release-away' ? { clientY: 30 } : {});
+ assert.equal(click().defaultPrevented, false);
+ assert.deepEqual(opened, []);
+ editor.destroy();
+ });
+ }
+
+ it('leaves text selection and an incomplete touch sequence alone', () => {
+ const { editor, opened, link, pointer, click } = setup();
+ pointer(link, 'pointerdown');
+ assert.equal(click().defaultPrevented, false);
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ const range = dom.window.document.createRange();
+ range.selectNodeContents(link);
+ dom.window.getSelection()!.addRange(range);
+ assert.equal(click().defaultPrevented, false);
+ assert.deepEqual(opened, []);
+ editor.destroy();
+ });
+
+ it('does not open a different link or consume touch state for a mouse click', () => {
+ const { editor, opened, link, pointer, click } = setup();
+ const second = dom.window.document.createElement('a');
+ second.href = 'https://example.com/other';
+ editor.view.dom.append(second);
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(click(second).defaultPrevented, false);
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(pointer(link, 'click', { pointerType: 'mouse' }).defaultPrevented, false);
+ pointer(link, 'pointerdown', { pointerType: 'mouse' });
+ pointer(link, 'pointerup', { pointerType: 'mouse' });
+ assert.equal(click().defaultPrevented, false);
+ assert.deepEqual(opened, []);
+ editor.destroy();
+ });
+
+ it('does not duplicate modifier opening or bypass the protocol guard', () => {
+ const { editor, opened, link, pointer, click } = setup();
+ for (const modifier of [{ ctrlKey: true }, { metaKey: true }]) {
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(click(link, modifier).defaultPrevented, false);
+ }
+ for (const href of ['javascript:alert(1)', 'data:text/html,unsafe']) {
+ link.href = href;
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(click().defaultPrevented, false);
+ }
+ assert.deepEqual(opened, []);
+ editor.destroy();
+ });
+
+ it('leaves read-only links and editors without touch handling to their existing behavior', () => {
+ for (const options of [{ editable: false }, { openOnTouch: false }]) {
+ const { editor, opened, link, pointer, click } = setup(options);
+ pointer(link, 'pointerdown');
+ pointer(link, 'pointerup');
+ assert.equal(click().defaultPrevented, false);
+ assert.deepEqual(opened, []);
+ editor.destroy();
+ }
+ });
+});
+
describe('MarkdownEditor markdown round trip', () => {
// The editor reports a blur only when the document changed, because reading the
// markdown back does not return the stored text. This pins the reason: drop it and
diff --git a/apps/web/src/components/common/editor/MarkdownEditor.tsx b/apps/web/src/components/common/editor/MarkdownEditor.tsx
index 450adcd3..4e855015 100644
--- a/apps/web/src/components/common/editor/MarkdownEditor.tsx
+++ b/apps/web/src/components/common/editor/MarkdownEditor.tsx
@@ -67,7 +67,7 @@ export default function MarkdownEditor({
}) {
const t = useTranslations('common.editor');
const editorRef = useRef<Editor | null>(null);
- const linkKeyboardHandlers = useMemo(createLinkKeyboardHandlers, []);
+ const linkKeyboardHandlers = useMemo(() => createLinkKeyboardHandlers(true), []);
// Held in a ref because the extensions are built once: the "@" menu reads the
// roster through it, so a list that arrives later is still offered.
const mentionCandidates = useMentionCandidates();
diff --git a/apps/web/src/components/common/editor/linkKeyboardHandlers.ts b/apps/web/src/components/common/editor/linkKeyboardHandlers.ts
index 1441869f..8da9ee87 100644
--- a/apps/web/src/components/common/editor/linkKeyboardHandlers.ts
+++ b/apps/web/src/components/common/editor/linkKeyboardHandlers.ts
@@ -1,11 +1,37 @@
import type { EditorProps } from '@tiptap/pm/view';
-import { openLinkOnAuxClick, openLinkOnEnter } from './modifierClickLink';
+import { openLink, openLinkOnAuxClick, openLinkOnEnter } from './modifierClickLink';
-export function createLinkKeyboardHandlers(): EditorProps['handleDOMEvents'] {
+export function createLinkKeyboardHandlers(openOnTouch = false): EditorProps['handleDOMEvents'] {
let focusedLink: HTMLAnchorElement | null = null;
let pointerFocus = false;
+ let touchTap: {
+ link: HTMLAnchorElement;
+ pointerId: number;
+ x: number;
+ y: number;
+ startedAt: number;
+ released: boolean;
+ } | null = null;
return {
+ click(view, event) {
+ const tap = touchTap;
+ touchTap = null;
+ if (
+ !view.editable ||
+ !tap?.released ||
+ event.button !== 0 ||
+ event.metaKey ||
+ event.ctrlKey ||
+ ('pointerType' in event && event.pointerType !== 'touch') ||
+ event.timeStamp - tap.startedAt > 500 ||
+ !(event.target instanceof Node) ||
+ !tap.link.contains(event.target) ||
+ window.getSelection()?.isCollapsed === false
+ )
+ return false;
+ return openLink(event, view.dom);
+ },
auxclick(view, event) {
return openLinkOnAuxClick(event, view.dom);
},
@@ -22,17 +48,50 @@ export function createLinkKeyboardHandlers(): EditorProps['handleDOMEvents'] {
}
return false;
},
- pointerdown() {
+ pointerdown(view, event) {
focusedLink = null;
pointerFocus = true;
+ touchTap = null;
+ if (!openOnTouch || event.pointerType !== 'touch' || !event.isPrimary) return false;
+ const link =
+ event.target instanceof Element ? event.target.closest<HTMLAnchorElement>('a[href]') : null;
+ if (link && view.dom.contains(link)) {
+ touchTap = {
+ link,
+ pointerId: event.pointerId,
+ x: event.clientX,
+ y: event.clientY,
+ startedAt: event.timeStamp,
+ released: false,
+ };
+ }
+ return false;
+ },
+ pointermove(_view, event) {
+ if (
+ touchTap &&
+ event.pointerId === touchTap.pointerId &&
+ Math.hypot(event.clientX - touchTap.x, event.clientY - touchTap.y) > 10
+ )
+ touchTap = null;
return false;
},
- pointerup() {
+ pointerup(_view, event) {
pointerFocus = false;
+ if (touchTap && event.pointerId === touchTap.pointerId) {
+ if (Math.hypot(event.clientX - touchTap.x, event.clientY - touchTap.y) > 10)
+ touchTap = null;
+ else touchTap.released = true;
+ }
return false;
},
pointercancel() {
pointerFocus = false;
+ touchTap = null;
+ return false;
+ },
+ contextmenu() {
+ touchTap = null;
return false;
},
keydown(view, event) {
@@ -40,6 +99,7 @@ export function createLinkKeyboardHandlers(): EditorProps['handleDOMEvents'] {
const link = focusedLink;
focusedLink = null;
pointerFocus = false;
+ touchTap = null;
return openLinkOnEnter(event, view.dom, link);
},
};
diff --git a/apps/web/src/components/common/editor/modifierClickLink.ts b/apps/web/src/components/common/editor/modifierClickLink.ts
index 35f4ff1f..a300efb1 100644
--- a/apps/web/src/components/common/editor/modifierClickLink.ts
+++ b/apps/web/src/components/common/editor/modifierClickLink.ts
@@ -21,7 +21,7 @@ export function openLinkOnEnter(
return openLink(event, root);
}
-function openLink(
+export function openLink(
event: MouseEvent | KeyboardEvent,
root: HTMLElement,
target = event.target as Element | null,