@ckeditor/ckeditor5-fullscreen 48.2.0 → 48.3.0-alpha.0

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,21 +1,21 @@
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 { Fullscreen, FullscreenEditing, FullscreenUI, FullscreenCommand, FullscreenConfig } from './index.js';
6
- declare module '@ckeditor/ckeditor5-core' {
7
- interface EditorConfig {
8
- /**
9
- * Configuration for the fullscreen mode feature.
10
- */
11
- fullscreen?: FullscreenConfig;
12
- }
13
- interface PluginsMap {
14
- [Fullscreen.pluginName]: Fullscreen;
15
- [FullscreenEditing.pluginName]: FullscreenEditing;
16
- [FullscreenUI.pluginName]: FullscreenUI;
17
- }
18
- interface CommandsMap {
19
- toggleFullscreen: FullscreenCommand;
20
- }
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 { Fullscreen, FullscreenEditing, FullscreenUI, FullscreenCommand, FullscreenConfig } from "./index.js";
6
+ declare module "@ckeditor/ckeditor5-core" {
7
+ interface EditorConfig {
8
+ /**
9
+ * Configuration for the fullscreen mode feature.
10
+ */
11
+ fullscreen?: FullscreenConfig;
12
+ }
13
+ interface PluginsMap {
14
+ [Fullscreen.pluginName]: Fullscreen;
15
+ [FullscreenEditing.pluginName]: FullscreenEditing;
16
+ [FullscreenUI.pluginName]: FullscreenUI;
17
+ }
18
+ interface CommandsMap {
19
+ toggleFullscreen: FullscreenCommand;
20
+ }
21
21
  }
@@ -1,27 +1,27 @@
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 fullscreen/fullscreen
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { FullscreenEditing } from './fullscreenediting.js';
10
- import { FullscreenUI } from './fullscreenui.js';
6
+ * @module fullscreen/fullscreen
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { FullscreenEditing } from "./fullscreenediting.js";
10
+ import { FullscreenUI } from "./fullscreenui.js";
11
11
  /**
12
- * The fullscreen mode feature.
13
- */
12
+ * The fullscreen mode feature.
13
+ */
14
14
  export declare class Fullscreen extends Plugin {
15
- /**
16
- * @inheritDoc
17
- */
18
- static get requires(): readonly [typeof FullscreenEditing, typeof FullscreenUI];
19
- /**
20
- * @inheritDoc
21
- */
22
- static get pluginName(): "Fullscreen";
23
- /**
24
- * @inheritDoc
25
- */
26
- static get isOfficialPlugin(): true;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ static get requires(): PluginDependenciesOf<[FullscreenEditing, FullscreenUI]>;
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get pluginName(): "Fullscreen";
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static override get isOfficialPlugin(): true;
27
27
  }
@@ -1,55 +1,55 @@
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 fullscreen/fullscreencommand
7
- */
8
- import { Command, type Editor } from '@ckeditor/ckeditor5-core';
9
- import { FullscreenAbstractEditorHandler } from './handlers/abstracteditorhandler.js';
6
+ * @module fullscreen/fullscreencommand
7
+ */
8
+ import { Command, type Editor } from "@ckeditor/ckeditor5-core";
9
+ import { FullscreenAbstractEditorHandler } from "./handlers/abstracteditorhandler.js";
10
10
  /**
11
- * A command toggling the fullscreen mode.
12
- */
11
+ * A command toggling the fullscreen mode.
12
+ */
13
13
  export declare class FullscreenCommand extends Command {
14
- /**
15
- * Indicates whether the fullscreen mode is enabled.
16
- *
17
- * @observable
18
- * @readonly
19
- */
20
- value: boolean;
21
- /**
22
- * Specialized class handling the fullscreen mode toggling for a specific editor type.
23
- *
24
- * If you want to add support for a new editor type (for now, only Classic and Decoupled editors are handled),
25
- * create a custom handler that extends `FullscreenAbstractEditorHandler` and replace `fullscreenHandler` with it after
26
- * editor initialization:
27
- *
28
- * ```ts
29
- * // See the details of how to implement a custom handler in the `FullscreenAbstractEditorHandler` class API docs.
30
- * class CustomEditorHandler extends FullscreenAbstractEditorHandler {}
31
- *
32
- * CustomEditorClass.create()
33
- * .then( ( editor ) => {
34
- * editor.commands.get( 'toggleFullscreen' ).fullscreenHandler = new CustomEditorHandler( editor );
35
- * } );
36
- * ```
37
- */
38
- fullscreenHandler: FullscreenAbstractEditorHandler;
39
- /**
40
- * @inheritDoc
41
- */
42
- constructor(editor: Editor);
43
- /**
44
- * Toggles the fullscreen mode.
45
- */
46
- execute(): void;
47
- /**
48
- * Enables the fullscreen mode.
49
- */
50
- private _enableFullscreenMode;
51
- /**
52
- * Disables the fullscreen mode.
53
- */
54
- private _disableFullscreenMode;
14
+ /**
15
+ * Indicates whether the fullscreen mode is enabled.
16
+ *
17
+ * @observable
18
+ * @readonly
19
+ */
20
+ value: boolean;
21
+ /**
22
+ * Specialized class handling the fullscreen mode toggling for a specific editor type.
23
+ *
24
+ * If you want to add support for a new editor type (for now, only Classic and Decoupled editors are handled),
25
+ * create a custom handler that extends `FullscreenAbstractEditorHandler` and replace `fullscreenHandler` with it after
26
+ * editor initialization:
27
+ *
28
+ * ```ts
29
+ * // See the details of how to implement a custom handler in the `FullscreenAbstractEditorHandler` class API docs.
30
+ * class CustomEditorHandler extends FullscreenAbstractEditorHandler {}
31
+ *
32
+ * CustomEditorClass.create()
33
+ * .then( ( editor ) => {
34
+ * editor.commands.get( 'toggleFullscreen' ).fullscreenHandler = new CustomEditorHandler( editor );
35
+ * } );
36
+ * ```
37
+ */
38
+ fullscreenHandler: FullscreenAbstractEditorHandler;
39
+ /**
40
+ * @inheritDoc
41
+ */
42
+ constructor(editor: Editor);
43
+ /**
44
+ * Toggles the fullscreen mode.
45
+ */
46
+ override execute(): void;
47
+ /**
48
+ * Enables the fullscreen mode.
49
+ */
50
+ private _enableFullscreenMode;
51
+ /**
52
+ * Disables the fullscreen mode.
53
+ */
54
+ private _disableFullscreenMode;
55
55
  }
@@ -1,70 +1,70 @@
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 fullscreen/fullscreenconfig
7
- */
6
+ * @module fullscreen/fullscreenconfig
7
+ */
8
8
  /**
9
- * The configuration of the fullscreen mode feature.
10
- *
11
- * The properties defined in this config are set in the `config.fullscreen` namespace.
12
- *
13
- * ```ts
14
- * ClassicEditor
15
- * .create( {
16
- * fullscreen: {
17
- * // Fullscreen mode configuration.
18
- * }
19
- * } )
20
- * .then( ... )
21
- * .catch( ... );
22
- * ```
23
- *
24
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
25
- */
9
+ * The configuration of the fullscreen mode feature.
10
+ *
11
+ * The properties defined in this config are set in the `config.fullscreen` namespace.
12
+ *
13
+ * ```ts
14
+ * ClassicEditor
15
+ * .create( {
16
+ * fullscreen: {
17
+ * // Fullscreen mode configuration.
18
+ * }
19
+ * } )
20
+ * .then( ... )
21
+ * .catch( ... );
22
+ * ```
23
+ *
24
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
25
+ */
26
26
  export interface FullscreenConfig {
27
- /**
28
- * Customizable callback that is called when you enter the fullscreen mode.
29
- * It's executed after the editor UI elements are moved to the fullscreen mode.
30
- *
31
- * @default `() => {}`
32
- */
33
- onEnterCallback?: (container: HTMLElement) => void;
34
- /**
35
- * Customizable callback that is called when you leave the fullscreen mode.
36
- * It's executed before the editor UI elements are moved back to the normal mode.
37
- *
38
- * @default `() => {}`
39
- */
40
- onLeaveCallback?: (container: HTMLElement) => void;
41
- /**
42
- * The container element for the fullscreen mode. This should be a reference to an existing, positioned element in the DOM.
43
- * By default, the fullscreen mode is appended to the `<body>` element.
44
- */
45
- container?: HTMLElement;
46
- /**
47
- * The configuration of the menu bar in the fullscreen mode.
48
- */
49
- menuBar?: {
50
- /**
51
- * Whether the menu bar is visible in the fullscreen mode.
52
- *
53
- * @default true
54
- */
55
- isVisible?: boolean;
56
- };
57
- /**
58
- * The configuration of the toolbar in the fullscreen mode.
59
- */
60
- toolbar?: {
61
- /**
62
- * Whether toolbar should be grouping items for which there is not enough space.
63
- * By default, toolbar will behave the same as outside the fullscreen mode. You can specify this option to change this behavior
64
- * independently for the fullscreen mode.
65
- *
66
- * @default `!!config.toolbar.shouldNotGroupWhenFull`
67
- */
68
- shouldNotGroupWhenFull?: boolean;
69
- };
27
+ /**
28
+ * Customizable callback that is called when you enter the fullscreen mode.
29
+ * It's executed after the editor UI elements are moved to the fullscreen mode.
30
+ *
31
+ * @default `() => {}`
32
+ */
33
+ onEnterCallback?: (container: HTMLElement) => void;
34
+ /**
35
+ * Customizable callback that is called when you leave the fullscreen mode.
36
+ * It's executed before the editor UI elements are moved back to the normal mode.
37
+ *
38
+ * @default `() => {}`
39
+ */
40
+ onLeaveCallback?: (container: HTMLElement) => void;
41
+ /**
42
+ * The container element for the fullscreen mode. This should be a reference to an existing, positioned element in the DOM.
43
+ * By default, the fullscreen mode is appended to the `<body>` element.
44
+ */
45
+ container?: HTMLElement;
46
+ /**
47
+ * The configuration of the menu bar in the fullscreen mode.
48
+ */
49
+ menuBar?: {
50
+ /**
51
+ * Whether the menu bar is visible in the fullscreen mode.
52
+ *
53
+ * @default true
54
+ */
55
+ isVisible?: boolean;
56
+ };
57
+ /**
58
+ * The configuration of the toolbar in the fullscreen mode.
59
+ */
60
+ toolbar?: {
61
+ /**
62
+ * Whether toolbar should be grouping items for which there is not enough space.
63
+ * By default, toolbar will behave the same as outside the fullscreen mode. You can specify this option to change this behavior
64
+ * independently for the fullscreen mode.
65
+ *
66
+ * @default `!!config.toolbar.shouldNotGroupWhenFull`
67
+ */
68
+ shouldNotGroupWhenFull?: boolean;
69
+ };
70
70
  }
@@ -1,29 +1,29 @@
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 fullscreen/fullscreenediting
7
- */
8
- import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
6
+ * @module fullscreen/fullscreenediting
7
+ */
8
+ import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * A plugin that registers the fullscreen mode command.
11
- */
10
+ * A plugin that registers the fullscreen mode command.
11
+ */
12
12
  export declare class FullscreenEditing extends Plugin {
13
- /**
14
- * @inheritDoc
15
- */
16
- static get pluginName(): "FullscreenEditing";
17
- /**
18
- * @inheritDoc
19
- */
20
- static get isOfficialPlugin(): true;
21
- /**
22
- * @inheritDoc
23
- */
24
- constructor(editor: Editor);
25
- /**
26
- * @inheritDoc
27
- */
28
- init(): void;
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): "FullscreenEditing";
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static override get isOfficialPlugin(): true;
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ constructor(editor: Editor);
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ init(): void;
29
29
  }
