ngx-mat-table-multi-sort 19.7.1 → 20.0.0

package/lib/mat-multi-sort.directive.d.ts

@@ -1,139 +0,0 @@
-import { EventEmitter, InjectionToken, WritableSignal } from "@angular/core";
-import { MatSort, MatSortable, MatSortDefaultOptions, Sort, SortDirection } from "@angular/material/sort";
-import * as i0 from "@angular/core";
-/**
- * Injection token for the storage mechanism used to persist sorting state.
- *
- * This token can be used to provide a custom storage implementation for persisting
- * the sorting state of a table. By default, it can be set to use localStorage, sessionStorage,
- * or any other storage mechanism that implements the Storage interface.
- *
- */
-export declare const SORT_PERSISTENCE_STORAGE: InjectionToken<Storage>;
-/**
- * Injection token used to enable or disable the persistence of sorting state.
- *
- * This token can be provided in the application's dependency injection system
- * to control whether the sorting state of a table should be persisted across
- * sessions or not.
- *
- * @example
- * // To enable sort persistence:
- * providers: [
- *   { provide: SORT_PERSISTENCE_ENABLED, useValue: true }
- * ]
- *
- * @example
- * // To disable sort persistence:
- * providers: [
- *   { provide: SORT_PERSISTENCE_ENABLED, useValue: false }
- * ]
- */
-export declare const SORT_PERSISTENCE_ENABLED: InjectionToken<boolean>;
-/**
- * Injection token for the key used to persist sorting state.
- *
- * This token can be used to provide a custom key for storing
- * the sorting state in a persistence layer, such as local storage
- * or a database.
- */
-export declare const SORT_PERSISTENCE_KEY: InjectionToken<string>;
-export declare class MatMultiSortDirective extends MatSort {
-    isPersistenceEnabled: boolean;
-    readonly initialKey: string;
-    private readonly storage;
-    /**
-     * Event emitter that fires when the persistence state changes.
-     *
-     * This output emits an array of Sort objects whenever the sorting state
-     * is persisted or restored from storage. This can be useful for components
-     * that need to react to changes in the persisted sorting configuration.
-     *
-     * @example
-     * ```html
-     * <table mat-table [dataSource]="dataSource" matMultiSort
-     *        (persistenceChanged)="onPersistenceChanged($event)">
-     * ```
-     *
-     * @example
-     * ```typescript
-     * onPersistenceChanged(sorts: Sort[]): void {
-     *   console.log('Sorting state changed:', sorts);
-     *   // Handle the updated sorting configuration
-     * }
-     * ```
-     */
-    readonly persistenceChanged: EventEmitter<Sort[]>;
-    private _key;
-    /**
-     * A writable signal that holds an array of Sort objects.
-     * This signal is used to manage the sorting state of the table.
-     *
-     * @readonly
-     */
-    readonly _sorts: WritableSignal<Sort[]>;
-    /**
-     * Gets the key used for column configuration persistence.
-     *
-     * @returns {string} The key used for column configuration persistence.
-     */
-    get key(): string;
-    constructor(isPersistenceEnabled: boolean, initialKey: string, storage: Storage, defaultOptions?: MatSortDefaultOptions | undefined);
-    /**
-     * Retrieves the sort direction for a given column ID.
-     *
-     * @param id - The ID of the column to get the sort direction for.
-     * @returns The sort direction ('asc', 'desc', or '') for the specified column ID.
-     */
-    getSortDirection(id: string): SortDirection;
-    /**
-     * Gets the sort index of the given column ID.
-     *
-     * @param id - The ID of the column to get the sort index for.
-     * @returns The sort index of the column, or -1 if the column is not active.
-     */
-    getSortIndex(id: string): number;
-    sort(sortable: MatSortable): void;
-    /**
-     * Removes a sort level by its identifier.
-     * If the sort level is not found, the method returns without making any changes.
-     *
-     * @param id - The identifier of the sort level to be removed.
-     * @returns void
-     */
-    removeSortLevel(id: string): void;
-    /**
-     * Reorders the sort level by moving an item in the sort array from a previous index to a current index.
-     * If the previous index is the same as the current index, the function returns without making any changes.
-     *
-     * @param previousIndex - The index of the item to be moved.
-     * @param currentIndex - The index to which the item should be moved.
-     */
-    reorderSortLevel(previousIndex: number, currentIndex: number): void;
-    /**
-     * Toggles the sort direction for the given column ID.
-     *
-     * @param id - The unique identifier of the column to toggle the sort direction for.
-     * @returns void
-     */
-    toggleSortDirection(id: string): void;
-    /**
-     * Clears the current sorting state.
-     *
-     * @param id - The unique identifier of the column to toggle the sort direction for.
-     * @returns void
-     */
-    clearSorting(): void;
-    private persistSortSettings;
-    /**
-     * Sets the persistence key for storing sort settings and optionally overwrites the persisted value.
-     *
-     * @param key - The key to be used for persisting sort settings.
-     * @param overwritePersistedValue - If true, the current sort settings will be persisted immediately, overwriting any existing value. Defaults to false.
-     *
-     * @returns void
-     */
-    setPersistenceKey(key: string, overwritePersistedValue?: boolean): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MatMultiSortDirective, [{ optional: true; }, { optional: true; }, { optional: true; }, { optional: true; }]>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<MatMultiSortDirective, "[matMultiSort]", ["matMultiSort"], {}, { "persistenceChanged": "persistenceChanged"; }, never, never, true, never>;
-}

