npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

codex.editor.list

1.2.3 • Public • Published

List Tool for CodeX Editor

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

Installation

Install via NPM

Get the package

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

Include module at your application

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

Download to your project's source dir

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

Load from CDN

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.

<script src="..."></script>

Usage

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

var editor = CodexEditor({
  ...
  
  tools: {
    ...
    list: {
      class: List,
      inlineToolbar: true,
    },
  }
  
  ...
});

Config Params

This Tool has no config params

Tool's settings

You can choose list`s type.

Output data

Field Type Description
style string type of list: ordered or unordered
items string[] array of list's items
{
    "type" : "list",
    "data" : {
        "style" : "unordered",
        "items" : [
            "This is a block-styled editor",
            "Clean output data",
            "Simple and powerful API"
        ]
    }
},

install

npm i codex.editor.list

Downloadsweekly downloads

14

version

1.2.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability