` where line breaks should be handled by default behaviour. |
+| `enableLineBreaks` | _Boolean_ | `false` | With this option, Editor.js won't handle Enter keydowns. Can be helpful for Tools like `` where line breaks should be handled by default behaviour. |
| `isInline` | _Boolean_ | `false` | Describes Tool as a [Tool for the Inline Toolbar](tools-inline.md) |
## User configuration
@@ -65,8 +65,8 @@ All Tools can be configured by users. You can set up some of available settings
to the `tools` property of Editor Config.
```javascript
-var editor = new CodexEditor({
- holderId : 'codex-editor',
+var editor = new EditorJS({
+ holderId : 'editorjs',
tools: {
text: {
class: Text,
@@ -79,7 +79,7 @@ var editor = new CodexEditor({
});
```
-There are few options available by CodeX Editor.
+There are few options available by Editor.js.
| Name | Type | Default Value | Description |
| -- | -- | -- | -- |
@@ -88,7 +88,7 @@ There are few options available by CodeX Editor.
## Paste handling
-CodeX Editor handles paste on Blocks and provides API for Tools to process the pasted data.
+Editor.js handles paste on Blocks and provides API for Tools to process the pasted data.
When user pastes content into Editor, pasted content will be splitted into blocks.
@@ -226,7 +226,7 @@ onPaste (event) {
## Sanitize
-CodeX Editor provides [API](sanitizer.md) to clean taint strings.
+Editor.js provides [API](sanitizer.md) to clean taint strings.
Use it manually at the `save()` method or or pass `sanitizer` config to do it automatically.
### Sanitizer Configuration
@@ -298,7 +298,7 @@ save() {
### Automatic sanitize
-If you pass the sanitizer config as static getter, CodeX Editor will automatically sanitize your saved data.
+If you pass the sanitizer config as static getter, Editor.js will automatically sanitize your saved data.
Note that if your Tool is allowed to use the Inline Toolbar, we will get sanitizing rules for each Inline Tool
and merge with your passed config.
diff --git a/docs/usage.md b/docs/usage.md
index 3eabfd2f6..600d05145 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -1,10 +1,10 @@
-# So how to use CodeX Editor
+# So how to use Editor.js
## Basics
-CodeX Editor is a Block-Styled editor. Blocks is a structural units, of which the Entry is composed.
+Editor.js is a Block-Styled editor. Blocks is a structural units, of which the Entry is composed.
For example, `Paragraph`, `Heading`, `Image`, `Video`, `List` are Blocks. Each Block is represented by a Plugin.
-We have [many](http://github.com/codex-editor) ready-to-use Plugins and the [simple API](tools.md) for creation new ones.
+We have [many](http://github.com/codex-editor/) ready-to-use Plugins and the [simple API](tools.md) for creation new ones.
So how to use the Editor after [Installation](installation.md).
@@ -40,7 +40,7 @@ Action | Shortcut | Restrictions
Also we support shortcuts on the all type of Tools. Specify a shortcut with the Tools configuration. For example:
```js
-var editor = CodexEditor({
+var editor = EditorJS({
//...
tools: {
header: {
@@ -63,7 +63,7 @@ If you want to focus Editor after page has been loaded, you can enable autofocus
```js
-var editor = CodexEditor({
+var editor = EditorJS({
//...
autofocus: true
//...
diff --git a/example/example.html b/example/example.html
index 86ec95cc5..de43f4d86 100644
--- a/example/example.html
+++ b/example/example.html
@@ -2,7 +2,7 @@
- CodeX Editor 🤩🧦🤨 example
+ Editor.js 🤩🧦🤨 example
@@ -11,14 +11,14 @@
-
+