@ckeditor/ckeditor5-editor-inline 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,143 +1,143 @@
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 editor-inline/inlineeditoruiview
7
- */
8
- import { BalloonPanelView, EditorUIView, InlineEditableUIView, ToolbarView } from '@ckeditor/ckeditor5-ui';
9
- import { type PositioningFunction, type Locale } from '@ckeditor/ckeditor5-utils';
10
- import type { EditingView } from '@ckeditor/ckeditor5-engine';
11
- import type { ViewRootElementDefinition } from '@ckeditor/ckeditor5-core';
12
- import '../theme/inlineeditor.css';
6
+ * @module editor-inline/inlineeditoruiview
7
+ */
8
+ import { BalloonPanelView, EditorUIView, InlineEditableUIView, ToolbarView } from "@ckeditor/ckeditor5-ui";
9
+ import { type PositioningFunction, type Locale } from "@ckeditor/ckeditor5-utils";
10
+ import type { EditingView } from "@ckeditor/ckeditor5-engine";
11
+ import type { ViewRootElementDefinition } from "@ckeditor/ckeditor5-core";
12
+ import "../theme/inlineeditor.css";
13
13
  /**
14
- * Inline editor UI view. Uses an nline editable and a floating toolbar.
15
- */
14
+ * Inline editor UI view. Uses an nline editable and a floating toolbar.
15
+ */
16
16
  export declare class InlineEditorUIView extends EditorUIView {
17
- /**
18
- * A floating toolbar view instance.
19
- */
20
- readonly toolbar: ToolbarView;
21
- /**
22
- * The offset from the top edge of the web browser's viewport which makes the
23
- * UI become sticky. The default value is `0`, which means that the UI becomes
24
- * sticky when its upper edge touches the top of the page viewport.
25
- *
26
- * This attribute is useful when the web page has UI elements positioned to the top
27
- * either using `position: fixed` or `position: sticky`, which would cover the
28
- * UI or vice–versa (depending on the `z-index` hierarchy).
29
- *
30
- * Bound to {@link module:ui/editorui/editorui~EditorUI#viewportOffset `EditorUI#viewportOffset`}.
31
- *
32
- * If {@link module:core/editor/editorconfig~EditorConfig#ui `EditorConfig#ui.viewportOffset.top`} is defined, then
33
- * it will override the default value.
34
- *
35
- * @observable
36
- * @default 0
37
- */
38
- viewportTopOffset: number;
39
- /**
40
- * A balloon panel view instance.
41
- */
42
- readonly panel: BalloonPanelView;
43
- /**
44
- * A set of positioning functions used by the {@link #panel} to float around
45
- * {@link #element editableElement}.
46
- *
47
- * The positioning functions are as follows:
48
- *
49
- * * West:
50
- *
51
- * ```
52
- * [ Panel ]
53
- * +------------------+
54
- * | #editableElement |
55
- * +------------------+
56
- *
57
- * +------------------+
58
- * | #editableElement |
59
- * |[ Panel ] |
60
- * | |
61
- * +------------------+
62
- *
63
- * +------------------+
64
- * | #editableElement |
65
- * +------------------+
66
- * [ Panel ]
67
- * ```
68
- *
69
- * * East:
70
- *
71
- * ```
72
- * [ Panel ]
73
- * +------------------+
74
- * | #editableElement |
75
- * +------------------+
76
- *
77
- * +------------------+
78
- * | #editableElement |
79
- * | [ Panel ]|
80
- * | |
81
- * +------------------+
82
- *
83
- * +------------------+
84
- * | #editableElement |
85
- * +------------------+
86
- * [ Panel ]
87
- * ```
88
- *
89
- * See: {@link module:utils/dom/position~DomOptimalPositionOptions#positions}.
90
- */
91
- readonly panelPositions: Array<PositioningFunction>;
92
- /**
93
- * Editable UI view.
94
- */
95
- readonly editable: InlineEditableUIView;
96
- /**
97
- * An instance of the resize observer that helps dynamically determine the geometry of the toolbar
98
- * and manage items that do not fit into a single row.
99
- *
100
- * **Note:** Created in {@link #render}.
101
- */
102
- private _resizeObserver;
103
- /**
104
- * Creates an instance of the inline editor UI view.
105
- *
106
- * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
107
- * @param editingView The editing view instance this view is related to.
108
- * @param editableElement The editable element. If not specified, it will be automatically created by
109
- * {@link module:ui/editableui/editableuiview~EditableUIView}. Otherwise, the given element will be used.
110
- * @param options Configuration options for the view instance.
111
- * @param options.shouldToolbarGroupWhenFull When set `true` enables automatic items grouping
112
- * in the main {@link module:editor-inline/inlineeditoruiview~InlineEditorUIView#toolbar toolbar}.
113
- * See {@link module:ui/toolbar/toolbarview~ToolbarOptions#shouldGroupWhenFull} to learn more.
114
- * @param options.label When set, this value will be used as an accessible `aria-label` of the
115
- * {@link module:ui/editableui/editableuiview~EditableUIView editable view}.
116
- */
117
- constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition, options?: {
118
- shouldToolbarGroupWhenFull?: boolean;
119
- useMenuBar?: boolean;
120
- label?: string | Record<string, string>;
121
- });
122
- /**
123
- * @inheritDoc
124
- */
125
- render(): void;
126
- /**
127
- * @inheritDoc
128
- */
129
- destroy(): void;
130
- /**
131
- * Determines the panel top position of the {@link #panel} in {@link #panelPositions}.
132
- *
133
- * @param editableRect Rect of the {@link #element}.
134
- * @param panelRect Rect of the {@link #panel}.
135
- */
136
- private _getPanelPositionTop;
137
- /**
138
- * Returns the positions for {@link #panelPositions}.
139
- *
140
- * See: {@link module:utils/dom/position~DomOptimalPositionOptions#positions}.
141
- */
142
- private _getPanelPositions;
17
+ /**
18
+ * A floating toolbar view instance.
19
+ */
20
+ override readonly toolbar: ToolbarView;
21
+ /**
22
+ * The offset from the top edge of the web browser's viewport which makes the
23
+ * UI become sticky. The default value is `0`, which means that the UI becomes
24
+ * sticky when its upper edge touches the top of the page viewport.
25
+ *
26
+ * This attribute is useful when the web page has UI elements positioned to the top
27
+ * either using `position: fixed` or `position: sticky`, which would cover the
28
+ * UI or vice–versa (depending on the `z-index` hierarchy).
29
+ *
30
+ * Bound to {@link module:ui/editorui/editorui~EditorUI#viewportOffset `EditorUI#viewportOffset`}.
31
+ *
32
+ * If {@link module:core/editor/editorconfig~EditorConfig#ui `EditorConfig#ui.viewportOffset.top`} is defined, then
33
+ * it will override the default value.
34
+ *
35
+ * @observable
36
+ * @default 0
37
+ */
38
+ viewportTopOffset: number;
39
+ /**
40
+ * A balloon panel view instance.
41
+ */
42
+ readonly panel: BalloonPanelView;
43
+ /**
44
+ * A set of positioning functions used by the {@link #panel} to float around
45
+ * {@link #element editableElement}.
46
+ *
47
+ * The positioning functions are as follows:
48
+ *
49
+ * * West:
50
+ *
51
+ * ```
52
+ * [ Panel ]
53
+ * +------------------+
54
+ * | #editableElement |
55
+ * +------------------+
56
+ *
57
+ * +------------------+
58
+ * | #editableElement |
59
+ * |[ Panel ] |
60
+ * | |
61
+ * +------------------+
62
+ *
63
+ * +------------------+
64
+ * | #editableElement |
65
+ * +------------------+
66
+ * [ Panel ]
67
+ * ```
68
+ *
69
+ * * East:
70
+ *
71
+ * ```
72
+ * [ Panel ]
73
+ * +------------------+
74
+ * | #editableElement |
75
+ * +------------------+
76
+ *
77
+ * +------------------+
78
+ * | #editableElement |
79
+ * | [ Panel ]|
80
+ * | |
81
+ * +------------------+
82
+ *
83
+ * +------------------+
84
+ * | #editableElement |
85
+ * +------------------+
86
+ * [ Panel ]
87
+ * ```
88
+ *
89
+ * See: {@link module:utils/dom/position~DomOptimalPositionOptions#positions}.
90
+ */
91
+ readonly panelPositions: Array<PositioningFunction>;
92
+ /**
93
+ * Editable UI view.
94
+ */
95
+ readonly editable: InlineEditableUIView;
96
+ /**
97
+ * An instance of the resize observer that helps dynamically determine the geometry of the toolbar
98
+ * and manage items that do not fit into a single row.
99
+ *
100
+ * **Note:** Created in {@link #render}.
101
+ */
102
+ private _resizeObserver;
103
+ /**
104
+ * Creates an instance of the inline editor UI view.
105
+ *
106
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
107
+ * @param editingView The editing view instance this view is related to.
108
+ * @param editableElement The editable element. If not specified, it will be automatically created by
109
+ * {@link module:ui/editableui/editableuiview~EditableUIView}. Otherwise, the given element will be used.
110
+ * @param options Configuration options for the view instance.
111
+ * @param options.shouldToolbarGroupWhenFull When set `true` enables automatic items grouping
112
+ * in the main {@link module:editor-inline/inlineeditoruiview~InlineEditorUIView#toolbar toolbar}.
113
+ * See {@link module:ui/toolbar/toolbarview~ToolbarOptions#shouldGroupWhenFull} to learn more.
114
+ * @param options.label When set, this value will be used as an accessible `aria-label` of the
115
+ * {@link module:ui/editableui/editableuiview~EditableUIView editable view}.
116
+ */
117
+ constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition, options?: {
118
+ shouldToolbarGroupWhenFull?: boolean;
119
+ useMenuBar?: boolean;
120
+ label?: string | Record<string, string>;
121
+ });
122
+ /**
123
+ * @inheritDoc
124
+ */
125
+ override render(): void;
126
+ /**
127
+ * @inheritDoc
128
+ */
129
+ override destroy(): void;
130
+ /**
131
+ * Determines the panel top position of the {@link #panel} in {@link #panelPositions}.
132
+ *
133
+ * @param editableRect Rect of the {@link #element}.
134
+ * @param panelRect Rect of the {@link #panel}.
135
+ */
136
+ private _getPanelPositionTop;
137
+ /**
138
+ * Returns the positions for {@link #panelPositions}.
139
+ *
140
+ * See: {@link module:utils/dom/position~DomOptimalPositionOptions#positions}.
141
+ */
142
+ private _getPanelPositions;
143
143
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ckeditor/ckeditor5-editor-inline",
3
- "version": "48.2.0",
3
+ "version": "48.3.0-alpha.1",
4
4
  "description": "Inline editor implementation for CKEditor 5.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "CKSource (http://cksource.com/)",
@@ -25,10 +25,10 @@
25
25
  "./package.json": "./package.json"
26
26
  },
27
27
  "dependencies": {
28
- "@ckeditor/ckeditor5-core": "48.2.0",
29
- "@ckeditor/ckeditor5-engine": "48.2.0",
30
- "@ckeditor/ckeditor5-ui": "48.2.0",
31
- "@ckeditor/ckeditor5-utils": "48.2.0",
28
+ "@ckeditor/ckeditor5-core": "48.3.0-alpha.1",
29
+ "@ckeditor/ckeditor5-engine": "48.3.0-alpha.1",
30
+ "@ckeditor/ckeditor5-ui": "48.3.0-alpha.1",
31
+ "@ckeditor/ckeditor5-utils": "48.3.0-alpha.1",
32
32
  "es-toolkit": "1.45.1"
33
33
  },
34
34
  "files": [