CKEditor 4 Documentation

CKEDITOR.skin

Files

Manages the loading of skin parts among all editor instances.

Defined By

Properties

CKEDITOR.skin
view source
: Object
The list of registered icons. ...

The list of registered icons. To add new icons to this list, use addIcon.

Defaults to: {}

CKEDITOR.skin
view source
: String

The name of the skin that is currently used.

The name of the skin that is currently used.

CKEDITOR.skin
view source
: Object
The list of file names matching the browser user agent string from CKEDITOR.env. ...

The list of file names matching the browser user agent string from CKEDITOR.env. This is used to load the skin part file in addition to the "main" skin file for a particular browser.

Note: For each of the defined skin parts the corresponding CSS file with the same name as the user agent must exist inside the skin directory.type?

Defined By

Methods

CKEDITOR.skin
view source
( name, path, [offset], [bgsize] )
Registers an icon. ...

Registers an icon.

Parameters

  • name : String

    The icon name.

  • path : String

    The path to the icon image file.

  • offset : Number (optional)

    The vertical offset position of the icon, if available inside a strip image.

  • bgsize : String (optional)

    The value of the CSS "background-size" property to use for this icon

CKEDITOR.skin
view source
( editor, part )
A function that supports the chameleon (skin color switch) feature, providing the skin color style updates to be appl...

A function that supports the chameleon (skin color switch) feature, providing the skin color style updates to be applied in runtime.

Note: The embedded $color variable is to be substituted with a specific UI color.

Parameters

  • editor : String

    The editor instance that the color changes apply to.

  • part : String

    The name of the skin part where the color changes take place.

CKEDITOR.skin
view source
( name, [rtl], [overridePath], [overrideOffset], [overrideBgsize] )
Gets the CSS background styles to be used to render a specific icon. ...

Gets the CSS background styles to be used to render a specific icon.

Parameters

  • name : String

    The icon name, as registered with addIcon.

  • rtl : Boolean (optional)

    Indicates that the RTL version of the icon is to be used, if available.

  • overridePath : String (optional)

    The path to the icon image file. It overrides the path defined by the named icon, if available, and is used if the named icon was not registered.

  • overrideOffset : Number (optional)

    The vertical offset position of the icon. It overrides the offset defined by the named icon, if available, and is used if the named icon was not registered.

  • overrideBgsize : String (optional)

    The value of the CSS "background-size" property to use for the icon. It overrides the value defined by the named icon, if available, and is used if the named icon was not registered.

CKEDITOR.skin
view source
( part )
Retrieves the real URL of a (CSS) skin part. ...

Retrieves the real URL of a (CSS) skin part.

Parameters

  • part : String
CKEDITOR.skin
view source
( part, fn )
Loads a skin part into the page. ...

Loads a skin part into the page. Does nothing if the part has already been loaded.

Note: The "editor" part is always auto loaded upon instance creation, thus this function is mainly used to lazy load other parts of the skin that do not have to be displayed until requested.

// Load the dialog part.
editor.skin.loadPart( 'dialog' );

Parameters

  • part : String

    The name of the skin part CSS file that resides in the skin directory.

  • fn : Function

    The provided callback function which is invoked after the part is loaded.

CKEDITOR.skin
view source
( )
Returns the root path to the skin directory. ...

Returns the root path to the skin directory.