Skip to content

Commit

Permalink
Merge pull request #115 from editor-js/rename-to-editorjs-list
Browse files Browse the repository at this point in the history
Chore (readme): update readme with info about class renaming
  • Loading branch information
e11sy authored Nov 18, 2024
2 parents a91662b + 1fd88b5 commit 273fd6f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# Editorjs List Tool

![](assets/readme_image.png)

- 🤩 Part of [Editor.js](https://editorjs.io/) ecosystem.
- 📂 Nesting.
- 🔥 Ordered and Unordered lists.
Expand All @@ -26,25 +28,25 @@ yarn add @editorjs/list
Include module at your application

```javascript
import List from '@editorjs/list';
import EditorjsList from '@editorjs/list';
```

Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/list@latest)
Optionally, you can load this tool from CDN [JsDelivr CDN](https://cdn.jsdelivr.net/npm/@editorjs/list@2)

## 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';
import EditorjsList from '@editorjs/list';

var editor = EditorJS({
// ...
tools: {
...
list: {
class: List,
class: EditorjsList,
inlineToolbar: true,
config: {
defaultStyle: 'unordered'
Expand All @@ -53,6 +55,8 @@ var editor = EditorJS({
},
});
```
> [!IMPORTANT]
> Note that in List 2.0 class name changed from `List` to `EditorjsList`.
## Config Params

Expand Down
Binary file added assets/readme_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 273fd6f

Please sign in to comment.