6153ac82-d434-4f76-a606-92a7ebef5efc

Committed 12 Jan 2026 02:42AM UTC coverage: 36.974% (+0.07%) from 36.904%

Build # 6153ac82-d434-4f76-a606-92a7ebef5efc

Build Type

push

circleci

Committed by

pubuzhixing8

Commit Message

feat(virtual-scroll): support getRoughHeight to help plugin to get rough height by element data

Run Details

401 of 1279 branches covered (31.35%)

Branch coverage included in aggregate %.

2 of 5 new or added lines in 2 files covered. (40.0%)

1 existing line in 1 file now uncovered.

1102 of 2786 relevant lines covered (39.55%)

24.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

32.35

/packages/src/plugins/with-angular.ts

import { Editor, Element, Node, Operation, Path, PathRef, Range, Transforms } from 'slate';
import { ClipboardData, OriginEvent } from '../types/clipboard';
import { SlateError } from '../types/error';
import { completeTable, EDITOR_TO_VIRTUAL_SCROLL_SELECTION, isInvalidTable, VIRTUAL_SCROLL_DEFAULT_BLOCK_HEIGHT } from '../utils';
import { getClipboardData, setClipboardData } from '../utils/clipboard/clipboard';
import { AngularEditor } from './angular-editor';
import { Key, NODE_TO_KEY, withDOM } from 'slate-dom';
import { getPlainText, isDOMText } from '../utils/dom';