package/lib/mat-table-column-config/mat-table-column-config.component.d.ts

@@ -1,51 +0,0 @@
-import { CdkDragDrop } from "@angular/cdk/drag-drop";
-import { OnDestroy, OnInit } from "@angular/core";
-import { TableColumn } from "../mat-table-column-config";
-import { MatTableColumnConfigPersistenceService } from "../mat-table-column-config-persistence.service";
-import * as i0 from "@angular/core";
-export declare class MatTableColumnConfigComponent<T> implements OnInit, OnDestroy {
-    private readonly persistenceService;
-    private subscription;
-    columns: TableColumn<T>[];
-    constructor(persistenceService: MatTableColumnConfigPersistenceService<T>);
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    /**
-     * Handles the event when a dragged column is dropped.
-     * This method updates the order of columns based on the drag and drop action.
-     *
-     * @param event - The event object containing information about the drag and drop action.
-     */
-    onColumnDropped(event: CdkDragDrop<T>): void;
-    /**
-     * Toggles the visibility of a column based on its identifier.
-     *
-     * @param id - The identifier of the column whose visibility is to be changed.
-     */
-    onColumnVisibilityChanged(id: keyof T): void;
-    /**
-     * Sets all columns in the table to visible and updates the persisted column configuration.
-     *
-     * Iterates through the `columns` array, setting each column's `visible` property to `true`.
-     * Then, updates the `persistenceService.columns` property to reflect the new visibility state.
-     */
-    selectAllColumns(): void;
-    /**
-     * Deselects all columns by setting their `visible` property to `false`.
-     * Updates the persisted columns state via the `persistenceService`.
-     *
-     * @remarks
-     * This method iterates through all columns in the `columns` array and hides each one.
-     * After updating the visibility, it synchronizes the state with the persistence service.
-     */
-    deselectAllColumns(): void;
-    /**
-     * Inverts the visibility state of all columns in the `columns` array.
-     * Each column's `visible` property is toggled between `true` and `false`.
-     * After updating the visibility, the modified columns array is assigned to the persistence service
-     * to persist the new visibility state.
-     */
-    invertColumnSelection(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MatTableColumnConfigComponent<any>, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MatTableColumnConfigComponent<any>, "mat-table-column-config", never, {}, {}, never, never, true, never>;
-}

package/lib/mat-table-column-config-persistence.service.d.ts

@@ -1,49 +0,0 @@
-import { Observable } from "rxjs";
-import { TableColumn } from "./mat-table-column-config";
-import * as i0 from "@angular/core";
-export declare class MatTableColumnConfigPersistenceService<T> {
-    isPersistenceEnabled: boolean;
-    readonly initialKey: string;
-    private readonly storage;
-    private readonly columns$;
-    private _key;
-    /**
-     * Gets the current table columns configuration.
-     *
-     * @returns {TableColumn<T>[]} An array of table columns.
-     */
-    get columns(): TableColumn<T>[];
-    /**
-     * Sets the columns configuration for the table and persists the configuration.
-     *
-     * @param value - An array of `TableColumn<T>` representing the new column configuration.
-     */
-    set columns(value: TableColumn<T>[]);
-    /**
-     * Gets the key used for column configuration persistence.
-     *
-     * @returns {string} The key used for column configuration persistence.
-     */
-    get key(): string;
-    constructor(isPersistenceEnabled: boolean, initialKey: string, storage: Storage);
-    /**
-     * Retrieves an observable stream of table columns.
-     *
-     * @returns {Observable<TableColumn<T>[]>} An observable that emits an array of table columns.
-     */
-    getColumns(): Observable<TableColumn<T>[]>;
-    private persistColumnConfig;
-    /**
-     * Sets the persistence key for storing column configurations.
-     *
-     * @param key - The key to be used for persistence.
-     * @param overwritePersistedValue - If true, the current column configuration will be persisted immediately overwriting any exising value stored under the new key.
-     *                                  If false, the persisted column configuration will be loaded and applied.
-     *                                  Defaults to false.
-     *
-     * @returns void
-     */
-    setPersistenceKey(key: string, overwritePersistedValue?: boolean): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MatTableColumnConfigPersistenceService<any>, [{ optional: true; }, { optional: true; }, { optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<MatTableColumnConfigPersistenceService<any>>;
-}

package/lib/mat-table-column-config-trigger.directive.d.ts

@@ -1,21 +0,0 @@
-import { Overlay } from "@angular/cdk/overlay";
-import { ComponentRef, ElementRef, ViewContainerRef } from "@angular/core";
-import { MatTableColumnConfigComponent } from "./mat-table-column-config/mat-table-column-config.component";
-import * as i0 from "@angular/core";
-export declare class MatTableColumnConfigTriggerDirective<T> {
-    private readonly elementRef;
-    private readonly overlay;
-    private readonly viewContainerRef;
-    private _componentRef;
-    /**
-     * Gets the reference to the MatTableColumnConfigComponent.
-     *
-     * @returns {ComponentRef<MatTableColumnConfigComponent<T>> | null}
-     *          The reference to the MatTableColumnConfigComponent if it exists, otherwise null.
-     */
-    get componentRef(): ComponentRef<MatTableColumnConfigComponent<T>> | null;
-    constructor(elementRef: ElementRef, overlay: Overlay, viewContainerRef: ViewContainerRef);
-    onClick(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MatTableColumnConfigTriggerDirective<any>, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTableColumnConfigTriggerDirective<any>, "[matTableColumnConfigTrigger]", ["matTableColumnConfigTrigger"], {}, {}, never, never, true, never>;
-}

package/lib/mat-table-column-config.d.ts

@@ -1,32 +0,0 @@
-import { InjectionToken } from "@angular/core";
-/**
- * Represents the configuration for a table column.
- *
- * @template T - The type of the data object that the table displays.
- */
-export interface TableColumn<T> {
-    id: keyof T;
-    label: string;
-    visible: boolean;
-}
-/**
- * Injection token for the storage mechanism used to persist column configuration.
- *
- * This token can be used to provide a custom storage implementation for saving
- * and retrieving the state of table column configurations.
- *
- */
-export declare const COLUMN_CONFIG_PERSISTENCE_STORAGE: InjectionToken<Storage>;
-/**
- * Injection token used to enable or disable column configuration persistence.
- *
- * This token can be provided with a boolean value to indicate whether the
- * column configurations should be persisted (e.g., in local storage or a database).
- *
- */
-export declare const COLUMN_CONFIG_PERSISTENCE_ENABLED: InjectionToken<boolean>;
-/**
- * Injection token for the column configuration persistence key.
- * This token is used to provide a unique key for persisting column configurations.
- */
-export declare const COLUMN_CONFIG_PERSISTENCE_KEY: InjectionToken<string>;

package/public-api.d.ts

@@ -1,8 +0,0 @@
-export * from "./lib/mat-table-column-config";
-export * from "./lib/mat-multi-sort.directive";
-export * from "./lib/mat-table-column-config-trigger.directive";
-export * from "./lib/mat-multi-sort-table-data-source";
-export * from "./lib/mat-table-column-config-persistence.service";
-export * from "./lib/mat-multi-sort-header/mat-multi-sort-header.component";
-export * from "./lib/mat-multi-sort-control/mat-multi-sort-control.component";
-export * from "./lib/mat-table-column-config/mat-table-column-config.component";