react-crud-mui 0.3.2 → 0.3.4

package/dist/components/detail-page/components/DetailPageStepForm.d.ts

@@ -11,5 +11,7 @@ interface DetailPageStepContentProps<TModel extends FieldValues> {
 /**
  * This component is used to create a form for each step in the detail page.
  */
-declare function DetailPageStepForm<TModel extends FieldValues>({ schema, name, children, defaultValues, validationOptions, }: DetailPageStepContentProps<TModel> & PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+declare function DetailPageStepForm<TModel extends FieldValues>({ schema, name, children, defaultValues, validationOptions, active, }: DetailPageStepContentProps<TModel> & PropsWithChildren<{
+    active: boolean;
+}>): import("react/jsx-runtime").JSX.Element;
 export default DetailPageStepForm;

package/dist/components/detail-page/hooks/useDetailPageModal.d.ts

@@ -485,6 +485,7 @@ declare function useDetailPageModal<TModel extends FieldValues, TProps extends S
     readonly successPanelVisible?: boolean;
     readonly successPanelProps?: import('../components/SuccessPanel').SuccessPanelProps | ((model: TModel, events: Pick<import('../pages/DetailPageContent').DetailPageContentProps<TModel>, "onClose" | "onCreate">) => import('../components/SuccessPanel').SuccessPanelProps) | undefined;
     readonly onSuccessPanel?: ((model: TModel, events: Pick<import('../pages/DetailPageContent').DetailPageContentProps<TModel>, "onClose" | "onCreate">) => React.ReactNode) | undefined;
+    readonly alertsScrollMarginTop?: number;
     readonly onAfterDelete?: ((variables: import('../pages/DetailPageData').DeletePayload<TModel>, form: import('../../form/hooks/useForm').UseFormReturn<TModel, FieldValues>) => void) | undefined;
     readonly onAfterSave?: ((result: void | Awaited<TModel> | undefined, variables: import('../pages/DetailPageData').SavePayload<TModel>, form: import('../../form/hooks/useForm').UseFormReturn<TModel, FieldValues>) => void) | undefined;
     readonly showSuccessMessages?: boolean;

package/dist/components/detail-page/pages/DetailPageContent.d.ts

@@ -167,6 +167,11 @@ export interface DetailPageContentProps<TModel extends FieldValues> extends Omit
      * Custom render for success panel
      */
     onSuccessPanel?: (model: TModel, events: Pick<DetailPageContentProps<TModel>, 'onCreate' | 'onClose'>) => React.ReactNode;
+    /**
+     * Offset (in px) reserved above the alerts section when scrolling it into view on error,
+     * useful when the consumer app has a sticky/fixed header that would otherwise cover it
+     */
+    alertsScrollMarginTop?: number;
 }
-declare function DetailPageContent<TModel extends FieldValues>({ activeSegmentIndex, alerts, autoSave, children, commandsPosition, commandsProps, customSteps: CustomSteps, data, defaultSaveMode, disabled, disableShortCuts, enableClose, enableCopy, enableCreate, enableDelete, enableDiscardChanges, enableSave, error, form, hotkeyScopes, loading, onClose, onCommands, onContentLayout, onCopy, onCreate, onDelete, onDiscardChanges, onSegmentChanged, onExtraCommands, onHeader, onNavigate, onSave, onSaveClose, onSaveCreate, onTabChanged, onWrapperLayout, readOnly, reason, showHeader, steps, stepsProps, successPanelVisible, successPanelProps, onSuccessPanel, tabExtraContent, ...pageProps }: DetailPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
+declare function DetailPageContent<TModel extends FieldValues>({ activeSegmentIndex, alerts, alertsScrollMarginTop, autoSave, children, commandsPosition, commandsProps, customSteps: CustomSteps, data, defaultSaveMode, disabled, disableShortCuts, enableClose, enableCopy, enableCreate, enableDelete, enableDiscardChanges, enableSave, error, form, hotkeyScopes, loading, onClose, onCommands, onContentLayout, onCopy, onCreate, onDelete, onDiscardChanges, onSegmentChanged, onExtraCommands, onHeader, onNavigate, onSave, onSaveClose, onSaveCreate, onTabChanged, onWrapperLayout, readOnly, reason, showHeader, steps, stepsProps, successPanelVisible, successPanelProps, onSuccessPanel, tabExtraContent, ...pageProps }: DetailPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
 export default DetailPageContent;

package/dist/components/hooks/index.d.ts

@@ -12,3 +12,4 @@ export { default as useTemplate } from '../combobox/hooks/useComboboxTemplate';
 export { default as useUpdateEffect } from './useUpdateEffect';
 export { default as useZodRefine } from './useZodRefine';
 export { useSpinDelay } from './useSpinDelay';
+export { default as useScrollToTop } from './useScrollToTop';

package/dist/components/hooks/useScrollToTop.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Scrolls the window to top whenever `key` changes (e.g. on route change).
+ * Fixes react-router-dom keeping the previous page's scroll position when
+ * navigating to a new route (browser doesn't reset scroll on pushState).
+ */
+declare function useScrollToTop(key: unknown): void;
+export default useScrollToTop;

package/dist/components/list-page/pages/ListPageContent.d.ts

@@ -168,6 +168,11 @@ export interface ListPageContentProps<TModel extends FieldValues> extends Omit<P
      * List type @default table
      */
     listType?: ListType;
+    /**
+     * Offset (in px) reserved above the alerts section when scrolling it into view on error,
+     * useful when the consumer app has a sticky/fixed header that would otherwise cover it
+     */
+    alertsScrollMarginTop?: number;
 }
-declare function ListPageContent<TModel extends FieldValues>({ activeSegmentIndex, actionCommandsProps, actionColumnProps, alerts, autoSearch, cardProps, children, columns, commandsProps, data, dataCount, disabled, disableShortCuts, enableActionCommands, enableRowClickToDetails, enableClear, enableCreateItem, enableRefetch, enableExport, enableSearch, error, filterContent, hotkeyScopes, listType, loading, onActionClick, onActionCommands, onClear, onClose, onCommands, onCustomTable, onDetailPage, onExcelExport, onExtraCommands, onHeader, onLayout, onSearch, onTabChanged, tableProps, onWrapperLayout, showHeader, showDataCountOnHeader, ...pageProps }: ListPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
+declare function ListPageContent<TModel extends FieldValues>({ activeSegmentIndex, actionCommandsProps, actionColumnProps, alerts, alertsScrollMarginTop, autoSearch, cardProps, children, columns, commandsProps, data, dataCount, disabled, disableShortCuts, enableActionCommands, enableRowClickToDetails, enableClear, enableCreateItem, enableRefetch, enableExport, enableSearch, error, filterContent, hotkeyScopes, listType, loading, onActionClick, onActionCommands, onClear, onClose, onCommands, onCustomTable, onDetailPage, onExcelExport, onExtraCommands, onHeader, onLayout, onSearch, onTabChanged, tableProps, onWrapperLayout, showHeader, showDataCountOnHeader, ...pageProps }: ListPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
 export default ListPageContent;

package/dist/components/page/components/DefaultPanels.d.ts

@@ -2,12 +2,13 @@ import { ReactNode } from 'react';
 import { AccordionProps } from '@mui/material/Accordion';
 import { AccordionDetailsProps } from '@mui/material/AccordionDetails';
 import { BoxProps } from '@mui/material/Box';
-export type PanelPane = Omit<AccordionProps, 'children' | 'key'> & {
+export type PanelPane = Omit<AccordionProps, 'children' | 'key' | 'hidden'> & {
     children?: ReactNode;
     footer?: ReactNode;
     label?: ReactNode;
     key: string;
     detailsProps?: AccordionDetailsProps;
+    hidden?: boolean;
 };
 export interface DefaultAccordionsProps extends BoxProps {
     panels: PanelPane[];

package/dist/components/page/components/DefaultTabs.d.ts

@@ -2,7 +2,7 @@ import { ReactNode } from 'react';
 import { SxProps } from '@mui/material/styles';
 import { TabProps } from '@mui/material/Tab';
 import { TabsProps } from '@mui/material/Tabs';
-export type TabPane = Omit<TabProps, 'children' | 'key'> & {
+export type TabPane = Omit<TabProps, 'children' | 'key' | 'hidden'> & {
     children?: ReactNode;
     key: string;
     hidden?: boolean;

package/dist/components/table/Table.d.ts

@@ -58,6 +58,7 @@ export interface TableProps<TData extends FieldValues> extends Omit<TableOptions
     onCellProps?: (cell: Cell<TData, unknown>, table: TableType<TData>) => React.ComponentProps<typeof BodyTableCell> | undefined;
     onHeadCellProps?: (header: Header<TData, unknown>, table: TableType<TData>) => React.ComponentProps<typeof HeadTableCell> | undefined;
     onFooterCellProps?: (header: Header<TData, unknown>, table: TableType<TData>) => React.ComponentProps<typeof BodyTableCell> | undefined;
+    onDescriptionCellProps?: (row: Row<TData>, table: TableType<TData>) => React.ComponentProps<typeof BodyTableCell> | undefined;
     onSubTreeRows?: Path<TData> | ((originalRow: TData) => unknown[] | undefined);
     rowIdField?: Path<TData>;
     scrollProps?: Partial<ScrollbarProps>;
@@ -75,7 +76,7 @@ export interface TableProps<TData extends FieldValues> extends Omit<TableOptions
     alternateColor?: boolean;
     delayOptions?: SpinDelayOptions;
 }
-declare function Table<TData extends FieldValues>({ alternateColor, autoFocus, bordered, columns, data, delayOptions, descriptionField, emptyText, enablePagination, enableRowClickSelect, enableNestedComponent, enableSkeleton, headerSx, highlightedRowIndex, loading, newRowButtonText, newRowButtonContent, onCellProps, onFooterCellProps, onHeadCellProps, onNewRow, onRenderNestedComponent, onRowClick, onRowEnterPress, onRowProps, onSubTreeRows, paginationProps, rowIdField, rowSx, size, showEmptyText, showHeader, showFooter, stickyHeader, scrollProps, showEmptyImage, showNewRowButton, skeletonRows, state, sx, ...tableProps }: TableProps<TData>): import("react/jsx-runtime").JSX.Element;
+declare function Table<TData extends FieldValues>({ alternateColor, autoFocus, bordered, columns, data, delayOptions, descriptionField, emptyText, enablePagination, enableRowClickSelect, enableNestedComponent, enableSkeleton, headerSx, highlightedRowIndex, loading, newRowButtonText, newRowButtonContent, onCellProps, onDescriptionCellProps, onFooterCellProps, onHeadCellProps, onNewRow, onRenderNestedComponent, onRowClick, onRowEnterPress, onRowProps, onSubTreeRows, paginationProps, rowIdField, rowSx, size, showEmptyText, showHeader, showFooter, stickyHeader, scrollProps, showEmptyImage, showNewRowButton, skeletonRows, state, sx, ...tableProps }: TableProps<TData>): import("react/jsx-runtime").JSX.Element;
 declare namespace Table {
     var MoreMenu: typeof TableMoreMenu;
     var MoreMenuItem: typeof TableMoreMenuItem;