export const withAngular = <T extends Editor>(editor: T, clipboardFormatKey = 'x-slate-fragment') => {
    let e = editor as T & AngularEditor;
    let { apply } = e;

    e = withDOM(e, clipboardFormatKey);

    e.setFragmentData = (dataTransfer?: Pick<DataTransfer, 'getData' | 'setData'>, originEvent?: OriginEvent) => {
        const { selection } = e;

        if (!selection) {
            return;
        }

        const [start, end] = Range.edges(selection);
        const startVoid = Editor.void(e, { at: start.path });
        const endVoid = Editor.void(e, { at: end.path });

        if (Range.isCollapsed(selection) && !startVoid) {
            return;
        }

        // Create a fake selection so that we can add a Base64-encoded copy of the
        // fragment to the HTML, to decode on future pastes.
        let domRange: globalThis.Range;
        if (AngularEditor.isEnabledVirtualScroll(e)) {
            const virtualScrollSelection = EDITOR_TO_VIRTUAL_SCROLL_SELECTION.get(e);
            if (virtualScrollSelection) {
                domRange = AngularEditor.toDOMRange(e, virtualScrollSelection);
            }
        }
        domRange = domRange ?? AngularEditor.toDOMRange(e, selection);
        let contents = domRange.cloneContents();
        let attach = contents.childNodes[0] as HTMLElement;

        // Make sure attach is non-empty, since empty nodes will not get copied.
        const contentsArray = Array.from(contents.children);
        contentsArray.forEach(node => {
            if (node.textContent && node.textContent.trim() !== '') {
                attach = node as HTMLElement;
            }
        });

        // COMPAT: If the end node is a void node, we need to move the end of the
        // range from the void node's spacer span, to the end of the void node's
        // content, since the spacer is before void's content in the DOM.
        if (endVoid) {
            const [voidNode] = endVoid;
            const r = domRange.cloneRange();
            const domNode = AngularEditor.toDOMNode(e, voidNode);
            r.setEndAfter(domNode);
            contents = r.cloneContents();
        }

        // COMPAT: If the start node is a void node, we need to attach the encoded
        // fragment to the void node's content node instead of the spacer, because
        // attaching it to empty `<div>/<span>` nodes will end up having it erased by
        // most browsers. (2018/04/27)
        if (startVoid) {
            attach = contents.querySelector('[data-slate-spacer]')! as HTMLElement;
        }

        // Remove any zero-width space spans from the cloned DOM so that they don't
        // show up elsewhere when pasted.
        Array.from(contents.querySelectorAll('[data-slate-zero-width]')).forEach(zw => {
            const isNewline = zw.getAttribute('data-slate-zero-width') === 'n';
            zw.textContent = isNewline ? '\n' : '';
        });

        // Set a `data-slate-fragment` attribute on a non-empty node, so it shows up
        // in the HTML, and can be used for intra-Slate pasting. If it's a text
        // node, wrap it in a `<span>` so we have something to set an attribute on.
        if (isDOMText(attach)) {
            const span = attach.ownerDocument.createElement('span');
            // COMPAT: In Chrome and Safari, if we don't add the `white-space` style
            // then leading and trailing spaces will be ignored. (2017/09/21)
            span.style.whiteSpace = 'pre';
            span.appendChild(attach);
            contents.appendChild(span);
            attach = span;
        }

        const fragment = e.getFragment();

        // Add the content to a <div> so that we can get its inner HTML.
        const div = contents.ownerDocument.createElement('div');
        const attachWrapper = document.createElement('div');
        const elements = Array.from(contents.children);
        if (isInvalidTable(elements)) {
            contents = completeTable(contents.cloneNode(true) as DocumentFragment);
        }

        attachWrapper.appendChild(contents);
        div.appendChild(attachWrapper);
        div.setAttribute('hidden', 'true');
        contents.ownerDocument.body.appendChild(div);
        setClipboardData({ text: getPlainText(div), elements: fragment as Element[] }, div, attachWrapper, dataTransfer);
        contents.ownerDocument.body.removeChild(div);
    };

    e.deleteCutData = () => {
        const { selection } = editor;
        if (selection) {
            if (Range.isExpanded(selection)) {
                Editor.deleteFragment(editor);
            } else {
                const node = Node.parent(editor, selection.anchor.path);
                if (Element.isElement(node) && Editor.isVoid(editor, node)) {
                    Transforms.delete(editor);
                }
            }
        }
    };

    e.insertData = async (data: DataTransfer) => {
        if (!(await e.customInsertFragmentData(data, null))) {
            e.insertTextData(data);
        }
    };

    e.customInsertFragmentData = async (data: DataTransfer, contextClipboardData: ClipboardData): Promise<boolean> => {
        /**
         * Checking copied fragment from application/x-slate-fragment or data-slate-fragment
         */
        const clipboardData = contextClipboardData || (await getClipboardData(data));
        if (clipboardData && clipboardData.elements) {
            e.insertFragment(clipboardData.elements);
            return true;
        }
        return false;
    };

    e.customInsertTextData = async (data: DataTransfer): Promise<boolean> => {
        const clipboardData = await getClipboardData(data);

        if (clipboardData && clipboardData.text) {
            const lines = clipboardData.text.split(/\r\n|\r|\n/);
            let split = false;

            for (const line of lines) {
                if (split) {
                    Transforms.splitNodes(e, { always: true });
                }

                e.insertText(line);
                split = true;
            }
            return true;
        }
        return false;
    };

    e.onKeydown = () => {};

    e.onClick = () => {};

    e.isBlockCard = element => false;

    e.isExpanded = element => true;

    e.onError = (errorData: SlateError) => {
        if (errorData.nativeError) {
            console.error(errorData.nativeError);
        } else {
            console.error(errorData);
        }
    };

    // exist issue for move operation in withDOM
    e.apply = (op: Operation) => {
        const matches: [Path | PathRef, Key][] = [];

        switch (op.type) {
            case 'insert_text':
            case 'remove_text':
            case 'set_node': {
                for (const [node, path] of Editor.levels(e, { at: op.path })) {
                    const key = AngularEditor.findKey(e, node);
                    matches.push([path, key]);
                }

                break;
            }

            case 'insert_node':
            case 'remove_node':
            case 'merge_node':
            case 'split_node': {
                for (const [node, path] of Editor.levels(e, {
                    at: Path.parent(op.path)
                })) {
                    const key = AngularEditor.findKey(e, node);
                    matches.push([path, key]);
                }

                break;
            }

            case 'move_node': {
                const commonPath = Path.common(Path.parent(op.path), Path.parent(op.newPath));
                for (const [node, path] of Editor.levels(e, {
                    at: Path.parent(op.path)
                })) {
                    const key = AngularEditor.findKey(e, node);
                    matches.push([Editor.pathRef(editor, path), key]);
                }
                for (const [node, path] of Editor.levels(e, {
                    at: Path.parent(op.newPath)
                })) {
                    if (path.length > commonPath.length) {
                        const key = AngularEditor.findKey(e, node);
                        matches.push([Editor.pathRef(editor, path), key]);
                    }
                }
                break;
            }
        }

        apply(op);

        for (const [source, key] of matches) {
            const [node] = Editor.node(e, Path.isPath(source) ? source : source.current);
            NODE_TO_KEY.set(node, key);
        }
    };

    e.selectAll = () => {
        Transforms.select(e, []);
    };

    e.isVisible = element => {
        return true;
    };

    e.getRoughHeight = (element: Element, defaultHeight?: number) => {
        return defaultHeight === undefined ? VIRTUAL_SCROLL_DEFAULT_BLOCK_HEIGHT : defaultHeight;
    };

    return e;
};

