Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AutoFormatPlugin

Auto Format plugin handles auto formatting, such as transforming * characters into a bullet list. It can be customized with options to enable or disable auto list features.

Hierarchy

  • AutoFormatPlugin

Implements

Index

Constructors

Methods

Constructors

constructor

  • Parameters

    • options: AutoFormatOptions = ...

      An optional parameter that takes in an object of type AutoFormatOptions, which includes the following properties:

      • autoBullet: A boolean that enables or disables automatic bullet list formatting. Defaults to false.
      • autoNumbering: A boolean that enables or disables automatic numbering formatting. Defaults to false.
      • autoHyphen: A boolean that enables or disables automatic hyphen transformation. Defaults to false.
      • autoFraction: A boolean that enables or disables automatic fraction transformation. Defaults to false.
      • autoOrdinals: A boolean that enables or disables automatic ordinal number transformation. Defaults to false.
      • autoLink: A boolean that enables or disables automatic hyperlink url address creation when pasting or typing content. Defaults to false.
      • autoUnlink: A boolean that enables or disables automatic hyperlink removal when pressing backspace. Defaults to false.
      • autoTel: A boolean that enables or disables automatic hyperlink telephone numbers transformation. Defaults to false.
      • autoMailto: A boolean that enables or disables automatic hyperlink email address transformation. Defaults to false.

    Returns AutoFormatPlugin

Methods

dispose

  • dispose(): void

  • The last method that editor will call to a plugin before it is disposed. Plugin can take this chance to clear the reference to editor. After this method is called, plugin should not call to any editor method since it will result in error.

    Returns void

getName

  • getName(): string

initialize

  • initialize(editor: IEditor): void

  • The first method that editor will call to a plugin when editor is initializing. It will pass in the editor instance, plugin should take this chance to save the editor reference so that it can call to any editor method or format API later.

    Parameters

    • editor: IEditor

      The editor object

    Returns void

onPluginEvent

Generated using TypeDoc