@equinor/apollo-components 2.0.0 → 3.1.0

package/dist/index.d.ts

@@ -1,11 +1,14 @@
 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 { ColumnDef as ColumnDef$1 } from '@tanstack/table-core';
-import { SetRequired } from 'type-fest';
+import { ReactNode, ReactElement, HTMLProps, MutableRefObject, Dispatch, SetStateAction, SyntheticEvent } from 'react';
 import * as styled_components from 'styled-components';
+import * as _equinor_eds_core_react from '@equinor/eds-core-react';
 import { CellProps, TypographyProps as TypographyProps$1 } from '@equinor/eds-core-react';
+import { Cell, CellContext, Header, 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 { Variants } from '@equinor/eds-core-react/dist/types/components/types';
+import { FieldError } from 'react-hook-form';
 
 interface AppShellProps {
     children?: ReactNode;
@@ -26,14 +29,108 @@ 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;
 
+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;
+
+declare function EditableCheckboxCell<T extends FormMeta>(context: CellContext<T, boolean>): JSX.Element;
+
+interface EditableDateCellProps<T extends FormMeta> extends CellContext<T, unknown> {
+    dateStringFormatter?: (date: string) => string;
+}
+declare function EditableDateCell<T extends FormMeta>(props: EditableDateCellProps<T>): JSX.Element;
+
+interface Option {
+    label: string;
+    value: string;
+}
+interface EditableDropdownCellProps<T extends FormMeta> extends CellContext<T, unknown> {
+    /**
+     * `Option.value` is used internally to get and update selection state. `Option.label` is *only* for visual purposes.
+     */
+    options: Option[];
+}
+declare function EditableDropdownCell<T extends FormMeta>(props: EditableDropdownCellProps<T>): JSX.Element;
+declare const AutocompleteCustom: styled_components.StyledComponent<(<T>(props: {
+    options: T[];
+    label: string;
+    initialSelectedOptions?: T[] | undefined;
+    meta?: string | undefined;
+    disabled?: boolean | undefined;
+    readOnly?: boolean | undefined;
+    hideClearButton?: boolean | undefined;
+    selectedOptions?: T[] | undefined;
+    onOptionsChange?: ((changes: _equinor_eds_core_react.AutocompleteChanges<T>) => void) | undefined;
+    multiple?: boolean | undefined;
+    optionLabel?: ((option: T) => string) | undefined;
+    disablePortal?: boolean | undefined;
+    optionDisabled?: ((option: T) => boolean) | undefined;
+    optionsFilter?: ((option: T, inputValue: string) => boolean) | undefined;
+    autoWidth?: boolean | undefined;
+    placeholder?: string | undefined;
+    clearSearchOnChange?: boolean | undefined;
+} & react.HTMLAttributes<HTMLDivElement> & {
+    ref?: react.ForwardedRef<HTMLDivElement> | undefined;
+    displayName?: string | undefined;
+}) => JSX.Element), any, {}, never>;
+
+declare function EditableNumberCell<T extends FormMeta>(context: CellContext<T, number>): JSX.Element;
+
+interface EdtiableTextAreaProps<T extends FormMeta> extends CellContext<T, string> {
+    dialogTitle: string;
+}
+declare function EditableTextAreaCell<T extends FormMeta>(props: EdtiableTextAreaProps<T>): JSX.Element;
+
+declare function EditableTextFieldCell<T extends FormMeta>(context: CellContext<T, unknown>): 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;
 };
 declare function HierarchyCell<T>(cell: CellContext<T, any>, options?: HierarchyCellOptions): JSX.Element;
 
+interface PopoverCellProps {
+    id: string;
+    value: string;
+    title?: string | JSX.Element | ReactNode;
+}
+declare const PopoverCell: (props: PopoverCellProps) => JSX.Element;
+
 interface ColumnSelectProps<T> {
     table: Table<T>;
 }
@@ -45,18 +142,6 @@ interface TableHeaderProps<T> {
 }
 declare function TableHeader<T>({ table, sticky }: TableHeaderProps<T>): JSX.Element;
 
-interface HeaderConfig {
-    sticky?: boolean;
-}
-interface FilterConfig {
-    enableTableCaption?: boolean;
-    totalRowCount?: number;
-    columnSelect?: boolean;
-    globalFilter?: boolean;
-    globalFilterPlaceholder?: string;
-    filterFromLeafRows?: boolean;
-    customActions?: <T>(table: Table<T>) => ReactNode;
-}
 interface TableRowWrapper<T> {
     (props: TableRowWrapperProps<T>): ReactElement;
 }
@@ -109,10 +194,10 @@ interface DataTableProps<T> {
     columns: ColumnDef<T, any>[];
     cellConfig?: CellConfig<T>;
     rowConfig?: RowConfig<T>;
-    headerConfig?: HeaderConfig;
     isLoading?: boolean;
     height?: string;
     width?: string;
+    stickyHeader?: boolean;
     /**
      * Defaults to `'auto'`.
      *
@@ -139,7 +224,10 @@ interface DataTableProps<T> {
     };
     globalFilter?: ControlledState<string>;
     columnVisibility?: ControlledState<VisibilityState>;
-    actionsRow?: {
+    /**
+     * Everything that has todo with the area (banner) over the table
+     */
+    bannerConfig?: {
         enableTableCaption?: boolean;
         totalRowCount?: number;
         enableColumnSelect?: boolean;
@@ -147,6 +235,11 @@ interface DataTableProps<T> {
         globalFilterPlaceholder?: string;
         filterFromLeafRows?: boolean;
         customActions?: <T>(table: Table<T>) => ReactNode;
+        /**
+         * Default 1rem
+         * Accepts any CSS padding value
+         */
+        padding?: string;
     };
     tableContainerProps?: HTMLPropsRef<HTMLDivElement>;
     infiniteScroll?: InfiniteScrollConfig;
@@ -172,11 +265,36 @@ 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;
 
-export { AppShell, AppSidebar, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableProps, DynamicCell, FilterConfig, HTMLPropsRef, HeaderConfig, HierarchyCell, InfiniteScrollConfig, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, TypographyCustom, capitalizeHeader, prependSelectColumn };
+/**
+ * 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;
+/** Wrap an event handler and stop event propagation */
+declare function stopPropagation<T extends HTMLElement>(handler: (e: SyntheticEvent<T>) => void): (e: SyntheticEvent<T>) => void;
+interface GetHelperTextPropsProps {
+    error?: FieldError;
+    warning?: {
+        message: string;
+    };
+    helperText?: string;
+}
+interface GetHelperTextProps {
+    variant?: Variants;
+    helperText?: string;
+    helperIcon: JSX.Element | null;
+}
+declare function getHelperTextProps({ error, warning, helperText, }: GetHelperTextPropsProps): GetHelperTextProps;
+
+export { AppShell, AppSidebar, AutocompleteCustom, CellConfig, ChipsCell, ColumnSelect, DataTable, DataTableProps, DynamicCell, EditableCheckboxCell, EditableDateCell, EditableDateCellProps, EditableDropdownCell, EditableDropdownCellProps, EditableNumberCell, EditableTextAreaCell, EditableTextFieldCell, FormMeta, HTMLPropsRef, HeaderCell, HierarchyCell, InfiniteScrollConfig, Option, PopoverCell, RowConfig, RowSelectionMode, SelectColumnDef, SortConfig, StickyCell, StickyHeaderCell, StyledStickyCell, TableHeader, TableLayout, TableRowWrapper, TableRowWrapperProps, TruncateMode, TypographyCustom, TypographyProps, WithoutFormMeta, addFormMeta, capitalizeHeader, getHelperTextProps, leftCellShadow, prependSelectColumn, removeFormMeta, stopPropagation, stringToHslColor, useEditMode, useGetIsNew, useHasRemoteChange, useSetFormMeta };