@@ -1,35 +1,35 @@
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 fullscreen/fullscreenui
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { FullscreenEditing } from './fullscreenediting.js';
10
- import '../theme/fullscreen.css';
6
+ * @module fullscreen/fullscreenui
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { FullscreenEditing } from "./fullscreenediting.js";
10
+ import "../theme/fullscreen.css";
11
11
  /**
12
- * A plugin registering the fullscreen mode buttons.
13
- */
12
+ * A plugin registering the fullscreen mode buttons.
13
+ */
14
14
  export declare class FullscreenUI extends Plugin {
15
- /**
16
- * @inheritDoc
17
- */
18
- static get requires(): readonly [typeof FullscreenEditing];
19
- /**
20
- * @inheritDoc
21
- */
22
- static get pluginName(): "FullscreenUI";
23
- /**
24
- * @inheritDoc
25
- */
26
- static get isOfficialPlugin(): true;
27
- /**
28
- * @inheritDoc
29
- */
30
- init(): void;
31
- /**
32
- * Creates a button that toggles the fullscreen mode.
33
- */
34
- private _createButton;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ static get requires(): PluginDependenciesOf<[FullscreenEditing]>;
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get pluginName(): "FullscreenUI";
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static override get isOfficialPlugin(): true;
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ init(): void;
31
+ /**
32
+ * Creates a button that toggles the fullscreen mode.
33
+ */
34
+ private _createButton;
35
35
  }