ViewElementConsumables (engine/conversion)
@ckeditor/ckeditor5-engine/src/conversion/viewconsumable
This is a private helper-class for ViewConsumable.
It represents and manipulates consumable parts of a single Element.
Filtering
Properties
-
readonly
element : Node | DocumentFragmentmodule:engine/conversion/viewconsumable~ViewElementConsumables#element -
private
_canConsumeName : null | booleanmodule:engine/conversion/viewconsumable~ViewElementConsumables#_canConsumeNameFlag indicating if name of the element can be consumed.
-
private readonly
_consumables : Record<'attributes' | 'classes' | 'styles', Map<string, boolean>>module:engine/conversion/viewconsumable~ViewElementConsumables#_consumablesContains maps of element's consumables: attributes, classes and styles.
Methods
-
constructor( from )module:engine/conversion/viewconsumable~ViewElementConsumables#constructorCreates ViewElementConsumables instance.
Parameters
from : Node | DocumentFragmentView node or document fragment from which
ViewElementConsumablesis being created.
-
add( consumables ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#addAdds consumable parts of the view element. Element's name itself can be marked to be consumed (when element's name is consumed its attributes, classes and styles still could be consumed):
consumables.add( { name: true } );Attributes classes and styles:
consumables.add( { attributes: 'title', classes: 'foo', styles: 'color' } ); consumables.add( { attributes: [ 'title', 'name' ], classes: [ 'foo', 'bar' ] );Throws CKEditorError
viewconsumable-invalid-attributewhenclassorstyleattribute is provided - it should be handled separately by providingstyleandclassin consumables object.Parameters
consumables : ConsumablesObject describing which parts of the element can be consumed.
Returns
void
-
consume( consumables ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#consumeConsumes parts of view element. This function does not check if consumable item is already consumed - it consumes all consumable items provided. Element's name can be consumed:
consumables.consume( { name: true } );Attributes classes and styles:
consumables.consume( { attributes: 'title', classes: 'foo', styles: 'color' } ); consumables.consume( { attributes: [ 'title', 'name' ], classes: [ 'foo', 'bar' ] );Parameters
consumables : Match | ConsumablesObject describing which parts of the element should be consumed.
Returns
void
-
revert( consumables ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#revertRevert already consumed parts of view Element, so they can be consumed once again. Element's name can be reverted:
consumables.revert( { name: true } );Attributes classes and styles:
consumables.revert( { attributes: 'title', classes: 'foo', styles: 'color' } ); consumables.revert( { attributes: [ 'title', 'name' ], classes: [ 'foo', 'bar' ] );Parameters
consumables : ConsumablesObject describing which parts of the element should be reverted.
Returns
void
-
test( consumables ) → null | booleanmodule:engine/conversion/viewconsumable~ViewElementConsumables#testTests if parts of the view node can be consumed.
Element's name can be tested:
consumables.test( { name: true } );Attributes classes and styles:
consumables.test( { attributes: 'title', classes: 'foo', styles: 'color' } ); consumables.test( { attributes: [ 'title', 'name' ], classes: [ 'foo', 'bar' ] );Parameters
consumables : Match | ConsumablesObject describing which parts of the element should be tested.
Returns
null | booleantruewhen all tested items can be consumed,nullwhen even one of the items was never marked for consumption andfalsewhen even one of the items was already consumed.
-
private
_add( type, item ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#_addHelper method that adds consumables of a given type: attribute, class or style.
Throws CKEditorError
viewconsumable-invalid-attributewhenclassorstyletype is provided - it should be handled separately by providing actual style/class type.Parameters
type : 'attributes' | 'classes' | 'styles'Type of the consumable item:
attributes,classesorstyles.item : ArrayOrItem<string>Consumable item or array of items.
Returns
void
-
private
_consume( type, item ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#_consumeHelper method that consumes items of a given type: attribute, class or style.
Parameters
type : 'attributes' | 'classes' | 'styles'Type of the consumable item:
attributes,classesorstyles.item : ArrayOrItem<string>Consumable item or array of items.
Returns
void
-
private
_revert( type, item ) → voidmodule:engine/conversion/viewconsumable~ViewElementConsumables#_revertHelper method that reverts items of a given type: attribute, class or style.
Parameters
type : 'attributes' | 'classes' | 'styles'Type of the consumable item:
attributes,classesor ,styles.item : ArrayOrItem<string>Consumable item or array of items.
Returns
void
-
private
_test( type, item ) → null | booleanmodule:engine/conversion/viewconsumable~ViewElementConsumables#_testHelper method that tests consumables of a given type: attribute, class or style.
Parameters
type : 'attributes' | 'classes' | 'styles'Type of the consumable item:
attributes,classesorstyles.item : ArrayOrItem<string>Consumable item or array of items.
Returns
null | booleanReturns
trueif all items can be consumed,nullwhen one of the items cannot be consumed andfalsewhen one of the items is already consumed.
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.