prosemirror-flat-list/src/types.ts

Powerful list support for ProseMirror

import type { Attrs, Node } from 'prosemirror-model'

/**
 * All default list node kinds.
 *
 * @public @group Schema
 */
export type ListKind = 'bullet' | 'ordered' | 'task' | 'toggle'

/**
 * @public @group Schema
 */
export interface ListAttributes {
  kind?: string
  order?: number | null
  checked?: boolean
  collapsed?: boolean
}

/**
 * @public @group Schema
 */
export interface ProsemirrorNodeJSON {
  type: string
  marks?: Array<{ type: string; attrs?: Attrs } | string>
  text?: string
  content?: ProsemirrorNodeJSON[]
  attrs?: Attrs
}

export type { Node as ProsemirrorNode }