@ckeditor/ckeditor5-ckfinder 48.2.0 → 48.3.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,22 +1,22 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
5
- import type { CKFinder, CKFinderCommand, CKFinderConfig, CKFinderEditing } from './index.js';
6
- declare module '@ckeditor/ckeditor5-core' {
7
- interface EditorConfig {
8
- /**
9
- * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}.
10
- *
11
- * Read more in {@link module:ckfinder/ckfinderconfig~CKFinderConfig}.
12
- */
13
- ckfinder?: CKFinderConfig;
14
- }
15
- interface PluginsMap {
16
- [CKFinder.pluginName]: CKFinder;
17
- [CKFinderEditing.pluginName]: CKFinderEditing;
18
- }
19
- interface CommandsMap {
20
- ckfinder: CKFinderCommand;
21
- }
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
+ import type { CKFinder, CKFinderCommand, CKFinderConfig, CKFinderEditing } from "./index.js";
6
+ declare module "@ckeditor/ckeditor5-core" {
7
+ interface EditorConfig {
8
+ /**
9
+ * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}.
10
+ *
11
+ * Read more in {@link module:ckfinder/ckfinderconfig~CKFinderConfig}.
12
+ */
13
+ ckfinder?: CKFinderConfig;
14
+ }
15
+ interface PluginsMap {
16
+ [CKFinder.pluginName]: CKFinder;
17
+ [CKFinderEditing.pluginName]: CKFinderEditing;
18
+ }
19
+ interface CommandsMap {
20
+ ckfinder: CKFinderCommand;
21
+ }
22
22
  }
@@ -1,42 +1,42 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder/ckfinder
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { CKFinderUploadAdapter } from '@ckeditor/ckeditor5-adapter-ckfinder';
10
- import { Link } from '@ckeditor/ckeditor5-link';
11
- import { CKFinderUI } from './ckfinderui.js';
12
- import { CKFinderEditing } from './ckfinderediting.js';
6
+ * @module ckfinder/ckfinder
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { CKFinderUploadAdapter } from "@ckeditor/ckeditor5-adapter-ckfinder";
10
+ import { Link } from "@ckeditor/ckeditor5-link";
11
+ import { CKFinderUI } from "./ckfinderui.js";
12
+ import { CKFinderEditing } from "./ckfinderediting.js";
13
13
  /**
14
- * The CKFinder feature, a bridge between the CKEditor 5 WYSIWYG editor and the
15
- * [CKFinder](https://ckeditor.com/ckfinder) file manager and uploader.
16
- *
17
- * This is a "glue" plugin which enables:
18
- *
19
- * * {@link module:ckfinder/ckfinderediting~CKFinderEditing},
20
- * * {@link module:ckfinder/ckfinderui~CKFinderUI},
21
- * * {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter}.
22
- *
23
- * See the {@glink features/file-management/ckfinder "CKFinder integration" guide} to learn how to configure
24
- * and use this feature.
25
- *
26
- * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload" guide} to learn about
27
- * other ways to upload images into CKEditor 5.
28
- */
14
+ * The CKFinder feature, a bridge between the CKEditor 5 WYSIWYG editor and the
15
+ * [CKFinder](https://ckeditor.com/ckfinder) file manager and uploader.
16
+ *
17
+ * This is a "glue" plugin which enables:
18
+ *
19
+ * * {@link module:ckfinder/ckfinderediting~CKFinderEditing},
20
+ * * {@link module:ckfinder/ckfinderui~CKFinderUI},
21
+ * * {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter}.
22
+ *
23
+ * See the {@glink features/file-management/ckfinder "CKFinder integration" guide} to learn how to configure
24
+ * and use this feature.
25
+ *
26
+ * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload" guide} to learn about
27
+ * other ways to upload images into CKEditor 5.
28
+ */
29
29
  export declare class CKFinder extends Plugin {
30
- /**
31
- * @inheritDoc
32
- */
33
- static get pluginName(): "CKFinder";
34
- /**
35
- * @inheritDoc
36
- */
37
- static get isOfficialPlugin(): true;
38
- /**
39
- * @inheritDoc
40
- */
41
- static get requires(): readonly [typeof Link, typeof CKFinderUploadAdapter, typeof CKFinderEditing, typeof CKFinderUI];
30
+ /**
31
+ * @inheritDoc
32
+ */
33
+ static get pluginName(): "CKFinder";
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ static override get isOfficialPlugin(): true;
38
+ /**
39
+ * @inheritDoc
40
+ */
41
+ static get requires(): PluginDependenciesOf<[Link, CKFinderUploadAdapter, CKFinderEditing, CKFinderUI]>;
42
42
  }
@@ -1,36 +1,36 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder/ckfindercommand
7
- */
8
- import { Command, type Editor } from '@ckeditor/ckeditor5-core';
6
+ * @module ckfinder/ckfindercommand
7
+ */
8
+ import { Command, type Editor } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The CKFinder command. It is used by the {@link module:ckfinder/ckfinderediting~CKFinderEditing CKFinder editing feature}
11
- * to open the CKFinder file manager to insert an image or a link to a file into the editor content.
12
- *
13
- * ```ts
14
- * editor.execute( 'ckfinder' );
15
- * ```
16
- *
17
- * **Note:** This command uses other features to perform tasks:
18
- * - To insert images the {@link module:image/image/insertimagecommand~InsertImageCommand 'insertImage'} command
19
- * from the {@link module:image/image~Image Image feature}.
20
- * - To insert links to files the {@link module:link/linkcommand~LinkCommand 'link'} command
21
- * from the {@link module:link/link~Link Link feature}.
22
- */
10
+ * The CKFinder command. It is used by the {@link module:ckfinder/ckfinderediting~CKFinderEditing CKFinder editing feature}
11
+ * to open the CKFinder file manager to insert an image or a link to a file into the editor content.
12
+ *
13
+ * ```ts
14
+ * editor.execute( 'ckfinder' );
15
+ * ```
16
+ *
17
+ * **Note:** This command uses other features to perform tasks:
18
+ * - To insert images the {@link module:image/image/insertimagecommand~InsertImageCommand 'insertImage'} command
19
+ * from the {@link module:image/image~Image Image feature}.
20
+ * - To insert links to files the {@link module:link/linkcommand~LinkCommand 'link'} command
21
+ * from the {@link module:link/link~Link Link feature}.
22
+ */
23
23
  export declare class CKFinderCommand extends Command {
24
- /**
25
- * @inheritDoc
26
- */
27
- constructor(editor: Editor);
28
- /**
29
- * @inheritDoc
30
- */
31
- refresh(): void;
32
- /**
33
- * @inheritDoc
34
- */
35
- execute(): void;
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ constructor(editor: Editor);
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ override refresh(): void;
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ override execute(): void;
36
36
  }
@@ -1,73 +1,73 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder/ckfinderconfig
7
- */
6
+ * @module ckfinder/ckfinderconfig
7
+ */
8
8
  /**
9
- * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}
10
- * and its {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter upload adapter}.
11
- *
12
- * ```
13
- * ClassicEditor
14
- * .create( {
15
- * ckfinder: {
16
- * options: {
17
- * resourceType: 'Images'
18
- * }
19
- * }
20
- * } )
21
- * .then( ... )
22
- * .catch( ... );
23
- * ```
24
- *
25
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
26
- */
9
+ * The configuration of the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature}
10
+ * and its {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter upload adapter}.
11
+ *
12
+ * ```
13
+ * ClassicEditor
14
+ * .create( {
15
+ * ckfinder: {
16
+ * options: {
17
+ * resourceType: 'Images'
18
+ * }
19
+ * }
20
+ * } )
21
+ * .then( ... )
22
+ * .catch( ... );
23
+ * ```
24
+ *
25
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
26
+ */
27
27
  export interface CKFinderConfig {
28
- /**
29
- * The configuration options passed to the CKFinder file manager instance.
30
- *
31
- * Check the file manager [documentation](https://ckeditor.com/docs/ckfinder/ckfinder3/#!/api/CKFinder.Config-cfg-language)
32
- * for the complete list of options.
33
- */
34
- options?: CKFinderOptions;
35
- /**
36
- * The type of the CKFinder opener method.
37
- *
38
- * Supported types are:
39
- *
40
- * * `'modal'` &ndash; Opens CKFinder in a modal,
41
- * * `'popup'` &ndash; Opens CKFinder in a new "pop-up" window.
42
- *
43
- * Defaults to `'modal'`.
44
- */
45
- openerMethod?: 'modal' | 'popup';
46
- /**
47
- * The path (URL) to the connector which handles the file upload in CKFinder file manager.
48
- * When specified, it enables the automatic upload of resources such as images inserted into the content.
49
- *
50
- * For instance, to use CKFinder's
51
- * [quick upload](https://ckeditor.com/docs/ckfinder/ckfinder3-php/commands.html#command_quick_upload)
52
- * command, your can use the following (or similar) path:
53
- *
54
- * ```ts
55
- * ClassicEditor
56
- * .create( {
57
- * ckfinder: {
58
- * uploadUrl: '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files&responseType=json'
59
- * }
60
- * } )
61
- * .then( ... )
62
- * .catch( ... );
63
- * ```
64
- *
65
- * Used by the {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter upload adapter}.
66
- */
67
- uploadUrl?: string;
28
+ /**
29
+ * The configuration options passed to the CKFinder file manager instance.
30
+ *
31
+ * Check the file manager [documentation](https://ckeditor.com/docs/ckfinder/ckfinder3/#!/api/CKFinder.Config-cfg-language)
32
+ * for the complete list of options.
33
+ */
34
+ options?: CKFinderOptions;
35
+ /**
36
+ * The type of the CKFinder opener method.
37
+ *
38
+ * Supported types are:
39
+ *
40
+ * * `'modal'` &ndash; Opens CKFinder in a modal,
41
+ * * `'popup'` &ndash; Opens CKFinder in a new "pop-up" window.
42
+ *
43
+ * Defaults to `'modal'`.
44
+ */
45
+ openerMethod?: "modal" | "popup";
46
+ /**
47
+ * The path (URL) to the connector which handles the file upload in CKFinder file manager.
48
+ * When specified, it enables the automatic upload of resources such as images inserted into the content.
49
+ *
50
+ * For instance, to use CKFinder's
51
+ * [quick upload](https://ckeditor.com/docs/ckfinder/ckfinder3-php/commands.html#command_quick_upload)
52
+ * command, your can use the following (or similar) path:
53
+ *
54
+ * ```ts
55
+ * ClassicEditor
56
+ * .create( {
57
+ * ckfinder: {
58
+ * uploadUrl: '/ckfinder/core/connector/php/connector.php?command=QuickUpload&type=Files&responseType=json'
59
+ * }
60
+ * } )
61
+ * .then( ... )
62
+ * .catch( ... );
63
+ * ```
64
+ *
65
+ * Used by the {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter upload adapter}.
66
+ */
67
+ uploadUrl?: string;
68
68
  }
69
69
  export interface CKFinderOptions extends Record<string, unknown> {
70
- chooseFiles?: boolean;
71
- onInit?: (finder: any) => void;
72
- language?: string;
70
+ chooseFiles?: boolean;
71
+ onInit?: (finder: any) => void;
72
+ language?: string;
73
73
  }
@@ -1,31 +1,31 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder/ckfinderediting
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { LinkEditing } from '@ckeditor/ckeditor5-link';
10
- import { Notification } from '@ckeditor/ckeditor5-ui';
6
+ * @module ckfinder/ckfinderediting
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { LinkEditing } from "@ckeditor/ckeditor5-link";
10
+ import { Notification } from "@ckeditor/ckeditor5-ui";
11
11
  /**
12
- * The CKFinder editing feature. It introduces the {@link module:ckfinder/ckfindercommand~CKFinderCommand CKFinder command}.
13
- */
12
+ * The CKFinder editing feature. It introduces the {@link module:ckfinder/ckfindercommand~CKFinderCommand CKFinder command}.
13
+ */
14
14
  export declare class CKFinderEditing extends Plugin {
15
- /**
16
- * @inheritDoc
17
- */
18
- static get pluginName(): "CKFinderEditing";
19
- /**
20
- * @inheritDoc
21
- */
22
- static get isOfficialPlugin(): true;
23
- /**
24
- * @inheritDoc
25
- */
26
- static get requires(): readonly [typeof Notification, typeof LinkEditing];
27
- /**
28
- * @inheritDoc
29
- */
30
- init(): void;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ static get pluginName(): "CKFinderEditing";
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static override get isOfficialPlugin(): true;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get requires(): PluginDependenciesOf<[Notification, LinkEditing]>;
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ init(): void;
31
31
  }
@@ -1,56 +1,56 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder/ckfinderui
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
6
+ * @module ckfinder/ckfinderui
7
+ */
8
+ import { Plugin } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * Introduces UI components for `CKFinder` plugin.
11
- *
12
- * The plugin introduces two UI components to the {@link module:ui/componentfactory~ComponentFactory UI component factory}:
13
- *
14
- * * the `'ckfinder'` toolbar button,
15
- * * the `'menuBar:ckfinder'` menu bar component, which is by default added to the `'Insert'` menu.
16
- *
17
- * It also integrates with the `insertImage` toolbar component and `menuBar:insertImage` menu component.
18
- */
10
+ * Introduces UI components for `CKFinder` plugin.
11
+ *
12
+ * The plugin introduces two UI components to the {@link module:ui/componentfactory~ComponentFactory UI component factory}:
13
+ *
14
+ * * the `'ckfinder'` toolbar button,
15
+ * * the `'menuBar:ckfinder'` menu bar component, which is by default added to the `'Insert'` menu.
16
+ *
17
+ * It also integrates with the `insertImage` toolbar component and `menuBar:insertImage` menu component.
18
+ */
19
19
  export declare class CKFinderUI extends Plugin {
20
- /**
21
- * @inheritDoc
22
- */
23
- static get pluginName(): "CKFinderUI";
24
- /**
25
- * @inheritDoc
26
- */
27
- static get isOfficialPlugin(): true;
28
- /**
29
- * @inheritDoc
30
- */
31
- init(): void;
32
- /**
33
- * Creates the base for various kinds of the button component provided by this feature.
34
- */
35
- private _createButton;
36
- /**
37
- * Creates a simple toolbar button for files management, with an icon and a tooltip.
38
- */
39
- private _createFileToolbarButton;
40
- /**
41
- * Creates a simple toolbar button for images management, with an icon and a tooltip.
42
- */
43
- private _createImageToolbarButton;
44
- /**
45
- * Creates a button for images management for the dropdown view, with an icon, text and no tooltip.
46
- */
47
- private _createImageDropdownButton;
48
- /**
49
- * Creates a button for files management for the menu bar.
50
- */
51
- private _createFileMenuBarButton;
52
- /**
53
- * Creates a button for images management for the menu bar.
54
- */
55
- private _createImageMenuBarButton;
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get pluginName(): "CKFinderUI";
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static override get isOfficialPlugin(): true;
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ init(): void;
32
+ /**
33
+ * Creates the base for various kinds of the button component provided by this feature.
34
+ */
35
+ private _createButton;
36
+ /**
37
+ * Creates a simple toolbar button for files management, with an icon and a tooltip.
38
+ */
39
+ private _createFileToolbarButton;
40
+ /**
41
+ * Creates a simple toolbar button for images management, with an icon and a tooltip.
42
+ */
43
+ private _createImageToolbarButton;
44
+ /**
45
+ * Creates a button for images management for the dropdown view, with an icon, text and no tooltip.
46
+ */
47
+ private _createImageDropdownButton;
48
+ /**
49
+ * Creates a button for files management for the menu bar.
50
+ */
51
+ private _createFileMenuBarButton;
52
+ /**
53
+ * Creates a button for images management for the menu bar.
54
+ */
55
+ private _createImageMenuBarButton;
56
56
  }
@@ -2,3 +2,4 @@
2
2
  * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
4
  */
5
+
@@ -2,3 +2,4 @@
2
2
  * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
4
  */
5
+
package/dist/index.css CHANGED
@@ -3,5 +3,3 @@
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
4
  */
5
5
 
6
-
7
- /*# sourceMappingURL=index.css.map */
package/dist/index.d.ts CHANGED
@@ -1,13 +1,13 @@
1
1
  /**
2
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
- */
2
+ * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
4
+ */
5
5
  /**
6
- * @module ckfinder
7
- */
8
- export { CKFinder } from './ckfinder.js';
9
- export { CKFinderEditing } from './ckfinderediting.js';
10
- export { CKFinderUI } from './ckfinderui.js';
11
- export { CKFinderCommand } from './ckfindercommand.js';
12
- export type { CKFinderConfig, CKFinderOptions } from './ckfinderconfig.js';
13
- import './augmentation.js';
6
+ * @module ckfinder
7
+ */
8
+ export { CKFinder } from "./ckfinder.js";
9
+ export { CKFinderEditing } from "./ckfinderediting.js";
10
+ export { CKFinderUI } from "./ckfinderui.js";
11
+ export { CKFinderCommand } from "./ckfindercommand.js";
12
+ export type { CKFinderConfig, CKFinderOptions } from "./ckfinderconfig.js";
13
+ import "./augmentation.js";