@eztrak/shared 0.13.8 → 0.15.0

package/dist/components/index.d.ts

@@ -4,7 +4,7 @@ import { Props, StylesConfig } from 'react-select';
 import { PlacesType } from 'react-tooltip';
 import { IconType } from 'react-icons';
 import { TippyProps } from '@tippyjs/react';
-import { R as RtkQueryError } from '../handleApiError-CwVIJOqO.js';
+import { C as ConfirmationAlertOptions, R as RtkQueryError } from '../handleApiError-CwVIJOqO.js';
 
 type EztrakTab = {
     id: string;
@@ -129,6 +129,11 @@ interface SearchInputProps extends Omit<InputHTMLAttributes<HTMLInputElement>, "
     debounceDelay?: number;
     customIcon?: ReactNode | null;
     defaultValue?: string;
+    /**
+     * Pagination param reset to page 1 when the query changes. Defaults to "page";
+     * match `CustomPagination`'s `paramNames.page` if the screen overrides it.
+     */
+    pageParam?: string;
 }
 interface DropdownFilterProps<Option extends Record<string, unknown>> extends Omit<Props<Option, false>, "value" | "onChange" | "options" | "styles" | "name"> {
     /** URL search param key synced with the selected option. */
@@ -142,13 +147,18 @@ interface DropdownFilterProps<Option extends Record<string, unknown>> extends Om
     borderRadius?: string;
     /** When true, persists the selected value in localStorage under `name`. */
     saveToLocalStorage?: boolean;
+    /**
+     * Pagination param reset to page 1 when the selection changes. Defaults to
+     * "page"; match `CustomPagination`'s `paramNames.page` if the screen overrides it.
+     */
+    pageParam?: string;
 }
 
-declare function DropdownFilter<Option extends Record<string, unknown>>({ name, valueKey, options, placeholder, borderRadius, className, isClearable, isSearchable, isDisabled, isLoading, saveToLocalStorage, ...otherProps }: DropdownFilterProps<Option>): react.JSX.Element;
+declare function DropdownFilter<Option extends Record<string, unknown>>({ name, valueKey, options, placeholder, borderRadius, className, isClearable, isSearchable, isDisabled, isLoading, saveToLocalStorage, pageParam, ...otherProps }: DropdownFilterProps<Option>): react.JSX.Element;
 
 declare function ResetFiltersButton({ label, showLabel, icon, variant, className, onReset, disabled, }: ResetFiltersButtonProps): react.JSX.Element;
 
-declare function SearchInput({ placeholder, searchBtn, searchClassName, searchWrapperClass, searchIconClassName, defaultParam, showIcon, name, type, liveSearch, debounceDelay, customIcon, defaultValue, ...props }: SearchInputProps): react.JSX.Element;
+declare function SearchInput({ placeholder, searchBtn, searchClassName, searchWrapperClass, searchIconClassName, defaultParam, showIcon, name, type, liveSearch, debounceDelay, customIcon, defaultValue, pageParam, ...props }: SearchInputProps): react.JSX.Element;
 
 declare const dropdownStyles: <Option>(_borderRadius: string) => StylesConfig<Option, false>;
 
@@ -307,6 +317,8 @@ interface PopupCellRendererProps<TRow = unknown> {
     params?: PopupCellRendererParams<TRow>;
     onAction?: (actionType: string, rowData: TRow | undefined, hide: () => void) => void;
     placement?: TippyProps["placement"];
+    /** Default `"Row actions"`. */
+    ariaLabel?: string;
     tippyProps?: Omit<Partial<TippyProps>, "children" | "content" | "visible" | "placement">;
 }
 
