CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

engine/view/styles/utils

@ckeditor/ckeditor5-engine/src/view/styles/utils

module

Filtering

Functions

  • getBoxSidesStyleShorthandValue( __namedParameters ) → string

    See source

    Returns a shorthand notation of a CSS property value.

    getBoxSidesStyleShorthandValue( { top: '1px', right: '1px', bottom: '2px', left: '1px' } );
// will return '1px 1px 2px'

    Parameters

    __namedParameters : BoxStyleSides

    Returns

    string

  • getBoxSidesStyleValueReducer( styleShorthand ) → ( value: StyleValue ) => Array<StylePropertyDescriptor>

    See source

    Default reducer for CSS properties that concerns edges of a box shorthand notations:

    stylesProcessor.setReducer( 'padding', getBoxSidesStyleValueReducer( 'padding' ) );

    Parameters

    styleShorthand : string

    Returns

    ( value: StyleValue ) => Array<StylePropertyDescriptor>

  • getBoxSidesStyleValues( value ) → BoxStyleSides

    See source

    Parses box sides as individual values.

    Parameters

    value : string

    Defaults to ''

    Returns

    BoxStyleSides

  • getPositionStyleShorthandNormalizer( shorthand ) → ( value: string ) => object

    See source

    Creates a normalizer for a shorthand 1-to-4 value.

    stylesProcessor.setNormalizer( 'margin', getPositionStyleShorthandNormalizer( 'margin' ) );

    Parameters

    shorthand : string

    Returns

    ( value: string ) => object

  • getShorthandStylesValues( string ) → Array<string>

    See source

    Parses parts of a 1-to-4 value notation - handles some CSS values with spaces (like RGB()).

    getShorthandStylesValues( 'red blue RGB(0, 0, 0)');
// will return [ 'red', 'blue', 'RGB(0, 0, 0)' ]

    Parameters

    string : string

    Returns

    Array<string>

  • isAttachmentStyleValue( string ) → boolean

    See source

    Checks if string contains background attachment CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isColorStyleValue( string ) → boolean

    See source

    Checks if string contains color CSS value.

    isColorStyleValue( '#f00' );						// true
isColorStyleValue( '#AA00BB33' );				// true
isColorStyleValue( 'rgb(0, 0, 250)' );			// true
isColorStyleValue( 'hsla(240, 100%, 50%, .7)' );	// true
isColorStyleValue( 'deepskyblue' );				// true

    Note: It does not support CSS Level 4 whitespace syntax, system colors and radius values for HSL colors.

    Parameters

    string : string

    Returns

    boolean

  • isLengthStyleValue( string ) → boolean

    See source

    Checks if string contains length CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isLineStyleValue( string ) → boolean

    See source

    Checks if string contains line style CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isPercentageStyleValue( string ) → boolean

    See source

    Checks if string contains percentage CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isPositionStyleValue( string ) → boolean

    See source

    Checks if string contains background position CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isRepeatStyleValue( string ) → boolean

    See source

    Checks if string contains background repeat CSS value.

    Parameters

    string : string

    Returns

    boolean

  • isURLStyleValue( string ) → boolean

    See source

    Checks if string contains URL CSS value.

    Parameters

    string : string

    Returns

    boolean