html-support/utils

@ckeditor/ckeditor5-html-support/src/utils

Interfaces

• GHSViewAttributesmodule:html-support/utils~GHSViewAttributes

Functions

• getHtmlAttributeName( viewElementName ) → stringmodule:html-support/utils~getHtmlAttributeName

  See source

  Returns the attribute name of the model element that holds raw HTML attributes.

  Parameters

  viewElementName : string

  Returns

  string

• mergeViewElementAttributes( target, source ) → GHSViewAttributesmodule:html-support/utils~mergeViewElementAttributes

  See source

  Merges view element attribute objects.

  Parameters

  target : GHSViewAttributes

  source : GHSViewAttributes

  Returns

  GHSViewAttributes

• modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → voidmodule:html-support/utils~modifyGhsAttribute

  See source

  Updates a GHS attribute on a specified item.

  Parameters

  writer : Writer

  item : DocumentSelection | Item

  ghsAttributeName : string

  subject : 'attributes'

  callback : ModifyGhsAttributesCallback

  That receives a map as an argument and should modify it (add or remove entries).

  Returns

  void

• modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → voidmodule:html-support/utils~modifyGhsAttribute

  See source

  Updates a GHS attribute on a specified item.

  Parameters

  writer : Writer

  item : DocumentSelection | Item

  ghsAttributeName : string

  subject : 'styles'

  callback : ModifyGhsStylesCallback

  That receives a map as an argument and should modify it (add or remove entries).

  Returns

  void

• modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → voidmodule:html-support/utils~modifyGhsAttribute

  See source

  Updates a GHS attribute on a specified item.

  Parameters

  writer : Writer

  item : DocumentSelection | Item

  ghsAttributeName : string

  subject : 'classes'

  callback : ModifyGhsClassesCallback

  That receives a set as an argument and should modify it (add or remove entries).

  Returns

  void

• removeViewAttributes( writer, viewAttributes, viewElement ) → voidmodule:html-support/utils~removeViewAttributes

  See source

  Helper function for the downcast converter. Removes attributes on the given view element.

  Parameters

  writer : DowncastWriter

  The view writer.

  viewAttributes : GHSViewAttributes

  The GHS attribute value.

  viewElement : Element

  The view element to update.

  Returns

  void

• setViewAttributes( writer, viewAttributes, viewElement ) → voidmodule:html-support/utils~setViewAttributes

  See source

  Helper function for the downcast converter. Sets attributes on the given view element.

  Parameters

  writer : DowncastWriter

  The view writer.

  viewAttributes : GHSViewAttributes

  The GHS attribute value.

  viewElement : Element

  The view element to update.

  Returns

  void

• toPascalCase( data ) → stringmodule:html-support/utils~toPascalCase

  See source

  Transforms passed string to PascalCase format. Examples:

  • div => Div
  • h1 => H1
  • table => Table

  Parameters

  data : string

  Returns

  string

• updateViewAttributes( writer, oldViewAttributes, newViewAttributes, viewElement ) → voidmodule:html-support/utils~updateViewAttributes

  See source

  Helper function for the downcast converter. Updates attributes on the given view element.

  Parameters

  writer : DowncastWriter

  The view writer.

  oldViewAttributes : GHSViewAttributes

  The previous GHS attribute value.

  newViewAttributes : GHSViewAttributes

  The current GHS attribute value.

  viewElement : Element

  The view element to update.

  Returns

  void