@taiga-ui/core 3.51.0 → 3.52.0

package/utils/dom/get-viewport-height.d.ts

@@ -1 +1,18 @@
+/**
+ * @description:
+ * Cross-browser @media (height)
+ *
+ * 1. window.innerWidth
+ * 1.1. gets CSS viewport @media (height) which include scrollbars
+ * 1.2. initial-scale and zoom variations may cause mobile values to
+ *      wrongly scale down to what PPK calls the visual
+ *      viewport and be smaller than the @media values
+ *  1.3. zoom may cause values to be 1px off due to native rounding
+ *
+ *  2. document.documentElement.clientHeight
+ *  2.1. equals CSS viewport width minus scrollbar width
+ *  2.2. matches @media (height) when there is no scrollbar
+ *  2.3. available cross-browser
+ *  2.4. inaccurate if doctype is missing
+ */
 export declare function tuiGetViewportHeight({ document, innerHeight }: Window): number;

package/utils/dom/get-viewport-width.d.ts

@@ -1 +1,18 @@
+/**
+ * @description:
+ * Cross-browser @media (width)
+ *
+ * 1. window.innerWidth
+ * 1.1. gets CSS viewport @media (width) which include scrollbars
+ * 1.2. initial-scale and zoom variations may cause mobile values to
+ *      wrongly scale down to what PPK calls the visual
+ *      viewport and be smaller than the @media values
+ *  1.3. zoom may cause values to be 1px off due to native rounding
+ *
+ *  2. document.documentElement.clientWidth
+ *  2.1. equals CSS viewport width minus scrollbar width
+ *  2.2. matches @media (width) when there is no scrollbar
+ *  2.3. available cross-browser
+ *  2.4. inaccurate if doctype is missing
+ */
 export declare function tuiGetViewportWidth({ document, innerWidth }: Window): number;

package/utils/dom/get-word-range.d.ts

@@ -1 +1,7 @@
+/**
+ * Creates a cloned range with its boundaries set at word boundaries
+ *
+ * @param currentRange a range to clone
+ * @return modified range
+ */
 export declare function tuiGetWordRange(currentRange: Range): Range;

package/utils/dom/taiga-ui-core-utils-dom.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils/dom" />
 export * from './index';

package/utils/format/capitalize.d.ts

@@ -1 +1,8 @@
+/**
+ * Capitalizes a given string, replacing it with a lowercase string and making
+ * the first letter of each word uppercase.
+ *
+ * @param value the input string
+ * @return the capitalized string
+ */
 export declare function tuiCapitalize(value: string): string;

package/utils/format/format-number.d.ts

@@ -1,2 +1,10 @@
 import { TuiNumberFormatSettings } from '@taiga-ui/core/interfaces';
+/**
+ * Formats number adding a thousand separators and correct decimal separator
+ * padding decimal part with zeroes to given length
+ *
+ * @param value the input number
+ * @param settings See {@link TuiNumberFormatSettings}
+ * @return the formatted string
+ */
 export declare function tuiFormatNumber(value: number, settings?: Partial<TuiNumberFormatSettings>): string;

package/utils/format/format-phone.d.ts

@@ -1 +1,20 @@
+/**
+ * TODO: delete in v4.0
+ * @deprecated Use {@link https://maskito.dev/core-concepts/transformer maskitoTransform} instead<br/>
+ * @example
+ * import {maskitoTransform} from '@maskito/core';
+ *
+ * const mask = {
+ *     mask: ['+', '1', ' ', /\d/, /\d/, /\d/, ')', ' ', /\d/, /\d/, /\d/, '-', /\d/, /\d/, /\d/, /\d/],
+ * };
+ * maskitoTransform('12125552368', mask); // +1 (212) 555-2368
+ * ___
+ * Formats a string with the phone format +7XXXXXXXXXXXX or XXXXXXXXXXXX,
+ * adding parentheses and hyphens.
+ *
+ * @param value the input string
+ * @param countryCode a country code
+ * @param phoneMask a phone number mask
+ * @return the formatted phone string of the form +7 XXX XXX-XX-XX
+ */
 export declare function tuiFormatPhone(value: string, countryCode: string, phoneMask: string): string;

package/utils/format/get-fractional-part-padded.d.ts

@@ -1 +1,8 @@
+/**
+ * Return fractional part of number
+ *
+ * @param value the number
+ * @param precision number of digits of decimal part, null to keep untouched
+ * @return the fractional part of number
+ */
 export declare function tuiGetFractionPartPadded(value: number, precision?: number | null): string;

package/utils/format/number-to-string-without-exp.d.ts

@@ -1 +1,7 @@
+/**
+ * Convert number to string with replacing exponent part on decimals
+ *
+ * @param value the number
+ * @return string representation of a number
+ */
 export declare function tuiNumberToStringWithoutExp(value: number): string;

package/utils/format/taiga-ui-core-utils-format.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils/format" />
 export * from './index';

package/utils/mask/create-auto-corrected-money-pipe.d.ts

