https://github.com/editor-js/list-legacy
List Tool for Editor.js 2.0
https://github.com/editor-js/list-legacy
codex-editor editor li list ul
Last synced: 4 months ago
JSON representation
List Tool for Editor.js 2.0
- Host: GitHub
- URL: https://github.com/editor-js/list-legacy
- Owner: editor-js
- License: mit
- Created: 2018-07-31T11:48:03.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-13T18:37:41.000Z (over 1 year ago)
- Last Synced: 2025-10-11T05:14:56.578Z (8 months ago)
- Topics: codex-editor, editor, li, list, ul
- Language: JavaScript
- Homepage:
- Size: 1.63 MB
- Stars: 58
- Watchers: 1
- Forks: 71
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# List Tool for Editor.js
> [!IMPORTANT]
> This repository is deprecated and is no longer supported.
Take a look at a new repository [List tool](https://github.com/editor-js/list) with more functionality and compatibility with old data.
## Installation
Get the package
```shell
yarn add @editorjs/list
```
Include module at your application
```javascript
import List from "@editorjs/list";
```
Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/list@latest)
## Usage
Add the List Tool to the `tools` property of the Editor.js initial config.
```javascript
import EditorJS from '@editorjs/editorjs';
import List from '@editorjs/list';
var editor = EditorJS({
// ...
tools: {
...
list: {
class: List,
inlineToolbar: true,
config: {
defaultStyle: 'unordered'
}
},
},
});
```
## Config Params
| Field | Type | Description |
| ------------ | -------- | -------------------------------------------------------------- |
| defaultStyle | `string` | type of a list: `ordered` or `unordered`, default is `ordered` |
## Tool's settings
You can choose list`s type.
## Output data
| Field | Type | Description |
| ----- | ---------- | ---------------------------------------- |
| style | `string` | type of a list: `ordered` or `unordered` |
| items | `string[]` | the 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"
]
}
},
```
## I18n support
This tool supports the [i18n api](https://editorjs.io/i18n-api).
To localize UI labels, put this object to your i18n dictionary under the `tools` section:
```json
"list": {
"Ordered": "Нумерованный",
"Unordered": "Маркированный"
}
```
See more instructions about Editor.js internationalization here: [https://editorjs.io/internationalization](https://editorjs.io/internationalization)