@ckeditor/ckeditor5-ui 40.0.0 → 40.1.0

package/src/bindings/injectcsstransitiondisabler.js

@@ -1,71 +1,71 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * A decorator that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
- * {@link module:ui/view~View#setTemplate} is called:
- *
- * ```ts
- * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
- *
- * class MyView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		this.setTemplate( { ... } );
- *
- * 		// ...
- *
- * 		injectCssTransitionDisabler( this );
- *
- * 		// ...
- * 	}
- * }
- * ```
- *
- * The usage comes down to:
- *
- * ```ts
- * const view = new MyView();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @deprecated
- * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
- * @param view View instance that should get this functionality.
- */
-export default function injectCssTransitionDisabler(view) {
-    const decorated = view;
-    decorated.set('_isCssTransitionsDisabled', false);
-    decorated.disableCssTransitions = () => {
-        decorated._isCssTransitionsDisabled = true;
-    };
-    decorated.enableCssTransitions = () => {
-        decorated._isCssTransitionsDisabled = false;
-    };
-    decorated.extendTemplate({
-        attributes: {
-            class: [
-                decorated.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
-            ]
-        }
-    });
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * A decorator that brings the possibility to temporarily disable CSS transitions using
+ * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+ * when the view is first displayed but they should work normal in other cases.
+ *
+ * The methods to control the CSS transitions are:
+ * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+ * {@link module:ui/view~View#element view element}.
+ * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+ * {@link module:ui/view~View#element view element}.
+ *
+ * **Note**: This helper extends the {@link module:ui/view~View#template template} and must be used **after**
+ * {@link module:ui/view~View#setTemplate} is called:
+ *
+ * ```ts
+ * import injectCssTransitionDisabler from '@ckeditor/ckeditor5-ui/src/bindings/injectcsstransitiondisabler';
+ *
+ * class MyView extends View {
+ * 	constructor() {
+ * 		super();
+ *
+ * 		// ...
+ *
+ * 		this.setTemplate( { ... } );
+ *
+ * 		// ...
+ *
+ * 		injectCssTransitionDisabler( this );
+ *
+ * 		// ...
+ * 	}
+ * }
+ * ```
+ *
+ * The usage comes down to:
+ *
+ * ```ts
+ * const view = new MyView();
+ *
+ * // ...
+ *
+ * view.disableCssTransitions();
+ * view.show();
+ * view.enableCssTransitions();
+ * ```
+ *
+ * @deprecated
+ * @see module:ui/bindings/csstransitiondisablermixin~CssTransitionDisablerMixin
+ * @param view View instance that should get this functionality.
+ */
+export default function injectCssTransitionDisabler(view) {
+    const decorated = view;
+    decorated.set('_isCssTransitionsDisabled', false);
+    decorated.disableCssTransitions = () => {
+        decorated._isCssTransitionsDisabled = true;
+    };
+    decorated.enableCssTransitions = () => {
+        decorated._isCssTransitionsDisabled = false;
+    };
+    decorated.extendTemplate({
+        attributes: {
+            class: [
+                decorated.bindTemplate.if('_isCssTransitionsDisabled', 'ck-transitions-disabled')
+            ]
+        }
+    });
+}

package/src/bindings/preventdefault.d.ts

@@ -1,33 +1,33 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module ui/bindings/preventdefault
- */
-import type { ListenerBinding } from '../template';
-import type View from '../view';
-/**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- */
-export default function preventDefault(view: View): ListenerBinding;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ui/bindings/preventdefault
+ */
+import type { ListenerBinding } from '../template';
+import type View from '../view';
+/**
+ * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
+ * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
+ * {@link module:ui/view~View#template template}.
+ *
+ * ```ts
+ * // In a class extending View.
+ * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
+ *
+ * // ...
+ *
+ * this.setTemplate( {
+ * 	tag: 'div',
+ *
+ * 	on: {
+ * 		// Prevent the default mousedown action on this view.
+ * 		mousedown: preventDefault( this )
+ * 	}
+ * } );
+ * ```
+ *
+ * @param view View instance that defines the template.
+ */
+export default function preventDefault(view: View): ListenerBinding;

package/src/bindings/preventdefault.js

@@ -1,34 +1,34 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- */
-export default function preventDefault(view) {
-    return view.bindTemplate.to(evt => {
-        if (evt.target === view.element) {
-            evt.preventDefault();
-        }
-    });
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
+ * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
+ * {@link module:ui/view~View#template template}.
+ *
+ * ```ts
+ * // In a class extending View.
+ * import preventDefault from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
+ *
+ * // ...
+ *
+ * this.setTemplate( {
+ * 	tag: 'div',
+ *
+ * 	on: {
+ * 		// Prevent the default mousedown action on this view.
+ * 		mousedown: preventDefault( this )
+ * 	}
+ * } );
+ * ```
+ *
+ * @param view View instance that defines the template.
+ */
+export default function preventDefault(view) {
+    return view.bindTemplate.to(evt => {
+        if (evt.target === view.element) {
+            evt.preventDefault();
+        }
+    });
+}

package/src/bindings/submithandler.d.ts

@@ -1,57 +1,57 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module ui/bindings/submithandler
- */
-import type View from '../view';
-/**
- * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
- * `submit` event, prevents the default web browser behavior (navigation and page reload) and
- * fires the `submit` event on a view instead. Such a custom event can be then used by any
- * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
- *
- * ```ts
- * import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
- *
- * // ...
- *
- * class AnyFormView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		submitHandler( {
- * 			view: this
- * 		} );
- * 	}
- * }
- *
- * // ...
- *
- * const view = new AnyFormView();
- *
- * // A sample listener attached by an emitter working with the view.
- * this.listenTo( view, 'submit', () => {
- * 	saveTheFormData();
- * 	hideTheForm();
- * } );
- * ```
- *
- * @param options Configuration options.
- * @param options.view The view which DOM `submit` events should be handled.
- */
-export default function submitHandler({ view }: {
-    view: View;
-}): void;
-/**
- * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper.
- *
- * @eventName module:ui/view~View#submit
- */
-export type SubmitHandlerEvent = {
-    name: 'submit';
-    args: [];
-};
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ui/bindings/submithandler
+ */
+import type View from '../view';
+/**
+ * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
+ * `submit` event, prevents the default web browser behavior (navigation and page reload) and
+ * fires the `submit` event on a view instead. Such a custom event can be then used by any
+ * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
+ *
+ * ```ts
+ * import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
+ *
+ * // ...
+ *
+ * class AnyFormView extends View {
+ * 	constructor() {
+ * 		super();
+ *
+ * 		// ...
+ *
+ * 		submitHandler( {
+ * 			view: this
+ * 		} );
+ * 	}
+ * }
+ *
+ * // ...
+ *
+ * const view = new AnyFormView();
+ *
+ * // A sample listener attached by an emitter working with the view.
+ * this.listenTo( view, 'submit', () => {
+ * 	saveTheFormData();
+ * 	hideTheForm();
+ * } );
+ * ```
+ *
+ * @param options Configuration options.
+ * @param options.view The view which DOM `submit` events should be handled.
+ */
+export default function submitHandler({ view }: {
+    view: View;
+}): void;
+/**
+ * Fired by {@link module:ui/bindings/submithandler~submitHandler} helper.
+ *
+ * @eventName module:ui/view~View#submit
+ */
+export type SubmitHandlerEvent = {
+    name: 'submit';
+    args: [];
+};

package/src/bindings/submithandler.js

@@ -1,47 +1,47 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
- * `submit` event, prevents the default web browser behavior (navigation and page reload) and
- * fires the `submit` event on a view instead. Such a custom event can be then used by any
- * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
- *
- * ```ts
- * import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
- *
- * // ...
- *
- * class AnyFormView extends View {
- * 	constructor() {
- * 		super();
- *
- * 		// ...
- *
- * 		submitHandler( {
- * 			view: this
- * 		} );
- * 	}
- * }
- *
- * // ...
- *
- * const view = new AnyFormView();
- *
- * // A sample listener attached by an emitter working with the view.
- * this.listenTo( view, 'submit', () => {
- * 	saveTheFormData();
- * 	hideTheForm();
- * } );
- * ```
- *
- * @param options Configuration options.
- * @param options.view The view which DOM `submit` events should be handled.
- */
-export default function submitHandler({ view }) {
-    view.listenTo(view.element, 'submit', (evt, domEvt) => {
-        domEvt.preventDefault();
-        view.fire('submit');
-    }, { useCapture: true });
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * A handler useful for {@link module:ui/view~View views} working as HTML forms. It intercepts a native DOM
+ * `submit` event, prevents the default web browser behavior (navigation and page reload) and
+ * fires the `submit` event on a view instead. Such a custom event can be then used by any
+ * {@link module:utils/dom/emittermixin~DomEmitter emitter}, e.g. to serialize the form data.
+ *
+ * ```ts
+ * import submitHandler from '@ckeditor/ckeditor5-ui/src/bindings/submithandler';
+ *
+ * // ...
+ *
+ * class AnyFormView extends View {
+ * 	constructor() {
+ * 		super();
+ *
+ * 		// ...
+ *
+ * 		submitHandler( {
+ * 			view: this
+ * 		} );
+ * 	}
+ * }
+ *
+ * // ...
+ *
+ * const view = new AnyFormView();
+ *
+ * // A sample listener attached by an emitter working with the view.
+ * this.listenTo( view, 'submit', () => {
+ * 	saveTheFormData();
+ * 	hideTheForm();
+ * } );
+ * ```
+ *
+ * @param options Configuration options.
+ * @param options.view The view which DOM `submit` events should be handled.
+ */
+export default function submitHandler({ view }) {
+    view.listenTo(view.element, 'submit', (evt, domEvt) => {
+        domEvt.preventDefault();
+        view.fire('submit');
+    }, { useCapture: true });
+}