@stenajs-webui/grid 17.30.7 → 17.31.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v17.31.0 (Wed Feb 01 2023)
+
+#### 🚀 Enhancement
+
+- External sorting and `onSortOrderChange` prop in StandardTable [#554](https://github.com/StenaIT/stenajs-webui/pull/554) ([@mattias800](https://github.com/mattias800))
+
+#### Authors: 1
+
+- Mattias Andersson ([@mattias800](https://github.com/mattias800))
+
+---
+
 # v17.29.0 (Mon Dec 12 2022)
 
 #### 🐛 Bug Fix

package/dist/features/standard-table/components/StandardTable.d.ts

@@ -1,8 +1,8 @@
+import { ResultListBannerState } from "@stenajs-webui/elements";
 import { ReactNode } from "react";
 import { StandardTableConfig } from "../config/StandardTableConfig";
 import { TableContext } from "../context/StandardTableStateContext";
-import { StandardTableOnKeyDown } from "../types/StandardTableOnKeyDown";
-import { ResultListBannerState } from "@stenajs-webui/elements";
+import { StandardTableOnKeyDown, StandardTableOnSortOrderChange } from "../types/StandardTableEvents";
 export interface StandardTableProps<TItem, TColumnKey extends string, TColumnGroupKey extends string> {
     /**
      * Variant of table
@@ -77,6 +77,11 @@ export interface StandardTableProps<TItem, TColumnKey extends string, TColumnGro
      * an object that contains columnId and item for the focused cell.
      */
     onKeyDown?: StandardTableOnKeyDown<TItem, TColumnKey>;
+    /**
+     * Event listener for when user changes the sort order.
+     * This is triggered when user clicks on the table headers, even if using external sorting.
+     */
+    onSortOrderChange?: StandardTableOnSortOrderChange<TColumnKey>;
 }
 export declare type StandardTableVariant = "relaxed" | "standard" | "condensed" | "compact";
-export declare const StandardTable: <TItem, TColumnKey extends string, TColumnGroupKey extends string>({ tableContext, config, columnOrder, columnGroupOrder, tableId, variant, onKeyDown, ...props }: StandardTableProps<TItem, TColumnKey, TColumnGroupKey>) => JSX.Element;
+export declare const StandardTable: <TItem, TColumnKey extends string, TColumnGroupKey extends string>({ tableContext, config, columnOrder, columnGroupOrder, tableId, variant, onKeyDown, onSortOrderChange, ...props }: StandardTableProps<TItem, TColumnKey, TColumnGroupKey>) => JSX.Element;

package/dist/features/standard-table/config/StandardTableConfig.d.ts

@@ -47,6 +47,11 @@ export interface StandardTableConfigBase<TItem, TColumnKey extends string> {
      * If true, click on table headers does not change sort order.
      */
     disableSorting?: boolean;
+    /**
+     * If true, click on table headers works as usual, but no sorting is applied.
+     * Sort must be applied outside of StandardTable, in client or in backend.
+     */
+    enableExternalSorting?: boolean;
     /**
      * Table will be sorted by specified column key as default.
      * Only used when using internal reducer. If redux is used, this setting is ignored.

package/dist/features/standard-table/context/OnKeyDownContext.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
-import { StandardTableOnKeyDown } from "../types/StandardTableOnKeyDown";
+import { StandardTableOnKeyDown } from "../types/StandardTableEvents";
 export declare const OnKeyDownContext: import("react").Context<StandardTableOnKeyDown<any, any> | undefined>;
-export declare const useOnKeyDownContext: <TItem, TColumnKey extends string>() => StandardTableOnKeyDown<TItem, TColumnKey>;
+export declare const useOnKeyDownContext: <TItem, TColumnKey extends string>() => StandardTableOnKeyDown<TItem, TColumnKey> | undefined;

package/dist/features/standard-table/context/OnSortOrderChangeContext.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { StandardTableOnSortOrderChange } from "../types/StandardTableEvents";
+export declare const OnSortOrderChangeContext: import("react").Context<StandardTableOnSortOrderChange<any> | undefined>;
+export declare const useOnSortOrderChangeContext: <TColumnKey extends string>() => StandardTableOnSortOrderChange<TColumnKey> | undefined;

package/dist/features/standard-table/types/{StandardTableOnKeyDown.d.ts → StandardTableEvents.d.ts}

@@ -1,3 +1,4 @@
 import * as React from "react";
 import { StandardTableOnKeyDownArgs } from "../config/StandardTableConfig";
 export declare type StandardTableOnKeyDown<TItem, TColumnKey extends string> = (ev: React.KeyboardEvent<HTMLDivElement>, args: StandardTableOnKeyDownArgs<TItem, TColumnKey>) => void;
+export declare type StandardTableOnSortOrderChange<TColumnKey extends string> = (sortOrder: TColumnKey, desc: boolean) => void;

package/dist/index.d.ts

@@ -30,7 +30,7 @@ export * from "./features/standard-table/features/checkboxes/StandardTableRowChe
 export * from "./features/standard-table/features/sorting/UseTableSortHeader";
 export * from "./features/standard-table/features/sorting/MultitypeComparator";
 export * from "./features/standard-table/features/column-groups/ColumnGroupFactory";
-export * from "./features/standard-table/types/StandardTableOnKeyDown";
+export * from "./features/standard-table/types/StandardTableEvents";
 export * from "./features/standard-table/helpers/cell-renderers/editable-text-cell/EditableTextCell";
 export * from "./features/standard-table/helpers/cell-renderers/editable-text-cell/EditableTextCellWithStatus";
 export * from "./features/standard-table/hooks/UseCellBackground";