@equinor/apollo-components 3.0.0 → 3.1.1

package/dist/index.d.ts

@@ -1,11 +1,40 @@
+export * from 'apollo-common';
 import { IconData } from '@equinor/eds-icons';
 import * as react from 'react';
 import { ReactNode, ReactElement, HTMLProps, MutableRefObject, Dispatch, SetStateAction } from 'react';
-import { Cell, CellContext, Table, Row, SortingState, OnChangeFn, ColumnDef, RowSelectionState, ExpandedState, VisibilityState, HeaderContext } from '@tanstack/react-table';
+import * as styled_components from 'styled-components';
+import * as _equinor_eds_core_react from '@equinor/eds-core-react';
+import { CellProps } from '@equinor/eds-core-react';
+import { Cell, Header, CellContext, Table, Row, SortingState, OnChangeFn, ColumnDef, RowSelectionState, ExpandedState, VisibilityState, HeaderContext } from '@tanstack/react-table';
 import { ColumnDef as ColumnDef$1 } from '@tanstack/table-core';
 import { SetRequired } from 'type-fest';
-import * as styled_components from 'styled-components';
-import { CellProps, TypographyProps as TypographyProps$1 } from '@equinor/eds-core-react';
+
+declare type FormMeta = {
+    _isNew?: boolean;
+    _editMode?: boolean;
+    _hasRemoteChange?: boolean;
+};
+declare type WithoutFormMeta<T extends FormMeta> = Omit<T, keyof FormMeta>;
+
+/**
+ * Subscribes to the `_editMode` field in a `react-hook-form` context.
+ *
+ * @returns edit mode value
+ */
+declare function useEditMode(): boolean;
+/**
+ * Subscribes to the `_hasRemoteChange` field in a `react-hook-form` context.
+ *
+ * @returns edit mode value
+ */
+declare function useHasRemoteChange(): boolean;
+/**
+ * @returns function getting is new meta
+ */
+declare function useGetIsNew(): () => boolean;
+declare function useSetFormMeta<T extends FormMeta>(): (newValues: Partial<T>) => void;
+declare function removeFormMeta<T extends FormMeta>(withFormMeta: T): Omit<T, keyof FormMeta>;
+declare function addFormMeta<T>(withoutFormMeta: T): T & FormMeta;
 
 interface AppShellProps {
     children?: ReactNode;
@@ -26,8 +55,18 @@ declare type TableCellProps<T> = {
     highlight?: boolean;
     getStickyCellColor?: (cell: Cell<T, unknown>) => string;
 };
+declare type StyledStickyCellProps = {
+    highlight?: boolean;
+    backgroundColor?: string;
+};
+declare const StyledStickyCell: styled_components.StyledComponent<react.ForwardRefExoticComponent<_equinor_eds_core_react.CellProps & react.RefAttributes<HTMLTableCellElement>>, any, ({} & _equinor_eds_core_react.CellProps) & StyledStickyCellProps, never>;
 declare function DynamicCell<T>({ cell, highlight, getStickyCellColor }: TableCellProps<T>): JSX.Element;
 
+interface HeaderCellProps<TData, TValue> {
+    header: Header<TData, TValue>;
+}
+declare const HeaderCell: <TData, TValue>({ header }: HeaderCellProps<TData, TValue>) => JSX.Element;
+
 declare type HierarchyCellOptions = {
     getRowDepth?: () => number;
     getDisplayName?: () => string;
@@ -168,11 +207,16 @@ declare function prependSelectColumn<T>(columns: ColumnDef<T>[], config?: DataTa
 
 declare function SelectColumnDef<T>(props: SetRequired<DataTableProps<T>, 'rowSelection'>['rowSelection']): ColumnDef$1<T, any>;
 
+declare const leftCellShadow: styled_components.FlattenSimpleInterpolation;
 declare const StickyCell: styled_components.StyledComponent<react.ForwardRefExoticComponent<CellProps & react.RefAttributes<HTMLTableCellElement>>, any, {} & CellProps, never>;
+declare const StickyHeaderCell: styled_components.StyledComponent<react.ForwardRefExoticComponent<CellProps & react.RefAttributes<HTMLTableCellElement>>, any, ({} & CellProps) & CellProps, never>;
 
-declare type TypographyProps = {
-    truncate?: boolean;
-} & TypographyProps$1;
-declare const TypographyCustom: (props: TypographyProps) => JSX.Element;
+/**
+ * Generate a HSL color based on a given string.
+ *
+ * @param str - Any given string
+ * @returns A valid hsl color
+ */
+declare function stringToHslColor(str: string, s?: number, l?: number): string;
 
-export { AppShell, AppSidebar, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableProps, DynamicCell, HTMLPropsRef, HierarchyCell, InfiniteScrollConfig, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, TypographyCustom, capitalizeHeader, prependSelectColumn };
+export { AppShell, AppSidebar, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableProps, DynamicCell, FormMeta, HTMLPropsRef, HeaderCell, HierarchyCell, InfiniteScrollConfig, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, StickyHeaderCell, StyledStickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, WithoutFormMeta, addFormMeta, capitalizeHeader, leftCellShadow, prependSelectColumn, removeFormMeta, stringToHslColor, useEditMode, useGetIsNew, useHasRemoteChange, useSetFormMeta };