CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

LineHeightConfig (line-height)

@ckeditor/ckeditor5-line-height/src/lineheightconfig

interface

The configuration of the LineHeight feature.

Read more in LineHeightConfig.

Filtering

Properties

  • defaultValue : number | undefined

    Default value of line height attribute. Defaults to 1.5.

  • options : Array<string | number | LineHeightOption> | undefined

    Available line height options. The default value is:

    const lineHeightConfig = {
	options: [ 0.5, 1, 1.5, 2, 2.5 ]
};

    Note: Line height values have to be provided in a format without units. The available values are always multipliers of the default line height applied to the edited content.

  • supportAllValues : boolean | undefined

    By default, the plugin removes any line-height value that does not match the plugin's configuration. It means that if you paste content with line heights that the editor does not understand, the line-height attribute will be removed and the content will be displayed with the default line height.

    You can preserve pasted line heights values by switching the supportAllValues option to true:

    const lineHeightConfig = {
	supportAllValues: true
};

    With this configuration line heights not specified in the editor configuration will not be removed when pasting the content.