link/utils

Adds the protocol prefix to the specified link when:

• it does not contain it already, and there is a defaultProtocol configuration value provided,
• or the link is an email address.

Parameters

link : string

[ defaultProtocol ] : string

Returns

string

Creates a link ViewAttributeElement with the provided href attribute.

Parameters

href : string

__namedParameters : DowncastConversionApi

Returns

ViewAttributeElement

Returns a safe URL based on a given value.

A URL is considered safe if it is safe for the user (does not contain any malicious code).

If a URL is considered unsafe, a simple "#" is returned.

Parameters

url : unknown

allowedProtocols : Array<string>

Defaults to DEFAULT_LINK_PROTOCOLS

Returns

string

Returns a text of a link range.

If the returned value is undefined, the range contains elements other than text nodes.

Parameters

range : ModelRange

Returns

undefined | string

Returns the config.link.decorators configuration processed to respect the locale of the editor, i.e. to display the label in the correct language.

Note: Only the few most commonly used labels are translated automatically. Other labels should be manually translated in the config.link.decorators configuration.

Parameters

t : LocaleTranslate

Shorthand for Locale#t.

decorators : Array<NormalizedLinkDecoratorDefinition>

The decorator reference where the label values should be localized.

Returns

Array<NormalizedLinkDecoratorDefinition>

Returns true if the specified value is an email.

Parameters

value : string

Returns

boolean

Returns true if a given view node is the link element.

Parameters

node : ViewNode | ViewDocumentFragment

Returns

boolean

Returns true if the specified element can be linked (the element allows the linkHref attribute).

Parameters

element : null | ModelElement

schema : ModelSchema

Returns

element is ModelElement

Checks if protocol is already included in the link.

Parameters

link : string

Returns

boolean

Converts an object with defined decorators to a normalized array of decorators. The id key is added for each decorator and is used as the attribute's name in the model.

Parameters

[ decorators ] : Record<string, LinkDecoratorDefinition>

Returns

Array<NormalizedLinkDecoratorDefinition>

Opens the link in a new browser tab.

Parameters

link : string

Returns

void