@ckeditor/ckeditor5-ui 48.2.0-alpha.7 → 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.
- package/dist/arialiveannouncer.d.ts +90 -90
- package/dist/augmentation.d.ts +86 -86
- package/dist/autocomplete/autocompleteview.d.ts +70 -70
- package/dist/badge/badge.d.ts +119 -121
- package/dist/bindings/addkeyboardhandlingforgrid.d.ts +22 -22
- package/dist/bindings/clickoutsidehandler.d.ts +25 -25
- package/dist/bindings/csstransitiondisablermixin.d.ts +47 -36
- package/dist/bindings/draggableviewmixin.d.ts +45 -37
- package/dist/bindings/preventdefault.d.ts +30 -30
- package/dist/bindings/submithandler.d.ts +49 -49
- package/dist/button/button.d.ts +167 -167
- package/dist/button/buttonlabel.d.ts +28 -28
- package/dist/button/buttonlabelview.d.ts +26 -26
- package/dist/button/buttonview.d.ts +192 -192
- package/dist/button/filedialogbuttonview.d.ts +107 -99
- package/dist/button/listitembuttonview.d.ts +73 -73
- package/dist/button/switchbuttonview.d.ts +40 -40
- package/dist/collapsible/collapsibleview.d.ts +63 -63
- package/dist/colorgrid/colorgridview.d.ts +117 -117
- package/dist/colorgrid/colortileview.d.ts +21 -21
- package/dist/colorgrid/utils.d.ts +35 -35
- package/dist/colorpicker/colorpickerview.d.ts +155 -157
- package/dist/colorpicker/utils.d.ts +37 -37
- package/dist/colorselector/colorgridsfragmentview.d.ts +191 -191
- package/dist/colorselector/colorpickerfragmentview.d.ts +129 -129
- package/dist/colorselector/colorselectorview.d.ts +227 -229
- package/dist/colorselector/documentcolorcollection.d.ts +52 -59
- package/dist/componentfactory.d.ts +76 -76
- package/dist/dialog/dialog.d.ts +311 -288
- package/dist/dialog/dialogactionsview.d.ts +62 -62
- package/dist/dialog/dialogcontentview.d.ts +22 -22
- package/dist/dialog/dialogview.d.ts +255 -251
- package/dist/dropdown/button/dropdownbutton.d.ts +17 -17
- package/dist/dropdown/button/dropdownbuttonview.d.ts +41 -41
- package/dist/dropdown/button/splitbuttonview.d.ts +155 -155
- package/dist/dropdown/dropdownpanelfocusable.d.ts +16 -16
- package/dist/dropdown/dropdownpanelview.d.ts +56 -56
- package/dist/dropdown/dropdownview.d.ts +326 -326
- package/dist/dropdown/menu/dropdownmenubehaviors.d.ts +43 -43
- package/dist/dropdown/menu/dropdownmenubuttonview.d.ts +29 -29
- package/dist/dropdown/menu/dropdownmenulistitembuttonview.d.ts +12 -12
- package/dist/dropdown/menu/dropdownmenulistitemview.d.ts +17 -17
- package/dist/dropdown/menu/dropdownmenulistview.d.ts +19 -19
- package/dist/dropdown/menu/dropdownmenunestedmenupanelview.d.ts +28 -28
- package/dist/dropdown/menu/dropdownmenunestedmenuview.d.ts +126 -126
- package/dist/dropdown/menu/dropdownmenurootlistview.d.ts +132 -132
- package/dist/dropdown/menu/utils.d.ts +112 -112
- package/dist/dropdown/utils.d.ts +272 -272
- package/dist/editableui/editableuiview.d.ts +78 -78
- package/dist/editableui/inline/inlineeditableuiview.d.ts +38 -38
- package/dist/editorui/accessibilityhelp/accessibilityhelp.d.ts +50 -50
- package/dist/editorui/accessibilityhelp/accessibilityhelpcontentview.d.ts +30 -30
- package/dist/editorui/bodycollection.d.ts +86 -86
- package/dist/editorui/boxed/boxededitoruiview.d.ts +35 -35
- package/dist/editorui/editorui.d.ts +348 -351
- package/dist/editorui/editoruiview.d.ts +53 -53
- package/dist/editorui/evaluationbadge.d.ts +28 -28
- package/dist/editorui/poweredby.d.ts +25 -25
- package/dist/focuscycler.d.ts +265 -270
- package/dist/formheader/formheaderview.d.ts +53 -53
- package/dist/formrow/formrowview.d.ts +52 -52
- package/dist/highlightedtext/buttonlabelwithhighlightview.d.ts +25 -25
- package/dist/highlightedtext/highlightedtextview.d.ts +33 -33
- package/dist/highlightedtext/labelwithhighlightview.d.ts +21 -21
- package/dist/icon/iconview.d.ts +83 -83
- package/dist/iframe/iframeview.d.ts +42 -42
- package/dist/index.css.map +1 -1
- package/dist/index.d.ts +136 -136
- package/dist/index.js +16467 -17751
- package/dist/index.js.map +1 -1
- package/dist/input/inputbase.d.ts +114 -114
- package/dist/input/inputview.d.ts +28 -28
- package/dist/inputnumber/inputnumberview.d.ts +44 -44
- package/dist/inputtext/inputtextview.d.ts +13 -13
- package/dist/label/labelview.d.ts +31 -31
- package/dist/labeledfield/labeledfieldview.d.ts +180 -180
- package/dist/labeledfield/utils.d.ts +112 -112
- package/dist/labeledinput/labeledinputview.d.ts +120 -120
- package/dist/legacyerrors.d.ts +0 -4
- package/dist/list/listitemgroupview.d.ts +54 -54
- package/dist/list/listitemview.d.ts +31 -31
- package/dist/list/listseparatorview.d.ts +13 -13
- package/dist/list/listview.d.ts +119 -119
- package/dist/menubar/menubarmenubuttonview.d.ts +28 -28
- package/dist/menubar/menubarmenulistitembuttonview.d.ts +16 -16
- package/dist/menubar/menubarmenulistitemfiledialogbuttonview.d.ts +18 -18
- package/dist/menubar/menubarmenulistitemview.d.ts +20 -20
- package/dist/menubar/menubarmenulistview.d.ts +24 -24
- package/dist/menubar/menubarmenupanelview.d.ts +47 -47
- package/dist/menubar/menubarmenuview.d.ts +113 -113
- package/dist/menubar/menubarview.d.ts +145 -145
- package/dist/menubar/utils.d.ts +455 -455
- package/dist/model.d.ts +19 -18
- package/dist/notification/notification.d.ts +200 -200
- package/dist/panel/balloon/balloonpanelview.d.ts +692 -692
- package/dist/panel/balloon/contextualballoon.d.ts +298 -298
- package/dist/panel/sticky/stickypanelview.d.ts +151 -151
- package/dist/search/filteredview.d.ts +23 -23
- package/dist/search/filtergroupanditemnames.d.ts +11 -11
- package/dist/search/searchinfoview.d.ts +39 -39
- package/dist/search/searchresultsview.d.ts +49 -49
- package/dist/search/text/searchtextqueryview.d.ts +63 -63
- package/dist/search/text/searchtextview.d.ts +203 -203
- package/dist/spinner/spinnerview.d.ts +20 -20
- package/dist/template.d.ts +897 -902
- package/dist/textarea/textareaview.d.ts +96 -96
- package/dist/toolbar/balloon/balloontoolbar.d.ts +122 -122
- package/dist/toolbar/block/blockbuttonview.d.ts +30 -30
- package/dist/toolbar/block/blocktoolbar.d.ts +166 -166
- package/dist/toolbar/normalizetoolbarconfig.d.ts +35 -35
- package/dist/toolbar/toolbarlinebreakview.d.ts +13 -13
- package/dist/toolbar/toolbarseparatorview.d.ts +13 -13
- package/dist/toolbar/toolbarview.d.ts +271 -271
- package/dist/tooltipmanager.d.ts +190 -193
- package/dist/view.d.ts +385 -388
- package/dist/viewcollection.d.ts +134 -134
- package/package.json +6 -6
|
@@ -1,83 +1,83 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
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
|
-
|
|
7
|
-
|
|
8
|
-
import { View } from
|
|
9
|
-
import type { EditingView } from
|
|
10
|
-
import { type Locale } from
|
|
11
|
-
import type { ViewRootElementDefinition } from
|
|
6
|
+
* @module ui/editableui/editableuiview
|
|
7
|
+
*/
|
|
8
|
+
import { View } from "../view.js";
|
|
9
|
+
import type { EditingView } from "@ckeditor/ckeditor5-engine";
|
|
10
|
+
import { type Locale } from "@ckeditor/ckeditor5-utils";
|
|
11
|
+
import type { ViewRootElementDefinition } from "@ckeditor/ckeditor5-core";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
* The editable UI view class.
|
|
14
|
+
*/
|
|
15
15
|
export declare class EditableUIView extends View {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
16
|
+
/**
|
|
17
|
+
* The name of the editable UI view.
|
|
18
|
+
*/
|
|
19
|
+
name: string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Controls whether the editable is focused, i.e. the user is typing in it.
|
|
22
|
+
*
|
|
23
|
+
* @observable
|
|
24
|
+
*/
|
|
25
|
+
isFocused: boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Whether this editable is bound to an inline root (a root that only holds inline content, with no block children).
|
|
28
|
+
* Set by the editor's UI initialization, after plugin schema registrations have settled. When `true`, a
|
|
29
|
+
* `ck-editor__editable_inline-root` CSS class is added to the element so themes can distinguish inline roots from
|
|
30
|
+
* block ones; the placeholder helper also reads it to decide where to host the placeholder.
|
|
31
|
+
*
|
|
32
|
+
* @observable
|
|
33
|
+
*/
|
|
34
|
+
isInlineRoot: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* The editing view instance the editable is related to. Editable uses the editing
|
|
37
|
+
* view to dynamically modify its certain DOM attributes after {@link #render rendering}.
|
|
38
|
+
*
|
|
39
|
+
* **Note**: The DOM attributes are performed by the editing view and not UI
|
|
40
|
+
* {@link module:ui/view~View#bindTemplate template bindings} because once rendered,
|
|
41
|
+
* the editable DOM element must remain under the full control of the engine to work properly.
|
|
42
|
+
*/
|
|
43
|
+
protected _editingView: EditingView;
|
|
44
|
+
/**
|
|
45
|
+
* The element which is the main editable element (usually the one with `contentEditable="true"`).
|
|
46
|
+
*/
|
|
47
|
+
protected _editableElement: HTMLElement | null | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* Whether an external {@link #_editableElement} was passed into the constructor, which also means
|
|
50
|
+
* the view will not render its {@link #template}.
|
|
51
|
+
*/
|
|
52
|
+
private _hasExternalElement;
|
|
53
|
+
/**
|
|
54
|
+
* Creates an instance of EditableUIView class.
|
|
55
|
+
*
|
|
56
|
+
* @param locale The locale instance.
|
|
57
|
+
* @param editingView The editing view instance the editable is related to.
|
|
58
|
+
* @param editableElement The editable element. If an existing `HTMLElement` is passed, the view applies its
|
|
59
|
+
* template to it; otherwise the view creates a fresh element (a `<div>` by default, or one matching the given
|
|
60
|
+
* {@link module:core/editor/editorconfig~ViewRootElementDefinition}).
|
|
61
|
+
*/
|
|
62
|
+
constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition);
|
|
63
|
+
/**
|
|
64
|
+
* Renders the view by either applying the {@link #template} to the existing
|
|
65
|
+
* {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement} or assigning {@link #element}
|
|
66
|
+
* as {@link module:ui/editableui/editableuiview~EditableUIView#_editableElement}.
|
|
67
|
+
*/
|
|
68
|
+
override render(): void;
|
|
69
|
+
/**
|
|
70
|
+
* @inheritDoc
|
|
71
|
+
*/
|
|
72
|
+
override destroy(): void;
|
|
73
|
+
/**
|
|
74
|
+
* Whether an external {@link #_editableElement} was passed into the constructor, which also means
|
|
75
|
+
* the view will not render its {@link #template}.
|
|
76
|
+
*/
|
|
77
|
+
get hasExternalElement(): boolean;
|
|
78
|
+
/**
|
|
79
|
+
* Updates the `ck-focused` and `ck-blurred` CSS classes on the {@link #element} according to
|
|
80
|
+
* the {@link #isFocused} property value using the {@link #_editingView editing view} API.
|
|
81
|
+
*/
|
|
82
|
+
private _updateIsFocusedClasses;
|
|
83
83
|
}
|
|
@@ -1,45 +1,45 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
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
|
-
|
|
7
|
-
|
|
8
|
-
import { EditableUIView } from
|
|
9
|
-
import type { EditingView } from
|
|
10
|
-
import type { Locale } from
|
|
11
|
-
import type { ViewRootElementDefinition } from
|
|
6
|
+
* @module ui/editableui/inline/inlineeditableuiview
|
|
7
|
+
*/
|
|
8
|
+
import { EditableUIView } from "../editableuiview.js";
|
|
9
|
+
import type { EditingView } from "@ckeditor/ckeditor5-engine";
|
|
10
|
+
import type { Locale } from "@ckeditor/ckeditor5-utils";
|
|
11
|
+
import type { ViewRootElementDefinition } from "@ckeditor/ckeditor5-core";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
13
|
+
* The inline editable UI class implementing an inline {@link module:ui/editableui/editableuiview~EditableUIView}.
|
|
14
|
+
*/
|
|
15
15
|
export declare class InlineEditableUIView extends EditableUIView {
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
16
|
+
/**
|
|
17
|
+
* The cached options object passed to the constructor.
|
|
18
|
+
*/
|
|
19
|
+
private readonly _options;
|
|
20
|
+
/**
|
|
21
|
+
* Creates an instance of the InlineEditableUIView class.
|
|
22
|
+
*
|
|
23
|
+
* @param locale The locale instance.
|
|
24
|
+
* @param editingView The editing view instance the editable is related to.
|
|
25
|
+
* @param editableElement The editable element. May be an existing `HTMLElement`, a
|
|
26
|
+
* {@link module:core/editor/editorconfig~ViewRootElementDefinition} describing the element to create,
|
|
27
|
+
* or `undefined` to create a default `<div>` element. See
|
|
28
|
+
* {@link module:ui/editableui/editableuiview~EditableUIView}.
|
|
29
|
+
* @param options Additional configuration of the view.
|
|
30
|
+
* @param options.label The label of the editable for assistive technologies. If not provided, a default label is used or,
|
|
31
|
+
* the existing `aria-label` attribute value from the specified `editableElement` is preserved.
|
|
32
|
+
*/
|
|
33
|
+
constructor(locale: Locale, editingView: EditingView, editableElement?: HTMLElement | ViewRootElementDefinition, options?: InlineEditableUIViewOptions);
|
|
34
|
+
/**
|
|
35
|
+
* @inheritDoc
|
|
36
|
+
*/
|
|
37
|
+
override render(): void;
|
|
38
|
+
/**
|
|
39
|
+
* Returns a normalized label for the editable view based on the environment.
|
|
40
|
+
*/
|
|
41
|
+
getEditableAriaLabel(): string;
|
|
42
42
|
}
|
|
43
43
|
export type InlineEditableUIViewOptions = {
|
|
44
|
-
|
|
44
|
+
label?: ((view: InlineEditableUIView) => string) | string | Record<string, string>;
|
|
45
45
|
};
|
|
@@ -1,55 +1,55 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
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
|
-
|
|
7
|
-
|
|
8
|
-
import { Plugin } from
|
|
9
|
-
import { Dialog } from
|
|
10
|
-
import { AccessibilityHelpContentView } from
|
|
11
|
-
import
|
|
6
|
+
* @module ui/editorui/accessibilityhelp/accessibilityhelp
|
|
7
|
+
*/
|
|
8
|
+
import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
|
|
9
|
+
import { Dialog } from "../../dialog/dialog.js";
|
|
10
|
+
import { AccessibilityHelpContentView } from "./accessibilityhelpcontentview.js";
|
|
11
|
+
import "../../../theme/components/editorui/accessibilityhelp.css";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
13
|
+
* A plugin that brings the accessibility help dialog to the editor available under the <kbd>Alt</kbd>+<kbd>0</kbd>
|
|
14
|
+
* keystroke and via the "Accessibility help" toolbar button. The dialog displays a list of keystrokes that can be used
|
|
15
|
+
* by the user to perform various actions in the editor.
|
|
16
|
+
*
|
|
17
|
+
* Keystroke information is loaded from {@link module:core/accessibility~Accessibility#keystrokeInfos}. New entries can be
|
|
18
|
+
* added using the API provided by the {@link module:core/accessibility~Accessibility} class.
|
|
19
|
+
*/
|
|
20
20
|
export declare class AccessibilityHelp extends Plugin {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
21
|
+
/**
|
|
22
|
+
* The view that displays the dialog content (list of keystrokes).
|
|
23
|
+
* Created when the dialog is opened for the first time.
|
|
24
|
+
*/
|
|
25
|
+
contentView: AccessibilityHelpContentView | null;
|
|
26
|
+
/**
|
|
27
|
+
* @inheritDoc
|
|
28
|
+
*/
|
|
29
|
+
static get requires(): PluginDependenciesOf<[Dialog]>;
|
|
30
|
+
/**
|
|
31
|
+
* @inheritDoc
|
|
32
|
+
*/
|
|
33
|
+
static get pluginName(): "AccessibilityHelp";
|
|
34
|
+
/**
|
|
35
|
+
* @inheritDoc
|
|
36
|
+
*/
|
|
37
|
+
static override get isOfficialPlugin(): true;
|
|
38
|
+
/**
|
|
39
|
+
* @inheritDoc
|
|
40
|
+
*/
|
|
41
|
+
init(): void;
|
|
42
|
+
/**
|
|
43
|
+
* Creates a button to show accessibility help dialog, for use either in toolbar or in menu bar.
|
|
44
|
+
*/
|
|
45
|
+
private _createButton;
|
|
46
|
+
/**
|
|
47
|
+
* Injects a help text into each editing root's `aria-label` attribute allowing assistive technology users
|
|
48
|
+
* to discover the availability of the Accessibility help dialog.
|
|
49
|
+
*/
|
|
50
|
+
private _setupRootLabels;
|
|
51
|
+
/**
|
|
52
|
+
* Shows the accessibility help dialog. Also, creates {@link #contentView} on demand.
|
|
53
|
+
*/
|
|
54
|
+
private _toggleDialog;
|
|
55
55
|
}
|
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
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
|
-
|
|
7
|
-
|
|
8
|
-
import { type Locale } from
|
|
9
|
-
import { View } from
|
|
10
|
-
import type { KeystrokeInfoDefinitions } from
|
|
6
|
+
* @module ui/editorui/accessibilityhelp/accessibilityhelpcontentview
|
|
7
|
+
*/
|
|
8
|
+
import { type Locale } from "@ckeditor/ckeditor5-utils";
|
|
9
|
+
import { View } from "../../view.js";
|
|
10
|
+
import type { KeystrokeInfoDefinitions } from "@ckeditor/ckeditor5-core";
|
|
11
11
|
/**
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
* The view displaying keystrokes in the Accessibility help dialog.
|
|
13
|
+
*/
|
|
14
14
|
export declare class AccessibilityHelpContentView extends View<HTMLDivElement> {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
15
|
+
/**
|
|
16
|
+
* @inheritDoc
|
|
17
|
+
*/
|
|
18
|
+
constructor(locale: Locale, keystrokes: KeystrokeInfoDefinitions);
|
|
19
|
+
/**
|
|
20
|
+
* @inheritDoc
|
|
21
|
+
*/
|
|
22
|
+
focus(): void;
|
|
23
|
+
/**
|
|
24
|
+
* Creates `<section><h3>Category label</h3>...</section>` elements for each category of keystrokes.
|
|
25
|
+
*/
|
|
26
|
+
private _createCategories;
|
|
27
|
+
/**
|
|
28
|
+
* Creates `[<h4>Optional label</h4>]<dl>...</dl>` elements for each group of keystrokes in a category.
|
|
29
|
+
*/
|
|
30
|
+
private _createGroup;
|
|
31
|
+
/**
|
|
32
|
+
* Creates `<dt>Keystroke label</dt><dd>Keystroke definition</dd>` elements for each keystroke in a group.
|
|
33
|
+
*/
|
|
34
|
+
private _createGroupRow;
|
|
35
35
|
}
|
|
@@ -1,90 +1,90 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import { ViewCollection } from
|
|
6
|
-
import { type View } from
|
|
7
|
-
import { type Locale } from
|
|
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 { ViewCollection } from "../viewcollection.js";
|
|
6
|
+
import { type View } from "../view.js";
|
|
7
|
+
import { type Locale } from "@ckeditor/ckeditor5-utils";
|
|
8
8
|
/**
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
9
|
+
* This is a special {@link module:ui/viewcollection~ViewCollection} dedicated to elements that are detached from the DOM structure of
|
|
10
|
+
* the editor, like floating panels, floating toolbars, dialogs, etc.
|
|
11
|
+
*
|
|
12
|
+
* The body collection is available under the {@link module:ui/editorui/editoruiview~EditorUIView#body `editor.ui.view.body`} property.
|
|
13
|
+
* Any plugin can add a {@link module:ui/view~View view} to this collection.
|
|
14
|
+
*
|
|
15
|
+
* All views added to a body collection render in a dedicated DOM container (`<div class="ck ck-body ...">...</div>`). All body collection
|
|
16
|
+
* containers render in a common shared (`<div class="ck-body-wrapper">...</div>`) in the DOM to limit the pollution of
|
|
17
|
+
* the `<body>` element. The resulting DOM structure is as follows:
|
|
18
|
+
*
|
|
19
|
+
* ```html
|
|
20
|
+
* <body>
|
|
21
|
+
* <!-- Content of the webpage... -->
|
|
22
|
+
*
|
|
23
|
+
* <!-- The shared wrapper for all body collection containers. -->
|
|
24
|
+
* <div class="ck-body-wrapper">
|
|
25
|
+
* <!-- The container of the first body collection instance. -->
|
|
26
|
+
* <div class="ck ck-body ...">
|
|
27
|
+
* <!-- View elements belonging to the first body collection -->
|
|
28
|
+
* </div>
|
|
29
|
+
*
|
|
30
|
+
* <!-- The container of the second body collection instance. -->
|
|
31
|
+
* <div class="ck ck-body ...">...</div>
|
|
32
|
+
*
|
|
33
|
+
* <!-- More body collection containers for the rest of instances... -->
|
|
34
|
+
* </div>
|
|
35
|
+
* </body>
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* By default, the {@link module:ui/editorui/editoruiview~EditorUIView `editor.ui.view`} manages the life cycle of the
|
|
39
|
+
* {@link module:ui/editorui/editoruiview~EditorUIView#body `editor.ui.view.body`} collection, attaching and detaching it
|
|
40
|
+
* when the editor gets created or {@link module:core/editor/editor~Editor#destroy destroyed}.
|
|
41
|
+
*
|
|
42
|
+
* # Custom body collection instances
|
|
43
|
+
*
|
|
44
|
+
* Even though most editor instances come with a built-in body collection
|
|
45
|
+
* ({@link module:ui/editorui/editoruiview~EditorUIView#body `editor.ui.view.body`}), you can create your own instance of this
|
|
46
|
+
* class if you need to control their life cycle.
|
|
47
|
+
*
|
|
48
|
+
* The life cycle of a custom body collection must be handled manually by the developer using the dedicated API:
|
|
49
|
+
* * A body collection will render itself automatically in the DOM as soon as you call {@link ~BodyCollection#attachToDom}.
|
|
50
|
+
* * Calling {@link ~BodyCollection#detachFromDom} will remove the collection from the DOM.
|
|
51
|
+
*
|
|
52
|
+
* **Note**: The shared collection wrapper (`<div class="ck-body-wrapper">...</div>`) gets automatically removed from DOM when the
|
|
53
|
+
* last body collection is {@link ~BodyCollection#detachFromDom detached} and does not require any special handling.
|
|
54
|
+
*/
|
|
55
55
|
export declare class BodyCollection extends ViewCollection {
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
56
|
+
/**
|
|
57
|
+
* The {@link module:core/editor/editor~Editor#locale editor's locale} instance.
|
|
58
|
+
* See the view {@link module:ui/view~View#locale locale} property.
|
|
59
|
+
*/
|
|
60
|
+
readonly locale: Locale;
|
|
61
|
+
/**
|
|
62
|
+
* The element holding elements of the body collection.
|
|
63
|
+
*/
|
|
64
|
+
private _bodyCollectionContainer?;
|
|
65
|
+
/**
|
|
66
|
+
* The wrapper element that holds all of the {@link #_bodyCollectionContainer} elements.
|
|
67
|
+
*/
|
|
68
|
+
private static _bodyWrapper?;
|
|
69
|
+
/**
|
|
70
|
+
* Creates a new instance of the {@link module:ui/editorui/bodycollection~BodyCollection}.
|
|
71
|
+
*
|
|
72
|
+
* @param locale The {@link module:core/editor/editor~Editor editor's locale} instance.
|
|
73
|
+
* @param initialItems The initial items of the collection.
|
|
74
|
+
*/
|
|
75
|
+
constructor(locale: Locale, initialItems?: Iterable<View>);
|
|
76
|
+
/**
|
|
77
|
+
* The element holding elements of the body collection.
|
|
78
|
+
*/
|
|
79
|
+
get bodyCollectionContainer(): HTMLElement | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* Attaches the body collection to the DOM body element. You need to execute this method to render the content of
|
|
82
|
+
* the body collection.
|
|
83
|
+
*/
|
|
84
|
+
attachToDom(): void;
|
|
85
|
+
/**
|
|
86
|
+
* Detaches the collection from the DOM structure. Use this method when you do not need to use the body collection
|
|
87
|
+
* anymore to clean-up the DOM structure.
|
|
88
|
+
*/
|
|
89
|
+
detachFromDom(): void;
|
|
90
90
|
}
|