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

GeneralHtmlSupportConfig (html-support)

@ckeditor/ckeditor5-html-support/src/generalhtmlsupport

interface
See source

The configuration of the General HTML Support feature. The option is used by the GeneralHtmlSupport feature.

ClassicEditor
	.create( {
		htmlSupport: ... // General HTML Support feature config.
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • allow : Array.<MatcherPattern>

    The configuration of allowed content rules used by General HTML Support.

    See source

    Setting this configuration option will enable HTML features that are not explicitly supported by any other dedicated CKEditor 5 features.

    const htmlSupportConfig.allow = [
	{
		name: 'div',                      // Enable 'div' element support,
		classes: [ 'special-container' ], // allow 'special-container' class,
		styles: 'background',             // allow 'background' style,
		attributes: true                  // allow any attribute (can be empty).
	},
	{
		name: 'p',                                   // Extend existing Paragraph feature,
		classes: 'highlighted'                       // with 'highlighted' class,
		attributes: [
			{ key: 'data-i18n-context, value: true } // and i18n attribute.
		]
	}
];

  • disallow : Array.<MatcherPattern>

    The configuration of disallowed content rules used by General HTML Support.

    See source

    Setting this configuration option will disable listed HTML features.

    const htmlSupportConfig.disallow = [
	{
		name: /[\s\S]+/    // For every HTML feature,
		attributes: {
			key: /^on.*$/ // disable 'on*' attributes, like 'onClick', 'onError' etc.
		}
	}
];