@ckeditor/ckeditor5-table 38.1.0 → 38.1.1

package/src/utils/ui/table-properties.d.ts

@@ -1,193 +1,193 @@
-/**
- * @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 table/utils/ui/table-properties
- */
-import { type ColorOption, type LabeledFieldView, type ListDropdownItemDefinition, type NormalizedColorOption, type ToolbarView, type View } from 'ckeditor5/src/ui';
-import { Collection, type LocaleTranslate } from 'ckeditor5/src/utils';
-import type TableCellPropertiesView from '../../tablecellproperties/ui/tablecellpropertiesview';
-import type TablePropertiesView from '../../tableproperties/ui/tablepropertiesview';
-import ColorInputView from '../../ui/colorinputview';
-/**
- * Returns an object containing pairs of CSS border style values and their localized UI
- * labels. Used by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}
- * and {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView}.
- *
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
-export declare function getBorderStyleLabels(t: LocaleTranslate): Record<string, string>;
-/**
- * Returns a localized error string that can be displayed next to color (background, border)
- * fields that have an invalid value.
- *
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
-export declare function getLocalizedColorErrorText(t: LocaleTranslate): string;
-/**
- * Returns a localized error string that can be displayed next to length (padding, border width)
- * fields that have an invalid value.
- *
- * @param t The "t" function provided by the editor that is used to localize strings.
- */
-export declare function getLocalizedLengthErrorText(t: LocaleTranslate): string;
-/**
- * Returns `true` when the passed value is an empty string or a valid CSS color expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isColor}.
- */
-export declare function colorFieldValidator(value: string): boolean;
-/**
- * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isLength}.
- * See {@link module:engine/view/styles/utils~isPercentage}.
- */
-export declare function lengthFieldValidator(value: string): boolean;
-/**
- * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
- * Otherwise, `false` is returned.
- *
- * See {@link module:engine/view/styles/utils~isLength}.
- */
-export declare function lineWidthFieldValidator(value: string): boolean;
-/**
- * Generates item definitions for a UI dropdown that allows changing the border style of a table or a table cell.
- *
- * @param defaultStyle The default border.
- */
-export declare function getBorderStyleDefinitions(view: TableCellPropertiesView | TablePropertiesView, defaultStyle: string): Collection<ListDropdownItemDefinition>;
-/**
- * A helper that fills a toolbar with buttons that:
- *
- * * have some labels,
- * * have some icons,
- * * set a certain UI view property value upon execution.
- *
- * @param nameToValue A function that maps a button name to a value. By default names are the same as values.
- */
-export declare function fillToolbar<TView extends View, TPropertyName extends keyof TView>(options: {
-    view: TView;
-    icons: Record<string, string>;
-    toolbar: ToolbarView;
-    labels: Record<number, string>;
-    propertyName: TPropertyName;
-    nameToValue?: (name: string) => string;
-    defaultValue?: string;
-}): void;
-/**
- * A default color palette used by various user interfaces related to tables, for instance,
- * by {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI} or
- * {@link module:table/tableproperties/tablepropertiesui~TablePropertiesUI}.
- *
- * The color palette follows the {@link module:table/tableconfig~TableColorConfig table color configuration format}
- * and contains the following color definitions:
- *
- * ```ts
- * const defaultColors = [
- *   {
- *     color: 'hsl(0, 0%, 0%)',
- *     label: 'Black'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 30%)',
- *     label: 'Dim grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 60%)',
- *     label: 'Grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 90%)',
- *     label: 'Light grey'
- *   },
- *   {
- *     color: 'hsl(0, 0%, 100%)',
- *     label: 'White',
- *     hasBorder: true
- *   },
- *   {
- *     color: 'hsl(0, 75%, 60%)',
- *     label: 'Red'
- *   },
- *   {
- *     color: 'hsl(30, 75%, 60%)',
- *     label: 'Orange'
- *   },
- *   {
- *     color: 'hsl(60, 75%, 60%)',
- *     label: 'Yellow'
- *   },
- *   {
- *     color: 'hsl(90, 75%, 60%)',
- *     label: 'Light green'
- *   },
- *   {
- *     color: 'hsl(120, 75%, 60%)',
- *     label: 'Green'
- *   },
- *   {
- *     color: 'hsl(150, 75%, 60%)',
- *     label: 'Aquamarine'
- *   },
- *   {
- *     color: 'hsl(180, 75%, 60%)',
- *     label: 'Turquoise'
- *   },
- *   {
- *     color: 'hsl(210, 75%, 60%)',
- *     label: 'Light blue'
- *   },
- *   {
- *     color: 'hsl(240, 75%, 60%)',
- *     label: 'Blue'
- *   },
- *   {
- *     color: 'hsl(270, 75%, 60%)',
- *     label: 'Purple'
- *   }
- * ];
- * ```
- */
-export declare const defaultColors: Array<ColorOption>;
-/**
- * Returns a creator for a color input with a label.
- *
- * For given options, it returns a function that creates an instance of a
- * {@link module:table/ui/colorinputview~ColorInputView color input} logically related to
- * a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled view} in the DOM.
- *
- * The helper does the following:
- *
- * * It sets the color input `id` and `ariaDescribedById` attributes.
- * * It binds the color input `isReadOnly` to the labeled view.
- * * It binds the color input `hasError` to the labeled view.
- * * It enables a logic that cleans up the error when the user starts typing in the color input.
- *
- * Usage:
- *
- * ```ts
- * const colorInputCreator = getLabeledColorInputCreator( {
- *   colorConfig: [ ... ],
- *   columns: 3,
- * } );
- *
- * const labeledInputView = new LabeledFieldView( locale, colorInputCreator );
- * console.log( labeledInputView.view ); // A color input instance.
- * ```
- *
- * @internal
- * @param options Color input options.
- * @param options.colorConfig The configuration of the color palette displayed in the input's dropdown.
- * @param options.columns The configuration of the number of columns the color palette consists of in the input's dropdown.
- * @param options.defaultColorValue If specified, the color input view will replace the "Remove color" button with
- * the "Restore default" button. Instead of clearing the input field, the default color value will be set.
- */
-export declare function getLabeledColorInputCreator(options: {
-    colorConfig: Array<NormalizedColorOption>;
-    columns: number;
-    defaultColorValue?: string;
-}): (labeledFieldView: LabeledFieldView, viewUid: string, statusUid: string) => ColorInputView;
+/**
+ * @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 table/utils/ui/table-properties
+ */
+import { type ColorOption, type LabeledFieldView, type ListDropdownItemDefinition, type NormalizedColorOption, type ToolbarView, type View } from 'ckeditor5/src/ui';
+import { Collection, type LocaleTranslate } from 'ckeditor5/src/utils';
+import type TableCellPropertiesView from '../../tablecellproperties/ui/tablecellpropertiesview';
+import type TablePropertiesView from '../../tableproperties/ui/tablepropertiesview';
+import ColorInputView from '../../ui/colorinputview';
+/**
+ * Returns an object containing pairs of CSS border style values and their localized UI
+ * labels. Used by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}
+ * and {@link module:table/tableproperties/ui/tablepropertiesview~TablePropertiesView}.
+ *
+ * @param t The "t" function provided by the editor that is used to localize strings.
+ */
+export declare function getBorderStyleLabels(t: LocaleTranslate): Record<string, string>;
+/**
+ * Returns a localized error string that can be displayed next to color (background, border)
+ * fields that have an invalid value.
+ *
+ * @param t The "t" function provided by the editor that is used to localize strings.
+ */
+export declare function getLocalizedColorErrorText(t: LocaleTranslate): string;
+/**
+ * Returns a localized error string that can be displayed next to length (padding, border width)
+ * fields that have an invalid value.
+ *
+ * @param t The "t" function provided by the editor that is used to localize strings.
+ */
+export declare function getLocalizedLengthErrorText(t: LocaleTranslate): string;
+/**
+ * Returns `true` when the passed value is an empty string or a valid CSS color expression.
+ * Otherwise, `false` is returned.
+ *
+ * See {@link module:engine/view/styles/utils~isColor}.
+ */
+export declare function colorFieldValidator(value: string): boolean;
+/**
+ * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
+ * Otherwise, `false` is returned.
+ *
+ * See {@link module:engine/view/styles/utils~isLength}.
+ * See {@link module:engine/view/styles/utils~isPercentage}.
+ */
+export declare function lengthFieldValidator(value: string): boolean;
+/**
+ * Returns `true` when the passed value is an empty string, a number without a unit or a valid CSS length expression.
+ * Otherwise, `false` is returned.
+ *
+ * See {@link module:engine/view/styles/utils~isLength}.
+ */
+export declare function lineWidthFieldValidator(value: string): boolean;
+/**
+ * Generates item definitions for a UI dropdown that allows changing the border style of a table or a table cell.
+ *
+ * @param defaultStyle The default border.
+ */
+export declare function getBorderStyleDefinitions(view: TableCellPropertiesView | TablePropertiesView, defaultStyle: string): Collection<ListDropdownItemDefinition>;
+/**
+ * A helper that fills a toolbar with buttons that:
+ *
+ * * have some labels,
+ * * have some icons,
+ * * set a certain UI view property value upon execution.
+ *
+ * @param nameToValue A function that maps a button name to a value. By default names are the same as values.
+ */
+export declare function fillToolbar<TView extends View, TPropertyName extends keyof TView>(options: {
+    view: TView;
+    icons: Record<string, string>;
+    toolbar: ToolbarView;
+    labels: Record<number, string>;
+    propertyName: TPropertyName;
+    nameToValue?: (name: string) => string;
+    defaultValue?: string;
+}): void;
+/**
+ * A default color palette used by various user interfaces related to tables, for instance,
+ * by {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI} or
+ * {@link module:table/tableproperties/tablepropertiesui~TablePropertiesUI}.
+ *
+ * The color palette follows the {@link module:table/tableconfig~TableColorConfig table color configuration format}
+ * and contains the following color definitions:
+ *
+ * ```ts
+ * const defaultColors = [
+ *   {
+ *     color: 'hsl(0, 0%, 0%)',
+ *     label: 'Black'
+ *   },
+ *   {
+ *     color: 'hsl(0, 0%, 30%)',
+ *     label: 'Dim grey'
+ *   },
+ *   {
+ *     color: 'hsl(0, 0%, 60%)',
+ *     label: 'Grey'
+ *   },
+ *   {
+ *     color: 'hsl(0, 0%, 90%)',
+ *     label: 'Light grey'
+ *   },
+ *   {
+ *     color: 'hsl(0, 0%, 100%)',
+ *     label: 'White',
+ *     hasBorder: true
+ *   },
+ *   {
+ *     color: 'hsl(0, 75%, 60%)',
+ *     label: 'Red'
+ *   },
+ *   {
+ *     color: 'hsl(30, 75%, 60%)',
+ *     label: 'Orange'
+ *   },
+ *   {
+ *     color: 'hsl(60, 75%, 60%)',
+ *     label: 'Yellow'
+ *   },
+ *   {
+ *     color: 'hsl(90, 75%, 60%)',
+ *     label: 'Light green'
+ *   },
+ *   {
+ *     color: 'hsl(120, 75%, 60%)',
+ *     label: 'Green'
+ *   },
+ *   {
+ *     color: 'hsl(150, 75%, 60%)',
+ *     label: 'Aquamarine'
+ *   },
+ *   {
+ *     color: 'hsl(180, 75%, 60%)',
+ *     label: 'Turquoise'
+ *   },
+ *   {
+ *     color: 'hsl(210, 75%, 60%)',
+ *     label: 'Light blue'
+ *   },
+ *   {
+ *     color: 'hsl(240, 75%, 60%)',
+ *     label: 'Blue'
+ *   },
+ *   {
+ *     color: 'hsl(270, 75%, 60%)',
+ *     label: 'Purple'
+ *   }
+ * ];
+ * ```
+ */
+export declare const defaultColors: Array<ColorOption>;
+/**
+ * Returns a creator for a color input with a label.
+ *
+ * For given options, it returns a function that creates an instance of a
+ * {@link module:table/ui/colorinputview~ColorInputView color input} logically related to
+ * a {@link module:ui/labeledfield/labeledfieldview~LabeledFieldView labeled view} in the DOM.
+ *
+ * The helper does the following:
+ *
+ * * It sets the color input `id` and `ariaDescribedById` attributes.
+ * * It binds the color input `isReadOnly` to the labeled view.
+ * * It binds the color input `hasError` to the labeled view.
+ * * It enables a logic that cleans up the error when the user starts typing in the color input.
+ *
+ * Usage:
+ *
+ * ```ts
+ * const colorInputCreator = getLabeledColorInputCreator( {
+ *   colorConfig: [ ... ],
+ *   columns: 3,
+ * } );
+ *
+ * const labeledInputView = new LabeledFieldView( locale, colorInputCreator );
+ * console.log( labeledInputView.view ); // A color input instance.
+ * ```
+ *
+ * @internal
+ * @param options Color input options.
+ * @param options.colorConfig The configuration of the color palette displayed in the input's dropdown.
+ * @param options.columns The configuration of the number of columns the color palette consists of in the input's dropdown.
+ * @param options.defaultColorValue If specified, the color input view will replace the "Remove color" button with
+ * the "Restore default" button. Instead of clearing the input field, the default color value will be set.
+ */
+export declare function getLabeledColorInputCreator(options: {
+    colorConfig: Array<NormalizedColorOption>;
+    columns: number;
+    defaultColorValue?: string;
+}): (labeledFieldView: LabeledFieldView, viewUid: string, statusUid: string) => ColorInputView;