`
Returns descriptions for given suggestion chain.
The structure of the descriptions array is as follows (explained on an example):
```typescript
[
{ type: 'insertion', content: '*Insert:* 2 paragraphs' },
{ type: 'insertion', content: '*Insert:* image },
{ type: 'replace', content: '*Replace:* "Foo" *with* "Bar"' }
]
```
In above example there are three description instances (or lines). Two new (empty) paragraphs were added, an image was added and then "Foo" text was removed and "Bar" text was added. For example, above structure could be rendered as:
```html
Insert: 2 paragraphs
Insert: image
Replace: "Foo" with "Bar"
```
#### Parameters
* `suggestions: Array`
#### Returns
* `Array`
### `getItemLabel( element, quantity ) → string`
Returns label registered for given element or the element name if there is no label registered for it.
#### Parameters
* `element: ModelElement`
* `quantity: number`
Defaults to `1`
#### Returns
* `string`
### `registerAttributeLabel( attributeName, attributeLabel ) → void`
For given `attributeName` registers how this attribute will be labeled in a description (for example when it is added or removed).
Example usage with internationalization:
```typescript
const t = editor.locale.t; // Remember that you have to use function named `t`.
suggestionDescriptionFactory.registerAttributeLabel(
'bold',
t( 'bold' )
);
```
#### Parameters
* `attributeName: string`
* `attributeLabel: string`
#### Returns
* `void`
### `registerDescriptionCallback( callback ) → void`
Registers a callback function that returns a custom description for a suggestion.
Registered callback is fired for a suggestion whenever there is a need to generate a description for that suggestion.
The callback takes the suggestion instance as a parameter and should return [description object](module_track-changes_suggestiondescriptionfactory-SuggestionDescription.md) or a falsy value if the suggestion was not handled by the callback.
Example of a description callback for the bold style:
```typescript
suggestionDescriptionFactory.registerDescriptionCallback( suggestion => {
const { data } = suggestion;
// Omit suggestions that are not bold style suggestions.
if ( !data || data.commandName !== 'bold' ) {
return;
}
const isSet = !!data.commandParams[ 0 ].forceValue;
const content = isSet ? '*Set format:* bold' : '*Remove format:* bold';
return {
type: 'format',
content
};
} );
```
#### Parameters
* `callback: SuggestionDescriptionCallback`
#### Returns
* `void`
### `registerElementLabel( elementNameOrCallback, labelCallback, priority ) → void`
For given `elementName` registers how this element will be labeled in a description (for example when it is added or removed).
Instead of a string name you may provide a matching function that takes item [`ModelItem`](module_engine_model_item-ModelItem.md) as an input and should return boolean value.
Provided label callback takes one parameter, `quantity`, and is expected to return the label for the element as a string.
A simple use case without using internationalization:
```typescript
suggestionDescriptionFactory.registerElementLabel(
'paragraph',
quantity => quantity == 1 ? 'paragraph' : quantity + ' paragraphs'
);
```
If you want your feature to be localized to other languages, use localization service:
```typescript
const t = editor.locale.t; // Remember that you have to use function named `t`.
suggestionDescriptionFactory.registerElementLabel(
'paragraph',
quantity => t( { string: 'paragraph', plural: '%0 paragraphs', id: 'ELEMENT_PARAGRAPH' }, quantity )
);
```
#### Parameters
* `elementNameOrCallback: string | Function`
* `labelCallback: SuggestionLabelCallback`
* `priority: PriorityString`
Defaults to `priorities.normal`
#### Returns
* `void`
---
Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)