HighlightOption
interface
The highlight option descriptor. See HighlightConfig to learn more.
{
model: 'pinkMarker',
class: 'marker-pink',
title: 'Pink Marker',
color: 'var(--ck-content-highlight-marker-pink)',
type: 'marker'
}
Copy code
Properties
class : stringmodule:highlight/highlightconfig~HighlightOption#classThe CSS class used on the
<mark>element in the view. It should match thecolorsetting.color : stringmodule:highlight/highlightconfig~HighlightOption#colorThe CSS
var()used for the highlighter. The color is used in the user interface to represent the highlighter. There is a possibility to use the default color format like rgb, hex or hsl, but you need to care about the color of<mark>by adding CSS classes definition.model : stringmodule:highlight/highlightconfig~HighlightOption#modelThe unique attribute value in the model.
title : stringmodule:highlight/highlightconfig~HighlightOption#titleThe user-readable title of the option.
type : 'marker' | 'pen'module:highlight/highlightconfig~HighlightOption#typeThe type of highlighter:
'marker'– Uses thecoloras thebackground-colorstyle,'pen'– Uses thecoloras the fontcolorstyle.