CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Typedef

FormatData (track-changes)

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

typedefobject

Command parameters and additional suggestion parameters. Passed value is also saved in Suggestion#data property.

Filtering

Properties

  • [i: string] : unknown

  • commandName : string

    Name of the command to execute when the suggestion is accepted.

  • commandParams : Array<any>

    Parameters with which the command should be executed.

  • formatGroupId : string | undefined

    Additional grouping parameter for suggestions. If a suggestion would be set on an element which already has a different suggestion with the same formatGroupId, the new suggestion will overwrite the old one (the old one will be removed). Defaults to commandName parameter, so different suggestions of the same command overwrite each other. Using this parameter you might expand this behavior so that multiple commands overwrite each other.

  • multipleBlocks : boolean | undefined

    True when format suggestion uses ranges.