List Tool for CodeX Editor

This Tool for the CodeX Editor allows you to add ordered or unordered (bulleted) lists to your article.


Installation

$3

Get the package

``shell
npm i --save-dev codex.editor.list
`

Include module at your application

`javascript
const List = require('codex.editor.list');
`

$3

1. Upload folder dist from repository
2. Add dist/bundle.js file to your page.

$3

You can load specific version of package from jsDelivr CDN.

https://cdn.jsdelivr.net/npm/codex.editor.list@1.0.2

Then require this script on page with CodeX Editor.

`html

`

Usage

Add a new Tool to the tools property of the CodeX Editor initial config.

`javascript
var editor = CodexEditor({
...

tools: {
...
list: {
class: List,
inlineToolbar: true,
},
}

...
});
`

Config Params

This Tool has no config params

Tool's settings

![](https://capella.pics/bf5a42e4-1350-499d-a728-493b0fcaeda4.jpg)

You can choose lists type.

Output data

| Field | Type | Description |
| ----- | ---------- | -------------------------------------- |
| style | string | type of list: ordered or unordered |
| items | string[] | array of list's items |

``json
{
"type" : "list",
"data" : {
"style" : "unordered",
"items" : [
"This is a block-styled editor",
"Clean output data",
"Simple and powerful API"
]
}
},
``