@oc-digital/react-component-library 2.0.6 → 2.0.7-beta.1

package/build/EntityList/EntityList.types.d.ts

@@ -1,14 +1,14 @@
-import { ReactNode } from "react";
-export interface IEntity {
-    id: string;
-    name: string;
-    link: string;
-    [key: string]: any;
-}
-export interface IEntityListProps {
-    entities: IEntity[] | undefined;
-    icon: (entity?: IEntity) => ReactNode;
-    loadingMessage?: string;
-    emptyMessage?: string;
-    onClick?: (org: IEntity) => void;
-}
+import { ReactNode } from "react";
+export interface IEntity {
+    id: string;
+    name: string;
+    link: string;
+    [key: string]: any;
+}
+export interface IEntityListProps {
+    entities: IEntity[] | undefined;
+    icon: (entity?: IEntity) => ReactNode;
+    loadingMessage?: string;
+    emptyMessage?: string;
+    onClick?: (org: IEntity) => void;
+}

package/build/ErrorIndicator/ErrorIndicator.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IErrorIndicatorProps } from "./ErrorIndicator.types";
-declare const ErrorIndicator: React.FC<IErrorIndicatorProps>;
-export default ErrorIndicator;
+import React from "react";
+import { IErrorIndicatorProps } from "./ErrorIndicator.types";
+declare const ErrorIndicator: React.FC<IErrorIndicatorProps>;
+export default ErrorIndicator;

package/build/ErrorIndicator/ErrorIndicator.types.d.ts

@@ -1,4 +1,4 @@
-import { ReactNode } from "react";
-export interface IErrorIndicatorProps {
-    text?: ReactNode;
-}
+import { ReactNode } from "react";
+export interface IErrorIndicatorProps {
+    text?: ReactNode;
+}

package/build/ImageDisplayAndUpload/ImageDisplayAndUpload.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IImageDisplayAndUploadProps } from "./ImageDisplayAndUpload.types";
-declare const ImageDisplayAndUpload: React.FC<IImageDisplayAndUploadProps>;
-export default ImageDisplayAndUpload;
+import React from "react";
+import { IImageDisplayAndUploadProps } from "./ImageDisplayAndUpload.types";
+declare const ImageDisplayAndUpload: React.FC<IImageDisplayAndUploadProps>;
+export default ImageDisplayAndUpload;

package/build/ImageDisplayAndUpload/ImageDisplayAndUpload.types.d.ts

@@ -1,8 +1,8 @@
-import { IAuthoriserProp } from "../globals";
-export interface IImageDisplayAndUploadProps extends IAuthoriserProp {
-    id?: string;
-    url: string | null;
-    handleSaveImage: (format: string, buffer: ArrayBuffer, file: File) => Promise<void>;
-    roundedAvatar?: boolean;
-    alt?: string;
-}
+import { IAuthoriserProp } from "../globals";
+export interface IImageDisplayAndUploadProps extends IAuthoriserProp {
+    id?: string;
+    url: string | null;
+    handleSaveImage: (format: string, buffer: ArrayBuffer, file: File) => Promise<void>;
+    roundedAvatar?: boolean;
+    alt?: string;
+}

package/build/KeyboardDatePicker/KeyboardDatePicker.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IKeyboardDatePickerProps } from "./KeyboardDatePicker.types";
-declare const KeyboardDatePicker: React.FC<IKeyboardDatePickerProps>;
-export default KeyboardDatePicker;
+import React from "react";
+import { IKeyboardDatePickerProps } from "./KeyboardDatePicker.types";
+declare const KeyboardDatePicker: React.FC<IKeyboardDatePickerProps>;
+export default KeyboardDatePicker;

package/build/KeyboardDatePicker/KeyboardDatePicker.types.d.ts

@@ -1,5 +1,5 @@
-import { KeyboardDatePickerProps } from "@material-ui/pickers";
-import { IAuthoriserProp } from "../globals";
-export interface IKeyboardDatePickerProps extends IAuthoriserProp, KeyboardDatePickerProps {
-    styling?: string;
-}
+import { KeyboardDatePickerProps } from "@material-ui/pickers";
+import { IAuthoriserProp } from "../globals";
+export interface IKeyboardDatePickerProps extends IAuthoriserProp, KeyboardDatePickerProps {
+    styling?: string;
+}

