html-support/utils
Interfaces
-
module:html-support/utils~GHSViewAttributes
Functions
-
getHtmlAttributeName( viewElementName ) → string
internalmodule:html-support/utils~getHtmlAttributeName
Returns the attribute name of the model element that holds raw HTML attributes.
Parameters
viewElementName : string
Returns
string
-
mergeViewElementAttributes( target, source ) → GHSViewAttributes
internalmodule:html-support/utils~mergeViewElementAttributes
Merges view element attribute objects.
Parameters
target : GHSViewAttributes
source : GHSViewAttributes
Returns
-
modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → void
internalmodule:html-support/utils~modifyGhsAttribute
Updates a GHS attribute on a specified item.
Parameters
writer : ModelWriter
item : ModelDocumentSelection | ModelItem
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 ) → void
module:html-support/utils~modifyGhsAttribute
Updates a GHS attribute on a specified item.
Parameters
writer : ModelWriter
item : ModelDocumentSelection | ModelItem
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 ) → void
internalmodule:html-support/utils~modifyGhsAttribute
Updates a GHS attribute on a specified item.
Parameters
writer : ModelWriter
item : ModelDocumentSelection | ModelItem
ghsAttributeName : string
subject : 'classes'
callback : ModifyGhsClassesCallback
That receives a set as an argument and should modify it (add or remove entries).
Returns
void
-
removeFormatting( ghsAttributeName, itemRange, writer ) → void
internalmodule:html-support/utils~removeFormatting
Strips the
styles
, andclasses
keys from the GHS attribute value on the given item.Parameters
ghsAttributeName : string
itemRange : ModelRange
writer : ModelWriter
Returns
void
-
removeViewAttributes( writer, viewAttributes, viewElement ) → void
internalmodule:html-support/utils~removeViewAttributes
Helper function for the downcast converter. Removes attributes on the given view element.
Parameters
writer : ViewDowncastWriter
The view writer.
viewAttributes : GHSViewAttributes
The GHS attribute value.
viewElement : ViewElement
The view element to update.
Returns
void
-
setViewAttributes( writer, viewAttributes, viewElement ) → void
internalmodule:html-support/utils~setViewAttributes
Helper function for the downcast converter. Sets attributes on the given view element.
Parameters
writer : ViewDowncastWriter
The view writer.
viewAttributes : GHSViewAttributes
The GHS attribute value.
viewElement : ViewElement
The view element to update.
Returns
void
-
toPascalCase( data ) → string
internalmodule:html-support/utils~toPascalCase
Transforms passed string to PascalCase format. Examples:
div
=>Div
h1
=>H1
table
=>Table
Parameters
data : string
Returns
string
-
updateViewAttributes( writer, oldViewAttributes, newViewAttributes, viewElement ) → void
internalmodule:html-support/utils~updateViewAttributes
Helper function for the downcast converter. Updates attributes on the given view element.
Parameters
writer : ViewDowncastWriter
The view writer.
oldViewAttributes : GHSViewAttributes
The previous GHS attribute value.
newViewAttributes : GHSViewAttributes
The current GHS attribute value.
viewElement : ViewElement
The view element to update.
Returns
void