font/utils

@ckeditor/ckeditor5-font/src/utils

Constants

• FONT_BACKGROUND_COLORmodule:font/utils.FONT_BACKGROUND_COLOR

  static

  The name of the font background color plugin.

  See source

• FONT_COLORmodule:font/utils.FONT_COLOR

  static

  The name of the font color plugin.

  See source

• FONT_FAMILYmodule:font/utils.FONT_FAMILY

  static

  The name of the font family plugin.

  See source

• FONT_SIZEmodule:font/utils.FONT_SIZE

  static

  The name of the font size plugin.

  See source

Functions

• addColorTableToDropdown( config = { config.dropdownView, config.colors, config.removeButtonLabel, config.documentColorsLabel, config.documentColorsCount } ) → ColorTableViewmodule:font/utils.addColorTableToDropdown

  static

  A helper that adds ColorTableView to the color dropdown with proper initial values.

  See source

  Parameters

  config : Object

  The configuration object.

  Properties

  config.dropdownView : DropdownView

  The dropdown view to which a ColorTableView will be added.

  config.colors : Array.<ColorDefinition>

  An array with definitions representing colors to be displayed in the color table.

  config.removeButtonLabel : String

  The label for the button responsible for removing the color.

  config.documentColorsLabel : String

  The label for the section with document colors.

  config.documentColorsCount : String

  The number of document colors inside the dropdown.

  Returns

  ColorTableView

  The new color table view.

• buildDefinition( modelAttributeKey, options ) → ConverterDefinitionmodule:font/utils.buildDefinition

  static

  Builds a proper converter definition out of input data.

  See source

  Parameters

  modelAttributeKey : String

  Key

  options : Array.<FontFamilyOption> | Array.<FontSizeOption>

  Returns

  ConverterDefinition

• renderDowncastElement( styleAttr )module:font/utils.renderDowncastElement

  static

  A font color and font background color helper responsible for downcasting a color attribute to a <span> element.

  See source

  Note: The styleAttr parameter should be either 'color' or 'background-color'.

  Parameters

  styleAttr : String

• renderUpcastAttribute( styleAttr ) → Stringmodule:font/utils.renderUpcastAttribute

  static

  A font color and font background color helper responsible for upcasting data to the model.

  See source

  Note: The styleAttr parameter should be either 'color' or 'background-color'.

  Parameters

  styleAttr : String

  Returns

  String