CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

alignment/utils

@ckeditor/ckeditor5-alignment/src/utils

module

Filtering

Constants

  • supportedOptions

    See source

    The list of supported alignment options:

    • 'left',
    • 'right',
    • 'center',
    • 'justify'

Functions

  • isDefault( alignment, locale ) → Boolean

    See source

    Checks whether alignment is the default one considering the direction of the editor content.

    Parameters

    alignment : String

    The name of the alignment to check.

    locale : Locale

    The locale instance.

    Returns

    Boolean

  • isSupported( option ) → Boolean

    See source

    Checks whether the passed option is supported by AlignmentEditing.

    Parameters

    option : String

    The option value to check.

    Returns

    Boolean

  • normalizeAlignmentOptions( configuredOptions ) → Array.<AlignmentFormat>

    See source

    Brings the configuration to the common form, an array of objects.

    Parameters

    configuredOptions : Array.<(String | AlignmentFormat)>

    Alignment plugin configuration.

    Returns

    Array.<AlignmentFormat>

    Normalized object holding the configuration.