@guiexpert/preact-table 0.0.1 → 1.0.2

package/{PreactTable.d.ts → GuiexpertTable.d.ts}

@@ -1,7 +1,7 @@
 import { Component } from "preact";
 import { TableModelIf, TableOptions } from "@guiexpert/table";
 import { GeCheckboxEventFn, GeModelChangeEventFn, GeMouseEventFn, GeTableReadyEventFn } from "@guiexpert/react-table";
-export interface PreactTableProps {
+export interface GuiexpertTableProps {
     tableModel: TableModelIf;
     tableOptions?: TableOptions;
     mouseMoved?: GeMouseEventFn;
@@ -13,12 +13,12 @@ export interface PreactTableProps {
     modelChanged?: GeModelChangeEventFn;
     tableReady?: GeTableReadyEventFn;
 }
-export declare class PreactTable extends Component {
+export declare class GuiexpertTable extends Component {
     ref: import("preact").RefObject<any>;
-    constructor(props: PreactTableProps);
+    constructor(props: GuiexpertTableProps);
     componentDidMount(): void;
     componentWillUnmount(): void;
-    initTable(ele: HTMLDivElement, props: PreactTableProps): void;
+    initTable(ele: HTMLDivElement, props: GuiexpertTableProps): void;
     render(): import("preact").JSX.Element;
 }
-export default PreactTable;
+export default GuiexpertTable;

package/README.md

@@ -0,0 +1,103 @@
+
+# PreactTable (GuiExpert Table)
+
+This is the preact component of the GuiExpert Table Project.
+
+## Become a master at creating web applications with large tables
+
+This is the UI-agnostic table component for your next web app. 😊
+
+<img src="https://raw.githubusercontent.com/guiexperttable/ge-table/main/apps/table-website/src/assets/screens/heatmap.png" width="50%">
+
+### Features
+- Handle large datasets easily
+- Excellent performance for large tables by vertical and horizontal virtual scrolling
+- Fully-featured (advanced sorting and filtering)
+- Highly customizable data grid
+- Outstanding performance
+- No third-party dependencies
+- UI-agnostic
+- Column Interactions (resize, reorder)
+- Sorting Rows
+- Row, Column, and Range Selection
+- Single and Multi Selection
+- UI-agnostic
+- Row and Column Spanning
+- Fixed Columns (Left and Right)
+- Tree table (Hierarchical View)
+- Accessibility support: Keyboard Shortcuts
+- Custom Filtering
+- In-place Cell Editing
+- Userdefined Key and Mouse Events
+- Customizable Look & Feel (via CSS variables)
+- Row sorting
+- Column Reordering (Drag and Drop)
+- State Persistence (Row Sorting, Column Order, Selection)
+- Customizable Cell Contents via Renderer for Header, Body and Footer
+- Full control over the HTML structure and style
+
+
+## Links
+
+- [Demos](https://gui.expert/demos)
+- [Documentation](https://gui.expert/doc)
+- [API](https://gui.expert/api)
+
+## Get Started
+
+Add the following two NPM packages to your existing preact project (run this in your project root directory):
+
+```
+npm install --save @guiexpert/table @guiexpert/preact-table
+```
+
+Add PreactTable component to a template:
+
+```
+return (
+  <PreactTable
+    tableOptions={tableOptions}
+    tableModel={tableModel}
+    mouseClicked={console.info}
+    tableReady={tableReady}
+  />
+);
+```
+
+Import the following classes in your component:
+```
+import { PreactTable } from "@guiexpert/preact-table";
+import {
+  GeMouseEvent,
+  TableApi
+  TableModelFactory,
+  TableModelIf,
+  TableOptions,
+  TableOptionsIf
+} from "@guiexpert/table";
+```
+
+
+Add a tableModel property and a onTableReady method to the component:
+
+```
+const tableModel: TableModelIf = TableModelFactory
+  .createByArrayOfArraysParams<any>(param: {
+    columnLabels: [
+      ['Header 1', 'Header 2']
+    ],
+    data: [
+      ['Text 1a', 'Text 2a'],
+      ['Text 1b', 'Text 2b'],
+    ]
+  };
+const tableOptions = new TableOptions();
+
+function onTableReady(api: TableApi) {
+  console.info("onTableReady API:", api);
+}
+```
+
+There are numerous possibilities to create table models.
+Please refer to the [Documentation](https://gui.expert/doc) for further information or the [Demo](https://gui.expert/demos) section for examples.
+

package/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./PreactTable";
+export * from "./GuiexpertTable";
 export * from "./ComponentRendererWrapper";