IndentUsingOffset (indent/indentcommandbehavior)
@ckeditor/ckeditor5-indent/src/indentcommandbehavior/indentusingoffset
The block indentation behavior that uses offsets to set indentation.
Filtering
Properties
-
isForward : boolean
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#isForward
The direction of indentation.
-
offset : number
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#offset
The offset of the next indentation step.
-
unit : string
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#unit
Indentation unit.
Methods
-
constructor( config = { config.direction, config.offset, config.unit } )
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#constructor
Creates an instance of the indentation behavior.
Parameters
config : object
-
Properties
config.direction : 'forward' | 'backward'
The direction of indentation.
config.offset : number
The offset of the next indentation step.
config.unit : string
Indentation unit.
-
checkEnabled( indentAttributeValue ) → boolean
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#checkEnabled
Checks if the command should be enabled.
Parameters
indentAttributeValue : string
Returns
boolean
-
getNextIndent( indentAttributeValue ) → undefined | string
module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#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.