SuggestionDescription
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'
}
}
Properties
-
color : object | undefined
module:track-changes/suggestiondescriptionfactory~SuggestionDescription#color
The optional
color
property used for color-related suggestions. The object should provide thevalue
(for displaying the color) andtitle
(for describing the color) fields. -
content : string
module:track-changes/suggestiondescriptionfactory~SuggestionDescription#content
Description label. You may use
*
to bold part of the label. -
type : 'replace' | 'format' | 'insertion' | 'deletion'
module:track-changes/suggestiondescriptionfactory~SuggestionDescription#type