Skip to content

fix(editor): keep list item classes in getSemanticHTML #4838

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.

Sign up for GitHub

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

Open
dawidskowron wants to merge 1 commit into
base: main
Choose a base branch
from
+127 −2
Open

fix(editor): keep list item classes in getSemanticHTML #4838

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions packages/quill/src/core/editor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,10 +337,17 @@ function convertListHTML(
}
const [{ child, offset, length, indent, type }, ...rest] = items;
const [tag, attribute] = getListType(type);
const classes =
child.domNode instanceof Element
? Array.from(child.domNode.classList)
.filter((className) => !className.startsWith('ql-indent-'))
.join(' ')
: '';
const classAttribute = classes ? ` class="${escapeText(classes)}"` : '';
if (indent > lastIndent) {
types.push(type);
if (indent === lastIndent + 1) {
return `<${tag}><li${attribute}>${convertHTML(
return `<${tag}><li${attribute}${classAttribute}>${convertHTML(
child,
offset,
length,
Expand All @@ -350,7 +357,7 @@ function convertListHTML(
}
const previousType = types[types.length - 1];
if (indent === lastIndent && type === previousType) {
return `</li><li${attribute}>${convertHTML(
return `</li><li${attribute}${classAttribute}>${convertHTML(
child,
offset,
length,
Expand Down
118 changes: 118 additions & 0 deletions packages/quill/test/unit/core/editor.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { FontClass } from '../../../src/formats/font.js';
import Header from '../../../src/formats/header.js';
import Italic from '../../../src/formats/italic.js';
import { AlignClass } from '../../../src/formats/align.js';
import { DirectionClass } from '../../../src/formats/direction.js';
import Video from '../../../src/formats/video.js';
import Strike from '../../../src/formats/strike.js';
import Underline from '../../../src/formats/underline.js';
Expand Down Expand Up @@ -47,6 +48,7 @@ const createEditor = (htmlOrContents: string | Delta) => {
Header,
Italic,
AlignClass,
DirectionClass,
Video,
Strike,
Underline,
Expand Down Expand Up @@ -1242,6 +1244,122 @@ describe('Editor', () => {
expect(editor.getHTML(0, 5)).toEqual('<ul><li>Test</li></ul>');
});

test('aligned bullet list', () => {
const editor = createEditor(
`
<ol>
<li data-list="bullet" class="ql-align-center">One</li>
<li data-list="bullet" class="ql-align-right">Two</li>
<li data-list="bullet">Three</li>
</ol>
`,
);
expect(editor.getHTML(0, 14)).toEqualHTML(`
<ul>
<li class="ql-align-center">One</li>
<li class="ql-align-right">Two</li>
<li>Three</li>
</ul>
`);
});

test('aligned ordered list', () => {
const editor = createEditor(
`
<ol>
<li data-list="ordered" class="ql-align-right">One</li>
<li data-list="ordered" class="ql-align-right">Two</li>
</ol>
`,
);
expect(editor.getHTML(0, 8)).toEqualHTML(`
<ol>
<li class="ql-align-right">One</li>
<li class="ql-align-right">Two</li>
</ol>
`);
});

test('aligned checklist', () => {
const editor = createEditor(
`
<ol>
<li data-list="checked" class="ql-align-center">One</li>
<li data-list="unchecked" class="ql-align-right">Two</li>
</ol>
`,
);
expect(editor.getHTML(0, 8)).toEqualHTML(`
<ul>
<li data-list="checked" class="ql-align-center">One</li>
</ul>
<ul>
<li data-list="unchecked" class="ql-align-right">Two</li>
</ul>
`);
});

test('aligned nested list with skipped indent', () => {
const editor = createEditor(
`
<ol>
<li data-list="bullet">One</li>
<li data-list="bullet" class="ql-indent-2 ql-align-center">Two</li>
</ol>
`,
);
expect(editor.getHTML(0, 8)).toEqualHTML(`
<ul>
<li>One
<ul>
<li>
<ul>
<li class="ql-align-center">Two</li>
</ul>
</li>
</ul>
</li>
</ul>
`);
});

test('indent-only list item', () => {
const editor = createEditor(
`
<ol>
<li data-list="bullet" class="ql-indent-1">One</li>
</ol>
`,
);
expect(editor.getHTML(0, 4)).toEqualHTML(`
<ul>
<li>
<ul>
<li>One</li>
</ul>
</li>
</ul>
`);
});

test('list item direction and custom classes', () => {
const editor = createEditor(
'<ol><li data-list="bullet" class="ql-direction-rtl">One</li></ol>',
);
editor.scroll.domNode.querySelector('li')!.classList.add('custom');
expect(editor.getHTML(0, 4)).toEqualHTML(`
<ul><li class="ql-direction-rtl custom">One</li></ul>
`);
});

test('escape list item class attribute', () => {
const editor = createEditor('<ol><li data-list="bullet">One</li></ol>');
editor.scroll.domNode.querySelector('li')!.classList.add('custom"&<>');
expect(editor.getHTML(0, 4)).toEqual(
'<ul><li class="custom&quot;&amp;&lt;&gt;">One</li></ul>',
);
});

test('across lines', () => {
const editor = createEditor(
'<h1 class="ql-align-center">Header</h1><p>Text</p><blockquote>Quote</blockquote>',
Expand Down