@taiga-ui/cdk 3.51.0-canary.d032cc6 → 3.52.0-canary.164e55d

package/utils/dom/get-scroll-parent.d.ts

@@ -1 +1,7 @@
+/**
+ * Finds the nearest parent with scroll in it
+ *
+ * @param element initial element
+ * @param vertical flag for orientation of scroll
+ */
 export declare function tuiGetScrollParent(element: Element | null, vertical?: boolean): Element | null;

package/utils/dom/get-selected-text.d.ts

@@ -1 +1,9 @@
+/**
+ * @description:
+ * cross browser way to get selected text
+ *
+ * History:
+ * BUG - window.getSelection() fails when text selected in a form field
+ * https://bugzilla.mozilla.org/show_bug.cgi?id=85686
+ */
 export declare function tuiGetSelectedText({ getSelection, document }: Window): string | null;

package/utils/dom/is-inside-iframe.d.ts

@@ -1 +1,4 @@
+/**
+ * Checks if an app is running inside <iframe /> tag
+ */
 export declare function tuiIsInsideIframe(win: Window): boolean;

package/utils/dom/is-node-in.d.ts

@@ -1 +1,8 @@
+/**
+ * Checks if node is inside a specific selector
+ *
+ * @param node
+ * @param selector
+ * @return true if node is inside a particular selector
+ */
 export declare function tuiIsNodeIn(node: Node, selector: string): boolean;

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

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

package/utils/focus/blur-native-focused.d.ts

@@ -1 +1,4 @@
+/**
+ * Finds and blurs current active element, including shadow DOM
+ */
 export declare function tuiBlurNativeFocused(doc: Document): void;

package/utils/focus/get-closest-focusable.d.ts

@@ -1,7 +1,27 @@
 export interface TuiGetClosestFocusableOptions {
+    /**
+     * @description:
+     * current HTML element
+     */
     initial: Element;
+    /**
+     * @description:
+     * determine if only keyboard focus is of interest
+     */
     keyboard?: boolean;
+    /**
+     * @description:
+     * should it look backwards instead (find item that will be focused with Shift + Tab)
+     */
     previous?: boolean;
+    /**
+     * @description:
+     * top Node limiting the search area
+     */
     root: Node;
 }
+/**
+ * @description:
+ * Finds the closest element that can be focused with a keyboard or mouse in theory
+ */
 export declare function tuiGetClosestFocusable({ initial, root, previous, keyboard, }: TuiGetClosestFocusableOptions): HTMLElement | null;

package/utils/focus/get-native-focused.d.ts

@@ -1 +1,6 @@
+/**
+ * Returns current active element, including shadow dom
+ *
+ * @return element or null
+ */
 export declare function tuiGetNativeFocused({ activeElement }: Document): Element | null;

package/utils/focus/is-native-focused-in.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks if focused element is within given element.
+ *
+ * @param node
+ * @return true if focused node is contained within element
+ */
 export declare function tuiIsNativeFocusedIn(node: Node): boolean;

package/utils/focus/is-native-focused.d.ts

@@ -1 +1,9 @@
+/**
+ * Checks if element is focused.
+ *
+ * Could return true even after blur since element remains focused if you switch away from a browser tab.
+ *
+ * @param node or null (as a common return value of DOM nodes walking)
+ * @return true if focused
+ */
 export declare function tuiIsNativeFocused(node: Node | null): boolean;

package/utils/focus/is-native-keyboard-focusable.d.ts

@@ -1 +1,7 @@
+/**
+ * Checks for signs that element can be focused with keyboard. tabIndex above 0 is ignored to
+ * only target natural focus order. Not checking the possibility of an element to
+ * be focused, for example element can have display: none applied to it or any other
+ * circumstances could prevent actual focus.
+ */
 export declare function tuiIsNativeKeyboardFocusable(element: Element): boolean;

package/utils/focus/move-focus.d.ts

@@ -1 +1,8 @@
+/**
+ * Utility method for moving focus in a list of elements
+ *
+ * @param currentIndex currently focused index
+ * @param elements array of focusable elements
+ * @param step a step to move focus by, typically -1 or 1
+ */
 export declare function tuiMoveFocus(currentIndex: number, elements: readonly HTMLElement[], step: number): void;

package/utils/focus/set-native-mouse-focused.d.ts

@@ -1 +1,8 @@
+/**
+ * Focuses or blurs element with mouse action imitation (to spoof {@link TuiFocusVisibleService})
+ *
+ * @param element
+ * @param focused desired focused state
+ * @param preventScroll optionally prevent native browser scroll after focus
+ */
 export declare function tuiSetNativeMouseFocused(element: Element & HTMLOrSVGElement, focused?: boolean, preventScroll?: boolean): void;

package/utils/focus/taiga-ui-cdk-utils-focus.d.ts

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

package/utils/format/px.d.ts

@@ -1 +1,4 @@
+/**
+ * Adds 'px' to the number and turns it into a string
+ */
 export declare function tuiPx(value: number): string;

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

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

package/utils/math/clamp.d.ts

