@eui/ecl 19.3.3-snapshot-1754912586607 → 21.0.0-alpha.2

package/components/ecl-table/index.d.ts

@@ -1,8 +1,298 @@
-import { EclTableDirective, EclTableHeadDirective, EclTableHeaderDirective, EclTableRowDirective, EclTableBodyDirective, EclTableCellDirective, EclTableCellGroupDirective, EclTableResponsiveDirective, EclTableCaptionDirective } from './ecl-table.directive';
-import { EclTableSortButtonComponent } from './ecl-table-sort-button.component';
-export * from './ecl-table.module';
-export * from './ecl-table.directive';
-export * from './ecl-table-sort-button.component';
-export * from './events/ecl-sort-table.event';
-export declare const EUI_ECL_TABLE: readonly [typeof EclTableCaptionDirective, typeof EclTableDirective, typeof EclTableHeadDirective, typeof EclTableHeaderDirective, typeof EclTableRowDirective, typeof EclTableBodyDirective, typeof EclTableCellDirective, typeof EclTableCellGroupDirective, typeof EclTableSortButtonComponent, typeof EclTableResponsiveDirective];
-//# sourceMappingURL=index.d.ts.map
+import * as i0 from '@angular/core';
+import { DoCheck, OnDestroy, OnInit, AfterContentInit, EventEmitter, QueryList, AfterViewInit } from '@angular/core';
+import { EclBaseEvent, ECLBaseDirective, EclThemeService } from '@eui/ecl/core';
+
+/**
+ * Event emitted when the table sort order changes.
+ *
+ * Extends the base ECL event to provide sorting-specific information.
+ */
+declare class EclSortTableEvent extends EclBaseEvent {
+    /**
+     * The order in which the table is currently sorted.
+     * Can be 'ascending', 'descending', or null (unsorted).
+     */
+    sortOrder: SortOrder;
+    /**
+     * The identifier of the column that triggered the sort event.
+     */
+    columnId: string;
+    constructor(
+    /**
+     * The order in which the table is currently sorted.
+     * Can be 'ascending', 'descending', or null (unsorted).
+     */
+    sortOrder: SortOrder, 
+    /**
+     * The identifier of the column that triggered the sort event.
+     */
+    columnId: string);
+}
+
+/**
+ * Enum representing the sort order of a column.
+ */
+declare enum SortOrder {
+    DESCENDING = "descending",
+    ASCENDING = "ascending"
+}
+/**
+ * Directive for styling and managing behavior of ECL tables.
+ *
+ * Applies ECL-specific table classes and emits sort events when columns are sorted.
+ */
+declare class EclTableDirective extends ECLBaseDirective implements DoCheck, OnDestroy, OnInit, AfterContentInit {
+    /**
+     * Applies zebra striping to the table rows by adding the `ecl-table--zebra` class if true.
+     */
+    isZebra: boolean;
+    /**
+     * Applies the "simple" table variant if true.
+     * Automatically enabled if no header is detected.
+     */
+    isSimple: boolean;
+    /**
+     * The HTML ID attribute of the table. If not provided, a UUID is generated.
+     */
+    id: string;
+    /**
+     * Computed list of CSS classes for the host element.
+     */
+    get cssClasses(): string;
+    /**
+     * Emits an event when a column sort is triggered.
+     */
+    sort: EventEmitter<EclSortTableEvent>;
+    /**
+     * List of header directives detected in the content.
+     */
+    eclTableHeaders: QueryList<EclTableHeaderDirective>;
+    private destroy$;
+    private differ;
+    private differs;
+    constructor();
+    /**
+     * Lifecycle hook that runs on component initialization.
+     * Generates a unique ID if none is provided.
+     */
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that runs after content is fully initialized.
+     * Determines if the table should be rendered in "simple" mode.
+     */
+    ngAfterContentInit(): void;
+    /**
+     * Custom change detection for dynamically added header directives.
+     */
+    ngDoCheck(): void;
+    /**
+     * Cleans up subscriptions on destroy to prevent memory leaks.
+     */
+    ngOnDestroy(): void;
+    /**
+     * Sets the table to "simple" variant if no header directives are found.
+     */
+    private convertToSimpleVariant;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableDirective, "[eclTable]", never, { "isZebra": { "alias": "isZebra"; "required": false; }; "isSimple": { "alias": "isSimple"; "required": false; }; "id": { "alias": "id"; "required": false; }; }, { "sort": "sort"; }, ["eclTableHeaders"], never, true, never>;
+    static ngAcceptInputType_isZebra: unknown;
+    static ngAcceptInputType_isSimple: unknown;
+}
+/**
+ * Directive applied to `<thead>` elements inside a table.
+ * Detects header changes and manages ARIA attributes.
+ */
+declare class EclTableHeadDirective extends ECLBaseDirective implements OnDestroy, DoCheck {
+    /**
+     * Applies the ECL head class to the element.
+     */
+    get cssClasses(): string;
+    /**
+     * List of header directives under this head element.
+     */
+    eclTableHeaders: QueryList<EclTableHeaderDirective>;
+    private differs;
+    private destroy$;
+    private differ;
+    constructor();
+    /**
+     * Detects dynamic addition of header directives and resets ARIA sorting attributes.
+     */
+    ngDoCheck(): void;
+    /**
+     * Cleans up subscriptions on destroy to prevent memory leaks.
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableHeadDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableHeadDirective, "[eclTableHead]", never, {}, {}, ["eclTableHeaders"], never, true, never>;
+}
+declare class EclTableHeaderDirective extends ECLBaseDirective implements AfterContentInit, OnInit {
+    /**
+     * Current sort order of the column (`ascending`, `descending`, or `null`).
+     * This sets the `aria-sort` attribute used for accessibility.
+     */
+    sortOrder: SortOrder;
+    /**
+     * Enables sorting on the header. Also sets the `data-ecl-table-sort-toggle` attribute.
+     * Acts as the unique identifier for the column when sorting.
+     */
+    eclSortable: any;
+    /**
+     * Scope of the table header. Default is `col`. Sets the `scope` attribute.
+     */
+    scope: string;
+    /**
+     * HTML `id` attribute of the table header cell. If not provided, a UUID will be generated.
+     */
+    id: string;
+    /**
+     * Aria-label for the sort button that will be injected into the header cell.
+     */
+    sortButtonAriaLabel: string;
+    /**
+     * Computes the CSS classes applied to the header element.
+     */
+    get cssClasses(): string;
+    /**
+     * Emits an `EclSortTableEvent` when the header is clicked and sorting is triggered.
+     */
+    sort: EventEmitter<EclSortTableEvent>;
+    private el;
+    private viewContainerRef;
+    private renderer;
+    /**
+     * Lifecycle hook that runs on component initialization.
+     * Generates a unique `id` if not already defined.
+     */
+    ngOnInit(): void;
+    /**
+     * Lifecycle hook that runs after the view is initialized.
+     * Injects the sort button into the header cell if sorting is enabled.
+     */
+    ngAfterContentInit(): void;
+    /**
+     * Clears the `aria-sort` attribute, used to visually and semantically reset previous sort state.
+     *
+     * Remove the dark arrow for current sorting from prev sorted column
+     */
+    removeAriaSort(): void;
+    /**
+     * Handles click events on the header.
+     * Cycles through sort orders: `null` -> `ascending` -> `descending` -> `null`.
+     * Emits a `EclSortTableEvent` with the updated sort state and column identifier.
+     *
+     * Click triggers 1 -> asc sorting, 2 -> desc sorting then 3 -> initial sorting
+     */
+    onClick(evt: Event): void;
+    /**
+     * Dynamically creates and appends the sort button to the header cell.
+     * Optionally sets the button's `aria-label` if provided.
+     */
+    private initSortButtons;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableHeaderDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableHeaderDirective, "[eclTableHeader]", never, { "eclSortable": { "alias": "eclSortable"; "required": false; }; "scope": { "alias": "scope"; "required": false; }; "id": { "alias": "id"; "required": false; }; "sortButtonAriaLabel": { "alias": "sortButtonAriaLabel"; "required": false; }; }, { "sort": "sort"; }, never, never, true, never>;
+}
+declare class EclTableRowDirective extends ECLBaseDirective {
+    /**
+     * Applies `ecl-table__row` class to the table row.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableRowDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableRowDirective, "[eclTableRow]", never, {}, {}, never, never, true, never>;
+}
+declare class EclTableBodyDirective extends ECLBaseDirective {
+    /**
+     * Applies `ecl-table__body` class to the table body.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableBodyDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableBodyDirective, "[eclTableBody]", never, {}, {}, never, never, true, never>;
+}
+declare class EclTableCellDirective extends ECLBaseDirective {
+    /**
+     * Provides a reference to the related table header.
+     * Sets the `data-ecl-table-header` attribute for accessibility or responsive behavior.
+     */
+    eclTableCellHeader: string;
+    /**
+     * If `true`, applies additional group styling to the cell.
+     */
+    isGroup: boolean;
+    /**
+     * Computes and applies appropriate CSS classes for the table cell.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableCellDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableCellDirective, "[eclTableCell]", never, { "eclTableCellHeader": { "alias": "eclTableCellHeader"; "required": false; }; "isGroup": { "alias": "isGroup"; "required": false; }; }, {}, never, never, true, never>;
+}
+declare class EclTableCellGroupDirective extends ECLBaseDirective implements AfterViewInit {
+    /**
+     * Sets the `data-ecl-table-header-group` attribute to link to a header group.
+     */
+    eclTableCellGroup: string;
+    /**
+     * Applies the group-specific cell class.
+     */
+    get cssClasses(): string;
+    private cd;
+    /**
+     * Ensures `data-ecl-table-header-group` is not empty and triggers change detection.
+     */
+    ngAfterViewInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableCellGroupDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableCellGroupDirective, "[eclTableCellGroup]", never, { "eclTableCellGroup": { "alias": "eclTableCellGroup"; "required": false; }; }, {}, never, never, true, never>;
+}
+declare class EclTableResponsiveDirective extends ECLBaseDirective {
+    /**
+     * Applies the `ecl-table-responsive` class.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableResponsiveDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableResponsiveDirective, "[eclTableResponsive]", never, {}, {}, never, never, true, never>;
+}
+declare class EclTableCaptionDirective extends ECLBaseDirective {
+    /**
+     * Applies the `ecl-table__caption` class to the caption.
+     */
+    hasClass: boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableCaptionDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclTableCaptionDirective, "caption[eclTableCaption]", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Sort button component used inside sortable table headers.
+ *
+ * Applies ECL styling for table sort arrows and provides
+ * accessibility label for screen readers.
+ */
+declare class EclTableSortButtonComponent extends ECLBaseDirective {
+    eclThemeService: EclThemeService;
+    /**
+     * Accessibility label describing the button's function.
+     * This value is bound to the `aria-label` attribute.
+     */
+    ariaLabel: string;
+    /**
+     * CSS classes applied to the host element.
+     * Includes ECL base table sort arrow styling.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableSortButtonComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EclTableSortButtonComponent, "button[eclTableSortButton]", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Module that provides the EclTable component and its dependencies.
+ *
+ * @deprecated Use {@link EUI_ECL_TABLE} instead.
+ */
+declare class EclTableModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclTableModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<EclTableModule, never, [typeof EclTableCaptionDirective, typeof EclTableDirective, typeof EclTableHeadDirective, typeof EclTableHeaderDirective, typeof EclTableRowDirective, typeof EclTableBodyDirective, typeof EclTableCellDirective, typeof EclTableCellGroupDirective, typeof EclTableSortButtonComponent, typeof EclTableResponsiveDirective], [typeof EclTableCaptionDirective, typeof EclTableDirective, typeof EclTableHeadDirective, typeof EclTableHeaderDirective, typeof EclTableRowDirective, typeof EclTableBodyDirective, typeof EclTableCellDirective, typeof EclTableCellGroupDirective, typeof EclTableSortButtonComponent, typeof EclTableResponsiveDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<EclTableModule>;
+}
+
+declare const EUI_ECL_TABLE: readonly [typeof EclTableCaptionDirective, typeof EclTableDirective, typeof EclTableHeadDirective, typeof EclTableHeaderDirective, typeof EclTableRowDirective, typeof EclTableBodyDirective, typeof EclTableCellDirective, typeof EclTableCellGroupDirective, typeof EclTableSortButtonComponent, typeof EclTableResponsiveDirective];
+
+export { EUI_ECL_TABLE, EclSortTableEvent, EclTableBodyDirective, EclTableCaptionDirective, EclTableCellDirective, EclTableCellGroupDirective, EclTableDirective, EclTableHeadDirective, EclTableHeaderDirective, EclTableModule, EclTableResponsiveDirective, EclTableRowDirective, EclTableSortButtonComponent, SortOrder };
+//# sourceMappingURL=index.d.ts.map

package/components/ecl-table/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../components/ecl-table/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,EAC1B,2BAA2B,EAC3B,wBAAwB,EAC3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAC;AAEhF,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,eAAO,MAAM,aAAa,wUAWhB,CAAC"}
+{"version":3,"file":"index.d.ts","sources":["../../../components/ecl-table/events/ecl-sort-table.event.ts","../../../components/ecl-table/ecl-table.directive.ts","../../../components/ecl-table/ecl-table-sort-button.component.ts","../../../components/ecl-table/ecl-table.module.ts","../../../components/ecl-table/index.ts"],"sourcesContent":[null,null,null,null,null],"names":[],"mappings":";;;;AAGA;;;;AAIG;AACH,cAAA,iBAAA,SAAA,YAAA;AAEQ;;;AAGG;AACI,eAAA,SAAA;AAEP;;AAEG;AACI;;AATP;;;AAGG;AACI,eAAA,SAAA;AAEP;;AAEG;AACI;AAId;;ACOD;;AAEG;AACH,aAAA,SAAA;AACI;AACA;AACH;AAED;;;;AAIG;AACH,cAAA,iBAAA,SAAA,gBAAA,YAAA,OAAA,EAAA,SAAA,EAAA,MAAA,EAAA,gBAAA;AAII;;AAEG;AACqC;AAExC;;;AAGG;AACqC;AAExC;;AAEG;;AAGH;;AAEG;;AAMH;;AAEG;AACO,UAAA,YAAA,CAAA,iBAAA;AAEV;;AAEG;AAEH,qBAAA,SAAA,CAAA,uBAAA;;;;;AAWA;;;AAGG;AACH;AAMA;;;AAGG;AACH;AAIA;;AAEG;AACH;AAWA;;AAEG;AACH;AAKA;;AAEG;AACH;;;;;AAKH;AAED;;;AAGG;AACH,cAAA,qBAAA,SAAA,gBAAA,YAAA,SAAA,EAAA,OAAA;AAII;;AAEG;;AAMH;;AAEG;AAEH,qBAAA,SAAA,CAAA,uBAAA;;;;;AAWA;;AAEG;AACH;AAaA;;AAEG;AACH;;;AAIH;AAED,cAAA,uBAAA,SAAA,gBAAA,YAAA,gBAAA,EAAA,MAAA;AAQI;;;AAGG;;AAGH;;;AAGG;AACsD;AAEzD;;AAEG;AACiC;AAEpC;;AAEG;;AAGH;;AAEG;;AAGH;;AAEG;;AAMH;;AAEG;AACO,UAAA,YAAA,CAAA,iBAAA;;;;AAKV;;;AAGG;AACH;AAMA;;;AAGG;AACH;AAIA;;;;AAIG;AACH;AAIA;;;;;;AAMG;AAEH,iBAAA,KAAA;AAqBA;;;AAGG;AACH;;;AAWH;AAED,cAAA,oBAAA,SAAA,gBAAA;AAOI;;AAEG;;;;AAKN;AAED,cAAA,qBAAA,SAAA,gBAAA;AAOI;;AAEG;;;;AAKN;AAED,cAAA,qBAAA,SAAA,gBAAA;AAOI;;;AAGG;;AAGH;;AAEG;AACmD;AAEtD;;AAEG;;;;AAKN;AAED,cAAA,0BAAA,SAAA,gBAAA,YAAA,aAAA;AAOI;;AAEG;;AAGH;;AAEG;;;AAOH;;AAEG;AACH;;;AAIH;AAED,cAAA,2BAAA,SAAA,gBAAA;AAOI;;AAEG;;;;AAKN;AAED,cAAA,wBAAA,SAAA,gBAAA;AAOI;;AAEG;AACsC;;;AAC5C;;AC/aD;;;;;AAKG;AACH,cAAA,2BAAA,SAAA,gBAAA;AAOI,qBAAA,eAAA;AAEA;;;AAGG;AAC6B;AAEhC;;;AAGG;;;;AAKN;;ACRD;;;;AAIG;AACH,cAAA,cAAA;;;;AAI8B;;AClB9B,cAAA,aAAA,mBAAA,wBAAA,SAAA,iBAAA,SAAA,qBAAA,SAAA,uBAAA,SAAA,oBAAA,SAAA,qBAAA,SAAA,qBAAA,SAAA,0BAAA,SAAA,2BAAA,SAAA,2BAAA;;;;"}