@ckeditor/ckeditor5-fullscreen 45.2.1 → 46.0.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.
- package/build/fullscreen.js +1 -1
- package/dist/index.js +14 -13
- package/dist/index.js.map +1 -1
- package/package.json +8 -8
- package/src/fullscreen.d.ts +3 -3
- package/src/fullscreen.js +3 -3
- package/src/fullscreencommand.d.ts +7 -6
- package/src/fullscreencommand.js +12 -11
- package/src/fullscreenconfig.d.ts +1 -1
- package/src/fullscreenediting.d.ts +1 -1
- package/src/fullscreenediting.js +2 -2
- package/src/fullscreenui.d.ts +2 -2
- package/src/fullscreenui.js +2 -2
- package/src/handlers/abstracteditorhandler.d.ts +3 -3
- package/src/handlers/abstracteditorhandler.js +3 -3
- package/src/handlers/classiceditorhandler.d.ts +2 -2
- package/src/handlers/classiceditorhandler.js +2 -2
- package/src/handlers/decouplededitorhandler.d.ts +2 -2
- package/src/handlers/decouplededitorhandler.js +2 -2
- package/src/index.d.ts +8 -6
- package/src/index.js +7 -4
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor5-fullscreen",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "46.0.0-alpha.0",
|
|
4
4
|
"description": "Fullscreen mode feature for CKEditor 5.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ckeditor",
|
|
@@ -13,13 +13,13 @@
|
|
|
13
13
|
"type": "module",
|
|
14
14
|
"main": "src/index.js",
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@ckeditor/ckeditor5-core": "
|
|
17
|
-
"@ckeditor/ckeditor5-editor-classic": "
|
|
18
|
-
"@ckeditor/ckeditor5-editor-decoupled": "
|
|
19
|
-
"@ckeditor/ckeditor5-icons": "
|
|
20
|
-
"@ckeditor/ckeditor5-ui": "
|
|
21
|
-
"@ckeditor/ckeditor5-utils": "
|
|
22
|
-
"ckeditor5": "
|
|
16
|
+
"@ckeditor/ckeditor5-core": "46.0.0-alpha.0",
|
|
17
|
+
"@ckeditor/ckeditor5-editor-classic": "46.0.0-alpha.0",
|
|
18
|
+
"@ckeditor/ckeditor5-editor-decoupled": "46.0.0-alpha.0",
|
|
19
|
+
"@ckeditor/ckeditor5-icons": "46.0.0-alpha.0",
|
|
20
|
+
"@ckeditor/ckeditor5-ui": "46.0.0-alpha.0",
|
|
21
|
+
"@ckeditor/ckeditor5-utils": "46.0.0-alpha.0",
|
|
22
|
+
"ckeditor5": "46.0.0-alpha.0"
|
|
23
23
|
},
|
|
24
24
|
"author": "CKSource (http://cksource.com/)",
|
|
25
25
|
"license": "SEE LICENSE IN LICENSE.md",
|
package/src/fullscreen.d.ts
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
* @module fullscreen/fullscreen
|
|
7
7
|
*/
|
|
8
8
|
import { Plugin } from 'ckeditor5/src/core.js';
|
|
9
|
-
import FullscreenEditing from './fullscreenediting.js';
|
|
10
|
-
import FullscreenUI from './fullscreenui.js';
|
|
9
|
+
import { FullscreenEditing } from './fullscreenediting.js';
|
|
10
|
+
import { FullscreenUI } from './fullscreenui.js';
|
|
11
11
|
/**
|
|
12
12
|
* The fullscreen mode feature.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export declare class Fullscreen extends Plugin {
|
|
15
15
|
/**
|
|
16
16
|
* @inheritDoc
|
|
17
17
|
*/
|
package/src/fullscreen.js
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
* @module fullscreen/fullscreen
|
|
7
7
|
*/
|
|
8
8
|
import { Plugin } from 'ckeditor5/src/core.js';
|
|
9
|
-
import FullscreenEditing from './fullscreenediting.js';
|
|
10
|
-
import FullscreenUI from './fullscreenui.js';
|
|
9
|
+
import { FullscreenEditing } from './fullscreenediting.js';
|
|
10
|
+
import { FullscreenUI } from './fullscreenui.js';
|
|
11
11
|
/**
|
|
12
12
|
* The fullscreen mode feature.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export class Fullscreen extends Plugin {
|
|
15
15
|
/**
|
|
16
16
|
* @inheritDoc
|
|
17
17
|
*/
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
* @module fullscreen/fullscreencommand
|
|
7
7
|
*/
|
|
8
8
|
import { Command, type Editor } from 'ckeditor5/src/core.js';
|
|
9
|
-
import
|
|
9
|
+
import { FullscreenAbstractEditorHandler } from './handlers/abstracteditorhandler.js';
|
|
10
10
|
/**
|
|
11
11
|
* A command toggling the fullscreen mode.
|
|
12
12
|
*/
|
|
13
|
-
export
|
|
13
|
+
export declare class FullscreenCommand extends Command {
|
|
14
14
|
/**
|
|
15
15
|
* Indicates whether the fullscreen mode is enabled.
|
|
16
16
|
*
|
|
@@ -22,11 +22,12 @@ export default class FullscreenCommand extends Command {
|
|
|
22
22
|
* Specialized class handling the fullscreen mode toggling for a specific editor type.
|
|
23
23
|
*
|
|
24
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 `
|
|
25
|
+
* create a custom handler that extends `FullscreenAbstractEditorHandler` and replace `fullscreenHandler` with it after
|
|
26
|
+
* editor initialization:
|
|
26
27
|
*
|
|
27
28
|
* ```ts
|
|
28
|
-
* // See the details of how to implement a custom handler in the `
|
|
29
|
-
* class CustomEditorHandler extends
|
|
29
|
+
* // See the details of how to implement a custom handler in the `FullscreenAbstractEditorHandler` class API docs.
|
|
30
|
+
* class CustomEditorHandler extends FullscreenAbstractEditorHandler {}
|
|
30
31
|
*
|
|
31
32
|
* CustomEditorClass.create( document.querySelector( '#editor' ), {} )
|
|
32
33
|
* .then( ( editor ) => {
|
|
@@ -34,7 +35,7 @@ export default class FullscreenCommand extends Command {
|
|
|
34
35
|
* } );
|
|
35
36
|
* ```
|
|
36
37
|
*/
|
|
37
|
-
fullscreenHandler:
|
|
38
|
+
fullscreenHandler: FullscreenAbstractEditorHandler;
|
|
38
39
|
/**
|
|
39
40
|
* @inheritDoc
|
|
40
41
|
*/
|
package/src/fullscreencommand.js
CHANGED
|
@@ -6,22 +6,23 @@
|
|
|
6
6
|
* @module fullscreen/fullscreencommand
|
|
7
7
|
*/
|
|
8
8
|
import { Command } from 'ckeditor5/src/core.js';
|
|
9
|
-
import
|
|
10
|
-
import
|
|
11
|
-
import
|
|
9
|
+
import { FullscreenAbstractEditorHandler } from './handlers/abstracteditorhandler.js';
|
|
10
|
+
import { FullscreenClassicEditorHandler } from './handlers/classiceditorhandler.js';
|
|
11
|
+
import { FullscreenDecoupledEditorHandler } from './handlers/decouplededitorhandler.js';
|
|
12
12
|
/**
|
|
13
13
|
* A command toggling the fullscreen mode.
|
|
14
14
|
*/
|
|
15
|
-
export
|
|
15
|
+
export class FullscreenCommand extends Command {
|
|
16
16
|
/**
|
|
17
17
|
* Specialized class handling the fullscreen mode toggling for a specific editor type.
|
|
18
18
|
*
|
|
19
19
|
* If you want to add support for a new editor type (for now, only Classic and Decoupled editors are handled),
|
|
20
|
-
* create a custom handler that extends `
|
|
20
|
+
* create a custom handler that extends `FullscreenAbstractEditorHandler` and replace `fullscreenHandler` with it after
|
|
21
|
+
* editor initialization:
|
|
21
22
|
*
|
|
22
23
|
* ```ts
|
|
23
|
-
* // See the details of how to implement a custom handler in the `
|
|
24
|
-
* class CustomEditorHandler extends
|
|
24
|
+
* // See the details of how to implement a custom handler in the `FullscreenAbstractEditorHandler` class API docs.
|
|
25
|
+
* class CustomEditorHandler extends FullscreenAbstractEditorHandler {}
|
|
25
26
|
*
|
|
26
27
|
* CustomEditorClass.create( document.querySelector( '#editor' ), {} )
|
|
27
28
|
* .then( ( editor ) => {
|
|
@@ -40,15 +41,15 @@ export default class FullscreenCommand extends Command {
|
|
|
40
41
|
this.value = false;
|
|
41
42
|
// Choose the appropriate handler based on the editor type.
|
|
42
43
|
// Currently only `ClassicEditor` and `DecoupledEditor` are supported. For other editor types, you should create a custom handler
|
|
43
|
-
// that extends `
|
|
44
|
+
// that extends `FullscreenAbstractEditorHandler` and replace `fullscreenHandler` with it.
|
|
44
45
|
if (isClassicEditor(editor)) {
|
|
45
|
-
this.fullscreenHandler = new
|
|
46
|
+
this.fullscreenHandler = new FullscreenClassicEditorHandler(editor);
|
|
46
47
|
}
|
|
47
48
|
else if (isDecoupledEditor(editor)) {
|
|
48
|
-
this.fullscreenHandler = new
|
|
49
|
+
this.fullscreenHandler = new FullscreenDecoupledEditorHandler(editor);
|
|
49
50
|
}
|
|
50
51
|
else {
|
|
51
|
-
this.fullscreenHandler = new
|
|
52
|
+
this.fullscreenHandler = new FullscreenAbstractEditorHandler(editor);
|
|
52
53
|
}
|
|
53
54
|
}
|
|
54
55
|
/**
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
*
|
|
24
24
|
* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
|
|
25
25
|
*/
|
|
26
|
-
export
|
|
26
|
+
export interface FullscreenConfig {
|
|
27
27
|
/**
|
|
28
28
|
* Customizable callback that is called when you enter the fullscreen mode.
|
|
29
29
|
* It's executed after the editor UI elements are moved to the fullscreen mode.
|
|
@@ -9,7 +9,7 @@ import { Plugin, type Editor } from 'ckeditor5/src/core.js';
|
|
|
9
9
|
/**
|
|
10
10
|
* A plugin that registers the fullscreen mode command.
|
|
11
11
|
*/
|
|
12
|
-
export
|
|
12
|
+
export declare class FullscreenEditing extends Plugin {
|
|
13
13
|
/**
|
|
14
14
|
* @inheritDoc
|
|
15
15
|
*/
|
package/src/fullscreenediting.js
CHANGED
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { Plugin } from 'ckeditor5/src/core.js';
|
|
9
9
|
import { env } from 'ckeditor5/src/utils.js';
|
|
10
|
-
import FullscreenCommand from './fullscreencommand.js';
|
|
10
|
+
import { FullscreenCommand } from './fullscreencommand.js';
|
|
11
11
|
/**
|
|
12
12
|
* A plugin that registers the fullscreen mode command.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export class FullscreenEditing extends Plugin {
|
|
15
15
|
/**
|
|
16
16
|
* @inheritDoc
|
|
17
17
|
*/
|
package/src/fullscreenui.d.ts
CHANGED
|
@@ -6,12 +6,12 @@
|
|
|
6
6
|
* @module fullscreen/fullscreenui
|
|
7
7
|
*/
|
|
8
8
|
import { Plugin } from 'ckeditor5/src/core.js';
|
|
9
|
-
import FullscreenEditing from './fullscreenediting.js';
|
|
9
|
+
import { FullscreenEditing } from './fullscreenediting.js';
|
|
10
10
|
import '../theme/fullscreen.css';
|
|
11
11
|
/**
|
|
12
12
|
* A plugin registering the fullscreen mode buttons.
|
|
13
13
|
*/
|
|
14
|
-
export
|
|
14
|
+
export declare class FullscreenUI extends Plugin {
|
|
15
15
|
/**
|
|
16
16
|
* @inheritDoc
|
|
17
17
|
*/
|
package/src/fullscreenui.js
CHANGED
|
@@ -9,13 +9,13 @@ import { Plugin } from 'ckeditor5/src/core.js';
|
|
|
9
9
|
import { ButtonView, MenuBarMenuListItemButtonView } from 'ckeditor5/src/ui.js';
|
|
10
10
|
import { IconFullscreenEnter, IconFullscreenLeave } from 'ckeditor5/src/icons.js';
|
|
11
11
|
import { env } from 'ckeditor5/src/utils.js';
|
|
12
|
-
import FullscreenEditing from './fullscreenediting.js';
|
|
12
|
+
import { FullscreenEditing } from './fullscreenediting.js';
|
|
13
13
|
import '../theme/fullscreen.css';
|
|
14
14
|
const COMMAND_NAME = 'toggleFullscreen';
|
|
15
15
|
/**
|
|
16
16
|
* A plugin registering the fullscreen mode buttons.
|
|
17
17
|
*/
|
|
18
|
-
export
|
|
18
|
+
export class FullscreenUI extends Plugin {
|
|
19
19
|
/**
|
|
20
20
|
* @inheritDoc
|
|
21
21
|
*/
|
|
@@ -15,8 +15,8 @@ import type { ElementApi, Editor, EditorConfig } from 'ckeditor5/src/core.js';
|
|
|
15
15
|
* or if you wish to heavily customize the default behavior.
|
|
16
16
|
*
|
|
17
17
|
* The only method that is necessary to provide when extending this class is {@link #defaultOnEnter}. However, make sure to
|
|
18
|
-
* familiarize yourself with the below full list of actions taken by `
|
|
19
|
-
* and what should be provided by you.
|
|
18
|
+
* familiarize yourself with the below full list of actions taken by `FullscreenAbstractEditorHandler` to understand
|
|
19
|
+
* what is covered by default, and what should be provided by you.
|
|
20
20
|
*
|
|
21
21
|
* When entering the fullscreen mode, the {@link #enable} method is called. It creates the properly styled container
|
|
22
22
|
* and handles the editor features that need it, in the following order:
|
|
@@ -64,7 +64,7 @@ import type { ElementApi, Editor, EditorConfig } from 'ckeditor5/src/core.js';
|
|
|
64
64
|
*
|
|
65
65
|
* This class is exported to allow for custom extensions.
|
|
66
66
|
*/
|
|
67
|
-
export
|
|
67
|
+
export declare class FullscreenAbstractEditorHandler {
|
|
68
68
|
/**
|
|
69
69
|
* Maps placeholder names to placeholder elements and moved elements.
|
|
70
70
|
*/
|
|
@@ -19,8 +19,8 @@ const DIALOG_OFFSET = 28;
|
|
|
19
19
|
* or if you wish to heavily customize the default behavior.
|
|
20
20
|
*
|
|
21
21
|
* The only method that is necessary to provide when extending this class is {@link #defaultOnEnter}. However, make sure to
|
|
22
|
-
* familiarize yourself with the below full list of actions taken by `
|
|
23
|
-
* and what should be provided by you.
|
|
22
|
+
* familiarize yourself with the below full list of actions taken by `FullscreenAbstractEditorHandler` to understand
|
|
23
|
+
* what is covered by default, and what should be provided by you.
|
|
24
24
|
*
|
|
25
25
|
* When entering the fullscreen mode, the {@link #enable} method is called. It creates the properly styled container
|
|
26
26
|
* and handles the editor features that need it, in the following order:
|
|
@@ -68,7 +68,7 @@ const DIALOG_OFFSET = 28;
|
|
|
68
68
|
*
|
|
69
69
|
* This class is exported to allow for custom extensions.
|
|
70
70
|
*/
|
|
71
|
-
export
|
|
71
|
+
export class FullscreenAbstractEditorHandler {
|
|
72
72
|
/**
|
|
73
73
|
* Maps placeholder names to placeholder elements and moved elements.
|
|
74
74
|
*/
|
|
@@ -3,11 +3,11 @@
|
|
|
3
3
|
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
4
|
*/
|
|
5
5
|
import type { ClassicEditor } from '@ckeditor/ckeditor5-editor-classic';
|
|
6
|
-
import
|
|
6
|
+
import { FullscreenAbstractEditorHandler } from './abstracteditorhandler.js';
|
|
7
7
|
/**
|
|
8
8
|
* The classic editor fullscreen mode handler.
|
|
9
9
|
*/
|
|
10
|
-
export
|
|
10
|
+
export declare class FullscreenClassicEditorHandler extends FullscreenAbstractEditorHandler {
|
|
11
11
|
/**
|
|
12
12
|
* An editor instance.
|
|
13
13
|
*/
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
* @module fullscreen/handlers/classiceditorhandler
|
|
7
7
|
*/
|
|
8
8
|
import { MenuBarView } from 'ckeditor5/src/ui.js';
|
|
9
|
-
import
|
|
9
|
+
import { FullscreenAbstractEditorHandler } from './abstracteditorhandler.js';
|
|
10
10
|
/**
|
|
11
11
|
* The classic editor fullscreen mode handler.
|
|
12
12
|
*/
|
|
13
|
-
export
|
|
13
|
+
export class FullscreenClassicEditorHandler extends FullscreenAbstractEditorHandler {
|
|
14
14
|
/**
|
|
15
15
|
* An editor instance.
|
|
16
16
|
*/
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
* @module fullscreen/handlers/decouplededitorhandler
|
|
7
7
|
*/
|
|
8
8
|
import type { DecoupledEditor } from '@ckeditor/ckeditor5-editor-decoupled';
|
|
9
|
-
import
|
|
9
|
+
import { FullscreenAbstractEditorHandler } from './abstracteditorhandler.js';
|
|
10
10
|
/**
|
|
11
11
|
* The decoupled editor fullscreen mode handler.
|
|
12
12
|
*/
|
|
13
|
-
export
|
|
13
|
+
export declare class FullscreenDecoupledEditorHandler extends FullscreenAbstractEditorHandler {
|
|
14
14
|
/**
|
|
15
15
|
* An editor instance.
|
|
16
16
|
*/
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
* @license Copyright (c) 2003-2025, 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
|
-
import
|
|
5
|
+
import { FullscreenAbstractEditorHandler } from './abstracteditorhandler.js';
|
|
6
6
|
/**
|
|
7
7
|
* The decoupled editor fullscreen mode handler.
|
|
8
8
|
*/
|
|
9
|
-
export
|
|
9
|
+
export class FullscreenDecoupledEditorHandler extends FullscreenAbstractEditorHandler {
|
|
10
10
|
/**
|
|
11
11
|
* An editor instance.
|
|
12
12
|
*/
|
package/src/index.d.ts
CHANGED
|
@@ -5,10 +5,12 @@
|
|
|
5
5
|
/**
|
|
6
6
|
* @module fullscreen
|
|
7
7
|
*/
|
|
8
|
-
export {
|
|
9
|
-
export {
|
|
10
|
-
export {
|
|
11
|
-
export {
|
|
12
|
-
export
|
|
13
|
-
export
|
|
8
|
+
export { Fullscreen } from './fullscreen.js';
|
|
9
|
+
export { FullscreenEditing } from './fullscreenediting.js';
|
|
10
|
+
export { FullscreenUI } from './fullscreenui.js';
|
|
11
|
+
export { FullscreenCommand } from './fullscreencommand.js';
|
|
12
|
+
export { FullscreenAbstractEditorHandler } from './handlers/abstracteditorhandler.js';
|
|
13
|
+
export { FullscreenClassicEditorHandler } from './handlers/classiceditorhandler.js';
|
|
14
|
+
export { FullscreenDecoupledEditorHandler } from './handlers/decouplededitorhandler.js';
|
|
15
|
+
export type { FullscreenConfig } from './fullscreenconfig.js';
|
|
14
16
|
import './augmentation.js';
|
package/src/index.js
CHANGED
|
@@ -5,8 +5,11 @@
|
|
|
5
5
|
/**
|
|
6
6
|
* @module fullscreen
|
|
7
7
|
*/
|
|
8
|
-
export {
|
|
9
|
-
export {
|
|
10
|
-
export {
|
|
11
|
-
export {
|
|
8
|
+
export { Fullscreen } from './fullscreen.js';
|
|
9
|
+
export { FullscreenEditing } from './fullscreenediting.js';
|
|
10
|
+
export { FullscreenUI } from './fullscreenui.js';
|
|
11
|
+
export { FullscreenCommand } from './fullscreencommand.js';
|
|
12
|
+
export { FullscreenAbstractEditorHandler } from './handlers/abstracteditorhandler.js';
|
|
13
|
+
export { FullscreenClassicEditorHandler } from './handlers/classiceditorhandler.js';
|
|
14
|
+
export { FullscreenDecoupledEditorHandler } from './handlers/decouplededitorhandler.js';
|
|
12
15
|
import './augmentation.js';
|