Skip to content
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.

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

add spine to lists; add list-style for nested <ol> #392

Merged
merged 1 commit into from
Jul 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 21 additions & 4 deletions ui/src/components/nodes/Rich.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,11 @@ import {
CodeBlockExtension,
HeadingExtension,
IframeExtension,
BulletListExtension,
OrderedListExtension,
TaskListExtension,
CodeExtension,
StrikeExtension,
UnderlineExtension,
} from "remirror/extensions";

import {
Remirror,
EditorComponent,
Expand Down Expand Up @@ -126,6 +124,12 @@ import {
MathInlineExtension,
MathBlockExtension,
} from "./extensions/mathExtension";
import {
BulletListExtension,
OrderedListExtension,
TaskListExtension,
} from "./extensions/list";

import { NewPodButtons, level2fontsize } from "./utils";

class LinkExtension extends RemirrorLinkExtension {
Expand Down Expand Up @@ -660,7 +664,20 @@ const MyEditor = ({
onBlur={() => {
setPodBlur(id);
}}
sx={{ userSelect: "text", cursor: "auto" }}
sx={{
userSelect: "text",
cursor: "auto",
// Display different markers for different levels in nested ordered lists.
ol: {
"list-style-type": "decimal",
},
"ol li ol": {
"list-style-type": "lower-alpha",
},
"ol li ol li ol": {
"list-style-type": "lower-roman",
},
}}
ref={ref}
overflow="auto"
>
Expand Down
88 changes: 88 additions & 0 deletions ui/src/components/nodes/extensions/list.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
import {
BulletListExtension as RemirrorBulletListExtension,
OrderedListExtension as RemirrorOrderedListExtension,
TaskListExtension as RemirrorTaskListExtension,
} from "remirror/extensions";

import { ExtensionListTheme } from "@remirror/theme";
import { NodeViewMethod, ProsemirrorNode } from "@remirror/core";

function addSpine(dom, view, getPos) {
const pos = (getPos as () => number)();
const $pos = view.state.doc.resolve(pos + 1);

const parentListItemNode: ProsemirrorNode | undefined = $pos.node(
$pos.depth - 1
);

const isNotFirstLevel = ["listItem", "taskListItem"].includes(
parentListItemNode?.type?.name || ""
);

if (isNotFirstLevel) {
const spine = document.createElement("div");
spine.contentEditable = "false";
spine.classList.add(ExtensionListTheme.LIST_SPINE);
dom.append(spine);
}
}

/**
* Add spline but not listener.
*/
export class BulletListExtension extends RemirrorBulletListExtension {
createNodeViews(): NodeViewMethod | Record<string, never> {
return (_, view, getPos) => {
const dom = document.createElement("div");
dom.style.position = "relative";

addSpine(dom, view, getPos);

const contentDOM = document.createElement("ul");
dom.append(contentDOM);

return {
dom,
contentDOM,
};
};
}
}

export class OrderedListExtension extends RemirrorOrderedListExtension {
createNodeViews(): NodeViewMethod | Record<string, never> {
return (_, view, getPos) => {
const dom = document.createElement("div");
dom.style.position = "relative";

addSpine(dom, view, getPos);

const contentDOM = document.createElement("ol");
dom.append(contentDOM);

return {
dom,
contentDOM,
};
};
}
}

export class TaskListExtension extends RemirrorTaskListExtension {
createNodeViews(): NodeViewMethod | Record<string, never> {
return (_, view, getPos) => {
const dom = document.createElement("div");
dom.style.position = "relative";

addSpine(dom, view, getPos);

const contentDOM = document.createElement("ul");
dom.append(contentDOM);

return {
dom,
contentDOM,
};
};
}
}