@vuu-ui/vuu-table-types 0.9.2 → 0.10.0

package/index.d.ts

@@ -21,11 +21,12 @@ import type {
   RowClassNameGenerator,
 } from "@vuu-ui/vuu-utils";
 import type {
+  ComponentType,
   CSSProperties,
   FunctionComponent,
+  FunctionComponentElement,
   HTMLAttributes,
   MouseEvent,
-  ReactElement,
 } from "react";
 
 export declare type GroupToggleTarget = "toggle-icon" | "group-column";
@@ -39,7 +40,9 @@ export declare type TableSelectionModel =
 export declare type TableHeading = { label: string; width: number };
 export declare type TableHeadings = TableHeading[][];
 
-export declare type ValueFormatter = (value: unknown) => string;
+export declare type ValueFormatter<T extends string | JSX.Element = string> = (
+  value: unknown,
+) => T;
 
 export interface EditEventState {
   editType?: EditType;
@@ -65,6 +68,7 @@ export interface TableCellProps {
   onClick?: (event: MouseEvent, column: RuntimeColumnDescriptor) => void;
   onDataEdited?: DataCellEditHandler;
   row: DataSourceRow;
+  searchPattern?: Lowercase<string>;
 }
 
 export declare type CommitResponse = Promise<true | string>;
@@ -245,6 +249,11 @@ export interface ColumnDescriptor extends DataValueDescriptor {
   aggregate?: VuuAggType;
   align?: ColumnAlignment;
   className?: string;
+  /**
+   * Allows custom content to be rendered into the column header. This will be an identifier.
+   * The identifier will be used to retrieve content from the component registry. The componnet
+   * yielded will be rendered into the column header.
+   */
   colHeaderContentRenderer?: string;
   colHeaderLabelRenderer?: string;
   flex?: number;
@@ -267,6 +276,13 @@ export interface ColumnDescriptor extends DataValueDescriptor {
   pin?: PinLocation;
   resizeable?: boolean;
   sortable?: boolean;
+  /**
+   * 'client' columns will not receive data from dataSource.
+   * They can be used with a custom renderer, e.g to render
+   * action buttons.
+   * default is 'server'
+   */
+  source?: "client" | "server";
   width?: number;
 }
 
@@ -411,6 +427,7 @@ export interface RowProps extends BaseRowProps {
   onDataEdited?: DataCellEditHandler;
   onToggleGroup?: (row: DataSourceRow, column: RuntimeColumnDescriptor) => void;
   row: DataSourceRow;
+  searchPattern: Lowercase<string>;
   showBookends?: boolean;
   zebraStripes?: boolean;
 }
@@ -426,8 +443,9 @@ export interface HeaderCellProps
 
 export declare type TableConfigChangeHandler = (config: TableConfig) => void;
 
-export declare type CustomHeaderComponent = FC<BaseRowProps>;
-export declare type CustomHeaderElement = ReactElement;
+export declare type CustomHeaderComponent = ComponentType<BaseRowProps>;
+export declare type CustomHeaderElement =
+  FunctionComponentElement<BaseRowProps>;
 export declare type CustomHeader = CustomHeaderComponent | CustomHeaderElement;
 
 /**

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@vuu-ui/vuu-table-types",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "devDependencies": {
-    "@vuu-ui/vuu-data-types": "0.9.2",
-    "@vuu-ui/vuu-filter-types": "0.9.2",
-    "@vuu-ui/vuu-protocol-types": "0.9.2"
+    "@vuu-ui/vuu-data-types": "0.10.0",
+    "@vuu-ui/vuu-filter-types": "0.10.0",
+    "@vuu-ui/vuu-protocol-types": "0.10.0"
   },
   "author": "heswell",
   "license": "Apache-2.0",