@taiga-ui/cdk 3.51.0-canary.4016f4d → 3.51.0-canary.8873fad

package/services/parents-scroll.service.d.ts

@@ -1,6 +1,9 @@
 import { ElementRef } from '@angular/core';
 import { Observable } from 'rxjs';
 import * as i0 from "@angular/core";
+/**
+ * Service that subscribes to scroll events of all parent elements
+ */
 export declare class TuiParentsScrollService extends Observable<Event> {
     private readonly callback$;
     constructor(el: ElementRef<Element>, win: Window);

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

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

package/taiga-ui-cdk.d.ts

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

package/tokens/active-element.d.ts

@@ -1,2 +1,5 @@
 import { Observable } from 'rxjs';
+/**
+ * Active element on the document for ActiveZone
+ */
 export declare const TUI_ACTIVE_ELEMENT: import("@angular/core").InjectionToken<Observable<EventTarget | null>>;

package/tokens/alerts.d.ts

@@ -1,5 +1,8 @@
 import { Provider, Type } from '@angular/core';
 import { TuiAriaDialogContext } from '@taiga-ui/cdk/interfaces';
 import { Observable } from 'rxjs';
+/**
+ * A stream of alerts
+ */
 export declare const TUI_ALERTS: import("@angular/core").InjectionToken<readonly Observable<readonly TuiAriaDialogContext[]>[]>;
 export declare function tuiAsAlerts(useExisting: Type<Observable<readonly TuiAriaDialogContext[]>>): Provider;

package/tokens/default-renderer.d.ts

@@ -1,2 +1,8 @@
 import { Renderer2 } from '@angular/core';
+/**
+ * A Renderer2 for global services
+ * https://github.com/angular/angular/issues/17824#issuecomment-353239017
+ * @deprecated unnecessary
+ * TODO: remove in 4.0
+ */
 export declare const TUI_DEFAULT_RENDERER: import("@angular/core").InjectionToken<Renderer2>;

package/tokens/dialogs.d.ts

@@ -1,5 +1,8 @@
 import { Provider, Type } from '@angular/core';
 import { TuiAriaDialogContext } from '@taiga-ui/cdk/interfaces';
 import { Observable } from 'rxjs';
+/**
+ * A stream of dialogs
+ */
 export declare const TUI_DIALOGS: import("@angular/core").InjectionToken<readonly Observable<readonly TuiAriaDialogContext[]>[]>;
 export declare function tuiAsDialog(useExisting: Type<Observable<readonly TuiAriaDialogContext[]>>): Provider;

package/tokens/ensure-base-href.d.ts

@@ -1 +1,4 @@
+/**
+ * @deprecated: use {@link TUI_BASE_HREF}
+ */
 export declare const TUI_ENSURE_BASE_HREF: import("@angular/core").InjectionToken<string>;

package/tokens/focusable-item-accessor.d.ts

@@ -1,4 +1,7 @@
 import { InjectionToken, Provider, Type } from '@angular/core';
 import { TuiFocusableElementAccessor } from '@taiga-ui/cdk/interfaces';
+/**
+ * A component that can be focused
+ */
 export declare const TUI_FOCUSABLE_ITEM_ACCESSOR: InjectionToken<TuiFocusableElementAccessor>;
 export declare function tuiAsFocusableItemAccessor(useExisting: Type<TuiFocusableElementAccessor>): Provider;

package/tokens/is-android.d.ts

@@ -1 +1,4 @@
+/**
+ * Mobile browser that is not iOS (technically includes Windows Phone, Blackberry etc.)
+ */
 export declare const TUI_IS_ANDROID: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-apple.d.ts

@@ -1 +1,4 @@
+/**
+ * Apple(safari/webkit) detection
+ */
 export declare const TUI_IS_APPLE: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-chromium.d.ts

@@ -1 +1,4 @@
+/**
+ * Chromium browser engine detection
+ */
 export declare const TUI_IS_CHROMIUM: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-cypress.d.ts

@@ -1 +1,5 @@
+/**
+ * Detect if app is running under Cypress
+ * {@link https://docs.cypress.io/faq/questions/using-cypress-faq#Is-there-any-way-to-detect-if-my-app-is-running-under-Cypress Cypress docs}
+ */
 export declare const TUI_IS_CYPRESS: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-e2e.d.ts

@@ -1 +1,4 @@
+/**
+ * Detect if app is running under any of test frameworks
+ */
 export declare const TUI_IS_E2E: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-firefox.d.ts

@@ -1 +1,4 @@
+/**
+ * Firefox browser engine detection
+ */
 export declare const TUI_IS_FIREFOX: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-ios.d.ts

@@ -1 +1,4 @@
+/**
+ * iOS browser detection
+ */
 export declare const TUI_IS_IOS: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-mobile.d.ts

@@ -1 +1,4 @@
+/**
+ * Mobile browser detection
+ */
 export declare const TUI_IS_MOBILE: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-playwright.d.ts

@@ -1 +1,4 @@
+/**
+ * Detect if app is running under Playwright
+ */
 export declare const TUI_IS_PLAYWRIGHT: import("@angular/core").InjectionToken<boolean>;

package/tokens/is-webkit.d.ts

@@ -1 +1,4 @@
+/**
+ * Webkit browser engine detection
+ */
 export declare const TUI_IS_WEBKIT: import("@angular/core").InjectionToken<boolean>;

package/tokens/range.d.ts

@@ -1 +1,4 @@
+/**
+ * SSR safe default empty Range
+ */
 export declare const TUI_RANGE: import("@angular/core").InjectionToken<Range>;

package/tokens/removed-element.d.ts

@@ -1 +1,4 @@
+/**
+ * Element currently being removed by AnimationEngine
+ */
 export declare const TUI_REMOVED_ELEMENT: import("@angular/core").InjectionToken<import("rxjs").Observable<Element | null>>;

package/tokens/scroll-ref.d.ts

@@ -1,2 +1,5 @@
 import { ElementRef } from '@angular/core';
+/**
+ * Scrollable container
+ */
 export declare const TUI_SCROLL_REF: import("@angular/core").InjectionToken<ElementRef<HTMLElement>>;

package/tokens/swipe-options.d.ts

@@ -1,2 +1,5 @@
 import { TuiSwipeOptions } from '@taiga-ui/cdk/interfaces';
+/**
+ * Swipe options
+ */
 export declare const TUI_SWIPE_OPTIONS: import("@angular/core").InjectionToken<TuiSwipeOptions>;

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

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

package/tokens/take-only-trusted-events.d.ts

@@ -1 +1,7 @@
+/**
+ * @description:
+ * The isTrusted read-only property of the Event interface is a boolean value that is true
+ * when the event was generated by a user action, and false when the event was created or
+ * modified by a script or dispatched via EventTarget.dispatchEvent().
+ */
 export declare const TUI_TAKE_ONLY_TRUSTED_EVENTS: import("@angular/core").InjectionToken<boolean>;

package/tokens/window-height.d.ts

@@ -1 +1,4 @@
+/**
+ * @deprecated Use {@link TUI_WINDOW_SIZE} instead
+ */
 export declare const TUI_WINDOW_HEIGHT: import("@angular/core").InjectionToken<import("rxjs").Observable<number>>;

package/tokens/zoom-options.d.ts

@@ -1,2 +1,5 @@
 import { TuiZoomOptions } from '@taiga-ui/cdk/interfaces';
+/**
+ * Zoom options
+ */
 export declare const TUI_ZOOM_OPTIONS: import("@angular/core").InjectionToken<TuiZoomOptions>;

package/types/autocomplete.d.ts

@@ -1 +1,2 @@
+/** @deprecated remove in 4.0 */
 export declare type TuiAutofillFieldName = 'additional-name' | 'bday' | 'cc-csc' | 'cc-exp-month' | 'cc-exp-year' | 'cc-exp' | 'cc-name' | 'cc-number' | 'cc-type' | 'country-name' | 'current-password' | 'email' | 'family-name' | 'given-name' | 'name' | 'new-password' | 'off' | 'postal-code' | 'street-address' | 'tel' | 'transaction-amount' | 'transaction-currency' | 'username';

package/types/date-mode.d.ts

@@ -1 +1,6 @@
+/**
+ * * DMY - dd.mm.yyyy
+ * * MDY - mm.dd.yyyy
+ * * YMD - yyyy.mm.dd
+ */
 export declare type TuiDateMode = 'DMY' | 'MDY' | 'YMD';

package/types/event-with.d.ts

@@ -2,6 +2,9 @@ export interface TuiTypedEventTarget<E> {
     addEventListener(type: string, listener: ((evt: E) => void) | null, options?: AddEventListenerOptions | boolean): void;
     removeEventListener(type: string, listener?: ((evt: E) => void) | null, options?: EventListenerOptions | boolean): void;
 }
+/**
+ * Wrapper around {@link Event} to add typings to target and currentTarget.
+ */
 export declare type TuiEventWith<G extends Event, T extends TuiTypedEventTarget<G>> = G & {
     readonly currentTarget: T;
 };

package/types/mapper.d.ts

@@ -1 +1,11 @@
-export declare type TuiMapper<T extends unknown[], G> = (...args: T) => G;
+/**
+ * Typed mapping function.
+ *
+ * @deprecated Will be removed in v4.0. Use {@link TuiTypedMapper} instead.
+ */
+export declare type TuiMapper<T, G> = (item: T, ...args: any[]) => G;
+/**
+ * Typed mapping function.
+ * TODO: rename TuiTypedMapper to TuiMapper in v4.0
+ */
+export declare type TuiTypedMapper<T extends unknown[], G> = (...args: T) => G;

package/types/matcher.d.ts

@@ -1,5 +1,14 @@
 import { TuiStringHandler } from './handler';
-import { TuiMapper } from './mapper';
-export declare type TuiMatcher<I extends unknown[]> = TuiMapper<I, boolean>;
+import { TuiMapper, TuiTypedMapper } from './mapper';
+/**
+ * A matcher function to test items against with extra arguments.
+ *
+ * @deprecated Will be removed in v4.0. Use {@link TuiTypedMatcher} instead.
+ */
+export declare type TuiMatcher<I> = TuiMapper<I, boolean>;
+/**
+ * A matcher function to test items against with extra arguments.
+ */
+export declare type TuiTypedMatcher<I extends unknown[]> = TuiTypedMapper<I, boolean>;
 export declare type TuiStringMatcher<I> = (item: I, matchValue: string, stringify: TuiStringHandler<I>) => boolean;
 export declare type TuiIdentityMatcher<I> = (item1: I, item2: I) => boolean;

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

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

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

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

package/utils/color/hsv-to-rgb.d.ts

@@ -1 +1,4 @@
+/**
+ * https://stackoverflow.com/a/54024653/2706426
+ */
 export declare function tuiHsvToRgb(h: number, s: number, v: number): [number, number, number];

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

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

package/utils/dom/get-actual-target.d.ts

@@ -1 +1,4 @@
+/**
+ * Gets actual target from open Shadow DOM if event happened within it
+ */
 export declare function tuiGetActualTarget(event: Event): Node;

package/utils/dom/get-clipboard-data-text.d.ts

@@ -1 +1,4 @@
+/**
+ * Gets text from data of clipboardEvent, it also works in IE and Edge browsers
+ */
 export declare function tuiGetClipboardDataText(event: ClipboardEvent, format?: string): string;

package/utils/dom/get-element-obscurers.d.ts

@@ -1 +1,10 @@
+/**
+ * Returns array of Elements covering edges of given element or null if at least one edge middle point is visible
+ *
+ * CAUTION: Empty array means element if offscreen i.e. covered by no elements, rather than not covered
+ * TODO: v4.0 change function signature to
+ * ```ts
+ * function tuiGetElementObscures(element: Element): readonly [Element, Element, Element, Element] | [] | null
+ * ```
+ */
 export declare function tuiGetElementObscures(element: Element): readonly Element[] | null;

package/utils/dom/get-element-offset.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Calculates offset for an element relative to it's parent several levels above
+ *
+ * @param host parent element
+ * @param element
+ * @return object with offsetTop and offsetLeft number properties
+ */
 export declare function tuiGetElementOffset(host: Element, element: HTMLElement): {
     offsetLeft: number;
     offsetTop: number;

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;