@7shifts/sous-chef 3.27.1 → 3.28.0

package/dist/lists/DataTable/DataTable.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import type { DataTableColumn, DataTableCustomComponent, DataTableItem, DataTableSort } from './types';
+import type { DataTableColumn, DataTableCustomComponent, DataTableItem, DataTableSort, StickyColumns } from './types';
 declare type Props<T> = {
     /** Each element represents a row and each key of the object represents a column */
     items: DataTableItem<T>[];
@@ -28,6 +28,8 @@ declare type Props<T> = {
     hasVerticalBorders?: boolean;
     /** Used to override the default data-testid */
     testId?: string;
+    /** Used to make the left, rigth or both edge columns sticky */
+    stickyColumns?: StickyColumns;
 };
-declare const DataTable: <T extends unknown>({ items, columns, itemComponent, maxHeight, hasPrevious, hasNext, onPreviousClick, onNextClick, onSort, isLoading, showActionMenu, footerComponent, hasVerticalBorders, testId, skeletonRowLayout }: Props<T>) => JSX.Element;
+declare const DataTable: <T extends unknown>({ items, columns, itemComponent, maxHeight, hasPrevious, hasNext, onPreviousClick, onNextClick, onSort, isLoading, showActionMenu, footerComponent, hasVerticalBorders, testId, skeletonRowLayout, stickyColumns }: Props<T>) => JSX.Element;
 export default DataTable;

package/dist/lists/DataTable/DataTableCoverShadow/DataTableCoverShadow.d.ts

@@ -0,0 +1,7 @@
+declare type Props = {
+    showShadowOnLeft: boolean;
+    showShadowOnRight: boolean;
+    isShowingColumns: boolean;
+};
+declare const DataTableCoverShadow: ({ showShadowOnLeft, showShadowOnRight, isShowingColumns }: Props) => JSX.Element;
+export default DataTableCoverShadow;

package/dist/lists/DataTable/DataTableCoverShadow/index.d.ts

@@ -0,0 +1 @@
+export { default } from './DataTableCoverShadow';

package/dist/lists/DataTable/DataTableStickyColumnsContainer/DataTableStickyColumnsContainer.d.ts

@@ -0,0 +1,10 @@
+import { ReactNode } from 'react';
+import { StickyColumns } from '../types';
+declare type Props = {
+    children: ReactNode;
+    stickyColumns?: StickyColumns;
+    isShowingColumns: boolean;
+    isShowingFooter: boolean;
+};
+declare const DataTableStickyColumnsContainer: ({ children, stickyColumns, isShowingColumns, isShowingFooter }: Props) => JSX.Element;
+export default DataTableStickyColumnsContainer;

package/dist/lists/DataTable/DataTableStickyColumnsContainer/index.d.ts

@@ -0,0 +1 @@
+export { default } from './DataTableStickyColumnsContainer';

package/dist/lists/DataTable/constants.d.ts

@@ -3,4 +3,10 @@ export declare const DATA_TABLE_STATES: {
     readonly SKELETON_LOADING: "SKELETON_LOADING";
     readonly BACKGROUND_LOADING: "BACKGROUND_LOADING";
 };
+export declare const DATA_TABLE_SCROLL_STATES: {
+    readonly NO_SCROLL: "NO_SCROLL";
+    readonly SCROLLABLE_CONTENT_ON_BOTH_SIDES: "SCROLLABLE_CONTENT_ON_BOTH_SIDES";
+    readonly SCROLLABLE_CONTENT_ON_LEFT: "SCROLLABLE_CONTENT_ON_LEFT";
+    readonly SCROLLABLE_CONTENT_ON_RIGHT: "SCROLLABLE_CONTENT_ON_RIGHT";
+};
 export declare const AMOUNT_OF_SKELETON_ROWS = 10;

package/dist/lists/DataTable/domain.d.ts

@@ -1,2 +1,7 @@
-import { DataTableState } from './types';
+import { DataTableState, ScrollState } from './types';
 export declare const getDataTableState: (isLoading: boolean, amountOfItems: number) => DataTableState;
+export declare const calculateScrollState: (scrollContainer: {
+    scrollLeft: number;
+    scrollWidth: number;
+    clientWidth: number;
+}) => ScrollState;

package/dist/lists/DataTable/types.d.ts

@@ -34,4 +34,6 @@ declare type ButtonAction = {
 } & MenuAction;
 export declare type DataTableAction = KebabAction | ButtonAction;
 export declare type DataTableState = 'CONTENT' | 'SKELETON_LOADING' | 'BACKGROUND_LOADING';
+export declare type StickyColumns = 'left' | 'right' | 'both';
+export declare type ScrollState = 'NO_SCROLL' | 'SCROLLABLE_CONTENT_ON_BOTH_SIDES' | 'SCROLLABLE_CONTENT_ON_LEFT' | 'SCROLLABLE_CONTENT_ON_RIGHT';
 export {};

package/dist/lists/hooks/useDataTableScrollState.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="react" />
+import { ScrollState } from '../DataTable/types';
+export declare const useDataTableScrollState: (stickyColumns?: "left" | "right" | "both" | undefined) => {
+    scrollState: ScrollState;
+    onScroll: () => void;
+    scrollContainerRef: import("react").RefObject<HTMLDivElement>;
+    hasScrollOnLeft: boolean;
+    hasScrollOnRight: boolean;
+    hasRightColumnSticky: boolean;
+    hasLeftColumnSticky: boolean;
+    showCoverShadowOnRight: boolean;
+    showCoverShadowOnLeft: boolean;
+};

package/dist/utils/browser.d.ts

@@ -0,0 +1 @@
+export declare const getBrowserVersion: () => string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@7shifts/sous-chef",
-    "version": "3.27.1",
+    "version": "3.28.0",
     "description": "7shifts component library",
     "author": "7shifts",
     "license": "MIT",