prosemirror-flat-list/src/commands/toggle-list.ts

Powerful list support for ProseMirror

import { chainCommands } from 'prosemirror-commands'
import type { Command } from 'prosemirror-state'

import type { ListAttributes } from '../types'

import { createUnwrapListCommand } from './unwrap-list'
import { createWrapInListCommand } from './wrap-in-list'

/**
 * Returns a command function that wraps the selection in a list with the given
 * type and attributes, or change the list kind if the selection is already in
 * another kind of list, or unwrap the selected list if otherwise.
 *
 * @public @group Commands
 */
export function createToggleListCommand<
  T extends ListAttributes = ListAttributes,
>(
  /**
   * The list node attributes to toggle.
   */
  attrs: T,
): Command {
  const unwrapList = createUnwrapListCommand({ kind: attrs.kind })
  const wrapInList = createWrapInListCommand(attrs)
  return chainCommands(unwrapList, wrapInList)
}