Sign up (with export icon)

RestrictedEditingConfig

Api-interface icon interface

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( ... );
Copy code

See all editor options.

Properties

  • Chevron-right icon

    allowedAttributes : Array<string>

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

    The default value is:

    const restrictedEditingConfig = {
      allowedAttributes: [ 'bold', 'italic', 'linkHref' ]
    };
    
    Copy code
  • Chevron-right icon

    allowedCommands : Array<string>

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

    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' ]
    };
    
    Copy code

    Only inline content inserting or editing commands are allowed in this setting. Block content commands such as insertTable or enter cannot be allowed via this setting, as they are not supported in the restricted editing mode.

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