Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CustomReplace

The CustomReplace interface defines a custom replacement that can be used in CustomReplacePlugin.

Hierarchy

  • CustomReplace

Index

Properties

Properties

replacementHandler

replacementHandler: (previousSegment: ContentModelText, stringToReplace: string, replacementString: string, paragraph?: ContentModelParagraph) => boolean

Type declaration

    • The handler to replace the string.

      Parameters

      • previousSegment: ContentModelText

        The text segment to replace.

      • stringToReplace: string

        The string to replace.

      • replacementString: string

        The string to replace with.

      • Optional paragraph: ContentModelParagraph

        The paragraph that contains the text segment.

      Returns boolean

      True if the string is replaced successfully, otherwise false.

replacementString

replacementString: string

The string to replace with.

stringToReplace

stringToReplace: string

The string to replace in the editor.

Generated using TypeDoc