@digital-realty/ix-grid 1.4.1-alpha.1 → 1.4.1-alpha.2

package/package.json

@@ -3,7 +3,7 @@
   "description": "Webcomponent ix-grid following open-wc recommendations",
   "license": "MIT",
   "author": "Digital Realty",
-  "version": "1.4.1-alpha.1",
+  "version": "1.4.1-alpha.2",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -11,7 +11,6 @@
     ".": "./dist/index.js",
     "./ix-grid.js": "./dist/ix-grid.js",
     "./ix-grid-nav.js": "./dist/ix-grid-nav.js",
-    "./ix-grid.min.js": "./dist/ix-grid.min.js",
     "./ix-grid-no-rows.js": "./dist/ix-grid-no-rows.js",
     "./IxGridNav": "./dist/IxGridNav.js"
   },
@@ -46,11 +45,12 @@
   },
   "devDependencies": {
     "@custom-elements-manifest/analyzer": "^0.4.17",
-    "@digital-realty/ix-app-logic": "^1.2.2-alpha.1",
+    "@digital-realty/ix-app-logic": "^1.2.2-alpha.25",
     "@open-wc/eslint-config": "^9.2.1",
     "@open-wc/testing": "^3.1.6",
     "@rollup/plugin-alias": "^5.1.1",
     "@rollup/plugin-replace": "^6.0.2",
+    "@rollup/plugin-typescript": "^12.1.4",
     "@typescript-eslint/eslint-plugin": "^5.48.0",
     "@typescript-eslint/parser": "^5.48.0",
     "@web/dev-server": "^0.4.6",
@@ -69,7 +69,7 @@
     "rollup-plugin-uglify": "^6.0.4",
     "sinon": "^19.0.2",
     "tslib": "^2.3.1",
-    "typescript": "^4.5.2"
+    "typescript": "^4.9.5"
   },
   "customElements": "custom-elements.json",
   "eslintConfig": {

package/rollup.config.mjs

@@ -4,19 +4,45 @@ const minifyHTML = pkgMinifyHTML.default;
 import summary from 'rollup-plugin-summary';
 import { uglify } from "rollup-plugin-uglify";
 import nodeResolve from '@rollup/plugin-node-resolve';
-import { rollUpExternals } from "@digital-realty/ix-app-logic/build_scripts/shared-deps.generator.js";
+import { rollUpExternals } from "@digital-realty/ix-app-logic/build_scripts/shared-deps.js";
+import typescript from '@rollup/plugin-typescript';
 
+// const sourceDir = './src';
+// const outDir = './dist';
+//
+// export default {
+//   input: './src/index.ts',
+//   // input: {
+//   //   'ix-grid': `${sourceDir}/IxGrid.ts`,
+//   //   'ix-grid-nav': `${sourceDir}/components/IxGridNav.ts`,
+//   //   'ix-grid-no-rows': `${sourceDir}/components/IxGridNoRows.ts`,
+//   // },
+//   external: id => rollUpExternals(id),
+//   plugins: [
+//     typescript(),
+//     nodeResolve({
+//       exportConditions: ['browser', 'development'],
+//       browser: true,
+//     }),
+//     // Minify HTML template literals
+//     minifyHTML(),
+//     // Minify JS
+//     uglify(),
+//     // Print bundle summary
+//     summary(),
+//   ],
+//   output: {
+//     dir: outDir,
+//     entryFileNames: '[name].min.js',
+//     format: 'esm'
+//   },
+// };
 
 const target = './dist/ix-grid';
 
 export default {
   input: `${target}.js`,
-  external: id => rollUpExternals(id),
   plugins: [
-    nodeResolve({
-      exportConditions: ['browser', 'development'],
-      browser: true,
-    }),
     // Minify HTML template literals
     minifyHTML(),
     // Minify JS

package/src/IxGrid.d.ts

@@ -0,0 +1,148 @@
+import '@digital-realty/grid';
+import type { GridItemModel } from '@digital-realty/grid';
+import { GridColumn } from '@digital-realty/grid/src/vaadin-grid-column.js';
+import '@digital-realty/ix-icon-button/ix-icon-button.js';
+import '@digital-realty/ix-icon/ix-icon.js';
+import '@digital-realty/ix-progress/ix-progress.js';
+import { LitElement, nothing } from 'lit';
+import './components/IxGridColumnFilter.js';
+import './components/IxGridDownloadMenu.js';
+import './components/IxGridRowFilter.js';
+import './components/IxPagination.js';
+import { IxGridDownloadMenuItemModel } from './models/IxGridDownloadMenuItemModel.js';
+export interface Row {
+    [key: string]: unknown;
+}
+export type FilterOperator = 'equals' | 'contains';
+export type DataType = 'string' | 'dateTime';
+export type BodyRenderer = (item: any, model: GridItemModel<any>, column: GridColumn) => any;
+export interface Column {
+    name: string;
+    header: string;
+    bodyRenderer: BodyRenderer;
+    width?: string;
+    sortable?: boolean;
+    filterable?: boolean;
+    hidden?: boolean;
+    frozenToEnd?: boolean;
+    dataType?: DataType;
+    filterOperators?: FilterOperator[];
+    autoWidth?: boolean;
+    minWidth?: string;
+    maxWidth?: string;
+    responsive?: [string, string][];
+    flexGrow?: number;
+}
+export interface FieldOperator {
+    columnField: string;
+    operator: FilterOperator;
+}
+export declare class IxGrid extends LitElement {
+    static readonly styles: import("lit").CSSResult[];
+    private defaultPageSize;
+    private defaultPage;
+    private originalSearchParams;
+    grid: HTMLElement;
+    columnReorderingAllowed: boolean;
+    variantClass: string;
+    readonly columns: Column[];
+    rows: Row[];
+    defaultEmptyText: string;
+    sortedColumn: string;
+    sortDirection: string;
+    hideHeader: boolean;
+    hideFilters: boolean;
+    rowLimit: number;
+    page: number;
+    pageSize: number;
+    pageSizes: number[];
+    recordCount: number;
+    localStorageID: string | undefined;
+    showDownload: boolean;
+    isDownloading: boolean;
+    isLoading: boolean;
+    downloadMenuItems: IxGridDownloadMenuItemModel[];
+    addParamsToURL: boolean;
+    readParamsFromURL: boolean;
+    refreshDataOnColumnVisibilityChange: boolean;
+    filterValueChangeDebounceTime: number;
+    hideColumnHeaders: boolean;
+    preservedQueryParamKeys: string[];
+    filterMaxDate?: string;
+    hashedTableState: string;
+    hideViewMoreLessButtonIcon: boolean;
+    showAddButton: boolean;
+    disableAddButton: boolean;
+    addButtonLabel: string;
+    onAddButtonClick?: any;
+    showRemoveAllButton: boolean;
+    disableRemoveAllButton: boolean;
+    removeAllButtonLabel: string;
+    onRemoveAllButtonClick?: any;
+    private filters;
+    isColumnsReordering: boolean;
+    isExpanded: boolean;
+    displayColumns: Column[];
+    private defaultFilterKeys;
+    private initialised;
+    get isPersistable(): boolean;
+    get columnNames(): string[];
+    get columnsLocalStorageKey(): string;
+    get arrangedColumns(): {
+        width: string | undefined;
+        name: string;
+        header: string;
+        bodyRenderer: BodyRenderer;
+        sortable?: boolean | undefined;
+        filterable?: boolean | undefined;
+        hidden?: boolean | undefined;
+        frozenToEnd?: boolean | undefined;
+        dataType?: DataType | undefined;
+        filterOperators?: FilterOperator[] | undefined;
+        autoWidth?: boolean | undefined;
+        minWidth?: string | undefined;
+        maxWidth?: string | undefined;
+        responsive?: [string, string][] | undefined;
+        flexGrow?: number | undefined;
+    }[];
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    private handlePopState;
+    private updateSearchParamsFromUri;
+    private rebuildFiltersFromUri;
+    private dispatchChangeEvent;
+    update(changedProperties: Map<string, any>): void;
+    firstUpdated(): void;
+    private checkLocalStorageUpdate;
+    buildQueryFromFilters(): {
+        [k: string]: string;
+    };
+    rebuildQueryFromMatchingQuerystringParams(): Record<string, string>;
+    private getColumnsToDisplayFromLocalStorage;
+    private mapColumnsWithPersistedSettings;
+    private removeOldLocalStorageValues;
+    private findMatchingLocalStorageKeys;
+    private updatePage;
+    saveOriginalSearchParams(gridSearchParams: URLSearchParams): void;
+    handleSort(column?: string): void;
+    private renderColumnHeader;
+    setColumnsToLocalStorage(columns: Column[]): void;
+    reorderColumnsFromTable(): Promise<void>;
+    reorderColumnsFromFilter(e: CustomEvent): Promise<void>;
+    handleOnColumnFilter(e: CustomEvent): void;
+    cellPartNameGenerator(_column: Column, model: {
+        item: Row;
+    }): string;
+    private columnRenderer;
+    private renderHeader;
+    renderAddNewButton(): import("lit-html").TemplateResult<1> | typeof nothing;
+    get showViewMoreLessButton(): boolean;
+    renderViewMoreLessButton(): import("lit-html").TemplateResult<1> | typeof nothing;
+    renderRemoveAllButton(): import("lit-html").TemplateResult<1> | typeof nothing;
+    private renderRowControls;
+    private renderPaginationControls;
+    renderColumns(): import("lit-html").TemplateResult<1>;
+    renderLoading(): import("lit-html").TemplateResult<1>;
+    renderGrid(): import("lit-html").TemplateResult<1> | typeof nothing;
+    render(): import("lit-html").TemplateResult<1>;
+}