@@ -317,7 +329,147 @@ interface PopupCellRendererProps<TRow = unknown> {
  * `import "tippy.js/dist/tippy.css"`
  * `import "tippy.js/themes/light.css"`
  */
-declare function PopupCellRenderer<TRow = unknown>({ dropDownContent, actionIcon: ActionIcon, title, className, hideTitle, params, onAction, placement, tippyProps, }: PopupCellRendererProps<TRow>): react.JSX.Element;
+declare function PopupCellRenderer<TRow = unknown>({ dropDownContent, actionIcon: ActionIcon, title, className, hideTitle, params, onAction, placement, tippyProps, ariaLabel, }: PopupCellRendererProps<TRow>): react.JSX.Element;
+
+type RowActionPresetName = "edit" | "delete" | "view" | "notes" | "history" | "download" | "archive" | "resolve";
+type RowActionsMode = "menu" | "inline";
+type RowActionItemType = "item" | "divider";
+type RowActionFlag<TRow> = boolean | ((row: TRow | undefined) => boolean);
+type RowActionConfirmFn = (onConfirm: () => void | Promise<void>, options?: ConfirmationAlertOptions) => void;
+type RowAction<TRow = unknown> = {
+    /** Unique id. Falls back to `preset` when omitted. */
+    key?: string;
+    /** `"divider"` renders a separator. Default `"item"`. */
+    type?: RowActionItemType;
+    label?: string;
+    icon?: IconType;
+    /** Overrides `RowActions` `iconSize` for this item. */
+    iconSize?: number;
+    preset?: RowActionPresetName;
+    onClick?: (row: TRow | undefined) => void;
+    /** Fully custom row content (skips the default icon+label button). */
+    content?: ReactNode;
+    /** If set, the action is hidden unless `hasPermission(permission)` is true. */
+    permission?: string;
+    hidden?: RowActionFlag<TRow>;
+    disabled?: RowActionFlag<TRow>;
+    danger?: boolean;
+    highlight?: RowActionFlag<TRow>;
+    /** Default = resolved label. `false` hides the tooltip. */
+    tooltip?: string | false;
+    tooltipPlacement?: PlacesType;
+    confirm?: ConfirmationAlertOptions;
+    /** Default `true`. */
+    closeOnClick?: boolean;
+    /** Extra classes on this item (merged after defaults; can override hover). */
+    className?: string;
+};
+type RowActionsList<TRow = unknown> = RowAction<TRow>[] | ((data: TRow | undefined) => RowAction<TRow>[]);
+interface RowActionsRenderContext<TRow = unknown> {
+    data: TRow | undefined;
+    actions: ResolvedRowAction<TRow>[];
+    hide: () => void;
+    defaultMenu: ReactNode;
+}
+interface RowActionItemRenderContext<TRow = unknown> {
+    data: TRow | undefined;
+    hide: () => void;
+    defaultItem: ReactNode;
+}
+interface RowActionsProps<TRow = unknown> {
+    actions: RowActionsList<TRow>;
+    data?: TRow;
+    mode?: RowActionsMode;
+    /** Override the default vertical 3-dots trigger. */
+    actionIcon?: IconType;
+    /** Extra classes on the trigger button (merged with defaults). */
+    className?: string;
+    /** Extra classes on the dropdown panel (merged with defaults). */
+    menuClassName?: string;
+    /**
+     * Extra classes on every menu/inline item (merged after defaults).
+     * Override hover here, e.g. `hover:bg-gray-100 hover:text-gray-800`.
+     */
+    itemClassName?: string;
+    itemIconClassName?: string;
+    /** Default `16`. */
+    iconSize?: number;
+    /** Default `"Actions"`. Pass `false` to hide. */
+    triggerTooltip?: string | false;
+    triggerAriaLabel?: string;
+    hasPermission?: (permission: string) => boolean;
+    placement?: TippyProps["placement"];
+    tippyProps?: PopupCellRendererProps<TRow>["tippyProps"];
+    /** Override default `Fa*` preset icons/labels for this instance. */
+    presets?: Partial<Record<RowActionPresetName, Partial<RowActionPreset>>>;
+    /** Default: shared `confirmationAlert`. */
+    confirmFn?: RowActionConfirmFn;
+    tooltipPlacement?: PlacesType;
+    tooltipDelayShow?: number;
+    tooltipDelayHide?: number;
+    tooltipClassName?: string;
+    tooltipStyle?: CSSProperties;
+    /** Replace one item’s markup. */
+    renderItem?: (action: ResolvedRowAction<TRow>, ctx: RowActionItemRenderContext<TRow>) => ReactNode;
+    /** Replace the dropdown panel. Still opened by the default trigger unless `renderTrigger` is set. */
+    renderMenu?: (ctx: RowActionsRenderContext<TRow>) => ReactNode;
+    /** Replace trigger + popup engine entirely (e.g. a custom popover). */
+    renderTrigger?: (ctx: Omit<RowActionsRenderContext<TRow>, "hide"> & {
+        hide: () => void;
+    }) => ReactNode;
+}
+interface ActionMenuItemProps {
+    label: string;
+    icon?: IconType;
+    iconSize?: number;
+    iconClassName?: string;
+    tooltip?: string;
+    tooltipPlacement?: PlacesType;
+    tooltipDelayShow?: number;
+    tooltipDelayHide?: number;
+    tooltipClassName?: string;
+    tooltipStyle?: CSSProperties;
+    disabled?: boolean;
+    danger?: boolean;
+    highlight?: boolean;
+    showLabel?: boolean;
+    className?: string;
+    onClick: () => void;
+}
+interface ResolvedRowAction<TRow = unknown> {
+    key: string;
+    type: RowActionItemType;
+    label: string;
+    icon?: IconType;
+    iconSize?: number;
+    content?: ReactNode;
+    onClick?: (row: TRow | undefined) => void;
+    disabled: boolean;
+    danger: boolean;
+    highlight: boolean;
+    tooltip?: string;
+    tooltipPlacement?: PlacesType;
+    confirm?: ConfirmationAlertOptions;
+    closeOnClick: boolean;
+    className?: string;
+}
+interface RowActionPreset {
+    label: string;
+    icon: IconType;
+    danger?: boolean;
+}
+
+declare function RowActions<TRow = unknown>({ actions, data, mode, actionIcon, className, menuClassName, itemClassName, itemIconClassName, iconSize, triggerTooltip, triggerAriaLabel, hasPermission, placement, tippyProps, presets, confirmFn, tooltipPlacement, tooltipDelayShow, tooltipDelayHide, tooltipClassName, tooltipStyle, renderItem, renderMenu, renderTrigger, }: RowActionsProps<TRow>): react.JSX.Element | null;
+
+declare function ActionMenuItem({ label, icon: Icon, iconSize, iconClassName, tooltip, tooltipPlacement, tooltipDelayShow, tooltipDelayHide, tooltipClassName, tooltipStyle, disabled, danger, highlight, showLabel, className, onClick, }: ActionMenuItemProps): react.JSX.Element;
+
+/** Settings-app hover: peach bg `#FFF1EB` + orange text (`primary-50` / `primary-150`). */
+declare const ROW_ACTION_ITEM_HOVER_CLASS = "hover:bg-primary-50 hover:text-primary-150";
+declare const ROW_ACTION_DEFAULT_ICON_SIZE = 16;
+declare const ROW_ACTION_DEFAULT_MENU_TOOLTIP_STYLE: CSSProperties;
+declare const ROW_ACTION_PRESETS: Record<RowActionPresetName, RowActionPreset>;
+
+declare function resolveActions<TRow>(actions: RowActionsList<TRow>, data: TRow | undefined, hasPermission?: (permission: string) => boolean, presets?: Partial<Record<RowActionPresetName, Partial<RowActionPreset>>>): ResolvedRowAction<TRow>[];
 
 type TableErrorBoundaryProps = {
     isError: boolean;
@@ -332,4 +484,4 @@ type TableErrorBoundaryProps = {
 
 declare const TableErrorBoundary: react__default.FC<TableErrorBoundaryProps>;
 
-export { CardSkeleton, type CardSkeletonProps, type CardSkeletonVariant, type CellEditPayload, type CellEditorInputType, CustomCellEditor, type CustomCellEditorProps, type CustomCellEditorRef, CustomPagination, type CustomPaginationClassNames, type CustomPaginationProps, DropdownFilter, type DropdownFilterProps, type DropdownOption, type EztrakTab, EztrakTabs, type EztrakTabsClassNames, type EztrakTabsProps, type LayoutStatus, Loader, type LoaderProps, Modal, type ModalProps, type PaginationData, type PopupActionHandler, PopupCellRenderer, type PopupCellRendererParams, type PopupCellRendererProps, type PopupDropDownContent, ResetColumnsButton, type ResetColumnsButtonProps, ResetFiltersButton, type ResetFiltersButtonProps, type ResetFiltersButtonVariant, SearchInput, type SearchInputProps, TableErrorBoundary, type TableErrorBoundaryProps, TableLayoutToolbarControls, type TableLayoutToolbarControlsProps, ToolTip, type ToolTipProps, TooltipText, type TooltipTextProps, dropdownStyles };
+export { ActionMenuItem, type ActionMenuItemProps, CardSkeleton, type CardSkeletonProps, type CardSkeletonVariant, type CellEditPayload, type CellEditorInputType, CustomCellEditor, type CustomCellEditorProps, type CustomCellEditorRef, CustomPagination, type CustomPaginationClassNames, type CustomPaginationProps, DropdownFilter, type DropdownFilterProps, type DropdownOption, type EztrakTab, EztrakTabs, type EztrakTabsClassNames, type EztrakTabsProps, type LayoutStatus, Loader, type LoaderProps, Modal, type ModalProps, type PaginationData, type PopupActionHandler, PopupCellRenderer, type PopupCellRendererParams, type PopupCellRendererProps, type PopupDropDownContent, ROW_ACTION_DEFAULT_ICON_SIZE, ROW_ACTION_DEFAULT_MENU_TOOLTIP_STYLE, ROW_ACTION_ITEM_HOVER_CLASS, ROW_ACTION_PRESETS, ResetColumnsButton, type ResetColumnsButtonProps, ResetFiltersButton, type ResetFiltersButtonProps, type ResetFiltersButtonVariant, type ResolvedRowAction, type RowAction, type RowActionConfirmFn, type RowActionFlag, type RowActionItemRenderContext, type RowActionItemType, type RowActionPreset, type RowActionPresetName, RowActions, type RowActionsList, type RowActionsMode, type RowActionsProps, type RowActionsRenderContext, SearchInput, type SearchInputProps, TableErrorBoundary, type TableErrorBoundaryProps, TableLayoutToolbarControls, type TableLayoutToolbarControlsProps, ToolTip, type ToolTipProps, TooltipText, type TooltipTextProps, dropdownStyles, resolveActions };