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'
}

See source

Properties

class : string

The CSS class used on the <mark> element in the view. It should match the color setting.

See source (with github icon)
color : string

The 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.

See source (with github icon)
model : string

The unique attribute value in the model.

See source (with github icon)
title : string

The user-readable title of the option.

See source (with github icon)
type : 'marker' | 'pen'

module:highlight/highlightconfig~HighlightOption#type
The type of highlighter:
- 'marker' – Uses the color as the background-color style,
- 'pen' – Uses the color as the font color style.
See source (with github icon)