font/utils
@ckeditor/ckeditor5-font/src/utils
Filtering
Constants
-
FONT_BACKGROUND_COLOR : 'fontBackgroundColor'module:font/utils~FONT_BACKGROUND_COLORThe name of the font background color plugin.
-
FONT_COLOR : 'fontColor'module:font/utils~FONT_COLORThe name of the font color plugin.
-
FONT_FAMILY : 'fontFamily'module:font/utils~FONT_FAMILYThe name of the font family plugin.
-
FONT_SIZE : 'fontSize'module:font/utils~FONT_SIZEThe name of the font size plugin.
Type Definitions
-
ColorSelectorDropdownViewmodule:font/utils~ColorSelectorDropdownView -
FontConverterDefinitionmodule:font/utils~FontConverterDefinition
Functions
-
addColorSelectorToDropdown( options = { options.colorPickerLabel, options.colorPickerViewConfig, options.colors, options.columns, [options.documentColorsCount], [options.documentColorsLabel], options.dropdownView, options.removeButtonLabel } ) → ColorSelectorViewmodule:font/utils~addColorSelectorToDropdownA helper that adds
ColorSelectorViewto the color dropdown with proper initial values.Parameters
options : objectConfiguration options
Propertiesoptions.colorPickerLabel : stringThe label for the color picker button.
options.colorPickerViewConfig : false | ColorPickerViewConfigConfiguration of the color picker view.
options.colors : Array<ColorDefinition>An array with definitions representing colors to be displayed in the color selector.
options.columns : numberThe number of columns in the color grid.
[ options.documentColorsCount ] : numberThe number of document colors inside the dropdown.
[ options.documentColorsLabel ] : stringThe label for the section with document colors.
options.dropdownView : ColorSelectorDropdownViewThe dropdown view to which a
ColorSelectorViewwill be added.options.removeButtonLabel : stringThe label for the button responsible for removing the color.
Returns
ColorSelectorViewThe new color selector view.
-
buildDefinition( modelAttributeKey, options ) → FontConverterDefinitionmodule:font/utils~buildDefinitionBuilds a proper converter definition out of input data.
Parameters
modelAttributeKey : stringoptions : Array<FontFamilyOption> | Array<FontSizeOption>
Returns
-
renderDowncastElement( styleAttr ) → ( modelAttributeValue: string, __namedParameters: DowncastConversionApi ) => AttributeElementmodule:font/utils~renderDowncastElementA font color and font background color helper responsible for downcasting a color attribute to a
<span>element.Note: The
styleAttrparameter should be either'color'or'background-color'.Parameters
styleAttr : string
Returns
( modelAttributeValue: string, __namedParameters: DowncastConversionApi ) => AttributeElement
-
renderUpcastAttribute( styleAttr ) → ( viewElement: Element ) => stringmodule:font/utils~renderUpcastAttributeA font color and font background color helper responsible for upcasting data to the model.
Note: The
styleAttrparameter should be either'color'or'background-color'.Parameters
styleAttr : string
Returns
( viewElement: Element ) => string
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.