Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Variables

defaultPlugins: { inputRules: Plugin<{}>; keyMaps: Plugin<any>; menu: Plugin<any>; isDirty: Plugin<boolean>; baseKeyMap: Plugin<any>; dropCursor: Plugin<any>; gapCursor: Plugin<any>; history: Plugin<any>; tables: Plugin<any> } = ...

Type declaration

  • inputRules: Plugin<{}>
  • keyMaps: Plugin<any>
  • menu: Plugin<any>
  • isDirty: Plugin<boolean>
  • baseKeyMap: Plugin<any>
  • dropCursor: Plugin<any>
  • gapCursor: Plugin<any>
  • history: Plugin<any>
  • tables: Plugin<any>
dom: { parser: any; serializer: DOMSerializer; parseString: ((htmlString: string, schema: Schema) => Node); serializeString: ((doc: Node, [options]?: { schema: Schema; spaces: string | number }) => string) } = ...

Type declaration

  • parser: any
  • serializer: DOMSerializer
  • parseString: ((htmlString: string, schema: Schema) => Node)
      • (htmlString: string, schema: Schema): Node
      • Use the DOM and ProseMirror's DOMParser to construct a ProseMirror document state from an HTML string. This cannot be used server-side.

        Parameters

        • htmlString: string

          A string of HTML.

        • schema: Schema

        Returns Node

        The document node.

  • serializeString: ((doc: Node, [options]?: { schema: Schema; spaces: string | number }) => string)
      • (doc: Node, [options]?: { schema: Schema; spaces: string | number }): string
      • Use the StringSerializer to convert a ProseMirror document into an HTML string. This can be used server-side.

        Parameters

        • doc: Node

          The ProseMirror document.

        • [options]: { schema: Schema; spaces: string | number } = {}

          Additional options to configure serialization behavior.

          • schema: Schema
          • spaces: string | number

        Returns string

defaultSchema: Schema<"object" | "small" | "track" | "source" | "secret" | "audio" | "blockquote" | "caption" | "dd" | "details" | "dl" | "dt" | "fieldset" | "figcaption" | "figure" | "iframe" | "legend" | "picture" | "rp" | "rt" | "ruby" | "summary" | "table" | "tbody" | "tfoot" | "thead" | "video" | "image" | "text" | "doc" | "ordered_list" | "bullet_list" | "code_block" | "heading" | "horizontal_rule" | "hard_break" | "list_item" | "paragraph" | "image_link" | "list_item_text" | "summary_block" | "caption_block" | "table_row" | "table_cell" | "table_header" | "table_cell_block" | "table_header_block", "link" | "code" | "font" | "em" | "span" | "strong" | "underline" | "strikethrough" | "superscript" | "subscript"> = ...