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

List nesting/indent HTML is not semantic #979

Open
JoshuaDoshua opened this issue Sep 16, 2016 · 68 comments
Open

List nesting/indent HTML is not semantic #979

JoshuaDoshua opened this issue Sep 16, 2016 · 68 comments

Comments

@JoshuaDoshua
Copy link

Indent behavior could be improved.

Indenting a list item should wrap the current list item in a new <ul><li> or <ol><li> and nest it in the closest <li> tag (or do nothing if you are at the highest level or there is only one item in the list)

The current indent button simply adds a class to the <li>, which looks great but outputs bad HTML. The generated content would not be exportable to other platforms.

v1.0.3

This seems a bit more complicated than a simple fix. If I have time I'll try to get a PR in, but wanted to get the topic open for discussion

@rafbm
Copy link

rafbm commented Sep 22, 2016

I would also really like to have @jhchen’s thoughts on this. The Cloning Medium with Parchment guide states the following:

[…] While Inline blots can be nested, Block blots cannot. Instead of wrapping, Block blots replace one another when applied to the same text range.

I assume due the lack of support for Block blots nesting, nested lists (as well as nested blockquotes) cannot currently be implemented even with custom Parchment blots, is that correct?

@gregdetre
Copy link

gregdetre commented Sep 22, 2016

Here's what puzzles me - List actually inherits from Container, rather than from Block - I assume that's how Lists can contain ListItems.

I have tried and tried to create a CustomList that includes CustomList in its allowedChildren, but I haven't been able to get it to work :( In other words, I want this:

<ul class="nugget" nuggetid="1">
  <li>An item in the outer list</li>
  <ul class="nugget" nuggetid="2">
    <li>An item in the inner list</li>
  </ul>
</ul>

But no matter how hard I try, Quill ends up modifying that to:

<ul class="nugget" nuggetid="1">
  <li>An item in the outer list</li>
</ul>
<ul class="nugget" nuggetid="1">
  <li>An item in the inner list</li>
</ul>

[Note that it also mangles the second nuggetid, replacing "2" with "1".]

For reference, this is the javascript behind that:

'use strict';

import Quill from 'quill';

let Parchment = Quill.import ('parchment');
let List = Parchment.query('list');

let NuggetidAttributor = new Parchment.Attributor.Attribute('nuggetid', 'nuggetid', { 
});

class NuggetList extends List {
  format(name, value) {
    this.domNode.setAttribute('nuggetid', value);
  }
}
NuggetList.tagName = 'UL';
NuggetList.className = 'nugget';
NuggetList.allowedChildren.push(NuggetList);

Quill.register(NuggetidAttributor);
Quill.register(NuggetList, true);

If anybody has got this to work, I would love to hear from them.

@jhchen
Copy link
Member

jhchen commented Sep 22, 2016

@rafbm Yes the Blocks are a challenge but using Containers might be a solution but I have not thought about this rigourously.

@JoshuaDoshua By export do you mean paste into other applications?

@JoshuaDoshua
Copy link
Author

@jhchen Yessir. Essentially just using the innerHTML to save the editor content in a way that it can be used elsewhere independent of the indented class.

Containers does seem promising. But this is definitely a complicated topic. Indenting needs to be aware of above list elements. An interesting note though: The core currently recognizes if you try to apply a list to a new line directly after a list.
i.e. create an ordered list with 3 items, return to a new line breaking out of the list, enter some text and apply a list to that line appends it to the previous OL (now containing 4 items)

@luisrudge
Copy link

I also think the output of nested lists is less than ideal, but if we could have a css file with listing styles to make lists look the same as in the editor, maybe it would help initially.

@m00nk
Copy link

m00nk commented Jun 7, 2017

Is there some news about this enhancement?

@parterburn
Copy link

Using pseudo classes to accomplish nested lists prevents using Quill as a composer for anything that will be sent in email (as email clients do not allow the use of pseudo classes).

@AnrichVS
Copy link

@parterburn This is exactly my problem as well, forcing me to pre-parse content and adding actual numbering, which is very inconvenient

