html-support/converters
@ckeditor/ckeditor5-html-support/src/converters
Filtering
Functions
-
attributeToViewInlineConverter( __namedParameters ) → ( any, DowncastConversionApi ) => ( undefined | AttributeElement )module:html-support/converters~attributeToViewInlineConverterAttribute-to-view conversion helper applying attributes to view element preserved on
$text.Parameters
__namedParameters : DataSchemaInlineElementDefinition
Returns
( any, DowncastConversionApi ) => ( undefined | AttributeElement )Returns a conversion callback.
-
createObjectView( viewName, modelElement, writer ) → Elementmodule:html-support/converters~createObjectViewCreates object view element from the given model element.
Parameters
viewName : stringmodelElement : Elementwriter : DowncastWriter
Returns
-
emptyInlineModelElementToViewConverter( __namedParameters, [ asWidget ] ) → ElementCreatorFunctionmodule:html-support/converters~emptyInlineModelElementToViewConverterConversion helper converting an empty inline model element to an HTML element or widget.
Parameters
__namedParameters : DataSchemaInlineElementDefinition[ asWidget ] : boolean
Returns
-
modelToViewBlockAttributeConverter( __namedParameters ) → ( DowncastDispatcher ) => voidmodule:html-support/converters~modelToViewBlockAttributeConverterModel-to-view conversion helper applying attributes preserved in
html*Attributesattribute for block elements.Parameters
__namedParameters : DataSchemaBlockElementDefinition
Returns
( DowncastDispatcher ) => voidReturns a conversion callback.
-
toObjectWidgetConverter( editor, __namedParameters ) → ElementCreatorFunctionmodule:html-support/converters~toObjectWidgetConverterConversion helper converting an object element to an HTML object widget.
Parameters
editor : Editor__namedParameters : DataSchemaInlineElementDefinition
Returns
ElementCreatorFunctionReturns a conversion callback.
-
viewToAttributeInlineConverter( __namedParameters, dataFilter ) → ( UpcastDispatcher ) => voidmodule:html-support/converters~viewToAttributeInlineConverterView-to-attribute conversion helper preserving inline element attributes on
$text.Parameters
__namedParameters : DataSchemaInlineElementDefinitiondataFilter : DataFilter
Returns
( UpcastDispatcher ) => voidReturns a conversion callback.
-
viewToModelBlockAttributeConverter( __namedParameters, dataFilter ) → ( UpcastDispatcher ) => voidmodule:html-support/converters~viewToModelBlockAttributeConverterView-to-model conversion helper preserving allowed attributes on block element.
All matched attributes will be preserved on
html*Attributesattribute.Parameters
__namedParameters : DataSchemaBlockElementDefinitiondataFilter : DataFilter
Returns
( UpcastDispatcher ) => voidReturns a conversion callback.
-
viewToModelObjectConverter( __namedParameters ) → ( Element, UpcastConversionApi ) => Elementmodule:html-support/converters~viewToModelObjectConverterView-to-model conversion helper for object elements.
Preserves object element content in
htmlContentattribute.Parameters
__namedParameters : DataSchemaDefinition
Returns
( Element, UpcastConversionApi ) => ElementReturns a conversion callback.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.