GeneralHtmlSupportConfig
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.
Properties
-
allow : Array<MatcherObjectPattern> | undefinedmodule:html-support/generalhtmlsupportconfig~GeneralHtmlSupportConfig#allowThe configuration of allowed content rules used by General HTML Support.
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. ] } ];Copy code -
allowEmpty : Array<string> | undefinedmodule:html-support/generalhtmlsupportconfig~GeneralHtmlSupportConfig#allowEmptyThe configuration of allowed empty inline elements that should not be removed.
Note that you should also add an appropriate entry to
allowlist.const htmlSupportConfig.allowEmpty = [ 'i', 'span' ];Copy code -
disallow : Array<MatcherObjectPattern> | undefinedmodule:html-support/generalhtmlsupportconfig~GeneralHtmlSupportConfig#disallowThe configuration of disallowed content rules used by General HTML Support.
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. } } ];Copy code -
fullPage : GHSFullPageConfig | undefinedmodule:html-support/generalhtmlsupportconfig~GeneralHtmlSupportConfig#fullPageThe configuration of the Full page editing feature. The option is used by the
FullPagefeature.ClassicEditor .create( { htmlSupport: { fullPage: ... // Full page feature config. } } ) .then( ... ) .catch( ... );Copy code -
preserveEmptyBlocksInEditingView : boolean | undefinedmodule:html-support/generalhtmlsupportconfig~GeneralHtmlSupportConfig#preserveEmptyBlocksInEditingViewWhether a filler text (non-breaking space entity —
) will be inserted into empty block elements in HTML output. This is used to render block elements properly with line-height.When set to
true, empty blocks will be preserved in the editing view. Whenfalse(default), empty blocks are only preserved in the data output.The option is used by the
EmptyBlockfeature.Defaults to
false