package/build/LeftNavigation/LeftNavigation.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ILeftNavigationProps } from "./LeftNavigation.types";
-declare const LeftNavigation: React.FC<ILeftNavigationProps>;
-export default LeftNavigation;
+import React from "react";
+import { ILeftNavigationProps } from "./LeftNavigation.types";
+declare const LeftNavigation: React.FC<ILeftNavigationProps>;
+export default LeftNavigation;

package/build/LeftNavigation/LeftNavigation.types.d.ts

@@ -1,96 +1,96 @@
-import React, { ReactNode, ReactChild } from "react";
-import { ISvgComponentProps } from "../SvgComponents/types";
-export interface INavigationLink {
-    field: string;
-    path: string;
-    Icon: React.FC<ISvgComponentProps>;
-    hasSecondary?: boolean;
-}
-export type IExpandedOptions = {
-    view: string;
-    expanded: boolean;
-};
-export interface IMainNavigationItem {
-    id: string;
-    name: ReactChild;
-    route: string;
-    archived?: boolean;
-}
-export interface ISecondaryNavigationSubItem {
-    id: string;
-    name: ReactChild;
-    route: string;
-}
-export interface ISecondaryNavigationItem {
-    mainItem: IMainNavigationItem;
-    subItems?: ISecondaryNavigationSubItem[];
-    startDate: string;
-}
-export interface ISecondaryNavigationElement {
-    items: ISecondaryNavigationItem[];
-    archivedItems?: ISecondaryNavigationItem[];
-    button?: {
-        url: string;
-        text: string;
-    };
-}
-export interface ISecondaryNavigationElements {
-    [key: string]: ISecondaryNavigationElement;
-}
-export interface IPrimaryConfig {
-    background?: string;
-    text?: string;
-    activeText?: string;
-    moveLastItemToBottom?: boolean;
-    activeBorderColor?: string;
-}
-export interface ISecondaryMainConfig {
-    mainBackground?: string;
-    mainText?: string;
-    mainHover?: string;
-    mainIcon?: string;
-    mainActiveText?: string;
-}
-export interface ISecondarySubConfig {
-    subItemBackground?: string;
-    subItemText?: string;
-    subItemHover?: string;
-    subItemActiveBackground?: string;
-    subItemActiveHover?: string;
-    subItemActiveText?: string;
-}
-export interface ISideNavConfig {
-    rootRouteName: string;
-    primary?: IPrimaryConfig;
-    secondary?: {
-        mainItemColors?: ISecondaryMainConfig;
-        subItemColors?: ISecondarySubConfig;
-        closeButtonSvg?: ReactNode;
-        titleColor?: string;
-        titleIconColor?: string;
-    };
-}
-export interface ILeftNavigationProps {
-    primaryNavItems: INavigationLink[];
-    secondaryNavItems: ISecondaryNavigationElements;
-    config: ISideNavConfig;
-}
-export interface IListItemProps extends ISecondaryNavigationItem {
-    config: ISideNavConfig;
-    Icon: React.FC<ISvgComponentProps>;
-}
-export interface INavListItemStyleProps extends ISecondaryMainConfig, ISecondarySubConfig {
-}
-export interface IPrimaryLeftNavContainerProps {
-    expandedOptions: IExpandedOptions;
-    navigationLinks: INavigationLink[];
-    setExpandedOptions: React.Dispatch<React.SetStateAction<IExpandedOptions>>;
-    config: ISideNavConfig;
-}
-export interface ISecondaryLeftNavContainerProps {
-    secondaryNavItems: ISecondaryNavigationElements;
-    primaryNavItems: INavigationLink[];
-    expandedOptions: IExpandedOptions;
-    setExpandedOptions: React.Dispatch<React.SetStateAction<IExpandedOptions>>;
-    config: ISideNavConfig;
-}
+import React, { ReactNode, ReactChild } from "react";
+import { ISvgComponentProps } from "../SvgComponents/types";
+export interface INavigationLink {
+    field: string;
+    path: string;
+    Icon: React.FC<ISvgComponentProps>;
+    hasSecondary?: boolean;
+}
+export declare type IExpandedOptions = {
+    view: string;
+    expanded: boolean;
+};
+export interface IMainNavigationItem {
+    id: string;
+    name: ReactChild;
+    route: string;
+    archived?: boolean;
+}
+export interface ISecondaryNavigationSubItem {
+    id: string;
+    name: ReactChild;
+    route: string;
+}
+export interface ISecondaryNavigationItem {
+    mainItem: IMainNavigationItem;
+    subItems?: ISecondaryNavigationSubItem[];
+    startDate: string;
+}
+export interface ISecondaryNavigationElement {
+    items: ISecondaryNavigationItem[];
+    archivedItems?: ISecondaryNavigationItem[];
+    button?: {
+        url: string;
+        text: string;
+    };
+}
+export interface ISecondaryNavigationElements {
+    [key: string]: ISecondaryNavigationElement;
+}
+export interface IPrimaryConfig {
+    background?: string;
+    text?: string;
+    activeText?: string;
+    moveLastItemToBottom?: boolean;
+    activeBorderColor?: string;
+}
+export interface ISecondaryMainConfig {
+    mainBackground?: string;
+    mainText?: string;
+    mainHover?: string;
+    mainIcon?: string;
+    mainActiveText?: string;
+}
+export interface ISecondarySubConfig {
+    subItemBackground?: string;
+    subItemText?: string;
+    subItemHover?: string;
+    subItemActiveBackground?: string;
+    subItemActiveHover?: string;
+    subItemActiveText?: string;
+}
+export interface ISideNavConfig {
+    rootRouteName: string;
+    primary?: IPrimaryConfig;
+    secondary?: {
+        mainItemColors?: ISecondaryMainConfig;
+        subItemColors?: ISecondarySubConfig;
+        closeButtonSvg?: ReactNode;
+        titleColor?: string;
+        titleIconColor?: string;
+    };
+}
+export interface ILeftNavigationProps {
+    primaryNavItems: INavigationLink[];
+    secondaryNavItems: ISecondaryNavigationElements;
+    config: ISideNavConfig;
+}
+export interface IListItemProps extends ISecondaryNavigationItem {
+    config: ISideNavConfig;
+    Icon: React.FC<ISvgComponentProps>;
+}
+export interface INavListItemStyleProps extends ISecondaryMainConfig, ISecondarySubConfig {
+}
+export interface IPrimaryLeftNavContainerProps {
+    expandedOptions: IExpandedOptions;
+    navigationLinks: INavigationLink[];
+    setExpandedOptions: React.Dispatch<React.SetStateAction<IExpandedOptions>>;
+    config: ISideNavConfig;
+}
+export interface ISecondaryLeftNavContainerProps {
+    secondaryNavItems: ISecondaryNavigationElements;
+    primaryNavItems: INavigationLink[];
+    expandedOptions: IExpandedOptions;
+    setExpandedOptions: React.Dispatch<React.SetStateAction<IExpandedOptions>>;
+    config: ISideNavConfig;
+}

package/build/LeftNavigation/NavListItem.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IListItemProps } from "./LeftNavigation.types";
-declare const NavListItem: React.FC<IListItemProps>;
-export default NavListItem;
+import React from "react";
+import { IListItemProps } from "./LeftNavigation.types";
+declare const NavListItem: React.FC<IListItemProps>;
+export default NavListItem;

package/build/LeftNavigation/PrimaryLeftNavigation.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IPrimaryLeftNavContainerProps } from "./LeftNavigation.types";
-declare const PrimaryLeftNavContainer: React.FC<IPrimaryLeftNavContainerProps>;
-export default PrimaryLeftNavContainer;
+import React from "react";
+import { IPrimaryLeftNavContainerProps } from "./LeftNavigation.types";
+declare const PrimaryLeftNavContainer: React.FC<IPrimaryLeftNavContainerProps>;
+export default PrimaryLeftNavContainer;

package/build/LeftNavigation/SecondaryLeftNavigation.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISecondaryLeftNavContainerProps } from "./LeftNavigation.types";
-declare const SecondaryLeftNavContainer: React.FC<ISecondaryLeftNavContainerProps>;
-export default SecondaryLeftNavContainer;
+import React from "react";
+import { ISecondaryLeftNavContainerProps } from "./LeftNavigation.types";
+declare const SecondaryLeftNavContainer: React.FC<ISecondaryLeftNavContainerProps>;
+export default SecondaryLeftNavContainer;

package/build/LoadingSpinner/LoadingSpinner.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ILoadingSpinnerProps } from "./LoadingSpinner.types";
-declare const LoadingSpinner: React.FC<ILoadingSpinnerProps>;
-export default LoadingSpinner;
+import React from "react";
+import { ILoadingSpinnerProps } from "./LoadingSpinner.types";
+declare const LoadingSpinner: React.FC<ILoadingSpinnerProps>;
+export default LoadingSpinner;

package/build/LoadingSpinner/LoadingSpinner.types.d.ts

@@ -1,5 +1,5 @@
-import { ReactNode } from "react";
-export interface ILoadingSpinnerProps {
-    text?: ReactNode;
-    styling?: string;
-}
+import { ReactNode } from "react";
+export interface ILoadingSpinnerProps {
+    text?: ReactNode;
+    styling?: string;
+}

package/build/MainLayout/MainLayout.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IMainLayoutProps } from "./MainLayout.types";
-declare const MainLayout: React.FC<IMainLayoutProps>;
-export default MainLayout;
+import React from "react";
+import { IMainLayoutProps } from "./MainLayout.types";
+declare const MainLayout: React.FC<IMainLayoutProps>;
+export default MainLayout;

package/build/MainLayout/MainLayout.types.d.ts

@@ -1,9 +1,9 @@
-import { ReactElement } from "react";
-export interface IMainLayoutProps {
-    sideNavigation?: ReactElement;
-    desktopWidth?: boolean;
-    children: ReactElement;
-    topOffset?: number | string;
-}
-export interface IMainLayoutStyleProps extends Pick<IMainLayoutProps, "topOffset"> {
-}
+import { ReactElement } from "react";
+export interface IMainLayoutProps {
+    sideNavigation?: ReactElement;
+    desktopWidth?: boolean;
+    children: ReactElement;
+    topOffset?: number | string;
+}
+export interface IMainLayoutStyleProps extends Pick<IMainLayoutProps, "topOffset"> {
+}

package/build/SearchBar/SearchBar.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISearchBarProps } from "./SearchBar.types";
-declare const SearchBar: React.FC<ISearchBarProps>;
-export default SearchBar;
+import React from "react";
+import { ISearchBarProps } from "./SearchBar.types";
+declare const SearchBar: React.FC<ISearchBarProps>;
+export default SearchBar;

package/build/SearchBar/SearchBar.types.d.ts

@@ -1,23 +1,23 @@
-/// <reference types="react" />
-export interface ISearchBarProps {
-    array: any[] | undefined | null;
-    sortFn?: (arg1: any, arg2: any) => number;
-    sortKey?: string;
-    loading?: boolean;
-    buttonClick?: (item?: any) => void;
-    linkTo?: (item?: any) => string;
-    ItemTemplate: React.FC<{
-        item: any;
-    }>;
-    arrayKey?: string;
-    loadingMessage?: string;
-    emptyMessage?: string;
-    inputBackgroundColor?: string;
-    placeholder?: string;
-    disabledSearch?: boolean;
-    delay?: number;
-    minQueryLength?: number;
-    handleOnChange?: (query: string) => void;
-    searchKeys?: string[];
-    alphabetisedHeader?: boolean;
-}
+/// <reference types="react" />
+export interface ISearchBarProps {
+    array: any[] | undefined | null;
+    sortFn?: (arg1: any, arg2: any) => number;
+    sortKey?: string;
+    loading?: boolean;
+    buttonClick?: (item?: any) => void;
+    linkTo?: (item?: any) => string;
+    ItemTemplate: React.FC<{
+        item: any;
+    }>;
+    arrayKey?: string;
+    loadingMessage?: string;
+    emptyMessage?: string;
+    inputBackgroundColor?: string;
+    placeholder?: string;
+    disabledSearch?: boolean;
+    delay?: number;
+    minQueryLength?: number;
+    handleOnChange?: (query: string) => void;
+    searchKeys?: string[];
+    alphabetisedHeader?: boolean;
+}