@@ -1 +1,8 @@
+/**
+ * Clamps a value between two inclusive limits
+ *
+ * @param value
+ * @param min lower limit
+ * @param max upper limit
+ */
 export declare function tuiClamp(value: number, min: number, max: number): number;

package/utils/math/normalize-to-int-number.d.ts

@@ -1 +1,9 @@
+/**
+ * Normalizes any number to an integer within inclusive range
+ *
+ * @param value
+ * @param min lower inclusive integer
+ * @param max upper inclusive integer
+ * @return an integer between min and max inclusive
+ */
 export declare function tuiNormalizeToIntNumber(value: number, min: number, max: number): number;

package/utils/math/quantize.d.ts

@@ -1 +1,7 @@
+/**
+ * Rounds a number to the closest value in a fixed discrete series
+ *
+ * @param value
+ * @param quantum series step
+ */
 export declare function tuiQuantize(value: number, quantum: number): number;

package/utils/math/sum.d.ts

@@ -1 +1,4 @@
+/**
+ * Calculates sum of any number of passed arguments
+ */
 export declare function tuiSum(...args: number[]): number;

package/utils/math/taiga-ui-cdk-utils-math.d.ts

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

package/utils/math/to-radians.d.ts

@@ -1 +1,4 @@
+/**
+ * Converts angle in degrees to radians
+ */
 export declare function tuiToRadians(deg: number): number;

package/utils/miscellaneous/create-options.d.ts

@@ -1,2 +1,3 @@
 import { InjectionToken } from '@angular/core';
+/** @deprecated use {@link tuiCreateToken} instead */
 export declare function tuiCreateOptions<T>(defaults: T): InjectionToken<T>;

package/utils/miscellaneous/flat-length.d.ts

@@ -1 +1,6 @@
+/**
+ * Flattens two-dimensional array and calculates resulting length
+ *
+ * @param array twi dimensional array
+ */
 export declare function tuiFlatLength(array: ReadonlyArray<readonly unknown[]>): number;

package/utils/miscellaneous/get-original-array-from-query-list.d.ts

@@ -1,2 +1,8 @@
 import { QueryList } from '@angular/core';
+/**
+ * Extracts original array from {@link QueryList} rather than
+ * creating a copy like {@link QueryList.toArray} does.
+ * @param queryList
+ * @returns original array from {@link QueryList}.
+ */
 export declare function tuiGetOriginalArrayFromQueryList<T>(queryList: QueryList<T>): readonly T[];

package/utils/miscellaneous/is-string.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.tuiIsString = void 0;
 function tuiIsString(value) {
+    // eslint-disable-next-line @taiga-ui/experience/no-typeof
     return typeof value === `string`;
 }
 exports.tuiIsString = tuiIsString;

package/utils/miscellaneous/nullable-same.d.ts

@@ -1,2 +1,10 @@
 import { TuiIdentityMatcher } from '@taiga-ui/cdk/types';
+/**
+ * Checks identity for nullable elements.
+ *
+ * @param a element a
+ * @param b element b
+ * @param handler called if both elements are not null
+ * @return true if either both are null or they pass identity handler
+ */
 export declare function tuiNullableSame<T>(a: T | null, b: T | null, handler: TuiIdentityMatcher<T>): boolean;

package/utils/miscellaneous/object-from-entries.d.ts

@@ -1 +1,9 @@
+/**
+ * @deprecated use `Object.fromEntries` instead
+ * (check browser support first https://caniuse.com/mdn-javascript_builtins_object_fromentries)
+ * ___
+ * TODO: after we bump Firefox to 63+ replace this function with `Object.fromEntries`.
+ * TODO: Add `es2019.object` to `tsconfig.json` => `compilerOptions.lib`.
+ *
+ */
 export declare function tuiObjectFromEntries<K extends number | string, V>(keyValuePairs: Array<[K, V]>): Record<K, V>;

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

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

package/utils/os/is-apple-platform.d.ts

@@ -1 +1,11 @@
+/**
+ * @description:
+ * All Chrome / Chromium-based browsers will return MacIntel on macOS,
+ * no matter what the hardware architecture is. See the source code here:
+ * https://source.chromium.org/chromium/chromium/src/+/master:third_party/blink/renderer/core/frame/navigator_id.cc;l=64;drc=703d3c472cf27470dad21a3f2c8972aca3732cd6
+ * But maybe in future years, it will be changed to MacM1
+ *
+ * Documentation:
+ * https://developer.mozilla.org/en-US/docs/Web/API/Navigator/platform
+ */
 export declare function tuiIsApplePlatform(navigator: Navigator): boolean;

package/utils/os/taiga-ui-cdk-utils-os.d.ts

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

package/utils/svg/svg-linear-gradient-processor.d.ts

@@ -1,2 +1,16 @@
 import { TuiSafeHtml } from '@taiga-ui/cdk/interfaces';
