Skip to content

fix: use <details>/<summary> for toggle block HTML export #2523

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

Closed
YousefED wants to merge 1 commit into from
+315 −7
Closed

fix: use <details>/<summary> for toggle block HTML export #2523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion packages/core/src/api/exporters/html/util/serializeBlocksExternalHTML.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,13 @@ function serializeBlock<
}
}

if (editor.pmSchema.nodes[block.type as any].isInGroup("blockContent")) {
if ("childrenDOM" in ret && ret.childrenDOM) {
// block specifies where children should go (e.g. toggle blocks
// place children inside <details>)
ret.childrenDOM.append(childFragment);
} else if (
editor.pmSchema.nodes[block.type as any].isInGroup("blockContent")
) {
// default "blockContainer" style blocks are flattened (no "nested block" support) for externalHTML, so append the child fragment to the outer fragment
fragment.append(childFragment);
} else {
Expand Down
16 changes: 15 additions & 1 deletion packages/core/src/blocks/Heading/block.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { createBlockConfig, createBlockSpec } from "../../schema/index.js";
import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
import { createExtension } from "../../editor/BlockNoteExtension.js";
import { createBlockConfig, createBlockSpec } from "../../schema/index.js";
import {
addDefaultPropsExternalHTML,
defaultProps,
Expand Down Expand Up @@ -110,6 +110,20 @@ export const createHeadingBlockSpec = createBlockSpec(
const dom = document.createElement(`h${block.props.level}`);
addDefaultPropsExternalHTML(block.props, dom);

if ("isToggleable" in block.props && block.props.isToggleable) {
const details = document.createElement("details");
details.setAttribute("open", "");
const summary = document.createElement("summary");
summary.appendChild(dom);
details.appendChild(summary);

return {
dom: details,
contentDOM: dom,
childrenDOM: details,
};
}

return {
dom,
contentDOM: dom,
Expand Down
9 changes: 8 additions & 1 deletion packages/core/src/blocks/ListItem/ToggleListItem/block.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,20 @@ export const createToggleListItemBlockSpec = createBlockSpec(
},
toExternalHTML(block) {
const li = document.createElement("li");
const details = document.createElement("details");
details.setAttribute("open", "");
const summary = document.createElement("summary");
const p = document.createElement("p");
summary.appendChild(p);
details.appendChild(summary);

addDefaultPropsExternalHTML(block.props, li);
li.appendChild(p);
li.appendChild(details);

return {
dom: li,
contentDOM: p,
childrenDOM: details,
};
},
},
Expand Down
3 changes: 3 additions & 0 deletions packages/core/src/schema/blocks/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ export type LooseBlockSpec<
| {
dom: HTMLElement | DocumentFragment;
contentDOM?: HTMLElement;
childrenDOM?: HTMLElement;
}
| undefined;

Expand Down Expand Up @@ -203,6 +204,7 @@ export type BlockSpecs = {
| {
dom: HTMLElement | DocumentFragment;
contentDOM?: HTMLElement;
childrenDOM?: HTMLElement;
}
| undefined;
};
Expand Down Expand Up @@ -476,6 +478,7 @@ export type BlockImplementation<
| {
dom: HTMLElement | DocumentFragment;
contentDOM?: HTMLElement;
childrenDOM?: HTMLElement;
}
| undefined;

Expand Down
6 changes: 5 additions & 1 deletion tests/src/unit/core/clipboard/copy/__snapshots__/text/html/basicBlocks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ <h1>Heading 1</h1>
<p class="bn-inline-content">Check List Item 1</p>
</li>
<li>
<p class="bn-inline-content">Toggle List Item 1</p>
<details open="">
<summary>
<p class="bn-inline-content">Toggle List Item 1</p>
</summary>
</details>
</li>
</ul>
<pre>
Expand Down
6 changes: 5 additions & 1 deletion tests/src/unit/core/clipboard/copy/__snapshots__/text/html/basicBlocksWithProps.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ <h2 data-level="2">Heading 1</h2>
<p class="bn-inline-content">Check List Item 1</p>
</li>
<li style="text-align: right;" data-text-alignment="right">
<p class="bn-inline-content">Toggle List Item 1</p>
<details open="">
<summary>
<p class="bn-inline-content">Toggle List Item 1</p>
</summary>
</details>
</li>
</ul>
<pre data-language="typescript">
Expand Down
76 changes: 76 additions & 0 deletions ...it/core/formatConversion/export/__snapshots__/blocknoteHTML/lists/toggleWithChildren.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
<div class="bn-block" data-node-type="blockContainer" data-id="1">
<div class="bn-block-content" data-content-type="toggleListItem">
<div>
<div class="bn-toggle-wrapper" data-show-children="true">
<button class="bn-toggle-button" type="button">
<svg
xmlns="http://www.w3.org/2000/svg"
height="24px"
viewBox="0 -960 960 960"
width="24px"
fill="CURRENTCOLOR"
>
<path d="M320-200v-560l440 280-440 280Z"></path>
</svg>
</button>
<p class="bn-inline-content">Toggle List Item</p>
</div>
</div>
</div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="2">
<div class="bn-block" data-node-type="blockContainer" data-id="2">
<div class="bn-block-content" data-content-type="paragraph">
<p class="bn-inline-content">Toggle Child 1</p>
</div>
</div>
</div>
<div class="bn-block-outer" data-node-type="blockOuter" data-id="3">
<div class="bn-block" data-node-type="blockContainer" data-id="3">
<div class="bn-block-content" data-content-type="paragraph">
<p class="bn-inline-content">Toggle Child 2</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="bn-block-outer" data-node-type="blockOuter" data-id="4">
<div class="bn-block" data-node-type="blockContainer" data-id="4">
<div
class="bn-block-content"
data-content-type="heading"
data-level="2"
data-is-toggleable="true"
>
<div>
<div class="bn-toggle-wrapper" data-show-children="true">
<button class="bn-toggle-button" type="button">
<svg
xmlns="http://www.w3.org/2000/svg"
height="24px"
viewBox="0 -960 960 960"
width="24px"
fill="CURRENTCOLOR"
>
<path d="M320-200v-560l440 280-440 280Z"></path>
</svg>
</button>
<h2 class="bn-inline-content">Toggle Heading</h2>
</div>
</div>
</div>
<div class="bn-block-group" data-node-type="blockGroup">
<div class="bn-block-outer" data-node-type="blockOuter" data-id="5">
<div class="bn-block" data-node-type="blockContainer" data-id="5">
<div class="bn-block-content" data-content-type="paragraph">
<p class="bn-inline-content">Heading Child 1</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
6 changes: 5 additions & 1 deletion tests/src/unit/core/formatConversion/export/__snapshots__/html/lists/basic.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
<p class="bn-inline-content">Check List Item 2</p>
</li>
<li>
<p class="bn-inline-content">Toggle List Item 1</p>
<details open="">
<summary>
<p class="bn-inline-content">Toggle List Item 1</p>
</summary>
</details>
</li>
</ul>
6 changes: 5 additions & 1 deletion tests/src/unit/core/formatConversion/export/__snapshots__/html/lists/nested.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@
<p class="bn-inline-content">Check List Item 2</p>
<ul>
<li data-nesting-level="3">
<p class="bn-inline-content">Toggle List Item 1</p>
<details open="">
<summary>
<p class="bn-inline-content">Toggle List Item 1</p>
</summary>
</details>
</li>
</ul>
</li>
Expand Down
17 changes: 17 additions & 0 deletions tests/src/unit/core/formatConversion/export/__snapshots__/html/lists/toggleWithChildren.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<ul>
<li>
<details open="">
<summary>
<p class="bn-inline-content">Toggle List Item</p>
</summary>
<p data-nesting-level="1">Toggle Child 1</p>
<p data-nesting-level="1">Toggle Child 2</p>
</details>
</li>
</ul>
<details open="" data-level="2" data-is-toggleable="true">
<summary>
<h2 class="bn-inline-content">Toggle Heading</h2>
</summary>
<p data-nesting-level="1">Heading Child 1</p>
</details>
9 changes: 9 additions & 0 deletions ...core/formatConversion/export/__snapshots__/markdown/lists/toggleWithChildren.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
* Toggle List Item

Toggle Child 1

Toggle Child 2

## Toggle Heading

Heading Child 1
124 changes: 124 additions & 0 deletions ...s/src/unit/core/formatConversion/export/__snapshots__/nodes/lists/toggleWithChildren.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
[
{
"attrs": {
"id": "1",
},
"content": [
{
"attrs": {
"backgroundColor": "default",
"textAlignment": "left",
"textColor": "default",
},
"content": [
{
"text": "Toggle List Item",
"type": "text",
},
],
"type": "toggleListItem",
},
{
"content": [
{
"attrs": {
"id": "2",
},
"content": [
{
"attrs": {
"backgroundColor": "default",
"textAlignment": "left",
"textColor": "default",
},
"content": [
{
"text": "Toggle Child 1",
"type": "text",
},
],
"type": "paragraph",
},
],
"type": "blockContainer",
},
{
"attrs": {
"id": "3",
},
"content": [
{
"attrs": {
"backgroundColor": "default",
"textAlignment": "left",
"textColor": "default",
},
"content": [
{
"text": "Toggle Child 2",
"type": "text",
},
],
"type": "paragraph",
},
],
"type": "blockContainer",
},
],
"type": "blockGroup",
},
],
"type": "blockContainer",
},
{
"attrs": {
"id": "4",
},
"content": [
{
"attrs": {
"backgroundColor": "default",
"isToggleable": true,
"level": 2,
"textAlignment": "left",
"textColor": "default",
},
"content": [
{
"text": "Toggle Heading",
"type": "text",
},
],
"type": "heading",
},
{
"content": [
{
"attrs": {
"id": "5",
},
"content": [
{
"attrs": {
"backgroundColor": "default",
"textAlignment": "left",
"textColor": "default",
},
"content": [
{
"text": "Heading Child 1",
"type": "text",
},
],
"type": "paragraph",
},
],
"type": "blockContainer",
},
],
"type": "blockGroup",
},
],
"type": "blockContainer",
},
]
Loading
Loading