Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including codex.editor.list with all npm packages installed. Try it out:

var codexEditorList = require("codex.editor.list")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

codex.editor.list v1.2.3

List Tool for CodeX.Editor

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

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

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free