Skip to content

Fix Header Tool not supporting line breaks #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrspence wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix Header Tool not supporting line breaks #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f17122e
Feat: new config setting `allowLineBreaks: Boolean`
mrspence Dec 17, 2021
10fdaf8
Mod: update docs to include ` allowLineBreaks` config option
mrspence Dec 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,12 @@ var editor = EditorJS({

All properties are optional.

| Field | Type | Description |
| ------------ | ---------- | --------------------------- |
| placeholder | `string` | header's placeholder string |
| levels | `number[]` | enabled heading levels |
| defaultLevel | `number` | default heading level |
| Field | Type | Description |
| --------------- | ---------- | ----------------------------------- |
| placeholder | `string` | header's placeholder string |
| levels | `number[]` | enabled heading levels |
| defaultLevel | `number` | default heading level |
| allowLineBreaks | `bool` | allow line breaks. default: `false` |

```javascript
var editor = EditorJS({
Expand All @@ -95,7 +96,8 @@ var editor = EditorJS({
config: {
placeholder: 'Enter a header',
levels: [2, 3, 4],
defaultLevel: 3
defaultLevel: 3,
allowLineBreaks: true
}
}
}
Expand Down
14 changes: 10 additions & 4 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,10 +227,14 @@ class Header {
* @public
*/
save(toolsContent) {
return {
text: toolsContent.innerHTML,
const sanitizerConfig = {
br: !(typeof this._settings.allowLineBreaks === 'undefined' || this._settings.allowLineBreaks === false),
}

return Object.assign({}, {
text: this.api.sanitizer.clean(toolsContent.innerHTML, sanitizerConfig),
level: this.currentLevel.number,
};
});
}

/**
Expand All @@ -249,7 +253,9 @@ class Header {
static get sanitize() {
return {
level: false,
text: {},
text: {
br: true,
},
};
}

Expand Down