+/**
+ * @description:
+ * Any ‘linearGradient’ attributes which are defined on the referenced
+ * element which are not defined on this element are inherited by this element.
+ * If this element has no defined gradient stops, and the referenced element does
+ * (possibly due to its own ‘xlink:href’ attribute), then this element inherits
+ * the gradient stop from the referenced element. Inheritance can be indirect
+ * to an arbitrary level; thus, if the referenced element inherits attribute
+ * or gradient stops due to its own ‘xlink:href’ attribute, then the current
+ * element can inherit those attributes or gradient stops.
+ *
+ * Documentation: https://www.w3.org/TR/SVG11/pservers.html
+ *
+ */
 export declare function tuiSvgLinearGradientProcessor(svg: TuiSafeHtml, salt?: number | string, fallback?: string): TuiSafeHtml;

package/utils/svg/taiga-ui-cdk-utils-svg.d.ts

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

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

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

package/schematics/ng-update/steps/replace-const.d.ts

@@ -1,4 +0,0 @@
-import { TuiSchema } from '../../ng-add/schema';
-import { ReplacementConst } from '../interfaces/replacement-const';
-export declare function replaceConstants(options: TuiSchema, constants: readonly ReplacementConst[]): void;
-export declare function replaceConst({ from, to }: ReplacementConst): void;

package/schematics/ng-update/v3/interfaces/replaceable-tag.d.ts

@@ -1,5 +0,0 @@
-export interface ReplaceableTag {
-    readonly addAttributes: string[];
-    readonly from: string;
-    readonly to: string;
-}

package/schematics/ng-update/v4/steps/replace-thumbnail-card.d.ts

@@ -1,3 +0,0 @@
-import { Rule } from '@angular-devkit/schematics';
-import { TuiSchema } from '../../../ng-add/schema';
-export declare function replaceThumbnailCard(options: TuiSchema): Rule;

package/schematics/ng-update/v4/steps/replace-thumbnail-card.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceThumbnailCard = void 0;
-const ng_morph_1 = require("ng-morph");
-const constants_1 = require("../../../constants");
-const colored_log_1 = require("../../../utils/colored-log");
-const project_root_1 = require("../../../utils/project-root");
-const replace_tag_1 = require("../../../utils/replace-tag");
-const elements_1 = require("../../../utils/templates/elements");
-const get_component_templates_1 = require("../../../utils/templates/get-component-templates");
-const template_resource_1 = require("../../../utils/templates/template-resource");
-const get_file_system_1 = require("../../utils/get-file-system");
-const replace_text_1 = require("../../utils/replace-text");
-function replaceThumbnailCard(options) {
-    return (tree, _) => {
-        const fileSystem = get_file_system_1.getFileSystem(tree);
-        replaceCardTag(options, fileSystem);
-        replaceReferenceTypes(options, fileSystem);
-        !options[`skip-logs`] && colored_log_1.titleLog(`${colored_log_1.FINISH_SYMBOL} successfully migrated \n`);
-    };
-}
-exports.replaceThumbnailCard = replaceThumbnailCard;
-function replaceCardTag(options, fileSystem) {
-    !options[`skip-logs`] &&
-        colored_log_1.infoLog(`${colored_log_1.SMALL_TAB_SYMBOL}${colored_log_1.REPLACE_SYMBOL} replacing <tui-card /> to <tui-thumbnail-card />`);
-    const templateResources = get_component_templates_1.getComponentTemplates(constants_1.ALL_TS_FILES);
-    for (const resource of templateResources) {
-        const template = template_resource_1.getTemplateFromTemplateResource(resource, fileSystem);
-        const elements = elements_1.findElementsByTagName(template, `tui-card`);
-        const path = fileSystem.resolve(template_resource_1.getPathFromTemplateResource(resource));
-        const recorder = fileSystem.edit(path);
-        elements.forEach(({ sourceCodeLocation }) => {
-            if (sourceCodeLocation) {
-                replace_tag_1.replaceTag(recorder, sourceCodeLocation, `tui-card`, `tui-thumbnail-card`);
-            }
-        });
-    }
-    fileSystem.commitEdits();
-    ng_morph_1.saveActiveProject();
-    ng_morph_1.setActiveProject(ng_morph_1.createProject(fileSystem.tree, project_root_1.projectRoot(), constants_1.ALL_FILES));
-}
-function replaceReferenceTypes(options, fileSystem) {
-    !options[`skip-logs`] &&
-        colored_log_1.infoLog(`${colored_log_1.SMALL_TAB_SYMBOL}${colored_log_1.REPLACE_SYMBOL} replacing TuiCard(Module|Component) to TuiThumbnailCard(Module|Component)`);
-    replace_text_1.replaceText([
-        {
-            from: `TuiCardModule`,
-            to: `TuiThumbnailCardModule`,
-        },
-        {
-            from: `TuiCardComponent`,
-            to: `TuiThumbnailCardComponent`,
-        },
-    ]);
-    fileSystem.commitEdits();
-    ng_morph_1.saveActiveProject();
-    ng_morph_1.setActiveProject(ng_morph_1.createProject(fileSystem.tree, project_root_1.projectRoot(), constants_1.ALL_FILES));
-}