how to allow insert custom block element to document list?

[kuku711]

Provide a description of the task

I want to create custom element of block type and be able to insert the element inside a document list,
there is a way to do it? i dont see there is schema of document list that let me do allow children

[dufipl]

Hello @kuku711,

For the starters, please be aware that the document list is currently on the "experimental" level (#2973 (comment)) and we don't recommend using it in production without assessing the risk.

However, if you decide to give it a try, I can provide some tips for you.

If you would like to create your own custom widget and use it with the document lists, you need to register it inside of the schema as $blockObject:

schema.register( 'customWidget', {
	inheritAllFrom: '$blockObject',
	isBlock: true
} );

It is one of our generic items: https://ckeditor.com/docs/ckeditor5/latest/framework/guides/deep-dive/schema.html#generic-items

Also, to insert that element you should use model.insertObject() instead of model.insertContent(). Example of that you can find here:

ckeditor5/packages/ckeditor5-html-embed/src/htmlembedcommand.js

Line 68 in ebc3465

model.insertObject( htmlEmbedElement, null, null, { setSelection: 'on' } );

I hope that will help you, but please let me know if something remains unclear. :)

[kuku711]

thanks, its work !
i know its experimental i'm just checking my custom widgets because we will move to use it when it will be ready and will support to-dolist.

[dufipl]

I'm very glad to hear that! :)

I will close the issue now but feel free to post new comments in case of any additional questions.