table/utils/table-properties

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

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: string | number | undefined

defaultUnit: string

A default unit added to a numeric value.

Returns

string | number | undefined

Returns the normalized default cell properties.

Parameters

config?: Partial<NormalizedDefaultProperties>

The configuration to normalize.

options?: NormalizeTableDefaultPropertiesOptions

Options used to determine which properties should be added.

Returns

NormalizedDefaultProperties

Returns the normalized configuration.

Parameters

config?: Partial<NormalizedDefaultProperties>

The configuration to normalize.

options: NormalizeTableDefaultPropertiesOptions

Options used to determine which properties should be added.

Defaults to {}

Returns

NormalizedDefaultProperties

Returns the normalized default table properties.

Parameters

config?: Partial<NormalizedDefaultProperties>

The configuration to normalize.

options?: NormalizeTableDefaultPropertiesOptions

Options used to determine which properties should be added.

Returns

NormalizedDefaultProperties

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

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: string | BoxStyleSides | undefined

Returns

string | undefined