Description (track-changes)

@ckeditor/ckeditor5-track-changes/src/suggestiondescriptionfactory

interface

A description for the suggestion.

{
		type: 'format',
		label: '*Set format:* bold'
}

A description for the color-related suggestions like font color may specify the color property that will provide a better UX by displaying a color box next to the suggestion.

{
		type: 'format',
		label: '*Set font color:*',
		color: {
			value: 'hsl( 60, 60%, 60% )',
			title: 'yellow'
		}
}

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

color : object | undefined

The optional color property used for color-related suggestions. The object should provide the value (for displaying the color) and title (for describing the color) fields.
content : string

Description label. You may use * to bold part of the label.
type : 'replace' | 'format' | 'insertion' | 'deletion'

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.

Description (track-changes)

Filtering

Properties

`color : object | undefined`

`content : string`

`type : 'replace' | 'format' | 'insertion' | 'deletion'`

Description (track-changes)

Filtering

Properties

color : object | undefinedmodule:track-changes/suggestiondescriptionfactory~Description#color

content : stringmodule:track-changes/suggestiondescriptionfactory~Description#content

type : 'replace' | 'format' | 'insertion' | 'deletion'module:track-changes/suggestiondescriptionfactory~Description#type

`color : object | undefined`

`content : string`

`type : 'replace' | 'format' | 'insertion' | 'deletion'`