CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

IndentUsingOffset (indent/indentcommandbehavior)

@ckeditor/ckeditor5-indent/src/indentcommandbehavior/indentusingoffset

class
See source

The block indentation behavior that uses offsets to set indentation.

Filtering

Properties

  • isForward : Boolean

    The direction of indentation.

    See source

  • offset : Number

    The offset of the next indentation step.

    See source

  • unit : String

    Indentation unit.

    See source

Methods

  • constructor( config = { config.direction, config.offset, config.unit } )

    Creates an instance of the indentation behavior.

    See source

    Parameters

    config : Object
    Properties
    config.direction : String

    The direction of indentation.

    config.offset : Number

    The offset of the next indentation step.

    config.unit : String

    Indentation unit.

  • checkEnabled( indentAttributeValue ) → Boolean

    Checks if the command should be enabled.

    See source

    Parameters

    indentAttributeValue : String

    The current indent attribute value.

    Returns

    Boolean

  • getNextIndent( indentAttributeValue ) → String | undefined

    Returns a new indent attribute value based on the current indent. This method returns undefined when the indentation should be removed.

    See source

    Parameters

    indentAttributeValue : String

    The current indent attribute value.

    Returns

    String | undefined