@@ -1,3 +1,8 @@
 import { TuiTextMaskPipeHandler } from '@taiga-ui/core/mask';
 import { TuiDecimalSymbol } from '@taiga-ui/core/types';
+/**
+ * TODO: delete in v4.0
+ * @deprecated Use {@link https://maskito.dev/kit/number Number} from {@link https://github.com/taiga-family/maskito Maskito} instead <br/>
+ * Used to finish a number with zeros to a given precision
+ */
 export declare function tuiCreateAutoCorrectedNumberPipe(decimalLimit?: number, decimalSymbol?: TuiDecimalSymbol, thousandSymbol?: string, nativeInput?: HTMLInputElement | null, allowNegative?: boolean, isIOS?: boolean): TuiTextMaskPipeHandler;

package/utils/mask/create-correction-mask.d.ts

@@ -1,2 +1,6 @@
 import { TuiTextMaskCorrectionHandler, TuiTextMaskListHandler } from '@taiga-ui/core/mask';
+/**
+ * TODO: delete in v4.0
+ * @deprecated Use {@link https://maskito.dev/core-concepts/processors processors} from {@link https://github.com/taiga-family/maskito Maskito}
+ */
 export declare function tuiCreateCorrectionMask(allowed: RegExp, correctionHandler: TuiTextMaskCorrectionHandler): TuiTextMaskListHandler;

package/utils/mask/create-number-mask.d.ts

@@ -1,2 +1,7 @@
 import { TuiNumberMaskOptions, TuiTextMaskListHandler } from '@taiga-ui/core/mask';
+/**
+ * TODO: delete in v4.0
+ * @deprecated Use {@link https://maskito.dev/kit/number Number} from {@link https://github.com/taiga-family/maskito Maskito} instead <br/>
+ * Adaptation for {@link https://github.com/text-mask/text-mask/tree/master/addons#createnumbermask `createNumberMask`}
+ */
 export declare function tuiCreateNumberMask({ allowDecimal, decimalSymbol, thousandSymbol, autoCorrectDecimalSymbol, decimalLimit, requireDecimal, allowNegative, integerLimit, }?: TuiNumberMaskOptions): TuiTextMaskListHandler;

package/utils/mask/enable-auto-correct-decimal-symbol.d.ts

@@ -1,2 +1,6 @@
 import { TuiNumberFormatSettings } from '@taiga-ui/core/interfaces';
+/**
+ * TODO: delete in v4.0
+ * @deprecated Use {@link https://maskito.dev/kit/number Number} from {@link https://github.com/taiga-family/maskito Maskito} instead
+ */
 export declare function tuiEnableAutoCorrectDecimalSymbol({ thousandSeparator, }: TuiNumberFormatSettings): boolean;

package/utils/mask/masked-money-value-is-empty.d.ts

@@ -1 +1,8 @@
+/**
+ * TODO: delete in v4.0
+ * @deprecated use {@link https://maskito.dev/kit/number maskitoParseNumber} instead
+ * ```ts
+ * Number.isNaN(maskitoParseNumber(value, decimalSeparator))
+ * ```
+ */
 export declare function tuiMaskedMoneyValueIsEmpty(value: string): boolean;

package/utils/mask/masked-number-string-to-number.d.ts

@@ -1,2 +1,6 @@
 import { TuiDecimalSymbol } from '@taiga-ui/core/types';
+/**
+ * TODO: delete in v4.0
+ * @deprecated use {@link https://maskito.dev/kit/number maskitoParseNumber} instead
+ */
 export declare function tuiMaskedNumberStringToNumber(value: string, decimalsSymbol: TuiDecimalSymbol, thousandSymbol: string): number;

package/utils/mask/taiga-ui-core-utils-mask.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils/mask" />
 export * from './index';

package/utils/miscellaneous/is-editing-key.d.ts

@@ -1 +1,4 @@
+/**
+ * Check if pressed key is interactive in terms of input field
+ */
 export declare function tuiIsEditingKey(key: string): boolean;

package/utils/miscellaneous/is-obscured.d.ts

@@ -1 +1,4 @@
+/**
+ * @internal
+ */
 export declare function tuiIsObscured(el: HTMLElement, exceptSelector?: string): boolean;

package/utils/miscellaneous/size-bigger.d.ts

@@ -1,2 +1,8 @@
 import { TuiSizeXXL, TuiSizeXXS } from '@taiga-ui/core/types';
+/**
+ * Compares size constants to determine if first size is bigger than the second
+ *
+ * @param size size that we need to compare
+ * @param biggerThanSize size to compare with, 's' by default
+ */
 export declare function tuiSizeBigger(size: TuiSizeXXL | TuiSizeXXS, biggerThanSize?: TuiSizeXXL | TuiSizeXXS): boolean;

package/utils/miscellaneous/taiga-ui-core-utils-miscellaneous.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils/miscellaneous" />
 export * from './index';

package/utils/mobile/taiga-ui-core-utils-mobile.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils/mobile" />
 export * from './index';

package/utils/taiga-ui-core-utils.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
 /// <amd-module name="@taiga-ui/core/utils" />
 export * from './index';