New

docx-editor 1.x has shipped. Vue support, i18n, agents. Read the migration guide →

API Referencev1.0.2

@eigenpal/docx-editor-core/utils/listState

Pure list-state helpers used by both adapter toolbars to track whether the selection is in a bullet/numbered list and at what indent level. Lifted from packages/react/src/components/ui/ ListButtons.tsx so the React + Vue toolbars share identical state-mutation logic.

Functions(9)

declare function createBulletListState(level?: number, numId?: number): ListState;
declare function createDefaultListState(): ListState;
declare function createNumberedListState(level?: number, numId?: number): ListState;
declare function getNextIndentLevel(currentLevel: number): number;
declare function getPreviousIndentLevel(currentLevel: number): number;
declare function isAnyListState(state: ListState | undefined): boolean;
declare function isBulletListState(state: ListState | undefined): boolean;
declare function isNumberedListState(state: ListState | undefined): boolean;
declare function toggleListType(state: ListState | undefined, targetType: ListType): ListState;

Interfaces(1)

interface ListState
MemberTypeSummary
isInListboolean
levelnumber
numId?number
typeListType

Type aliases(1)

Pure list-state helpers used by both adapter toolbars to track whether the selection is in a bullet/numbered list and at what indent level. Lifted from packages/react/src/components/ui/ ListButtons.tsx so the React + Vue toolbars share identical state-mutation logic.

type ListType = 'bullet' | 'numbered' | 'none';