html-support/utils
Interfaces
module:html-support/utils~GHSViewAttributes
Functions
getHtmlAttributeName( viewElementName ) → stringinternalmodule:html-support/utils~getHtmlAttributeNameReturns the attribute name of the model element that holds raw HTML attributes.
Parameters
viewElementName : string
Returns
string
mergeViewElementAttributes( target, source ) → GHSViewAttributesinternalmodule:html-support/utils~mergeViewElementAttributesMerges view element attribute objects.
Parameters
target : GHSViewAttributessource : GHSViewAttributes
Returns
modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → voidinternalmodule:html-support/utils~modifyGhsAttributeUpdates a GHS attribute on a specified item.
Parameters
writer : ModelWriteritem : ModelDocumentSelection | ModelItemghsAttributeName : stringsubject : 'attributes'callback : ModifyGhsAttributesCallbackThat 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~modifyGhsAttributeUpdates a GHS attribute on a specified item.
Parameters
writer : ModelWriteritem : ModelDocumentSelection | ModelItemghsAttributeName : stringsubject : 'styles'callback : ModifyGhsStylesCallbackThat receives a map as an argument and should modify it (add or remove entries).
Returns
void
modifyGhsAttribute( writer, item, ghsAttributeName, subject, callback ) → voidinternalmodule:html-support/utils~modifyGhsAttributeUpdates a GHS attribute on a specified item.
Parameters
writer : ModelWriteritem : ModelDocumentSelection | ModelItemghsAttributeName : stringsubject : 'classes'callback : ModifyGhsClassesCallbackThat receives a set as an argument and should modify it (add or remove entries).
Returns
void
removeFormatting( ghsAttributeName, itemRange, writer ) → voidinternalmodule:html-support/utils~removeFormattingStrips the
styles, andclasseskeys from the GHS attribute value on the given item.Parameters
ghsAttributeName : stringitemRange : ModelRangewriter : ModelWriter
Returns
void
removeViewAttributes( writer, viewAttributes, viewElement ) → voidinternalmodule:html-support/utils~removeViewAttributesHelper function for the downcast converter. Removes attributes on the given view element.
Parameters
writer : ViewDowncastWriterThe view writer.
viewAttributes : GHSViewAttributesThe GHS attribute value.
viewElement : ViewElementThe view element to update.
Returns
void
setViewAttributes( writer, viewAttributes, viewElement ) → voidinternalmodule:html-support/utils~setViewAttributesHelper function for the downcast converter. Sets attributes on the given view element.
Parameters
writer : ViewDowncastWriterThe view writer.
viewAttributes : GHSViewAttributesThe GHS attribute value.
viewElement : ViewElementThe view element to update.
Returns
void
toPascalCase( data ) → stringinternalmodule:html-support/utils~toPascalCaseTransforms passed string to PascalCase format. Examples:
div=>Divh1=>H1table=>Table
Parameters
data : string
Returns
string
updateViewAttributes( writer, oldViewAttributes, newViewAttributes, viewElement ) → voidinternalmodule:html-support/utils~updateViewAttributesHelper function for the downcast converter. Updates attributes on the given view element.
Parameters
writer : ViewDowncastWriterThe view writer.
oldViewAttributes : GHSViewAttributesThe previous GHS attribute value.
newViewAttributes : GHSViewAttributesThe current GHS attribute value.
viewElement : ViewElementThe view element to update.
Returns
void