IndentUsingClasses (indent/indentcommandbehavior)
@ckeditor/ckeditor5-indent/src/indentcommandbehavior/indentusingclasses
class
The block indentation behavior that uses classes to set indentation.
Filtering
Properties
-
classes : Array<string>
module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses#classes
A list of classes used for indentation.
-
isForward : boolean
module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses#isForward
The direction of indentation.
Methods
-
constructor( config = { config.classes, config.direction } )
module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses#constructor
Creates an instance of the indentation behavior.
Parameters
config : object
-
Properties
config.classes : Array<string>
A list of classes used for indentation.
config.direction : 'forward' | 'backward'
The direction of indentation.
-
checkEnabled( indentAttributeValue ) → boolean
module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses#checkEnabled
Checks if the command should be enabled.
Parameters
indentAttributeValue : string
Returns
boolean
-
getNextIndent( indentAttributeValue ) → undefined | string
module:indent/indentcommandbehavior/indentusingclasses~IndentUsingClasses#getNextIndent
Returns a new indent attribute value based on the current indent. This method returns
undefined
when the indentation should be removed.Parameters
indentAttributeValue : string
Returns
undefined | string
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.