@ckeditor/ckeditor5-ui 38.0.1 → 38.1.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.
Files changed (127) hide show
  1. package/lang/translations/it.po +1 -1
  2. package/package.json +3 -32
  3. package/src/augmentation.d.ts +86 -86
  4. package/src/augmentation.js +5 -5
  5. package/src/bindings/addkeyboardhandlingforgrid.d.ts +27 -27
  6. package/src/bindings/addkeyboardhandlingforgrid.js +107 -107
  7. package/src/bindings/clickoutsidehandler.d.ts +28 -28
  8. package/src/bindings/clickoutsidehandler.js +36 -36
  9. package/src/bindings/csstransitiondisablermixin.d.ts +40 -40
  10. package/src/bindings/csstransitiondisablermixin.js +55 -55
  11. package/src/bindings/injectcsstransitiondisabler.d.ts +59 -59
  12. package/src/bindings/injectcsstransitiondisabler.js +71 -71
  13. package/src/bindings/preventdefault.d.ts +33 -33
  14. package/src/bindings/preventdefault.js +34 -34
  15. package/src/bindings/submithandler.d.ts +57 -57
  16. package/src/bindings/submithandler.js +47 -47
  17. package/src/button/button.d.ts +178 -178
  18. package/src/button/button.js +5 -5
  19. package/src/button/buttonview.d.ts +177 -177
  20. package/src/button/buttonview.js +231 -231
  21. package/src/button/switchbuttonview.d.ts +45 -45
  22. package/src/button/switchbuttonview.js +75 -75
  23. package/src/colorgrid/colorgridview.d.ts +132 -132
  24. package/src/colorgrid/colorgridview.js +124 -124
  25. package/src/colorgrid/colortileview.d.ts +28 -28
  26. package/src/colorgrid/colortileview.js +40 -40
  27. package/src/colorgrid/utils.d.ts +47 -47
  28. package/src/colorgrid/utils.js +84 -84
  29. package/src/colorpicker/colorpickerview.d.ts +110 -110
  30. package/src/colorpicker/colorpickerview.js +253 -250
  31. package/src/colorpicker/utils.d.ts +35 -35
  32. package/src/colorpicker/utils.js +99 -99
  33. package/src/componentfactory.d.ts +81 -81
  34. package/src/componentfactory.js +104 -104
  35. package/src/dropdown/button/dropdownbutton.d.ts +25 -25
  36. package/src/dropdown/button/dropdownbutton.js +5 -5
  37. package/src/dropdown/button/dropdownbuttonview.d.ts +48 -48
  38. package/src/dropdown/button/dropdownbuttonview.js +66 -66
  39. package/src/dropdown/button/splitbuttonview.d.ts +161 -161
  40. package/src/dropdown/button/splitbuttonview.js +152 -152
  41. package/src/dropdown/dropdownpanelfocusable.d.ts +21 -21
  42. package/src/dropdown/dropdownpanelfocusable.js +5 -5
  43. package/src/dropdown/dropdownpanelview.d.ts +62 -62
  44. package/src/dropdown/dropdownpanelview.js +96 -96
  45. package/src/dropdown/dropdownview.d.ts +315 -315
  46. package/src/dropdown/dropdownview.js +378 -378
  47. package/src/dropdown/utils.d.ts +221 -221
  48. package/src/dropdown/utils.js +434 -434
  49. package/src/editableui/editableuiview.d.ts +72 -72
  50. package/src/editableui/editableuiview.js +112 -112
  51. package/src/editableui/inline/inlineeditableuiview.d.ts +40 -40
  52. package/src/editableui/inline/inlineeditableuiview.js +48 -48
  53. package/src/editorui/bodycollection.d.ts +55 -51
  54. package/src/editorui/bodycollection.js +84 -78
  55. package/src/editorui/boxed/boxededitoruiview.d.ts +40 -40
  56. package/src/editorui/boxed/boxededitoruiview.js +81 -81
  57. package/src/editorui/editorui.d.ts +282 -274
  58. package/src/editorui/editorui.js +410 -388
  59. package/src/editorui/editoruiview.d.ts +39 -39
  60. package/src/editorui/editoruiview.js +38 -38
  61. package/src/editorui/poweredby.d.ts +71 -76
  62. package/src/editorui/poweredby.js +294 -291
  63. package/src/focuscycler.d.ts +183 -183
  64. package/src/focuscycler.js +220 -220
  65. package/src/formheader/formheaderview.d.ts +53 -53
  66. package/src/formheader/formheaderview.js +63 -63
  67. package/src/icon/iconview.d.ts +78 -78
  68. package/src/icon/iconview.js +112 -112
  69. package/src/iframe/iframeview.d.ts +50 -50
  70. package/src/iframe/iframeview.js +63 -63
  71. package/src/index.d.ts +62 -61
  72. package/src/index.js +61 -60
  73. package/src/input/inputview.d.ts +121 -121
  74. package/src/input/inputview.js +106 -106
  75. package/src/inputnumber/inputnumberview.d.ts +49 -49
  76. package/src/inputnumber/inputnumberview.js +40 -40
  77. package/src/inputtext/inputtextview.d.ts +18 -18
  78. package/src/inputtext/inputtextview.js +27 -27
  79. package/src/label/labelview.d.ts +36 -36
  80. package/src/label/labelview.js +41 -41
  81. package/src/labeledfield/labeledfieldview.d.ts +182 -182
  82. package/src/labeledfield/labeledfieldview.js +157 -157
  83. package/src/labeledfield/utils.d.ts +93 -93
  84. package/src/labeledfield/utils.js +131 -131
  85. package/src/labeledinput/labeledinputview.d.ts +125 -125
  86. package/src/labeledinput/labeledinputview.js +125 -125
  87. package/src/list/listitemview.d.ts +35 -35
  88. package/src/list/listitemview.js +40 -40
  89. package/src/list/listseparatorview.d.ts +18 -18
  90. package/src/list/listseparatorview.js +28 -28
  91. package/src/list/listview.d.ts +65 -65
  92. package/src/list/listview.js +90 -90
  93. package/src/model.d.ts +22 -22
  94. package/src/model.js +31 -31
  95. package/src/notification/notification.d.ts +211 -211
  96. package/src/notification/notification.js +187 -187
  97. package/src/panel/balloon/balloonpanelview.d.ts +685 -685
  98. package/src/panel/balloon/balloonpanelview.js +988 -988
  99. package/src/panel/balloon/contextualballoon.d.ts +299 -299
  100. package/src/panel/balloon/contextualballoon.js +572 -572
  101. package/src/panel/sticky/stickypanelview.d.ts +132 -132
  102. package/src/panel/sticky/stickypanelview.js +139 -139
  103. package/src/template.d.ts +942 -942
  104. package/src/template.js +1294 -1294
  105. package/src/toolbar/balloon/balloontoolbar.d.ts +122 -122
  106. package/src/toolbar/balloon/balloontoolbar.js +300 -300
  107. package/src/toolbar/block/blockbuttonview.d.ts +35 -35
  108. package/src/toolbar/block/blockbuttonview.js +41 -41
  109. package/src/toolbar/block/blocktoolbar.d.ts +161 -153
  110. package/src/toolbar/block/blocktoolbar.js +391 -374
  111. package/src/toolbar/normalizetoolbarconfig.d.ts +39 -39
  112. package/src/toolbar/normalizetoolbarconfig.js +51 -51
  113. package/src/toolbar/toolbarlinebreakview.d.ts +18 -18
  114. package/src/toolbar/toolbarlinebreakview.js +28 -28
  115. package/src/toolbar/toolbarseparatorview.d.ts +18 -18
  116. package/src/toolbar/toolbarseparatorview.js +28 -28
  117. package/src/toolbar/toolbarview.d.ts +265 -265
  118. package/src/toolbar/toolbarview.js +717 -717
  119. package/src/tooltipmanager.d.ts +180 -180
  120. package/src/tooltipmanager.js +353 -353
  121. package/src/view.d.ts +422 -422
  122. package/src/view.js +396 -396
  123. package/src/viewcollection.d.ts +139 -139
  124. package/src/viewcollection.js +206 -206
  125. package/theme/components/colorpicker/colorpicker.css +4 -4
  126. package/theme/globals/_poweredby.css +5 -1
  127. package/theme/icons/project-logo.svg +1 -1