@arist0tl3
Copy link

arist0tl3 commented Jul 30, 2017

@AnrichVS What is your strategy for getting the code back into the editor? Rewriting back to the ql-indent class structure?

I'm currently exploring this, as like you and @parterburn, we use the output in html emails and other places. CSS isn't really a solution. I'm considering writing up a parser that translates the ql-indent li tags into nested uls/ols, etc. Unfortunately, it looks like I'd also have to write the reverse, as pasting nested lists into the editor gives me a flat list every time. So I'd have to rewrite the correct nest back into ql-indented code.

Not something I'm really looking forward to, as it addresses a bit of an edge case, but does look noticeably wrong when a nested ol with numbers and letters gets flattened into one long ol.

@parterburn
Copy link

We ended up preventing ordered lists from indenting more than once and set the margin-left on unordered lists according the different indent-classes using a premailer stylesheet (https://rubygems.org/gems/premailer-rails).

@arist0tl3
Copy link

Haha, pretty much what I'm in the process of doing now. Except I think we are nixing the ordered lists instead of trying to limit them to the parent level. Thanks for the feedback!

@parterburn
Copy link

Here's our code, if it's helpful:

var bindings = {
  "indent": {
    key: "tab",
    format: ["list"],
    handler: function(range, context) {
      if(context.format.list == "ordered") {
        return false;
      } else {
        if (context.collapsed && context.offset !== 0) return true;
        this.quill.format('indent', '+1', Quill.sources.USER);
      }
    }
  }
};

var emailBodyQuill = new Quill($(".email-body-quill"), {
  theme: 'snow',
  modules: {
    keyboard: {
      bindings: bindings
    },
    toolbar: {
      container: [
        [{ 'size': ['small', false, 'large', 'huge'] }],
        ['bold', 'italic', 'underline', 'link'],
        [{ 'list': 'ordered' }, { 'list': 'bullet' }, 'blockquote'],
        ['clean', 'image']
      ]
    }
  }
});

@RobAley
Copy link

RobAley commented Oct 24, 2017

I've just come across this problem too.

I'm trying to create PDFs of the editor contents using mPDF, which doesn't support the CSS needed on li's to do it the current Quill.js way. This means that all nested lists have the same level of indentation as the parent, and the numbering on ordered lists is not reset for nested lists (i.e. the numbering continues sequentially for every li in the group of lists).

mPDF does allow setting these on ul's/ol's, so if the indented lists were wrapped in ol or ul, then all would work properly.

Instead I need to write a parser to manually identify and wrap each level (a job I think I'll put off until tomorrow!).

@AnrichVS
Copy link

AnrichVS commented Nov 8, 2017

@arist0tl3 I had to put this on hold for quite some time as you can see. My main problem is that I send emails containing Quill created content. On the web side of things all is well, but for emails I use premailer-rails to convert all CSS to inline (to support as many mail clients as possible). And you can't have pseudo selectors (::before in this case for list numbering) inline.

Thus my plan was, and probably still is, to parse the mails with an interceptor and add actual numbers into the HTML. The indentation CSS works fine inline so I don't have a problem with that, it's just the numbering.

I guess if I don't want multiple levels of numbering (1.1, 1.1.1 etc.), converting the <li> to properly nested <ol> and <li> will also work, but then I'll have to do the same thing on the editor side of things.

I was really hoping some progress has been made on this since my last struggle...

@arist0tl3
Copy link

@AnrichVS Agreed. We still haven't figured out a way to handle the numbering in a consistent manner.

Currently, we are just restricting the usage of lists to a single level. Not a great user experience, but we still prefer it to nested lists with broken styles and numbering in our emails.

I toyed with the idea of hooking into the indent code above to write the structure of the current node into an html attribute that could be parsed later to re-write the innerHTML and css, but just couldn't justify putting too much time towards it. I do think that leveraging the indent function to add some useful data to the element is a viable strategy, but again, just can't justify the cost/benefit right now.

@thomasgodart
Copy link

thomasgodart commented Jan 30, 2018

Well if I paste from Google Docs to Quill, pretty much everything in a "normal and simple" document is conserved, except the nesting of lists, as requested in this old feature request: "Add support for nested lists/bullets and indents #118" dating back to May 2014. It's right now the only lack of feature that prevents me from using Quill in production.

A list element is relative to a <ul> or <ol> element and therefore, can't be represented in a different way than the original html: relatively to the parent element. Lists and list elements can contain each other, just like every DOM element they are nodes, and nodes can contain each other.

The actual fix of using "ql-indent" class isn't fixing anything but the visual. But html is more than a visual, have you every though about how blind people see your documents? You can't remove nesting, it's removing meaning, so it can't be allowed.

@mansours
Copy link

mansours commented Feb 7, 2018

I'm fairly new to Quill. But I saw there are a couple tickets that point here, some with discussion whether this is a personal preference or a technical requirement. My statements below support technical requirement and present supporting W3 materials.

In Ontario, a province in Canada, there is legislation for all public institutions and private companies with 50+ employees to have websites and web products be WCAG 2.0 level A compliant today, and by 2021 level AA compliant. There are many other jurisdictions around the world with similar laws and deadlines Eg. US DoJ section 508 law.

Jurisdiction laws aside, we should want to remove barriers to participation online for screenreader and keyboard navigation users, and nested lists are interpreted and navigated differently. eg. skip list or sublist/next.

As @thomasgodart pointed out, in v1.3.5 of Quill, ql-indent-* classes do not provide the content structure needed for accessibility users.

That said, here are technical references by W3 about nested lists:

@RobAley
Copy link

RobAley commented Feb 22, 2018

The following is the code I came up with the convert the quill style lists into "proper" ol/ul nested lists.

Note that this is very hacky code, and will be brittle if quill changes its html rendering. It works on the HTML that Quill currently renders in most browsers (grabbed by .innerHTML or similar). It (obviously) won't work on documents stored as deltas, and may fail if any other processing has altered the structure of the HTML. I use this only when rendering to another format (pdf via MPDF, or non-interactive HTML), storing the unchanged quill document as normal for future editing.

That said, it seem reliable in my use case, an electron app. It uses jquery on a hidden div (to map the html to a dom), you can probably get it to work in node using jsdom or similar. It works on ul, li and mixed combinations. It deals with edge cases like starting a list indented beyond level 0.

I hope this helps someone.

//load a hidden div with the HTML from Quill
$('#manipulator').html(html);

$.each(['ul','ol'], function(index, type) { // works on both types of list

	// define some temporary tags <startol>,<endol>,<startul>,<endul>
	// which will be replaced with <ol>,</ol>,<ul>,</ul> at the end
	// We use temp tags so that they don't get accidentally selected
	// as we progress
	var start_tag = '<start'+type+'></start'+type+'>';
	var end_tag = '<end'+type+'></end'+type+'>';

	// Grab each list, and work on it in turn
	$('#manipulator '+type).each(function() {

		// account for the fact that the first li might not
		// be at level 0

		var first_li = $(this).children('li').first();
		// parse the level from the class name e.g. ql-indent-2 is level 2
		// level 0 has no class name
		var first_level = $(first_li).attr('class') || '0';
		first_level = first_level.replace( /[^\d]/g, '');

		// add an appropriate number of opening tags.
		$(first_li).before(start_tag.repeat(first_level));

		// we don't need to do this at the end, as the last li's "next"
		// element isn't a li and thus will always be given a 0 level
		// and so the appropriate number of closing tags will be applied

		// now work through each li in this List

		$(this).children('li').each(function() {

			// get the level for this li as above

			var current_level = $(this).attr('class') || '0';

			current_level = current_level.replace( /[^\d]/g, '');

			// get the next li (or false if we're at the end of the list)

			var next_li = $(this).next('li') || false;

			if (next_li) {

				// get the level of the next li as above

				var next_level = $(next_li).attr('class') || '0';

				next_level = next_level.replace( /[^\d]/g, '');

				// work out whether it is a higher level (+ve number)
				// or lower (-ve) or at the same level (0)

				var difference = next_level - current_level;

				// we only need to add tags if the level is changing
				if (difference) {

					if (difference > 0) {

						// if it's a higher level, add an appropriate number
						// of opening tags before it

						$(next_li).before(start_tag.repeat(difference));
					};
					if (difference < 0) {

						// if it's a lower level, add closing tags instead

						difference = 0 - difference; // get abs value

						$(this).after(end_tag.repeat(difference));

					};

				}

			}

		})

	});

})

// grab the html as a string

var new_html = $('#manipulator').html();

// and replace the temp tags with the correct ol/ul ones.

new_html = common.replace_all(new_html, '<startul></startul>', '<ul>');
new_html = common.replace_all(new_html, '<endul></endul>', '</ul>');
new_html = common.replace_all(new_html, '<startol></startol>', '<ol>');
new_html = common.replace_all(new_html, '<endol></endol>', '</ol>');

// new_html now contains the "correct" html.

@rlansky
Copy link

rlansky commented Apr 13, 2018

@RobAley, thanks so much for your solution, I found it very helpful.

For anyone else who needs this and is not using jQuery, here's my ES6 version of Rob's code with a few minor tweaks (all of Rob's caveats apply to this code as well):

  • I found that there were some missing tags for closing the lists, so I added some additional close tags at the end of the for-loops.
  • I was having problems with the < and > symbols in the start_tag and end_tag parameters getting encoding into < and > when I injected them into the document, so I changed those to :: instead.
  • I'm hiding the temporary element and removing it once I'm done with it.

Cheers,
--Rick

function getListLevel(el) {
  const className = el.className || '0';
  return +className.replace(/[^\d]/g, '');
}

function convertLists(richtext) {
  const tempEl = window.document.createElement('div');
  tempEl.setAttribute('style', 'display: none;');
  tempEl.innerHTML = richtext;

  ['ul','ol'].forEach((type) => {
    const startTag = `::start${type}::::/start${type}::`;
    const endTag = \`::end${type}::::/end${type}::\`;

    // Grab each list, and work on it in turn
    Array.from(tempEl.querySelectorAll(type)).forEach((outerListEl) => {
      const listChildren = Array.from(outerListEl.children).filter((el) => el.tagName === 'LI');

      // Account for the fact that the first li might not be at level 0
      const firstLi = listChildren[0];
      firstLi.before(startTag.repeat(getListLevel(firstLi)));

      // Now work through each li in this list
      listChildren.forEach((listEl, index) => {
        const currentLiLevel = getListLevel(listEl);
        if (index < listChildren.length - 1) {
          const difference = getListLevel(listChildren[index + 1]) - currentLiLevel;

          // we only need to add tags if the level is changing
          if (difference > 0) {
            listChildren[index + 1].before(startTag.repeat(difference));
          } else if (difference < 0) {
            listEl.after(endTag.repeat(-difference));
          }
        } else {
          listEl.after(endTag);
        }
      });
      outerListEl.after(endTag);
    });
  });

  //  Get the content in the element and replace the temporary tags with new ones
  let newContent = tempEl.innerHTML;
  newContent = newContent.replace(/::startul::::\/startul::/g, '<ul>');
  newContent = newContent.replace(/::endul::::\/endul::/g, '</ul>');
  newContent = newContent.replace(/::startol::::\/startol::/g, '<ol>');
  newContent = newContent.replace(/::endol::::\/endol::/g, '</ol>');

  tempEl.remove();
  return newContent;
}

@jasonrundell
Copy link

Here is what is expected when handling lists:

https://codepen.io/jasonrundell/pen/zjZrjq

Right now, Quill's lists are not expected behaviour in terms on DOM markup and this creates issues with accessibility and end users who are making lists and not seeing nested lists.

Right now my workaround is a CSS hack with ql-indent-X which is creating a dependency on the Editor when the markup needs to be decoupled from Quill logic.

Also, I can't hack around the fact that the index of the list items won't be correct as I won't be able to modify publisher content every time they add a new list.

@martijndekuijper
Copy link

Hi, anyone making progress on this? It's too bad there's this discussion because I strongly believe the output of a WYSIWYG editor should be semantically correct (same goes for soft enters). We use Quill for editing emails, which means the ability to style elements is limited.

@stephanvierkant
Copy link

I think the 'bug' label should be added to this issue.

This is a matter of 'semantically correctness', but also of WYSIWYG.

@stephanvierkant
Copy link

Ping @jhchen. Please mark this issue as a bug.

@mohit18513
Copy link

I am new to use quill editor and facing issue while copying nested bullets content from MS word doc. Content loses nested bullets and indentation. Can any one help on this?

@dantman
Copy link

dantman commented Jan 26, 2019

I just started adding Quill to a project expecting it was the most used/best editor to use. Then I quickly ran into this issue.

Now given how long this issue has been open I'm wondering if I should just switch to something else before it's too late.

@Vrq
Copy link

Vrq commented Feb 8, 2022

@JurajKavka @Daenero what is the status of this ticket?

@Aidenbuis
Copy link

Aidenbuis commented Mar 23, 2022

I implemented the fix by @Daenero but I experience the problem of users double indenting list items, which didn't get decoded right. To prevent the double tabbing I limited the indenting of list items with a custom handler for the Tab event in the Quill options. Might be handy for someone else :)

keyboard: {
    bindings: {
        indent: {
            key: 9,
            format: ['blockquote', 'indent', 'list'],
            handler: function (this: any, range: any) {
                // We want to disable the indentation if:
                // - (1) The current line is the first line and the indent level is 0 (not indented)
                // - (2) The current line is a list and the previous line is not a list
                // - (3) The current line is a list and the previous line too, but the previous lines indentation level is already one level lower

                const currentLineFormats = this.quill.getFormat(
                    range.index
                )
                const previousLineFormats =
                    this.quill.getFormat(range.index - 1)
                const currentLineIsTheFirstLine =
                    range.index === 0
                const currentLineIsAList =
                    currentLineFormats.list !== undefined
                const previousLineIsAList =
                    previousLineFormats.list !== undefined
                const currentLineIndent =
                    currentLineFormats.indent || 0
                const previousLineIndent =
                    previousLineFormats.indent || 0

                if (
                    (currentLineIsTheFirstLine &&
                        currentLineIndent === 0) ||
                    (currentLineIsAList &&
                        !previousLineIsAList) ||
                    (currentLineIsAList &&
                        previousLineIsAList &&
                        previousLineIndent ===
                            currentLineIndent - 1)
                ) {
                    return
                }

                this.quill.format(
                    'indent',
                    '+1',
                    Quill.sources.USER
                )
            },
        },
    },
},

@adithyavinjamoori
Copy link

I got a few problems with code updated by @rlansky / @maggask. Nested lists should be placed inside previous "li" element, otherwise we can get empty list item.

Actual:

<li>1</li>
<li>2</li>
<li>
    <ul>
        <li>2.1</li>
    </ul>
</li>

Expected:

<li>1</li>
<li>2
    <ul>
        <li>2.1</li>
    </ul>
</li>

I have fixed this behavior in my Gist here - https://gist.github.com/Daenero/3442213dc5093dc10f30711edb529729.

And also, as in example from @Vovan-VE, you can also encode HTML nested list to Quill format.

I guess it should help.

you saved a lot of debuggin time. Thanks @Daenero

@nawlbergs
Copy link

3 more year and we're at a decade.
What is the suggested workaround? use the Daenero code?

@paleo
Copy link

paleo commented Dec 6, 2023

Damn, Quill's inability to handle bulleted lists properly is a major flaw.

@paleo
Copy link

paleo commented Dec 19, 2023

Will Quill 2 solve the problem of nested lists?

https://github.com/quilljs/quill/releases/tag/v2.0.0-beta.0

@milelo
Copy link

milelo commented Jan 16, 2024

I've just replaced my google editor with Quill. It was looking good however I've just come across this issue in testing, unfortunately not being able to have true nested lists is a deal breaker for me. Its back to google or find a better alternative. Please fix this in release 2.0.

@paleo
Copy link

paleo commented Jan 30, 2024

Here is a good workaround: https://github.com/nozer/quill-delta-to-html

@timotheedorand
Copy link

This custom clipboard matchers fixed the issue on my side. Thanks to Subtletree on this issue: #1225

const Delta = Quill.import('delta');

function matchMsWordList(node, delta) {
  // Clone the operations
  let ops = delta.ops.map((op) => Object.assign({}, op));

  // Trim the front of the first op to remove the bullet/number
  let bulletOp = ops.find((op) => op.insert && op.insert.trim().length);
  if (!bulletOp) { return delta }

  bulletOp.insert = bulletOp.insert.trimLeft();
  let listPrefix = bulletOp.insert.match(/^.*?(^·|\.)/) || bulletOp.insert[0];
  bulletOp.insert = bulletOp.insert.substring(listPrefix[0].length, bulletOp.insert.length).trimLeft();

  // Trim the newline off the last op
  let last = ops[ops.length-1];
  last.insert = last.insert.substring(0, last.insert.length - 1);

  // Determine the list type
  let listType = listPrefix[0].length === 1 ? 'bullet' : 'ordered';

  // Determine the list indent
  let style = node.getAttribute('style').replace(/\n+/g, '');
  let levelMatch = style.match(/level(\d+)/);
  let indent = levelMatch ? levelMatch[1] - 1 : 0;

  // Add the list attribute
  ops.push({insert: '\n', attributes: {list: listType, indent}})

  return new Delta(ops);
}

function maybeMatchMsWordList(node, delta) {
  if (delta.ops[0].insert.trimLeft()[0] === '·') {
    return matchMsWordList(node, delta);
  }
  
  return delta;
}

const MSWORD_MATCHERS = [
  ['p.MsoListParagraphCxSpFirst', matchMsWordList],
  ['p.MsoListParagraphCxSpMiddle', matchMsWordList],
  ['p.MsoListParagraphCxSpLast', matchMsWordList],
  ['p.MsoListParagraph', matchMsWordList],
  ['p.msolistparagraph', matchMsWordList],
  ['p.MsoNormal', maybeMatchMsWordList]
];

// When instantiating a quill editor
let quill = new Quill('#editor', {
  modules: {
    clipboard: { matchers: MSWORD_MATCHERS }
  },
  placeholder: 'Compose an epic...',
  theme: 'snow'
});

#1225 (comment)

@Flexo013
Copy link

Flexo013 commented Mar 12, 2024

@luin Do you know whether there is any progress being made on this issue? It the second highest upvoted issue on this repo after all.

@luin
Copy link
Member

luin commented Mar 12, 2024

It's worth noting that you can use quill.getSemanticHTML() to get an expected HTML output: Playground. This function can be particularly useful for exporting Quill content to external platforms.

@timotheedorand
Copy link

Upgrading to Quill v2.0.0-rc.2 fixed the issue on my side.
https://github.com/quilljs/quill/releases/tag/v2.0.0-rc.2

@ivanShagarov
Copy link

Upgrading to Quill v2.0.0-rc.2 fixed the issue on my side. https://github.com/quilljs/quill/releases/tag/v2.0.0-rc.2

@timotheedorand Did you add some config to get the proper lists in this version? I've just upgraded to version Quill v2.0.0-rc.3, but no changes, still getting flat lists.

@timotheedorand
Copy link

@timotheedorand Did you add some config to get the proper lists in this version? I've just upgraded to version Quill v2.0.0-rc.3, but no changes, still getting flat lists.

Nothing specific, I've took the React Code they provide on the playground: https://quilljs.com/playground/react
In fact, if you copy paste an indented list from Word there, it works great.
Screenshot 2024-03-21 at 13 48 06

@JoshuaDoshua JoshuaDoshua changed the title List Indent HTML not nesting properly List nesting/indent HTML is not semantic Mar 21, 2024
@ivanShagarov
Copy link

Nothing specific, I've took the React Code they provide on the playground: https://quilljs.com/playground/react
In fact, if you copy paste an indented list from Word there, it works great.

Yes, if you paste from Word it works well, but it works bad when pasting to word, or trying to use Quill's html in other pages/emails.

@timotheedorand
Copy link

@ivanShagarov indeed, from Quill to Word doesn't work natively. I fixed this by using getSemanticHTML()

// Editor.js
        quill.on(Quill.events.TEXT_CHANGE, () => {
            onTextChangeRef.current?.(quill.getSemanticHTML());
        });

@luin
Copy link
Member

luin commented Mar 21, 2024

Yes, if you paste from Word it works well, but it works bad when pasting to word

When you copy content from Quill, semantic HTML is copied instead of just the innerHTML of the editor. Actually Quill internally calls the quill.getSemanticHTML() function. That means the expectation is that copying from Quill and pasting into external sites/apps should work (list indentations should be kept). If that's not the case, that would be a bug in quill.getSemanticHTML() and please feel free to raise a GitHub issue for it and I'll take a look.

@ivanShagarov
Copy link

@timotheedorand @luin Thank you guys! quill.getSemanticHTML() did the job :)

@fabiennecornel
Copy link

Made a workaround that might help others. In my case an unordered list was put as <ol><li data-list="bullet", so I made a function that corrects the semantics:

const findAllOccurrences = (str: string, substr: string) => {
  str = str.toLowerCase();
  
  let result = [];

  let idx = str.indexOf(substr)
  
  while (idx !== -1) {
    result.push(idx);
    idx = str.indexOf(substr, idx+1);
  }
  return result;
}

const replaceAt = (input: string, search: string, replace: string, start: number, end: number) => {
  return input.slice(0, start)
    + input.slice(start, end).replace(search, replace)
    + input.slice(end);
}

const onInput = (x: string) => {
  // This function fixes unordered lists that are put as <ol> instead of <ul>
  let input= x;
  const startIndexes = findAllOccurrences(input, '<ol><li data-list="bullet"');
  const endIndexes = findAllOccurrences(input, '</ol>');
  
  for (let i = 0; i < startIndexes.length; i++) {
    // Change belonging endIndexes to </ul>
    const endIndex = endIndexes.find(index => index > startIndexes[i]);
    if (endIndex) {
      input = replaceAt(output, '</ol>', '</ul>', endIndex, endIndex + 5)
    }
  }

  const output = output.replaceAll('<ol><li data-list="bullet"', '<ul><li data-list="bullet"');
// Do something with the output
  }

Also this CSS line made it look like an actual bullet list in the Quill Editor, since it showed numbers for me there too.

li[data-list="bullet"] {
    &:before {
      content: '•';
    }
  }

The result of all this:

input: <p>This is a numbered list:</p><ol><li data-list="ordered"><span class="ql-ui" contenteditable="false"></span>One</li><li data-list="ordered"><span class="ql-ui" contenteditable="false"></span>Two</li></ol><p>This is an unordered list:</p><ol><li data-list="bullet"><span class="ql-ui" contenteditable="false"></span>Something</li><li data-list="bullet"><span class="ql-ui" contenteditable="false"></span>Something else</li></ol>

output: <p>This is a numbered list:</p><ol><li data-list="ordered"><span class="ql-ui" contenteditable="false"></span>One</li><li data-list="ordered"><span class="ql-ui" contenteditable="false"></span>Two</li></ol><p>This is an unordered list:</p><ul><li data-list="bullet"><span class="ql-ui" contenteditable="false"></span>Something</li><li data-list="bullet"><span class="ql-ui" contenteditable="false"></span>Something else</li></ul>

How the editor looks (including the line of CSS for me)
image
Output on my website
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests