@elliemae/ds-global-header 2.3.0-alpha.8 → 2.3.0-alpha.9

package/dist/types/GlobalHeader.d.ts

@@ -0,0 +1,39 @@
+/// <reference path="../../../../shared/typings/react-desc.d.ts" />
+/// <reference types="react" />
+import type { GlobalHeaderPropsT as Props } from './GlobalHeaderTypes';
+declare const GlobalHeader: {
+    (props: Props): JSX.Element;
+    defaultProps: Props;
+    propTypes: {
+        Logo: {
+            defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+                deprecated: import("react-desc").PropTypesDescValidator;
+            };
+            isRequired: import("react-desc").PropTypesDescValue;
+        };
+        LogoWithBrand: {
+            defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+                deprecated: import("react-desc").PropTypesDescValidator;
+            };
+            isRequired: import("react-desc").PropTypesDescValue;
+        };
+        breadcrumb: {
+            defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+                deprecated: import("react-desc").PropTypesDescValidator;
+            };
+            isRequired: import("react-desc").PropTypesDescValue;
+        };
+        toolbar: {
+            defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+                deprecated: import("react-desc").PropTypesDescValidator;
+            };
+            isRequired: import("react-desc").PropTypesDescValue;
+        };
+    };
+};
+declare const GlobalHeaderWithSchema: {
+    (props?: unknown): JSX.Element;
+    propTypes: unknown;
+    toTypescript: () => import("react-desc").TypescriptSchema;
+};
+export { GlobalHeader, GlobalHeaderWithSchema };

package/dist/types/GlobalHeaderContainer.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { GlobalHeaderContainerT } from './GlobalHeaderTypes';
+export declare const GlobalHeaderContainer: ({ children }: GlobalHeaderContainerT) => JSX.Element;

package/dist/types/GlobalHeaderContext.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { ContextT } from './GlobalHeaderTypes';
+export declare const GlobalHeaderContext: import("react").Context<ContextT>;

package/dist/types/GlobalHeaderTypes.d.ts

@@ -0,0 +1,85 @@
+import React from 'react';
+import { DSAppPicker } from '@elliemae/ds-app-picker';
+export declare type AppPickerProps = React.ComponentProps<typeof DSAppPicker>;
+export interface ContextT {
+    showIconOnly: boolean;
+    setShowIconOnly: React.Dispatch<React.SetStateAction<boolean>>;
+    instanceUID: string;
+    globalHeaderToolbarGrid: string[];
+    globalHeaderBreadcrumbGrid: string[];
+    props: GlobalHeaderPropsT;
+}
+export interface GlobalHeaderContainerT {
+    children: React.ReactNode;
+}
+export interface GlobalHeaderPropsT {
+    Logo?: React.ComponentType;
+    LogoWithBrand?: React.ComponentType;
+    breadcrumb?: BreadcrumbItemT[];
+    toolbar?: ToolbarItemT[];
+    appPickerProps?: AppPickerProps;
+}
+export interface BreadcrumbItemT {
+    label: string;
+    hasNext?: boolean;
+    isSelected?: boolean;
+    onClick?: (event: React.MouseEvent<HTMLElement>) => void;
+    length: number;
+}
+export interface ToolbarItemT {
+    type?: 'ds-app-picker' | 'ds-popup-menu' | 'ds-search-toggle' | 'custom';
+    label: string;
+    Icon: React.ComponentType<Record<string, unknown>>;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    componentProps?: PopupPropsT | AppPickerProps | SearchTogglePropsT;
+    CustomComponent?: React.ComponentType<{
+        item: ToolbarItemT;
+    }>;
+}
+export interface PopupPropsT {
+    Icon?: React.ComponentType<Record<string, unknown>>;
+    options: PopupMenuItemT[];
+    closeOnClick?: boolean;
+    title?: string;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+}
+export interface AppPickerMenuItemT {
+    label: string;
+    icon: React.ComponentType;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    disabled?: boolean;
+}
+export interface PopupMenuItemT extends Record<string, unknown> {
+    type?: string;
+    Icon?: React.ComponentType;
+    label?: string;
+    onClick?: (event: React.MouseEvent<HTMLElement>) => void;
+    closeOnClick?: boolean;
+    Content?: React.ComponentType;
+}
+export interface PopupMenuContentPropsT {
+    options: PopupMenuItemT[];
+    onItemClick: (event: React.MouseEvent<HTMLElement>) => void;
+    onClose: () => void;
+}
+export interface PipeT {
+    showIconOnly: boolean;
+}
+export interface LabelT {
+    isSelected: boolean;
+    isOnlyItem: boolean;
+}
+export interface SearchTogglePropsT {
+    onNext: () => void;
+    onPrevious: () => void;
+    currentResultIndex: number;
+    totalResults: number;
+    placeholder: string;
+    value: string;
+    onChange: () => void;
+    onBlur: () => void;
+    onClear: () => void;
+    isOpen: boolean;
+    onKeyDown: (e: React.KeyboardEvent) => void;
+    onClick: (e: React.MouseEvent) => void;
+}

package/dist/types/components/Breadcrumb/GlobalHeaderBreadcrumb.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const GlobalHeaderBreadcrumb: () => JSX.Element;

package/dist/types/components/Breadcrumb/PureBreadcrumb.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { BreadcrumbItemT as Props } from '../../GlobalHeaderTypes';
+export declare const PureBreadcrumb: React.MemoExoticComponent<({ onClick, isSelected, length, label, hasNext, id, ...rest }: Props) => JSX.Element>;

package/dist/types/components/Breadcrumb/styles.d.ts

@@ -0,0 +1,5 @@
+import type { LabelT, PipeT } from '../../GlobalHeaderTypes';
+export declare const Pipe: import("styled-components").StyledComponent<"span", import("styled-components").DefaultTheme, PipeT, never>;
+export declare const BreadcrumbItem: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const LabelButton: import("styled-components").StyledComponent<"button", import("styled-components").DefaultTheme, {}, never>;
+export declare const Label: import("styled-components").StyledComponent<"p", import("styled-components").DefaultTheme, LabelT, never>;

package/dist/types/components/Title/GlobalHeaderTitle.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const GlobalHeaderTitle: () => JSX.Element;

package/dist/types/components/Toolbar/GlobalHeaderToolbar.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const GlobalHeaderToolbar: () => JSX.Element;

package/dist/types/components/Toolbar/ToolbarItems.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const ToolbarItems: () => JSX.Element;

package/dist/types/components/Toolbar/styles.d.ts

@@ -0,0 +1 @@
+export declare const Button: import("styled-components").StyledComponent<"button", import("styled-components").DefaultTheme, {}, never>;

package/dist/types/config/useGetPropsWithDefaults.d.ts

@@ -0,0 +1,2 @@
+import type { GlobalHeaderPropsT } from '../GlobalHeaderTypes';
+export declare const useGetPropsWithDefaults: (props: GlobalHeaderPropsT) => GlobalHeaderPropsT;

package/dist/types/config/useGlobalHeader.d.ts

@@ -0,0 +1,2 @@
+import type { ContextT, GlobalHeaderPropsT } from '../GlobalHeaderTypes';
+export declare const useGlobalHeader: (props: GlobalHeaderPropsT) => ContextT;

package/dist/types/config/useValidateProps.d.ts

@@ -0,0 +1,2 @@
+import { GlobalHeaderPropsT } from '../GlobalHeaderTypes';
+export declare const useValidateProps: (props: GlobalHeaderPropsT) => void;

package/dist/types/config/validateHelpers.d.ts

@@ -0,0 +1,27 @@
+export declare const breadcrumbProps: {
+    label: string;
+    onClick: string;
+    hasNext: string;
+    isSelected: string;
+};
+export declare const toolbarProps: {
+    label: string;
+    type: string;
+    componentProps: string;
+    Icon: string;
+    onClick: string;
+    options: string;
+    closeOnClick: string;
+    apps: string;
+    customApps: string;
+    sectionTitle: string;
+    customSectionTitle: string;
+};
+export declare const isObject: (obj: unknown) => boolean;
+export declare const getVariableType: (arg: unknown) => string;
+export declare const isValidToolbarType: (string: unknown) => boolean;
+export declare const throwBreadcrumbItemError: (validPropKey: keyof typeof breadcrumbProps, invalidProp: unknown) => void;
+export declare const throwToolbarPopupItemError: (validPropKey: keyof typeof toolbarProps, invalidProp: unknown) => void;
+export declare const throwToolbarAppPickerItemError: (validPropKey: keyof typeof toolbarProps, invalidProp: unknown) => void;
+export declare const throwToolbarItemGenericError: (validPropKey: keyof typeof toolbarProps, invalidProp: unknown) => void;
+export declare const throwLogoError: (validPropKey: string, invalidProp: unknown) => void;

package/dist/types/defaultProps.d.ts

@@ -0,0 +1,2 @@
+import type { GlobalHeaderPropsT } from './GlobalHeaderTypes';
+export declare const defaultProps: GlobalHeaderPropsT;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './GlobalHeader';
+export { GlobalHeader as default } from './GlobalHeader';

package/dist/types/outOfTheBox/AppPicker/AppPicker.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { DSAppPicker } from '@elliemae/ds-app-picker';
+declare type AppPickerProps = React.ComponentProps<typeof DSAppPicker>;
+export declare const AppPicker: ({ label, id, componentProps, ...otherProps }: AppPickerProps & {
+    label: string;
+    triggerOnClick?: React.MouseEventHandler<Element> | undefined;
+}) => JSX.Element;
+export {};

