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.

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

[lexical] Feature: Add listStyleType support to ListNode for customizable list styles #7285

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −1
Open

[lexical] Feature: Add listStyleType support to ListNode for customizable list styles #7285

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
54 changes: 53 additions & 1 deletion packages/lexical-list/src/LexicalListNode.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ import {$getListDepth, $wrapInListItem} from './utils';
export type SerializedListNode = Spread<
{
listType: ListType;
listStyleType?: ListStyleType;
start: number;
tag: ListNodeTagType;
},
Expand All @@ -49,6 +50,27 @@ export type SerializedListNode = Spread<

export type ListType = 'number' | 'bullet' | 'check';

export type ListStyleType =
| undefined // default
// eslint-disable-next-line @typescript-eslint/ban-types
| (string & {}) // string means custom style
| 'none'
| 'disc'
| 'circle'
| 'square'
| 'decimal'
| 'decimal-leading-zero'
| 'lower-roman'
| 'upper-roman'
| 'lower-greek'
| 'lower-alpha'
| 'lower-latin'
| 'upper-alpha'
| 'upper-latin'
| 'armenian'
| 'georgian'
| 'hebrew';

export type ListNodeTagType = 'ul' | 'ol';

/** @noInheritDoc */
Expand All @@ -59,6 +81,8 @@ export class ListNode extends ElementNode {
__start: number;
/** @internal */
__listType: ListType;
/** @internal */
__listStyleType: ListStyleType;

static getType(): string {
return 'list';
Expand All @@ -70,11 +94,17 @@ export class ListNode extends ElementNode {
return new ListNode(listType, node.__start, node.__key);
}

constructor(listType: ListType = 'number', start: number = 1, key?: NodeKey) {
constructor(
listType: ListType = 'number',
start: number = 1,
key?: NodeKey,
listStyleType?: ListStyleType,
) {
super(key);
const _listType = TAG_TO_LIST_TYPE[listType] || listType;
this.__listType = _listType;
this.__tag = _listType === 'number' ? 'ol' : 'ul';
this.__listStyleType = listStyleType;
this.__start = start;
}

Expand All @@ -93,6 +123,16 @@ export class ListNode extends ElementNode {
return this.__listType;
}

setListStyleType(type: ListStyleType): this {
const writable = this.getWritable();
writable.__listStyleType = type;
return writable;
}

getListStyleType(): ListStyleType {
return this.__listStyleType;
}

getStart(): number {
return this.__start;
}
Expand All @@ -114,6 +154,11 @@ export class ListNode extends ElementNode {
}
// @ts-expect-error Internal field.
dom.__lexicalListType = this.__listType;
if (this.__listStyleType) {
dom.style.setProperty('list-style-type', this.__listStyleType);
} else {
dom.style.removeProperty('list-style-type');
}
$setListThemeClassNames(dom, config.theme, this);

return dom;
Expand All @@ -124,6 +169,11 @@ export class ListNode extends ElementNode {
return true;
}

if (this.__listStyleType) {
dom.style.setProperty('list-style-type', this.__listStyleType);
} else {
dom.style.removeProperty('list-style-type');
}
$setListThemeClassNames(dom, config.theme, this);

return false;
Expand Down Expand Up @@ -158,6 +208,7 @@ export class ListNode extends ElementNode {
return super
.updateFromJSON(serializedNode)
.setListType(serializedNode.listType)
.setListStyleType(serializedNode.listStyleType)
.setStart(serializedNode.start);
}

Expand All @@ -179,6 +230,7 @@ export class ListNode extends ElementNode {
exportJSON(): SerializedListNode {
return {
...super.exportJSON(),
listStyleType: this.getListStyleType(),
listType: this.getListType(),
start: this.getStart(),
tag: this.getTag(),
Expand Down