package/build/Select/Select.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISelectProps } from "./Select.types";
-declare const Select: React.FC<ISelectProps>;
-export default Select;
+import React from "react";
+import { ISelectProps } from "./Select.types";
+declare const Select: React.FC<ISelectProps>;
+export default Select;

package/build/Select/Select.types.d.ts

@@ -1,14 +1,14 @@
-import { OutlinedTextFieldProps } from "@material-ui/core";
-import { IAuthoriserProp } from "../globals";
-export interface IStyleProps {
-    background: string;
-    size: "small" | "medium";
-}
-export interface ISelectProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
-    selectOptions: {
-        value: string | number;
-        description: string;
-    }[];
-    styling?: string;
-    background?: string;
-}
+import { OutlinedTextFieldProps } from "@material-ui/core";
+import { IAuthoriserProp } from "../globals";
+export interface IStyleProps {
+    background: string;
+    size: "small" | "medium";
+}
+export interface ISelectProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
+    selectOptions: {
+        value: string | number;
+        description: string;
+    }[];
+    styling?: string;
+    background?: string;
+}

package/build/StaticTable/StaticTable.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { IStaticTableProps } from "./StaticTable.types";
-declare const StaticTable: React.FC<IStaticTableProps>;
-export default StaticTable;
+import React from "react";
+import { IStaticTableProps } from "./StaticTable.types";
+declare const StaticTable: React.FC<IStaticTableProps>;
+export default StaticTable;

package/build/StaticTable/StaticTable.types.d.ts

@@ -1,21 +1,21 @@
-/// <reference types="react" />
-export type cellAlignmentOptions = "centerJustify" | "leftJustify" | "rightJustify";
-export type headerColours = {
-    background?: string;
-    border?: string;
-    text?: string;
-};
-export interface IStaticTableProps {
-    headers?: React.ReactNode[];
-    headerCellAlignment?: cellAlignmentOptions[];
-    rows: {
-        onClick?: () => void;
-        row: React.ReactNode[];
-    }[] | null | undefined;
-    rowCellAlignment?: cellAlignmentOptions[];
-    rowBorderSeparation?: boolean;
-    styling?: string;
-    headerColours?: headerColours;
-    paginate?: boolean;
-    itemsPerPage?: number;
-}
+/// <reference types="react" />
+export declare type cellAlignmentOptions = "centerJustify" | "leftJustify" | "rightJustify";
+export declare type headerColours = {
+    background?: string;
+    border?: string;
+    text?: string;
+};
+export interface IStaticTableProps {
+    headers?: React.ReactNode[];
+    headerCellAlignment?: cellAlignmentOptions[];
+    rows: {
+        onClick?: () => void;
+        row: React.ReactNode[];
+    }[] | null | undefined;
+    rowCellAlignment?: cellAlignmentOptions[];
+    rowBorderSeparation?: boolean;
+    styling?: string;
+    headerColours?: headerColours;
+    paginate?: boolean;
+    itemsPerPage?: number;
+}

package/build/SvgComponents/ContainedPartnersLogo.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISvgComponentProps } from "./types";
-declare const ContainedPartnersLogo: React.FC<ISvgComponentProps>;
-export default ContainedPartnersLogo;
+import React from "react";
+import { ISvgComponentProps } from "./types";
+declare const ContainedPartnersLogo: React.FC<ISvgComponentProps>;
+export default ContainedPartnersLogo;

