CKEditor Ecosystem Documentation
Search
⚠️ WarningNightly documentation ahead. Switch to the stable editor documentation.
Home/CKEditor 5/API
Module

table/utils/table-properties

@ckeditor/ckeditor5-table/src/utils/table-properties

module

Filtering

Functions

  • addDefaultUnitToNumericValue( value, defaultUnit ) → String | *

    Adds a unit to a value if the value is a number or a string representing a number.

    See source

    Note: It does nothing to non-numeric values.

    getSingleValue( 25, 'px' );		// '25px'
getSingleValue( 25, 'em' );		// '25em'
getSingleValue( '25em', 'px' );	// '25em'
getSingleValue( 'foo', 'px' );	// 'foo'

    Parameters

    value : *
    defaultUnit : String

    A default unit added to a numeric value.

    Returns

    String | *

  • getNormalizedDefaultProperties( config, [ options ] = { [options.includeAlignmentProperty], [options.includePaddingProperty], [options.includeVerticalAlignmentProperty], [options.includeHorizontalAlignmentProperty], [options.isRightToLeftContent] } ) → Object

    Returns the normalized configuration.

    See source

    Parameters

    config : Object
    [ options ] : Object
    Properties
    [ options.includeAlignmentProperty ] : Boolean

    Whether the "alignment" property should be added.

    Defaults to false

    [ options.includePaddingProperty ] : Boolean

    Whether the "padding" property should be added.

    Defaults to false

    [ options.includeVerticalAlignmentProperty ] : Boolean

    Whether the "verticalAlignment" property should be added.

    Defaults to false

    [ options.includeHorizontalAlignmentProperty ] : Boolean

    Whether the "horizontalAlignment" property should be added.

    Defaults to false

    [ options.isRightToLeftContent ] : Boolean

    Whether the content is right-to-left.

    Defaults to false

    Defaults to {}

    Returns

    Object

  • getSingleValue( objectOrString ) → BoxSides | String

    Returns a string if all four values of box sides are equal.

    See source

    If a string is passed, it is treated as a single value (pass-through).

    // Returns 'foo':
getSingleValue( { top: 'foo', right: 'foo', bottom: 'foo', left: 'foo' } );
getSingleValue( 'foo' );

// Returns undefined:
getSingleValue( { top: 'foo', right: 'foo', bottom: 'bar', left: 'foo' } );
getSingleValue( { top: 'foo', right: 'foo' } );

    Parameters

    objectOrString

    Returns

    BoxSides | String