Scribe configuration options

This documentation is based on the 3.2.0 release.

allowBlockElements

Boolean, default true

Enable/disable block element mode.

undo

Configuration object, defaults to:

{
  manager: false,
  enabled: true,
  limit: 100,
  interval: 250
}

You can use the enabled flag to enable/disable Scribe's custom Undo Manager:

undo: {
  enabled: false // disables Scribe's Undo Manager
}

defaultCommandPatches

Array of strings, defaults to:

[
  'bold',
  'indent',
  'insertHTML',
  'insertList',
  'outdent',
  'createLink'
]

Defines which command patches should be loaded by default. You can use this option to load only a subset of the default command patches.

defaultFormatters

Array of strings, defaults to:

[
  'escapeHtmlCharactersFormatter',
  'replaceNbspCharsFormatter'
]

Defines which formatters should be loaded by default. You can use this option to load only a subset of the default formatters.

• escapeHtmlCharactersFormatter converts the characters "&", "<", ">", '"', "'", and "`" to their corresponding HTML entities;
• replaceNbspCharsFormatter replaces sequences of consecutive whitespace characters (including  ) with a single space character.

defaultPlugins

Array of strings, defaults to an array based on block element mode.

allowBlockElements: true default plugins:

[
  'setRootPElement',
  'enforcePElements',
  'ensureSelectableContainers'
]

allowBlockElements: false default plugins:

[
  'inlineElementsMode'
]

Defines which plugins should be loaded by default. You can use this option to load only a subset of the default plugins. See the source code for explanations of what each plugin does.

Credits

This documentation initially provided by Dan Burzo, thanks.