package/build/SvgComponents/HomeSvg.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISvgComponentProps } from "./types";
-declare const HomeSvg: React.FC<ISvgComponentProps>;
-export default HomeSvg;
+import React from "react";
+import { ISvgComponentProps } from "./types";
+declare const HomeSvg: React.FC<ISvgComponentProps>;
+export default HomeSvg;

package/build/SvgComponents/NovelLogoSvg.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISvgComponentProps } from "./types";
-declare const NovelLogoSvg: React.FC<ISvgComponentProps>;
-export default NovelLogoSvg;
+import React from "react";
+import { ISvgComponentProps } from "./types";
+declare const NovelLogoSvg: React.FC<ISvgComponentProps>;
+export default NovelLogoSvg;

package/build/SvgComponents/OrganisationList.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISvgComponentProps } from "./types";
-declare const OrganisationList: React.FC<ISvgComponentProps>;
-export default OrganisationList;
+import React from "react";
+import { ISvgComponentProps } from "./types";
+declare const OrganisationList: React.FC<ISvgComponentProps>;
+export default OrganisationList;

package/build/SvgComponents/ProjectsSvg.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { ISvgComponentProps } from "./types";
-declare const ProjectsSvg: React.FC<ISvgComponentProps>;
-export default ProjectsSvg;
+import React from "react";
+import { ISvgComponentProps } from "./types";
+declare const ProjectsSvg: React.FC<ISvgComponentProps>;
+export default ProjectsSvg;

package/build/SvgComponents/index.d.ts

@@ -1,5 +1,5 @@
-export { default as NovelLogoSvg } from "./NovelLogoSvg";
-export { default as ContainedPartnersLogo } from "./ContainedPartnersLogo";
-export { default as OrganisationList } from "./OrganisationList";
-export { default as HomeSvg } from "./HomeSvg";
-export { default as ProjectsSvg } from "./ProjectsSvg";
+export { default as NovelLogoSvg } from "./NovelLogoSvg";
+export { default as ContainedPartnersLogo } from "./ContainedPartnersLogo";
+export { default as OrganisationList } from "./OrganisationList";
+export { default as HomeSvg } from "./HomeSvg";
+export { default as ProjectsSvg } from "./ProjectsSvg";

package/build/SvgComponents/types.d.ts

@@ -1,6 +1,6 @@
-export interface ISvgComponentProps {
-    color?: string;
-    styling?: string;
-    fontSize?: "small" | "medium" | "large" | "inherit";
-    id?: string;
-}
+export interface ISvgComponentProps {
+    color?: string;
+    styling?: string;
+    fontSize?: "small" | "medium" | "large" | "inherit";
+    id?: string;
+}

package/build/TextField/TextField.d.ts

@@ -1,15 +1,16 @@
-import React from "react";
-import { NumberFormatProps } from "react-number-format";
-import { ITextFieldProps } from "./TextField.types";
-declare const TextField: React.FC<ITextFieldProps>;
-export default TextField;
-interface INumberFormatProps extends Omit<NumberFormatProps, "onChange"> {
-    onChange: (event: {
-        target: {
-            name: string;
-            value: string;
-        };
-    }) => void;
-    fixedDecimalScale: boolean;
-}
-export declare const NumberFormatField: (props: INumberFormatProps) => JSX.Element;
+import React from "react";
+import NumberFormat, { NumberFormatProps } from "react-number-format";
+import { ITextFieldProps } from "./TextField.types";
+declare const TextField: React.FC<ITextFieldProps>;
+export default TextField;
+interface INumberFormatProps extends Omit<NumberFormatProps, "onChange"> {
+    onChange: (event: {
+        target: {
+            name: string;
+            value: string;
+        };
+    }) => void;
+    inputRef: (instance: NumberFormat | null) => void;
+    fixedDecimalScale: boolean;
+}
+export declare const NumberFormatField: (props: INumberFormatProps) => JSX.Element;