@@ -1,78 +1,78 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/icon/iconview
7
- */
8
- import View from '../view';
9
- import '../../theme/components/icon/icon.css';
10
- /**
11
- * The icon view class.
12
- */
13
- export default class IconView extends View {
14
- /**
15
- * The SVG source of the icon.
16
- *
17
- * @observable
18
- */
19
- content: string | undefined;
20
- /**
21
- * This attribute specifies the boundaries to which the
22
- * icon content should stretch.
23
- *
24
- * @observable
25
- * @default '0 0 20 20'
26
- */
27
- viewBox: string;
28
- /**
29
- * The fill color of the child `path.ck-icon__fill`.
30
- *
31
- * @observable
32
- * @default ''
33
- */
34
- fillColor: string;
35
- /**
36
- * When set true (default), all parts of the icon inherit the fill color from the CSS `color` property of the
37
- * icon's DOM parent.
38
- *
39
- * This effectively makes the icon monochromatic and allows it to change its fill color dynamically, for instance,
40
- * when a {@link module:ui/button/buttonview~ButtonView} displays an icon and it switches between different states
41
- * (pushed, hovered, etc.) the icon will follow along.
42
- *
43
- * **Note**: For the monochromatic icon to render properly, it must be made up of shapes that can be filled
44
- * with color instead of, for instance, paths with strokes. Be sure to use the *outline stroke* tool
45
- * (the name could be different in your vector graphics editor) before exporting your icon. Also, remove any
46
- * excess `fill="..."` attributes that could break the color inheritance.
47
- *
48
- * **Note**: If you want to preserve the original look of your icon and disable dynamic color inheritance,
49
- * set this flag to `false`.
50
- *
51
- * @observable
52
- * @default true
53
- */
54
- isColorInherited: boolean;
55
- /**
56
- * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
57
- * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
58
- *
59
- * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
60
- */
61
- private static presentationalAttributeNames;
62
- /**
63
- * @inheritDoc
64
- */
65
- constructor();
66
- /**
67
- * @inheritDoc
68
- */
69
- render(): void;
70
- /**
71
- * Updates the {@link #element} with the value of {@link #content}.
72
- */
73
- private _updateXMLContent;
74
- /**
75
- * Fills all child `path.ck-icon__fill` with the `#fillColor`.
76
- */
77
- private _colorFillPaths;
78
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/icon/iconview
7
+ */
8
+ import View from '../view';
9
+ import '../../theme/components/icon/icon.css';
10
+ /**
11
+ * The icon view class.
12
+ */
13
+ export default class IconView extends View {
14
+ /**
15
+ * The SVG source of the icon.
16
+ *
17
+ * @observable
18
+ */
19
+ content: string | undefined;
20
+ /**
21
+ * This attribute specifies the boundaries to which the
22
+ * icon content should stretch.
23
+ *
24
+ * @observable
25
+ * @default '0 0 20 20'
26
+ */
27
+ viewBox: string;
28
+ /**
29
+ * The fill color of the child `path.ck-icon__fill`.
30
+ *
31
+ * @observable
32
+ * @default ''
33
+ */
34
+ fillColor: string;
35
+ /**
36
+ * When set true (default), all parts of the icon inherit the fill color from the CSS `color` property of the
37
+ * icon's DOM parent.
38
+ *
39
+ * This effectively makes the icon monochromatic and allows it to change its fill color dynamically, for instance,
40
+ * when a {@link module:ui/button/buttonview~ButtonView} displays an icon and it switches between different states
41
+ * (pushed, hovered, etc.) the icon will follow along.
42
+ *
43
+ * **Note**: For the monochromatic icon to render properly, it must be made up of shapes that can be filled
44
+ * with color instead of, for instance, paths with strokes. Be sure to use the *outline stroke* tool
45
+ * (the name could be different in your vector graphics editor) before exporting your icon. Also, remove any
46
+ * excess `fill="..."` attributes that could break the color inheritance.
47
+ *
48
+ * **Note**: If you want to preserve the original look of your icon and disable dynamic color inheritance,
49
+ * set this flag to `false`.
50
+ *
51
+ * @observable
52
+ * @default true
53
+ */
54
+ isColorInherited: boolean;
55
+ /**
56
+ * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
57
+ * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
58
+ *
59
+ * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
60
+ */
61
+ private static presentationalAttributeNames;
62
+ /**
63
+ * @inheritDoc
64
+ */
65
+ constructor();
66
+ /**
67
+ * @inheritDoc
68
+ */
69
+ render(): void;
70
+ /**
71
+ * Updates the {@link #element} with the value of {@link #content}.
72
+ */
73
+ private _updateXMLContent;
74
+ /**
75
+ * Fills all child `path.ck-icon__fill` with the `#fillColor`.
76
+ */
77
+ private _colorFillPaths;
78
+ }
@@ -1,112 +1,112 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /* global DOMParser */
6
- /**
7
- * @module ui/icon/iconview
8
- */
9
- import View from '../view';
10
- import '../../theme/components/icon/icon.css';
11
- /**
12
- * The icon view class.
13
- */
14
- export default class IconView extends View {
15
- /**
16
- * @inheritDoc
17
- */
18
- constructor() {
19
- super();
20
- const bind = this.bindTemplate;
21
- this.set('content', '');
22
- this.set('viewBox', '0 0 20 20');
23
- this.set('fillColor', '');
24
- this.set('isColorInherited', true);
25
- this.setTemplate({
26
- tag: 'svg',
27
- ns: 'http://www.w3.org/2000/svg',
28
- attributes: {
29
- class: [
30
- 'ck',
31
- 'ck-icon',
32
- // Exclude icon internals from the CSS reset to allow rich (non-monochromatic) icons
33
- // (https://github.com/ckeditor/ckeditor5/issues/12599).
34
- 'ck-reset_all-excluded',
35
- // The class to remove the dynamic color inheritance is toggleable
36
- // (https://github.com/ckeditor/ckeditor5/issues/12599).
37
- bind.if('isColorInherited', 'ck-icon_inherit-color')
38
- ],
39
- viewBox: bind.to('viewBox')
40
- }
41
- });
42
- }
43
- /**
44
- * @inheritDoc
45
- */
46
- render() {
47
- super.render();
48
- this._updateXMLContent();
49
- this._colorFillPaths();
50
- // This is a hack for lack of innerHTML binding.
51
- // See: https://github.com/ckeditor/ckeditor5-ui/issues/99.
52
- this.on('change:content', () => {
53
- this._updateXMLContent();
54
- this._colorFillPaths();
55
- });
56
- this.on('change:fillColor', () => {
57
- this._colorFillPaths();
58
- });
59
- }
60
- /**
61
- * Updates the {@link #element} with the value of {@link #content}.
62
- */
63
- _updateXMLContent() {
64
- if (this.content) {
65
- const parsed = new DOMParser().parseFromString(this.content.trim(), 'image/svg+xml');
66
- const svg = parsed.querySelector('svg');
67
- const viewBox = svg.getAttribute('viewBox');
68
- if (viewBox) {
69
- this.viewBox = viewBox;
70
- }
71
- // Preserve presentational attributes of the <svg> element from the source.
72
- // They can affect rendering of the entire icon (https://github.com/ckeditor/ckeditor5/issues/12597).
73
- for (const { name, value } of Array.from(svg.attributes)) {
74
- if (IconView.presentationalAttributeNames.includes(name)) {
75
- this.element.setAttribute(name, value);
76
- }
77
- }
78
- while (this.element.firstChild) {
79
- this.element.removeChild(this.element.firstChild);
80
- }
81
- while (svg.childNodes.length > 0) {
82
- this.element.appendChild(svg.childNodes[0]);
83
- }
84
- }
85
- }
86
- /**
87
- * Fills all child `path.ck-icon__fill` with the `#fillColor`.
88
- */
89
- _colorFillPaths() {
90
- if (this.fillColor) {
91
- this.element.querySelectorAll('.ck-icon__fill').forEach(path => {
92
- path.style.fill = this.fillColor;
93
- });
94
- }
95
- }
96
- }
97
- /**
98
- * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
99
- * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
100
- *
101
- * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
102
- */
103
- IconView.presentationalAttributeNames = [
104
- 'alignment-baseline', 'baseline-shift', 'clip-path', 'clip-rule', 'color', 'color-interpolation',
105
- 'color-interpolation-filters', 'color-rendering', 'cursor', 'direction', 'display', 'dominant-baseline', 'fill', 'fill-opacity',
106
- 'fill-rule', 'filter', 'flood-color', 'flood-opacity', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style',
107
- 'font-variant', 'font-weight', 'image-rendering', 'letter-spacing', 'lighting-color', 'marker-end', 'marker-mid', 'marker-start',
108
- 'mask', 'opacity', 'overflow', 'paint-order', 'pointer-events', 'shape-rendering', 'stop-color', 'stop-opacity', 'stroke',
109
- 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width',
110
- 'text-anchor', 'text-decoration', 'text-overflow', 'text-rendering', 'transform', 'unicode-bidi', 'vector-effect',
111
- 'visibility', 'white-space', 'word-spacing', 'writing-mode'
112
- ];
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /* global DOMParser */
6
+ /**
7
+ * @module ui/icon/iconview
8
+ */
9
+ import View from '../view';
10
+ import '../../theme/components/icon/icon.css';
11
+ /**
12
+ * The icon view class.
13
+ */
14
+ export default class IconView extends View {
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ constructor() {
19
+ super();
20
+ const bind = this.bindTemplate;
21
+ this.set('content', '');
22
+ this.set('viewBox', '0 0 20 20');
23
+ this.set('fillColor', '');
24
+ this.set('isColorInherited', true);
25
+ this.setTemplate({
26
+ tag: 'svg',
27
+ ns: 'http://www.w3.org/2000/svg',
28
+ attributes: {
29
+ class: [
30
+ 'ck',
31
+ 'ck-icon',
32
+ // Exclude icon internals from the CSS reset to allow rich (non-monochromatic) icons
33
+ // (https://github.com/ckeditor/ckeditor5/issues/12599).
34
+ 'ck-reset_all-excluded',
35
+ // The class to remove the dynamic color inheritance is toggleable
36
+ // (https://github.com/ckeditor/ckeditor5/issues/12599).
37
+ bind.if('isColorInherited', 'ck-icon_inherit-color')
38
+ ],
39
+ viewBox: bind.to('viewBox')
40
+ }
41
+ });
42
+ }
43
+ /**
44
+ * @inheritDoc
45
+ */
46
+ render() {
47
+ super.render();
48
+ this._updateXMLContent();
49
+ this._colorFillPaths();
50
+ // This is a hack for lack of innerHTML binding.
51
+ // See: https://github.com/ckeditor/ckeditor5-ui/issues/99.
52
+ this.on('change:content', () => {
53
+ this._updateXMLContent();
54
+ this._colorFillPaths();
55
+ });
56
+ this.on('change:fillColor', () => {
57
+ this._colorFillPaths();
58
+ });
59
+ }
60
+ /**
61
+ * Updates the {@link #element} with the value of {@link #content}.
62
+ */
63
+ _updateXMLContent() {
64
+ if (this.content) {
65
+ const parsed = new DOMParser().parseFromString(this.content.trim(), 'image/svg+xml');
66
+ const svg = parsed.querySelector('svg');
67
+ const viewBox = svg.getAttribute('viewBox');
68
+ if (viewBox) {
69
+ this.viewBox = viewBox;
70
+ }
71
+ // Preserve presentational attributes of the <svg> element from the source.
72
+ // They can affect rendering of the entire icon (https://github.com/ckeditor/ckeditor5/issues/12597).
73
+ for (const { name, value } of Array.from(svg.attributes)) {
74
+ if (IconView.presentationalAttributeNames.includes(name)) {
75
+ this.element.setAttribute(name, value);
76
+ }
77
+ }
78
+ while (this.element.firstChild) {
79
+ this.element.removeChild(this.element.firstChild);
80
+ }
81
+ while (svg.childNodes.length > 0) {
82
+ this.element.appendChild(svg.childNodes[0]);
83
+ }
84
+ }
85
+ }
86
+ /**
87
+ * Fills all child `path.ck-icon__fill` with the `#fillColor`.
88
+ */
89
+ _colorFillPaths() {
90
+ if (this.fillColor) {
91
+ this.element.querySelectorAll('.ck-icon__fill').forEach(path => {
92
+ path.style.fill = this.fillColor;
93
+ });
94
+ }
95
+ }
96
+ }
97
+ /**
98
+ * A list of presentational attributes that can be set on the `<svg>` element and should be preserved
99
+ * when the icon {@link module:ui/icon/iconview~IconView#content content} is loaded.
100
+ *
101
+ * See the [specification](https://www.w3.org/TR/SVG/styling.html#TermPresentationAttribute) to learn more.
102
+ */
103
+ IconView.presentationalAttributeNames = [
104
+ 'alignment-baseline', 'baseline-shift', 'clip-path', 'clip-rule', 'color', 'color-interpolation',
105
+ 'color-interpolation-filters', 'color-rendering', 'cursor', 'direction', 'display', 'dominant-baseline', 'fill', 'fill-opacity',
106
+ 'fill-rule', 'filter', 'flood-color', 'flood-opacity', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style',
107
+ 'font-variant', 'font-weight', 'image-rendering', 'letter-spacing', 'lighting-color', 'marker-end', 'marker-mid', 'marker-start',
108
+ 'mask', 'opacity', 'overflow', 'paint-order', 'pointer-events', 'shape-rendering', 'stop-color', 'stop-opacity', 'stroke',
109
+ 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width',
110
+ 'text-anchor', 'text-decoration', 'text-overflow', 'text-rendering', 'transform', 'unicode-bidi', 'vector-effect',
111
+ 'visibility', 'white-space', 'word-spacing', 'writing-mode'
112
+ ];
@@ -1,50 +1,50 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/iframe/iframeview
7
- */
8
- import View from '../view';
9
- import type { Locale } from '@ckeditor/ckeditor5-utils';
10
- /**
11
- * The iframe view class.
12
- *
13
- * ```ts
14
- * const iframe = new IframeView();
15
- *
16
- * iframe.render();
17
- * document.body.appendChild( iframe.element );
18
- *
19
- * iframe.on( 'loaded', () => {
20
- * console.log( 'The iframe has loaded', iframe.element.contentWindow );
21
- * } );
22
- *
23
- * iframe.element.src = 'https://ckeditor.com';
24
- * ```
25
- */
26
- export default class IframeView extends View<HTMLIFrameElement> {
27
- /**
28
- * Creates a new instance of the iframe view.
29
- *
30
- * @param locale The locale instance.
31
- */
32
- constructor(locale?: Locale);
33
- /**
34
- * Renders the iframe's {@link #element} and returns a `Promise` for asynchronous
35
- * child `contentDocument` loading process.
36
- *
37
- * @returns A promise which resolves once the iframe `contentDocument` has
38
- * been {@link #event:loaded}.
39
- */
40
- render(): Promise<unknown>;
41
- }
42
- /**
43
- * Fired when the DOM iframe's `contentDocument` finished loading.
44
- *
45
- * @eventName ~IframeView#loaded
46
- */
47
- export type IframeViewLoadedEvent = {
48
- name: 'loaded';
49
- args: [];
50
- };
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/iframe/iframeview
7
+ */
8
+ import View from '../view';
9
+ import type { Locale } from '@ckeditor/ckeditor5-utils';
10
+ /**
11
+ * The iframe view class.
12
+ *
13
+ * ```ts
14
+ * const iframe = new IframeView();
15
+ *
16
+ * iframe.render();
17
+ * document.body.appendChild( iframe.element );
18
+ *
19
+ * iframe.on( 'loaded', () => {
20
+ * console.log( 'The iframe has loaded', iframe.element.contentWindow );
21
+ * } );
22
+ *
23
+ * iframe.element.src = 'https://ckeditor.com';
24
+ * ```
25
+ */
26
+ export default class IframeView extends View<HTMLIFrameElement> {
27
+ /**
28
+ * Creates a new instance of the iframe view.
29
+ *
30
+ * @param locale The locale instance.
31
+ */
32
+ constructor(locale?: Locale);
33
+ /**
34
+ * Renders the iframe's {@link #element} and returns a `Promise` for asynchronous
35
+ * child `contentDocument` loading process.
36
+ *
37
+ * @returns A promise which resolves once the iframe `contentDocument` has
38
+ * been {@link #event:loaded}.
39
+ */
40
+ render(): Promise<unknown>;
41
+ }
42
+ /**
43
+ * Fired when the DOM iframe's `contentDocument` finished loading.
44
+ *
45
+ * @eventName ~IframeView#loaded
46
+ */
47
+ export type IframeViewLoadedEvent = {
48
+ name: 'loaded';
49
+ args: [];
50
+ };
@@ -1,63 +1,63 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module ui/iframe/iframeview
7
- */
8
- import View from '../view';
9
- /**
10
- * The iframe view class.
11
- *
12
- * ```ts
13
- * const iframe = new IframeView();
14
- *
15
- * iframe.render();
16
- * document.body.appendChild( iframe.element );
17
- *
18
- * iframe.on( 'loaded', () => {
19
- * console.log( 'The iframe has loaded', iframe.element.contentWindow );
20
- * } );
21
- *
22
- * iframe.element.src = 'https://ckeditor.com';
23
- * ```
24
- */
25
- export default class IframeView extends View {
26
- /**
27
- * Creates a new instance of the iframe view.
28
- *
29
- * @param locale The locale instance.
30
- */
31
- constructor(locale) {
32
- super(locale);
33
- const bind = this.bindTemplate;
34
- this.setTemplate({
35
- tag: 'iframe',
36
- attributes: {
37
- class: [
38
- 'ck',
39
- 'ck-reset_all'
40
- ],
41
- // It seems that we need to allow scripts in order to be able to listen to events.
42
- // TODO: Research that. Perhaps the src must be set?
43
- sandbox: 'allow-same-origin allow-scripts'
44
- },
45
- on: {
46
- load: bind.to('loaded')
47
- }
48
- });
49
- }
50
- /**
51
- * Renders the iframe's {@link #element} and returns a `Promise` for asynchronous
52
- * child `contentDocument` loading process.
53
- *
54
- * @returns A promise which resolves once the iframe `contentDocument` has
55
- * been {@link #event:loaded}.
56
- */
57
- render() {
58
- return new Promise(resolve => {
59
- this.on('loaded', resolve);
60
- return super.render();
61
- });
62
- }
63
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module ui/iframe/iframeview
7
+ */
8
+ import View from '../view';
9
+ /**
10
+ * The iframe view class.
11
+ *
12
+ * ```ts
13
+ * const iframe = new IframeView();
14
+ *
15
+ * iframe.render();
16
+ * document.body.appendChild( iframe.element );
17
+ *
18
+ * iframe.on( 'loaded', () => {
19
+ * console.log( 'The iframe has loaded', iframe.element.contentWindow );
20
+ * } );
21
+ *
22
+ * iframe.element.src = 'https://ckeditor.com';
23
+ * ```
24
+ */
25
+ export default class IframeView extends View {
26
+ /**
27
+ * Creates a new instance of the iframe view.
28
+ *
29
+ * @param locale The locale instance.
30
+ */
31
+ constructor(locale) {
32
+ super(locale);
33
+ const bind = this.bindTemplate;
34
+ this.setTemplate({
35
+ tag: 'iframe',
36
+ attributes: {
37
+ class: [
38
+ 'ck',
39
+ 'ck-reset_all'
40
+ ],
41
+ // It seems that we need to allow scripts in order to be able to listen to events.
42
+ // TODO: Research that. Perhaps the src must be set?
43
+ sandbox: 'allow-same-origin allow-scripts'
44
+ },
45
+ on: {
46
+ load: bind.to('loaded')
47
+ }
48
+ });
49
+ }
50
+ /**
51
+ * Renders the iframe's {@link #element} and returns a `Promise` for asynchronous
52
+ * child `contentDocument` loading process.
53
+ *
54
+ * @returns A promise which resolves once the iframe `contentDocument` has
55
+ * been {@link #event:loaded}.
56
+ */
57
+ render() {
58
+ return new Promise(resolve => {
59
+ this.on('loaded', resolve);
60
+ return super.render();
61
+ });
62
+ }
63
+ }