prosemirror-flat-list/src/plugins/index.ts

Powerful list support for ProseMirror

import type { Schema } from 'prosemirror-model'
import type { Plugin } from 'prosemirror-state'

import { createListClipboardPlugin } from './clipboard'
import { createListEventPlugin } from './event'
import { createListRenderingPlugin } from './rendering'
import { createSafariInputMethodWorkaroundPlugin } from './safari-workaround'

/**
 * This function returns an array of plugins that are required for list to work.
 *
 * The plugins are shown below. You can pick and choose which plugins you want
 * to use if you want to customize some behavior.
 *
 * - {@link createListEventPlugin}
 * - {@link createListRenderingPlugin}
 * - {@link createListClipboardPlugin}
 * - {@link createSafariInputMethodWorkaroundPlugin}
 *
 * @public @group Plugins
 */
export function createListPlugins(options: { schema: Schema }): Plugin[] {
  const { schema } = options
  return [
    createListEventPlugin(),
    createListRenderingPlugin(),
    createListClipboardPlugin(schema),
    createSafariInputMethodWorkaroundPlugin(),
  ]
}

export {
  createListEventPlugin,
  createListClipboardPlugin,
  createListRenderingPlugin,
  createSafariInputMethodWorkaroundPlugin,
}