# CKFinderConfig

interface

The configuration of the [CKFinder feature](module_ckfinder_ckfinder-CKFinder.md) and its [upload adapter](module_adapter-ckfinder_uploadadapter-CKFinderUploadAdapter.md).

```
ClassicEditor
	.create( {
		ckfinder: {
			options: {
				resourceType: 'Images'
			}
		}
	} )
	.then( ... )
	.catch( ... );
```

See [all editor options](module_core_editor_editorconfig-EditorConfig.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts#L29)

<a id="properties">

## Properties

<a id="member-openerMethod">

### `openerMethod?: 'modal' | 'popup'`

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'`.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts#L49)

<a id="member-options">

### `options?: CKFinderOptions`

The configuration options passed to the CKFinder file manager instance.

Check the file manager [documentation](https://ckeditor.com/docs/ckfinder/ckfinder3/#!/api/CKFinder.Config-cfg-language) for the complete list of options.

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts#L37)

<a id="member-uploadUrl">

### `uploadUrl?: string`

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](https://ckeditor.com/docs/ckfinder/ckfinder3-php/commands.html#command_quick_upload) command, your can use the following (or similar) path:

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

Used by the [upload adapter](module_adapter-ckfinder_uploadadapter-CKFinderUploadAdapter.md).

[See source](https://github.com/ckeditor/ckeditor5/blob/master/packages/ckeditor5-ckfinder/src/ckfinderconfig.ts#L72)

---

Full index of the CKEditor 5 API reference: [llms.txt](llms.txt)
