LinkDecoratorManualDefinition

interface

Describes a manual link decorator. This decorator type is represented in the link feature's user interface as a switch that the user can use to control the presence of a predefined set of attributes.

For instance, to allow the users to manually control the presence of the target="_blank" and rel="noopener noreferrer" attributes on specific links, the decorator could look as follows:

{
	mode: 'manual',
	label: 'Open in a new tab',
	defaultValue: true,
	attributes: {
		target: '_blank',
		rel: 'noopener noreferrer'
	}
}

See source

Properties

attributes : Record<string, string> | undefined

Key-value pairs used as link attributes added to the output during the downcasting. Attributes should follow the ViewElementDefinition syntax.

See source (with github icon)
classes : ArrayOrItem<string> | undefined

Class names used as link classes added to the output during the downcasting. Classes should follow the ViewElementDefinition syntax.

See source (with github icon)
defaultValue : boolean | undefined

Controls whether the decorator is "on" by default.

See source (with github icon)
label : string

The label of the UI button that the user can use to control the presence of link attributes.

See source (with github icon)
mode : 'manual'

Link decorator type. It is 'manual' for all manual decorators.

See source (with github icon)
styles : Record<string, string> | undefined

Key-value pairs used as link styles added to the output during the downcasting. Styles should follow the ViewElementDefinition syntax.

See source (with github icon)

LinkDecoratorManualDefinition

Properties

`attributes : Record<string, string> | undefined`

`classes : ArrayOrItem<string> | undefined`

`defaultValue : boolean | undefined`

`label : string`

`mode : 'manual'`

`styles : Record<string, string> | undefined`