@oc-digital/react-component-library 8.17.4 → 8.17.6

package/build/Button/Button.types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { IAuthoriserProp } from "../globals";
-import type { ButtonProps } from "@mui/material/Button";
+import type { ButtonProps } from "@mui/material";
 export type IButtonProps<C extends React.ElementType = React.ElementType> = ButtonProps<C, {
     component?: C;
 }> & IAuthoriserProp & {

package/build/DatePicker/DatePicker.types.d.ts

@@ -1,5 +1,5 @@
-import { DatePickerProps } from "@mui/x-date-pickers/DatePicker";
-import { IAuthoriserProp } from "../globals";
+import type { DatePickerProps } from "@mui/x-date-pickers";
+import type { IAuthoriserProp } from "../globals";
 export type IDatePickerProps = DatePickerProps<Date> & IAuthoriserProp & {
     styling?: string;
 };

package/build/EditableTable/EditableTable.types.d.ts

@@ -5,51 +5,56 @@ export type IAlignment = "left" | "right" | "inherit" | "center" | "justify";
 export type RowData = {
     [key: string]: any;
 };
-export type ITableHeader = {
+/** @deprecated old legacy type - doesn't support recursive nested columns */
+type IBaseTableHeader = {
     Header: string | JSX.Element;
-    accessor: string;
+    stickyColumn?: boolean;
     textAlign?: IAlignment;
-    stickyCell?: boolean;
+};
+/** @deprecated old legacy type - doesn't support recursive nested columns */
+export type ITableHeader = IBaseTableHeader & {
+    accessor: string;
     shadedHeader?: boolean;
     linkedStatusColumn?: string;
 };
-export type ITableHeaderComplexAccessor = {
-    Header: string | JSX.Element;
+/** @deprecated old legacy type - doesn't support recursive nested columns */
+export type ITableHeaderComplexAccessor = IBaseTableHeader & {
     id: string;
     accessor: (originalRow: any, rowIndex: any) => any;
-    textAlign?: IAlignment;
-    stickyCell?: boolean;
     shadedHeader?: boolean;
 };
-export type IColumnsTableHeader = {
+type SharedHeaderStructure = {
     Header: string | JSX.Element;
     textAlign?: IAlignment;
-    stickyCell?: boolean;
     shadedHeaderGroup?: boolean;
-    accessor?: any;
-    columns: {
-        Header: string | JSX.Element;
-        shadedHeaderGroup?: boolean;
-        accessor: string;
-        textAlign?: IAlignment;
-        linkedStatusColumn?: string;
-    }[];
 };
-export type IColumnsTableHeaderComplexAccessor = {
-    Header: string | JSX.Element;
-    textAlign?: IAlignment;
-    stickyCell?: boolean;
-    shadedHeaderGroup?: boolean;
+type TopLevelOnlyFields = {
     accessor?: any;
-    columns: {
-        Header: string | JSX.Element;
-        id: string;
-        shadedHeaderGroup?: boolean;
-        accessor: (originalRow: any, rowIndex: any) => any;
-        textAlign?: IAlignment;
-        linkedStatusColumn?: string;
-    }[];
+    stickyColumn?: boolean;
+    shadedHeader?: boolean;
 };
+type LowerLevelOnlyFields = {
+    linkedStatusColumn?: string;
+} & ({
+    id: string;
+    accessor: (originalRow: any, rowIndex: any) => any;
+} | {
+    accessor?: string;
+});
+type TableHeaderWithSubColumns = LowerLevelOnlyFields & {
+    id?: string;
+    accessor?: never;
+    columns: (RecursiveTableHeader & LowerLevelOnlyFields)[];
+};
+type TableHeaderWithAccessor = LowerLevelOnlyFields & {
+    accessor: LowerLevelOnlyFields["accessor"];
+    columns?: never;
+};
+type RecursiveTableHeader = SharedHeaderStructure & (TableHeaderWithSubColumns | TableHeaderWithAccessor);
+export type IColumnsTableHeader = RecursiveTableHeader & TopLevelOnlyFields;
+/** @deprecated old legacy type - doesn't support recursive nested columns */
+export type IColumnsTableHeaderComplexAccessor = IColumnsTableHeader;
+/** @deprecated old legacy type - use IColumnsTableHeader directly */
 export type ITableHeaders = ITableHeader | ITableHeaderComplexAccessor | IColumnsTableHeader | IColumnsTableHeaderComplexAccessor;
 export type TableCellValues = null | undefined | string | number | Date | boolean | string[];
 export type SynchCellWithStateFn = (rowIndex: number, columnId: string, value: TableCellValues, errorStatus: boolean, forceUpdate?: boolean, original?: RowData) => void;
@@ -57,31 +62,35 @@ export type SortMeta = {
     sortingColumnId: string;
     asc: boolean;
 };
+type EditableTableFieldConfiguration = {
+    validationRule?: SchemaOf<any>;
+    dependentValidationRule?: (values: {
+        [key: string]: any;
+    }) => SchemaOf<any>;
+    customRenderFn?: (args: ICustomRenderFnProps) => JSX.Element;
+    prefix?: React.ReactNode | React.JSXElementConstructor<any>;
+    suffix?: React.ReactNode | React.JSXElementConstructor<any>;
+    textAlign?: IAlignment;
+    onBlur?: (args: {
+        rowIndex: number;
+        value: string;
+        setRows: React.Dispatch<React.SetStateAction<RowData[] | null>>;
+        values: RowData;
+    }) => Promise<void>;
+    isCheckbox?: boolean;
+    isDateField?: boolean;
+    onChangeValueModifier?: (value: string) => TableCellValues;
+    getCalculatedValue?: (values: RowData) => TableCellValues;
+    isReadOnly?: boolean;
+    total?: boolean;
+    canUserSort?: boolean;
+    sortCompareFn?: (a: any, b: any) => number;
+};
 export type FieldConfig = {
-    [key: string]: {
-        validationRule?: SchemaOf<any>;
-        dependentValidationRule?: (values: {
-            [key: string]: any;
-        }) => SchemaOf<any>;
-        customRenderFn?: (args: ICustomRenderFnProps) => JSX.Element;
-        prefix?: React.ReactNode | React.JSXElementConstructor<any>;
-        suffix?: React.ReactNode | React.JSXElementConstructor<any>;
-        textAlign?: IAlignment;
-        onBlur?: (args: {
-            rowIndex: number;
-            value: string;
-            setRows: React.Dispatch<React.SetStateAction<RowData[] | null>>;
-            values: RowData;
-        }) => Promise<void>;
-        isCheckbox?: boolean;
-        isDateField?: boolean;
-        onChangeValueModifier?: (value: string) => TableCellValues;
-        getCalculatedValue?: (values: RowData) => TableCellValues;
-        isReadOnly?: boolean;
-        total?: boolean;
-        canUserSort?: boolean;
-        sortCompareFn?: (a: any, b: any) => number;
-    };
+    [key: string]: EditableTableFieldConfiguration;
+};
+export type TypedFieldConfiguration<T> = {
+    [key in keyof T]?: EditableTableFieldConfiguration;
 };
 export interface IEditableTableProps {
     tableRows: RowData[] | null;
@@ -109,6 +118,8 @@ export interface IEditableTableProps {
     includeGlobalSearch?: boolean;
     disableHeaderSelect?: boolean;
     defaultSortMeta?: SortMeta | null;
+    shadedHeaderLeadingColumns?: 1 | 2;
+    freezeHeader?: boolean;
 }
 export interface IEditableTableRef {
     setValue: (rowIndex: number, columnId: string, value: TableCellValues) => void;
@@ -153,6 +164,8 @@ export interface ITableContentProps extends Pick<IEditableTableProps, "disabled"
     sortMeta: SortMeta | null;
     setSortMeta: React.Dispatch<React.SetStateAction<SortMeta | null>>;
     allColumns: ColumnInstance<RowData>[];
+    shadedHeaderLeadingColumns?: 1 | 2;
+    freezeHeader: boolean;
 }
 export interface IGlobalFilterProps {
     preGlobalFilteredRows: RowData[];

package/build/KeyboardDatePicker/KeyboardDatePicker.types.d.ts

@@ -1,5 +1,5 @@
-import { DatePickerProps } from "@mui/x-date-pickers/DatePicker";
-import { IAuthoriserProp } from "../globals";
+import type { DatePickerProps } from "@mui/x-date-pickers";
+import type { IAuthoriserProp } from "../globals";
 export interface IDatePickerProps extends IAuthoriserProp, DatePickerProps<Date> {
     styling?: string;
 }

package/build/MobileDatePicker/MobileDatePicker.types.d.ts

@@ -1,5 +1,5 @@
-import { MobileDatePickerProps } from "@mui/x-date-pickers/MobileDatePicker";
-import { IAuthoriserProp } from "../globals";
+import type { MobileDatePickerProps } from "@mui/x-date-pickers";
+import type { IAuthoriserProp } from "../globals";
 export type IMobileDatePickerProps = MobileDatePickerProps<Date> & IAuthoriserProp & {
     styling?: string;
 };

package/build/index.d.ts

@@ -17,7 +17,8 @@ import DatePicker from "./DatePicker/DatePicker";
 import KeyboardDatePicker from "./KeyboardDatePicker/KeyboardDatePicker";
 import ButtonWithConfirm from "./ButtonWithConfirm/ButtonWithConfirm";
 import EditableTable from "./EditableTable/EditableTable";
-import { FieldConfig, RowData, ITableHeader, ITableHeaderComplexAccessor, IColumnsTableHeader, IColumnsTableHeaderComplexAccessor, ITableHeaders, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, SortMeta, IEditableTableRef } from "./EditableTable/EditableTable.types";
+import { useElementDimensions } from "./hooks/useElementDimensions";
+import { FieldConfig, TypedFieldConfiguration, RowData, ITableHeader, ITableHeaderComplexAccessor, IColumnsTableHeader, IColumnsTableHeaderComplexAccessor, ITableHeaders, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, SortMeta, IEditableTableRef } from "./EditableTable/EditableTable.types";
 import { tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableCheckbox, TableSelect, TableMultipleSelect, NonEditableField } from "./EditableTable/defaultCells";
 import { useDebounceEffect, useInterval, useWhyDidYouUpdate } from "./hooks";
 import { didCellValueChange } from "./utils";
@@ -36,5 +37,5 @@ import { TableDateInput } from "./EditableTable/components/TableDateInput";
 import { TableTextInput } from "./EditableTable/components/TableTextInput";
 import type { ITableTextInputProps } from "./EditableTable/components/TableTextInput";
 import type { ISideNavConfig, ISecondaryNavigationElement, ISecondaryNavigationElements } from "./LeftNavigation/LeftNavigation.types";
-export { ImageDisplayAndUpload, Alert, Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner, Breadcrumbs, EntityList, ErrorIndicator, LeftNavigation, MainLayout, SearchBar, TextField, Select, DatePicker, AutoSaveTextField, AutoSaveSelectField, KeyboardDatePicker, MobileDatePicker, ButtonWithConfirm, EditableTable, TableSelect, TableMultipleSelect, NonEditableField, TableDateInput as TableDatePicker, TableTextInput as TableTextField, tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableCheckbox, didCellValueChange, useDebounceEffect, useInterval, useWhyDidYouUpdate, AlphabeticalList, NumberFormatField, NavbarLayout, OptionalTooltip, FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_INFO, FORM_DELETING, };
-export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, FormStatuses, ITableTextInputProps, ISideNavConfig, ITableHeaderComplexAccessor, IColumnsTableHeader, IColumnsTableHeaderComplexAccessor, ITableHeaders, SortMeta, IEditableTableRef, IAlertProps, ISecondaryNavigationElement, ISecondaryNavigationElements, };
+export { ImageDisplayAndUpload, Alert, Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner, Breadcrumbs, EntityList, ErrorIndicator, LeftNavigation, MainLayout, SearchBar, TextField, Select, DatePicker, AutoSaveTextField, AutoSaveSelectField, KeyboardDatePicker, MobileDatePicker, ButtonWithConfirm, EditableTable, TableSelect, TableMultipleSelect, NonEditableField, TableDateInput as TableDatePicker, TableTextInput as TableTextField, tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableCheckbox, didCellValueChange, useDebounceEffect, useInterval, useWhyDidYouUpdate, useElementDimensions, AlphabeticalList, NumberFormatField, NavbarLayout, OptionalTooltip, FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_INFO, FORM_DELETING, };
+export type { FieldConfig, TypedFieldConfiguration, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, FormStatuses, ITableTextInputProps, ISideNavConfig, ITableHeaderComplexAccessor, IColumnsTableHeader, IColumnsTableHeaderComplexAccessor, ITableHeaders, SortMeta, IEditableTableRef, IAlertProps, ISecondaryNavigationElement, ISecondaryNavigationElements, };