link/utils

@ckeditor/ckeditor5-link/src/utils

Constants

• LINK_KEYSTROKE : 'Ctrl+K'module:link/utils~LINK_KEYSTROKE

  See source

  A keystroke used by the link UI feature.

Type Definitions

• NormalizedLinkDecoratorAutomaticDefinitionmodule:link/utils~NormalizedLinkDecoratorAutomaticDefinition

• NormalizedLinkDecoratorDefinitionmodule:link/utils~NormalizedLinkDecoratorDefinition

• NormalizedLinkDecoratorManualDefinitionmodule:link/utils~NormalizedLinkDecoratorManualDefinition

Functions

• addLinkProtocolIfApplicable( link, [ defaultProtocol ] ) → stringmodule:link/utils~addLinkProtocolIfApplicable

  See source

  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

• createLinkElement( href, __namedParameters ) → ViewAttributeElementmodule:link/utils~createLinkElement

  See source

  Creates a link ViewAttributeElement with the provided href attribute.

  Parameters

  href : string

  __namedParameters : DowncastConversionApi

  Returns

  ViewAttributeElement

• internal

  ensureSafeUrl( url, allowedProtocols ) → stringmodule:link/utils~ensureSafeUrl

  See source

  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

• extractTextFromLinkRange( range ) → undefined | stringmodule:link/utils~extractTextFromLinkRange

  See source

  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

• internal

  getLocalizedDecorators( t, decorators ) → Array<NormalizedLinkDecoratorDefinition>module:link/utils~getLocalizedDecorators

  See source

  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>

• internal

  isEmail( value ) → booleanmodule:link/utils~isEmail

  See source

  Returns true if the specified value is an email.

  Parameters

  value : string

  Returns

  boolean

• isLinkElement( node ) → booleanmodule:link/utils~isLinkElement

  See source

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

  Parameters

  node : ViewNode | ViewDocumentFragment

  Returns

  boolean

• isLinkableElement( element, schema ) → element is ModelElementmodule:link/utils~isLinkableElement

  See source

  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

• internal

  linkHasProtocol( link ) → booleanmodule:link/utils~linkHasProtocol

  See source

  Checks if protocol is already included in the link.

  Parameters

  link : string

  Returns

  boolean

• internal

  normalizeDecorators( [ decorators ] ) → Array<NormalizedLinkDecoratorDefinition>module:link/utils~normalizeDecorators

  See source

  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>

• openLink( link ) → voidmodule:link/utils~openLink

  See source

  Opens the link in a new browser tab.

  Parameters

  link : string

  Returns

  void