package/dist/types/outOfTheBox/PopupMenu/PopupMenu.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import type { PopupPropsT as Props } from '../../GlobalHeaderTypes';
+export declare const PopupMenu: ({ Icon, title, onClick, id, componentProps, ...otherProps }: Props) => JSX.Element;

package/dist/types/outOfTheBox/PopupMenu/PopupMenuContent.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+import type { PopupMenuContentPropsT as Props } from '../../GlobalHeaderTypes';
+export declare const PopupMenuContent: React.MemoExoticComponent<({ options, onItemClick, onClose, popupOnKeyPress }: Props) => JSX.Element>;

package/dist/types/outOfTheBox/PopupMenu/styles.d.ts

@@ -0,0 +1,4 @@
+export declare const List: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const ItemWrapper: import("styled-components").StyledComponent<"button", import("styled-components").DefaultTheme, {}, never>;
+export declare const Label: import("styled-components").StyledComponent<"p", import("styled-components").DefaultTheme, {}, never>;
+export declare const Separator: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/dist/types/outOfTheBox/SearchToggle/SearchToggle.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const SearchToggle: ({ id, componentProps, ...otherProps }: SearchTogglePropsT) => JSX.Element;

package/dist/types/outOfTheBox/SearchToggle/styles.d.ts

@@ -0,0 +1 @@
+export declare const StyledNavSearchBoxContainer: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;

package/dist/types/outOfTheBox/index.d.ts

@@ -0,0 +1,3 @@
+export * from './AppPicker/AppPicker';
+export * from './PopupMenu/PopupMenu';
+export * from './SearchToggle/SearchToggle';

package/dist/types/propTypes.d.ts

@@ -0,0 +1,29 @@
+/// <reference path="../../../../shared/typings/react-desc.d.ts" />
+export declare const breadcrumbItem: import("react-desc").PropTypesDescValue;
+export declare const toolbarItem: import("react-desc").PropTypesDescValue;
+export declare const globalHeaderProps: {
+    Logo: {
+        defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+            deprecated: import("react-desc").PropTypesDescValidator;
+        };
+        isRequired: import("react-desc").PropTypesDescValue;
+    };
+    LogoWithBrand: {
+        defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+            deprecated: import("react-desc").PropTypesDescValidator;
+        };
+        isRequired: import("react-desc").PropTypesDescValue;
+    };
+    breadcrumb: {
+        defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+            deprecated: import("react-desc").PropTypesDescValidator;
+        };
+        isRequired: import("react-desc").PropTypesDescValue;
+    };
+    toolbar: {
+        defaultValue(arg: import("react-desc").ReactDescPossibleDefaultValues): {
+            deprecated: import("react-desc").PropTypesDescValidator;
+        };
+        isRequired: import("react-desc").PropTypesDescValue;
+    };
+};

package/dist/types/styles.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const Wrapper: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@elliemae/ds-grid/dist/types/types").GridPropsT & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {}, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/ds-global-header",
-  "version": "2.3.0-alpha.8",
+  "version": "2.3.0-alpha.9",
   "license": "MIT",
   "description": "ICE MT - Dimsum - Global Header",
   "files": [
@@ -129,14 +129,14 @@
   },
   "author": "ICE MT",
   "dependencies": {
-    "@elliemae/ds-app-picker": "2.3.0-alpha.8",
-    "@elliemae/ds-form": "2.3.0-alpha.8",
-    "@elliemae/ds-grid": "2.3.0-alpha.8",
-    "@elliemae/ds-icon": "2.3.0-alpha.8",
-    "@elliemae/ds-icons": "2.3.0-alpha.8",
-    "@elliemae/ds-popperjs": "2.3.0-alpha.8",
-    "@elliemae/ds-props-helpers": "2.3.0-alpha.8",
-    "@elliemae/ds-utilities": "2.3.0-alpha.8",
+    "@elliemae/ds-app-picker": "2.3.0-alpha.9",
+    "@elliemae/ds-form": "2.3.0-alpha.9",
+    "@elliemae/ds-grid": "2.3.0-alpha.9",
+    "@elliemae/ds-icon": "2.3.0-alpha.9",
+    "@elliemae/ds-icons": "2.3.0-alpha.9",
+    "@elliemae/ds-popperjs": "2.3.0-alpha.9",
+    "@elliemae/ds-props-helpers": "2.3.0-alpha.9",
+    "@elliemae/ds-utilities": "2.3.0-alpha.9",
     "react-desc": "~4.1.3",
     "uid": "~2.0.0"
   },