Sign up (with export icon)

CKFinderConfig

Api-interface icon interface

The configuration of the CKFinder feature and its upload adapter.

ClassicEditor
	.create( editorElement, {
		ckfinder: {
			options: {
				resourceType: 'Images'
			}
		}
	} )
	.then( ... )
	.catch( ... );
Copy code

See all editor options.

Properties

  • Chevron-right icon

    openerMethod : 'modal' | 'popup' | undefined

    The type of the CKFinder opener method.

    Supported types are:

    • 'modal' – Opens CKFinder in a modal,
    • 'popup' – Opens CKFinder in a new "pop-up" window.

    Defaults to 'modal'.

  • Chevron-right icon

    options : CKFinderOptions | undefined

    The configuration options passed to the CKFinder file manager instance.

    Check the file manager documentation for the complete list of options.

  • Chevron-right icon

    uploadUrl : string | undefined

    The path (URL) to the connector which handles the file upload in CKFinder file manager. When specified, it enables the automatic upload of resources such as images inserted into the content.

    For instance, to use CKFinder's quick upload command, your can use the following (or similar) path:

    ClassicEditor
    	.create( editorElement, {
    		ckfinder: {
    			uploadUrl: '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files&responseType=json'
    		}
    	} )
    	.then( ... )
    	.catch( ... );
    
    Copy code

    Used by the upload adapter.