IndentUsingOffset (indent/indentcommandbehavior)
@ckeditor/ckeditor5-indent/src/indentcommandbehavior/indentusingoffset
The block indentation behavior that uses offsets to set indentation.
Filtering
Properties
-
isForward : booleanmodule:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#isForwardThe direction of indentation.
-
offset : numbermodule:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#offsetThe offset of the next indentation step.
-
unit : stringmodule:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#unitIndentation unit.
Methods
-
constructor( config = { config.direction, config.offset, config.unit } )module:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#constructorCreates an instance of the indentation behavior.
Parameters
config : object-
Properties
config.direction : 'forward' | 'backward'The direction of indentation.
config.offset : numberThe offset of the next indentation step.
config.unit : stringIndentation unit.
-
checkEnabled( indentAttributeValue ) → booleanmodule:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#checkEnabledChecks if the command should be enabled.
Parameters
indentAttributeValue : string
Returns
boolean
-
getNextIndent( indentAttributeValue ) → undefined | stringmodule:indent/indentcommandbehavior/indentusingoffset~IndentUsingOffset#getNextIndentReturns a new indent attribute value based on the current indent. This method returns
undefinedwhen 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.
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.