1	import { Editor, Element, Node, Operation, Path, PathRef, Range, Transforms } from 'slate';
2	import { ClipboardData, OriginEvent } from '../types/clipboard';
3	import { SlateError } from '../types/error';
4	import { completeTable, EDITOR_TO_VIRTUAL_SCROLL_SELECTION, isInvalidTable, VIRTUAL_SCROLL_DEFAULT_BLOCK_HEIGHT } from '../utils';
5	import { getClipboardData, setClipboardData } from '../utils/clipboard/clipboard';
6	import { AngularEditor } from './angular-editor';
7	import { Key, NODE_TO_KEY, withDOM } from 'slate-dom';
8	import { getPlainText, isDOMText } from '../utils/dom';
9
10	export const withAngular = <T extends Editor>(editor: T, clipboardFormatKey = 'x-slate-fragment') => {	1✔
11	let e = editor as T & AngularEditor;	28✔
12	let { apply } = e;	28✔
13
14	e = withDOM(e, clipboardFormatKey);	28✔
15
16	e.setFragmentData = (dataTransfer?: Pick<DataTransfer, 'getData' \| 'setData'>, originEvent?: OriginEvent) => {	28✔
17	const { selection } = e;	×
18
19	if (!selection) {	×
20	return;	×
21	}
22
23	const [start, end] = Range.edges(selection);	×
24	const startVoid = Editor.void(e, { at: start.path });	×
25	const endVoid = Editor.void(e, { at: end.path });	×
26
27	if (Range.isCollapsed(selection) && !startVoid) {	×
28	return;	×
29	}
30
31	// Create a fake selection so that we can add a Base64-encoded copy of the
32	// fragment to the HTML, to decode on future pastes.
33	let domRange: globalThis.Range;
34	if (AngularEditor.isEnabledVirtualScroll(e)) {	×
35	const virtualScrollSelection = EDITOR_TO_VIRTUAL_SCROLL_SELECTION.get(e);	×
36	if (virtualScrollSelection) {	×
37	domRange = AngularEditor.toDOMRange(e, virtualScrollSelection);	×
38	}
39	}
40	domRange = domRange ?? AngularEditor.toDOMRange(e, selection);	×
41	let contents = domRange.cloneContents();	×
42	let attach = contents.childNodes[0] as HTMLElement;	×
43
44	// Make sure attach is non-empty, since empty nodes will not get copied.
45	const contentsArray = Array.from(contents.children);	×
46	contentsArray.forEach(node => {	×
47	if (node.textContent && node.textContent.trim() !== '') {	×
48	attach = node as HTMLElement;	×
49	}
50	});
51
52	// COMPAT: If the end node is a void node, we need to move the end of the
53	// range from the void node's spacer span, to the end of the void node's
54	// content, since the spacer is before void's content in the DOM.
55	if (endVoid) {	×
56	const [voidNode] = endVoid;	×
57	const r = domRange.cloneRange();	×
58	const domNode = AngularEditor.toDOMNode(e, voidNode);	×
59	r.setEndAfter(domNode);	×
60	contents = r.cloneContents();	×
61	}
62
63	// COMPAT: If the start node is a void node, we need to attach the encoded
64	// fragment to the void node's content node instead of the spacer, because
65	// attaching it to empty `<div>/<span>` nodes will end up having it erased by
66	// most browsers. (2018/04/27)
67	if (startVoid) {	×
68	attach = contents.querySelector('[data-slate-spacer]')! as HTMLElement;	×
69	}
70
71	// Remove any zero-width space spans from the cloned DOM so that they don't
72	// show up elsewhere when pasted.
73	Array.from(contents.querySelectorAll('[data-slate-zero-width]')).forEach(zw => {	×
74	const isNewline = zw.getAttribute('data-slate-zero-width') === 'n';	×
75	zw.textContent = isNewline ? '\n' : '';	×
76	});
77
78	// Set a `data-slate-fragment` attribute on a non-empty node, so it shows up
79	// in the HTML, and can be used for intra-Slate pasting. If it's a text
80	// node, wrap it in a `<span>` so we have something to set an attribute on.
81	if (isDOMText(attach)) {	×
82	const span = attach.ownerDocument.createElement('span');	×
83	// COMPAT: In Chrome and Safari, if we don't add the `white-space` style
84	// then leading and trailing spaces will be ignored. (2017/09/21)
85	span.style.whiteSpace = 'pre';	×
86	span.appendChild(attach);	×
87	contents.appendChild(span);	×
88	attach = span;	×
89	}
90
91	const fragment = e.getFragment();	×
92
93	// Add the content to a <div> so that we can get its inner HTML.
94	const div = contents.ownerDocument.createElement('div');	×
95	const attachWrapper = document.createElement('div');	×
96	const elements = Array.from(contents.children);	×
97	if (isInvalidTable(elements)) {	×
98	contents = completeTable(contents.cloneNode(true) as DocumentFragment);	×
99	}
100
101	attachWrapper.appendChild(contents);	×
102	div.appendChild(attachWrapper);	×
103	div.setAttribute('hidden', 'true');	×
104	contents.ownerDocument.body.appendChild(div);	×
105	setClipboardData({ text: getPlainText(div), elements: fragment as Element[] }, div, attachWrapper, dataTransfer);	×
106	contents.ownerDocument.body.removeChild(div);	×
107	};
108
109	e.deleteCutData = () => {	28✔
110	const { selection } = editor;	×
111	if (selection) {	×
112	if (Range.isExpanded(selection)) {	×
113	Editor.deleteFragment(editor);	×
114	} else {
115	const node = Node.parent(editor, selection.anchor.path);	×
116	if (Element.isElement(node) && Editor.isVoid(editor, node)) {	×
117	Transforms.delete(editor);	×
118	}
119	}
120	}
121	};
122
123	e.insertData = async (data: DataTransfer) => {	28✔
124	if (!(await e.customInsertFragmentData(data, null))) {	×
125	e.insertTextData(data);	×
126	}
127	};
128
129	e.customInsertFragmentData = async (data: DataTransfer, contextClipboardData: ClipboardData): Promise<boolean> => {	28✔
130	/**
131	* Checking copied fragment from application/x-slate-fragment or data-slate-fragment
132	*/
133	const clipboardData = contextClipboardData \|\| (await getClipboardData(data));	×
134	if (clipboardData && clipboardData.elements) {	×
135	e.insertFragment(clipboardData.elements);	×
136	return true;	×
137	}
138	return false;	×
139	};
140
141	e.customInsertTextData = async (data: DataTransfer): Promise<boolean> => {	28✔
142	const clipboardData = await getClipboardData(data);	×
143
144	if (clipboardData && clipboardData.text) {	×
145	const lines = clipboardData.text.split(/\r\n\|\r\|\n/);	×
146	let split = false;	×
147
148	for (const line of lines) {	×
149	if (split) {	×
150	Transforms.splitNodes(e, { always: true });	×
151	}
152
153	e.insertText(line);	×
154	split = true;	×
155	}
156	return true;	×
157	}
158	return false;	×
159	};
160
161	e.onKeydown = () => {};	28✔
162
163	e.onClick = () => {};	28✔
164
165	e.isBlockCard = element => false;	364✔
166
167	e.isExpanded = element => true;	215✔
168
169	e.onError = (errorData: SlateError) => {	28✔
170	if (errorData.nativeError) {	×
171	console.error(errorData.nativeError);	×
172	} else {
173	console.error(errorData);	×
174	}
175	};
176
177	// exist issue for move operation in withDOM
178	e.apply = (op: Operation) => {	28✔
179	const matches: [Path \| PathRef, Key][] = [];	24✔
180
181	switch (op.type) {	24✔
182	case 'insert_text':
183	case 'remove_text':
184	case 'set_node': {
185	for (const [node, path] of Editor.levels(e, { at: op.path })) {	3✔
186	const key = AngularEditor.findKey(e, node);	9✔
187	matches.push([path, key]);	9✔
188	}
189
190	break;	3✔
191	}
192
193	case 'insert_node':
194	case 'remove_node':
195	case 'merge_node':
196	case 'split_node': {
197	for (const [node, path] of Editor.levels(e, {	5✔
198	at: Path.parent(op.path)
199	})) {
200	const key = AngularEditor.findKey(e, node);	7✔
201	matches.push([path, key]);	7✔
202	}
203
204	break;	5✔
205	}
206
207	case 'move_node': {
208	const commonPath = Path.common(Path.parent(op.path), Path.parent(op.newPath));	8✔
209	for (const [node, path] of Editor.levels(e, {	8✔
210	at: Path.parent(op.path)
211	})) {
212	const key = AngularEditor.findKey(e, node);	14✔
213	matches.push([Editor.pathRef(editor, path), key]);	14✔
214	}
215	for (const [node, path] of Editor.levels(e, {	8✔
216	at: Path.parent(op.newPath)
217	})) {
218	if (path.length > commonPath.length) {	16✔
219	const key = AngularEditor.findKey(e, node);	5✔
220	matches.push([Editor.pathRef(editor, path), key]);	5✔
221	}
222	}
223	break;	8✔
224	}
225	}
226
227	apply(op);	24✔
228
229	for (const [source, key] of matches) {	24✔
230	const [node] = Editor.node(e, Path.isPath(source) ? source : source.current);	35✔
231	NODE_TO_KEY.set(node, key);	35✔
232	}
233	};
234
235	e.selectAll = () => {	28✔
236	Transforms.select(e, []);	×
237	};
238
239	e.isVisible = element => {	28✔
240	return true;	12✔
241	};
242
243	e.getRoughHeight = (element: Element, defaultHeight?: number) => {	28✔
NEW 244	return defaultHeight === undefined ? VIRTUAL_SCROLL_DEFAULT_BLOCK_HEIGHT : defaultHeight;	×
245	};
246
247	return e;	28✔
248	};

worktile / slate-angular / 6153ac82-d434-4f76-a606-92a7ebef5efc

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous