@cute-widgets/base 20.0.2 → 20.0.3

package/sort/index.d.ts

@@ -21,7 +21,7 @@ type SortDirection = 'asc' | 'desc' | '';
 
 /** Position of the arrow that displays when sorted. */
 type SortHeaderArrowPosition = 'before' | 'after';
-/** Interface for a directive that holds sorting state consumed by `MatSortHeader`. */
+/** Interface for a directive that holds sorting state consumed by `CuteSortHeader`. */
 interface CuteSortable {
     /** The id of the column being sorted. */
     id: string;
@@ -46,7 +46,7 @@ interface CuteSortDefaultOptions {
 }
 /** Injection token to be used to override the default options for `mat-sort`. */
 declare const CUTE_SORT_DEFAULT_OPTIONS: InjectionToken<CuteSortDefaultOptions>;
-/** Container for MatSortables to manage the sort state and provide default sort parameters. */
+/** Container for CuteSortables to manage the sort state and provide default sort parameters. */
 declare class CuteSort implements OnChanges, OnDestroy, OnInit {
     private _defaultOptions?;
     private _initializedStream;
@@ -229,7 +229,7 @@ declare class CuteSortHeader implements CuteSortable, OnDestroy, OnInit, AfterVi
     /** whether the sort header is disabled. */
     disabled: boolean;
     /**
-     * Description applied to MatSortHeader's button element with aria-describedby. This text should
+     * Description applied to CuteSortHeader's button element with aria-describedby. This text should
      * describe the action that will occur when the user clicks the sort header.
      */
     get sortActionDescription(): string;
@@ -263,7 +263,7 @@ declare class CuteSortHeader implements CuteSortable, OnDestroy, OnInit, AfterVi
     _toggleOnInteraction(): void;
     _handleClick(): void;
     _handleKeydown(event: KeyboardEvent): void;
-    /** Whether this MatSortHeader is currently sorted in either ascending or descending order. */
+    /** Whether this CuteSortHeader is currently sorted in either ascending or descending order. */
     _isSorted(): boolean;
     /** Returns the animation state for the arrow direction (indicator and pointers). */
     _getArrowDirectionState(): string;

package/table/index.d.ts

@@ -38,6 +38,9 @@ declare class CuteRecycleRows {
     static ɵfac: i0.ɵɵFactoryDeclaration<CuteRecycleRows, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<CuteRecycleRows, "cute-table[recycleRows], table[cute-table][recycleRows]", never, {}, {}, never, never, true, never>;
 }
+/**
+ * @inheritDoc
+ */
 declare class CuteTable<T> extends CdkTable<T> implements OnInit {
     /** Overrides the sticky CSS class set by the `CdkTable`. */
     protected stickyCssClass: string;
@@ -227,10 +230,10 @@ declare class CuteNoDataRow extends CdkNoDataRow {
 
 /**
  * Data source that accepts a client-side data array and includes native support of filtering,
- * sorting (using CuteSort), and pagination (using CutePaginator).
+ * sorting (using `CuteSort`), and pagination (using `CutePaginator`).
  *
- * Allows for sort customization by overriding sortingDataAccessor, which defines how data
- * properties are accessed. It also allows for filter customization by overriding filterPredicate,
+ * Allows for sort customization by overriding `sortingDataAccessor`, which defines how data
+ * properties are accessed. It also allows for filter customization by overriding `filterPredicate`,
  * which defines how row data is converted to a string for filter matching.
  *
  * **Note:** This class is meant to be a simple data source to help you get started. As such,
@@ -269,8 +272,8 @@ declare class CuteTableDataSource<T, P extends CutePaginator = CutePaginator> ex
     get filter(): string;
     set filter(filter: string);
     /**
-     * Instance of the CuteSort directive used by the table to control its sorting. Sort changes
-     * emitted by the CuteSort will trigger an update to the table's rendered data.
+     * Instance of the `CuteSort` directive used by the table to control its sorting. Sort changes
+     * emitted by the `CuteSort` will trigger an update to the table's rendered data.
      */
     get sort(): CuteSort | null;
     set sort(sort: CuteSort | null);
@@ -299,13 +302,13 @@ declare class CuteTableDataSource<T, P extends CutePaginator = CutePaginator> ex
      */
     sortingDataAccessor: (data: T, sortHeaderId: string) => string | number;
     /**
-     * Gets a sorted copy of the data array based on the state of the CuteSort. Called
-     * after changes are made to the filtered data or when sort changes are emitted from CuteSort.
+     * Gets a sorted copy of the data array based on the state of the `CuteSort`. Called
+     * after changes are made to the filtered data or when sort changes are emitted from `CuteSort`.
      * By default, the function retrieves the active sort and its direction and compares data
-     * by retrieving data using the sortingDataAccessor. May be overridden for a custom implementation
+     * by retrieving data using the {@link sortingDataAccessor}. May be overridden for a custom implementation
      * of data ordering.
      * @param data The array of data that should be sorted.
-     * @param sort The connected CuteSort that holds the current sort state.
+     * @param sort The connected `CuteSort` that holds the current sort state.
      */
     sortData: (data: T[], sort: CuteSort) => T[];
     /**
@@ -328,12 +331,12 @@ declare class CuteTableDataSource<T, P extends CutePaginator = CutePaginator> ex
     protected _updateChangeSubscription(): void;
     /**
      * Returns a filtered data array where each filter object contains the filter string within
-     * the result of the filterPredicate function. If no filter is set, return the data array
+     * the result of the {@link filterPredicate} function. If no filter is set, return the data array
      * as provided.
      */
     protected _filterData(data: T[]): T[];
     /**
-     * Returns a sorted copy of the data if CuteSort has a sort applied, otherwise just returns the
+     * Returns a sorted copy of the data if `CuteSort` has a sort applied, otherwise just returns the
      * data array as provided. Uses the default data accessor for data lookup, unless a
      * sortDataAccessor function is defined.
      */
@@ -350,11 +353,11 @@ declare class CuteTableDataSource<T, P extends CutePaginator = CutePaginator> ex
      */
     protected _updatePaginator(filteredDataLength: number): void;
     /**
-     * Used by the CuteTable. Called when it connects to the data source.
+     * Used by the {@link CuteTable}. Called when it connects to the data source.
      */
     connect(): BehaviorSubject<T[]>;
     /**
-     * Used by the CuteTable. Called when it disconnects from the data source.
+     * Used by the {@link CuteTable}. Called when it disconnects from the data source.
      */
     disconnect(): void;
 }

package/tree/index.d.ts

@@ -241,6 +241,7 @@ declare class CuteTreeFlattener<T, F, K = F> {
     getLevel: (node: F) => number;
     isExpandable: (node: F) => boolean;
     getChildren: (node: T) => Observable<T[]> | T[] | undefined | null;
+    private _subscription;
     constructor(transformFunction: (node: T, level: number) => F, getLevel: (node: F) => number, isExpandable: (node: F) => boolean, getChildren: (node: T) => Observable<T[]> | T[] | undefined | null);
     private _flattenNode;
     private _flattenChildren;
@@ -255,6 +256,10 @@ declare class CuteTreeFlattener<T, F, K = F> {
      * The returned list may have different length.
      */
     expandFlattenedNodes(nodes: F[], treeControl: TreeControl<F, K>): F[];
+    /**
+     * Performs the final actions with the flattener before destroying it.
+     */
+    finalize(): void;
 }
 /**
  * Data source for a flat tree.