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

RestrictedEditingModeConfig (restricted-editing)

@ckeditor/ckeditor5-restricted-editing/src/restrictededitingmode

interface
See source

The configuration of the restricted editing mode feature. The option is used by the RestrictedEditingMode feature.

ClassicEditor
	.create( {
		restrictedEditing: {
			allowedCommands: [ 'bold', 'link', 'unlink' ],
			allowedAttributes: [ 'bold', 'linkHref' ]
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • allowedAttributes : Array.<String>

    The text attribute names allowed when pasting content ot non-restricted areas.

    See source

    The default value is:

    const restrictedEditingConfig = {
	allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
};

  • allowedCommands : Array.<String>

    The command names allowed in non-restricted areas of the content.

    See source

    Defines which feature commands should be enabled in the restricted editing mode. The commands used for typing and deleting text ('input', 'delete' and 'deleteForward') are allowed by the feature inside non-restricted regions and do not need to be defined.

    Note: The restricted editing mode always allows to use the restricted mode navigation commands as well as 'undo' and 'redo' commands.

    The default value is:

    const restrictedEditingConfig = {
	allowedCommands: [ 'bold', 'italic', 'link', 'unlink' ]
};

    To make a command always enabled (also outside non-restricted areas) use enableCommand method.