Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaaaaaaaaaaai/paragraph-with-alignment
Paragraph Tool for Editor.js 2.0
https://github.com/kaaaaaaaaaaai/paragraph-with-alignment
Last synced: about 2 months ago
JSON representation
Paragraph Tool for Editor.js 2.0
- Host: GitHub
- URL: https://github.com/kaaaaaaaaaaai/paragraph-with-alignment
- Owner: kaaaaaaaaaaai
- License: mit
- Created: 2020-08-07T09:07:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-28T15:52:41.000Z (over 1 year ago)
- Last Synced: 2024-11-04T04:36:27.298Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 597 KB
- Stars: 44
- Watchers: 0
- Forks: 20
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-editorjs - paragraph-with-alignment - text block base tool with alignment control. FYI [editorjs-alignment-blocktune](https://github.com/kaaaaaaaaaaai/editorjs-alignment-blocktune) (Tools / Block Tools)
README
# Paragraph Tool with alignment for Editor.js
#### If you can help, please push the Star button :)
### If you want to add an alignment to another block
This is useful
[editorjs-alignment-blocktune](https://github.com/kaaaaaaaaaaai/editorjs-alignment-blocktune)
## versions
| version | Description |
| ------ | -------- |
| @2.x | support alignment left/center/right |
| @3.x | support alignment left/center/right/justify |
## Installation
### Install via NPM
Get the package
```shell
npm i --save [email protected]
```
Include module at your application
```javascript
const Paragraph = require('editorjs-paragraph-with-alignment');
```
### 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
`https://cdn.jsdelivr.net/npm/[email protected]`
## Usage
The Paragraph tool is included at editor.js by default, so you don't need to connect it manually.
If you want to connect your customized version of this tool, do not forget to use the [`initialBlock`](https://editorjs.io/configuration#change-the-default-block)
option of the editor config.
Add a new Tool to the `tools` property of the Editor.js initial config.
```javascript
var editor = EditorJS({
...
tools: {
...
paragraph: {
class: Paragraph,
inlineToolbar: true,
},
}
...
});
```
## Config Params
The Paragraph Tool supports these configuration parameters:
| Field | Type | Description |
| ----- | -------- | ------------------ |
| placeholder | `string` | The placeholder. Will be shown only in the first paragraph when the whole editor is empty. |
| preserveBlank | `boolean` | (default: `false`) Whether or not to keep blank paragraphs when saving editor data |
## Output data
| Field | Type | Description |
| ------ | -------- | ---------------- |
| text | `string` | paragraph's text |
| alignment | `string` | left/center/right/justify |
```json
{
"type" : "paragraph",
"data" : {
"text" : "Check out our projects on a GitHub page.",
"alignment": "left"
}
}
```