@oc-digital/react-component-library 7.2.3-beta.0 → 7.2.3-beta.10

package/build/MobileDatePicker/MobileDatePicker.types.d.ts

@@ -0,0 +1,6 @@
+import { MobileDatePickerProps } from '@mui/x-date-pickers/MobileDatePicker';
+import { IAuthoriserProp } from '../globals';
+
+export type IMobileDatePickerProps = MobileDatePickerProps<Date> & IAuthoriserProp & {
+    styling?: string;
+};

package/build/NavbarLayout/Navbar.d.ts

@@ -0,0 +1,13 @@
+import { FC } from 'react';
+import { ISvgComponentProps } from '../SvgComponents/types';
+
+export type NavbarProps = {
+    tabs: Array<{
+        Icon: FC<ISvgComponentProps>;
+        field: string;
+        path: string;
+        separate?: boolean;
+    }>;
+};
+declare const Navbar: ({ tabs }: NavbarProps) => JSX.Element;
+export default Navbar;

package/build/NavbarLayout/NavbarLayout.d.ts

@@ -0,0 +1,17 @@
+import { default as React, FC } from 'react';
+import { ISvgComponentProps } from '../SvgComponents/types';
+
+export type NavbarLayoutTabs = Array<{
+    Icon: FC<ISvgComponentProps>;
+    field: string;
+    path: string;
+    separate?: boolean;
+}>;
+export type NavbarLayoutProps = {
+    tabs: NavbarLayoutTabs;
+    hideTabs?: boolean;
+    leaveHeightForMenu?: boolean;
+    children: React.ReactNode;
+};
+declare const NavbarLayout: ({ tabs, hideTabs, leaveHeightForMenu, children, }: NavbarLayoutProps) => JSX.Element;
+export default NavbarLayout;

package/build/NavbarLayout/index.d.ts

@@ -0,0 +1,2 @@
+export { default as NavbarLayout } from './NavbarLayout';
+export type { NavbarLayoutProps, NavbarLayoutTabs } from './NavbarLayout';

package/build/SearchBar/SearchBar.d.ts

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

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

@@ -0,0 +1,33 @@
+/// <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;
+    /** setting this will initialise the search query to a value */
+    initialSearchQuery?: string;
+    /** dynamically generate an empty list message based on what was searched for */
+    dynamicEmptyMessage?: (query: string) => string | JSX.Element;
+    isResultDisabled?: (result: any) => {
+        disabled: true;
+        reason: string;
+    } | {
+        disabled: false;
+    };
+}

package/build/Select/Select.d.ts

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

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

@@ -0,0 +1,16 @@
+import { OutlinedTextFieldProps } from '@mui/material';
+import { IAuthoriserProp } from '../globals';
+
+export interface ISelectProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
+    selectOptions: {
+        value: string | number;
+        description: React.ReactNode;
+        disabled?: boolean;
+    }[];
+    maxListHeight?: number;
+    styling?: string;
+    variant?: "outlined" | "standard";
+    onOpen?: () => unknown;
+    onClose?: () => unknown;
+    itemClassName?: string;
+}

package/build/StaticTable/StaticTable.d.ts

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

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

@@ -0,0 +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;
+}

package/build/SvgComponents/ContainedPartnersLogo.d.ts

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

package/build/SvgComponents/HomeSvg.d.ts

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

package/build/SvgComponents/NovelLogoSvg.d.ts

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

package/build/SvgComponents/OrganisationList.d.ts

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

package/build/SvgComponents/ProjectsSvg.d.ts

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

package/build/SvgComponents/index.d.ts

@@ -0,0 +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';

package/build/SvgComponents/types.d.ts

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

package/build/TextField/TextField.d.ts

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

package/build/TextField/TextField.types.d.ts

@@ -0,0 +1,8 @@
+import { OutlinedTextFieldProps } from '@mui/material';
+import { IAuthoriserProp } from '../globals';
+
+export interface ITextFieldProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
+    styling?: string;
+    numberField?: boolean;
+    fixedDecimalScale?: boolean;
+}

package/build/Tooltip/OptionalTooltip.d.ts

@@ -0,0 +1,9 @@
+import { default as React } from 'react';
+
+interface IOptionalTooltipProps {
+    showTooltip: boolean;
+    tooltipText: string;
+    children: JSX.Element;
+}
+export declare const OptionalTooltip: React.FC<IOptionalTooltipProps>;
+export {};

package/build/Tooltip/index.d.ts

@@ -0,0 +1 @@
+export * from './OptionalTooltip';

package/build/globals/index.d.ts

@@ -0,0 +1,26 @@
+export declare const HALF_REM = "0.5rem";
+export declare const ONE_REM = "1rem";
+export declare const ONE_AND_HALF_REM = "1.5rem";
+export declare const TWO_REM = "3rem";
+export declare const THREE_REM = "3rem";
+export declare const EDITED_STATUS = "EDITED";
+export declare const NEW_STATUS = "NEW";
+export declare const VALIDATION_MESSAGE_REQUIRED = "Required";
+export declare const REGEX_NUMBER_WITH_DECIMALS: RegExp;
+export declare const YUP_REQUIRED_STRING_SHORT_MESSAGE: import('yup/lib/string').RequiredStringSchema<string | undefined, import('yup/lib/types').AnyObject>;
+export declare const YUP_STRING_NUMBER_WITH_DECIMALS: import('yup/lib/string').RequiredStringSchema<string | undefined, import('yup/lib/types').AnyObject>;
+export declare const FORM_SUCCESS = "success";
+export declare const FORM_ERROR = "error";
+export declare const FORM_LOADING = "loading";
+export declare const FORM_ENABLED = "enabled";
+export declare const FORM_WARNING = "warning";
+export declare const FORM_DELETING = "deleting";
+export type FormStatuses = typeof FORM_SUCCESS | typeof FORM_ERROR | typeof FORM_LOADING | typeof FORM_ENABLED | typeof FORM_WARNING | typeof FORM_DELETING;
+export declare const READ_LEVEL = "read";
+export declare const WRITE_LEVEL = "write";
+export declare const NO_ACCESS_LEVEL = "noAccess";
+export type AccessLevels = typeof READ_LEVEL | typeof WRITE_LEVEL | typeof NO_ACCESS_LEVEL;
+export interface IAuthoriserProp {
+    accessLevel?: AccessLevels;
+}
+export declare const BORDER_RADIUS = "14px";

package/build/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export { default as useDebounceEffect } from './useDebounceEffect';
+export { default as useInterval } from './useInterval';
+export { default as useWhyDidYouUpdate } from './useWhyDidYouUpdate';

package/build/hooks/useDebounceEffect.d.ts

@@ -0,0 +1,2 @@
+declare const useDebounceEffect: (effect: (query: string) => void, deps: any[], delay?: number) => void;
+export default useDebounceEffect;

package/build/hooks/useInterval.d.ts

@@ -0,0 +1,2 @@
+declare const useInterval: (callback: () => void, delay: number | null) => void;
+export default useInterval;

package/build/hooks/useWhyDidYouUpdate.d.ts

@@ -0,0 +1 @@
+export default function useWhyDidYouUpdate(name: string, props: Record<string, any>): void;

package/build/index.d.ts

@@ -0,0 +1,38 @@
+import { default as Button } from './Button/Button';
+import { default as ContentLabel } from './ContentLabel/ContentLabel';
+import { default as ContentBox } from './ContentBox/ContentBox';
+import { default as StaticTable } from './StaticTable/StaticTable';
+import { default as LoadingSpinner } from './LoadingSpinner/LoadingSpinner';
+import { default as Breadcrumbs } from './Breadcrumbs/Breadcrumbs';
+import { default as EntityList } from './EntityList/EntityList';
+import { IEntity } from './EntityList/EntityList.types';
+import { default as ErrorIndicator } from './ErrorIndicator/ErrorIndicator';
+import { default as LeftNavigation } from './LeftNavigation/LeftNavigation';
+import { INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem } from './LeftNavigation/LeftNavigation.types';
+import { default as MainLayout } from './MainLayout/MainLayout';
+import { default as SearchBar } from './SearchBar/SearchBar';
+import { default as TextField, NumberFormatField } from './TextField/TextField';
+import { default as Select } from './Select/Select';
+import { default as DatePicker } from './DatePicker/DatePicker';
+import { default as KeyboardDatePicker } from './KeyboardDatePicker/KeyboardDatePicker';
+import { default as ButtonWithConfirm } from './ButtonWithConfirm/ButtonWithConfirm';
+import { default as EditableTable } from './EditableTable/EditableTable';
+import { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps } from './EditableTable/EditableTable.types';
+import { tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableCheckbox, TableSelect, TableMultipleSelect, NonEditableField } from './EditableTable/defaultCells';
+import { useDebounceEffect, useInterval, useWhyDidYouUpdate } from './hooks';
+import { didCellValueChange } from './utils';
+import { default as ImageDisplayAndUpload } from './ImageDisplayAndUpload/ImageDisplayAndUpload';
+import { default as Alert } from './Alert/Alert';
+import { default as AlphabeticalList } from './AlphabeticalList/AlphabeticalList';
+import { ISelectProps } from './Select/Select.types';
+import { NavbarLayout, NavbarLayoutTabs } from './NavbarLayout';
+import { FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_DELETING, FormStatuses } from './globals';
+import { default as MobileDatePicker } from './MobileDatePicker/MobileDatePicker';
+import { AutoSaveTextField } from './AutoSave/Text';
+import { AutoSaveSelectField } from './AutoSave/Select';
+import { OptionalTooltip } from './Tooltip';
+import { TableDateInput } from './EditableTable/components/TableDateInput';
+import { TableTextInput } from './EditableTable/components/TableTextInput';
+
+export { ImageDisplayAndUpload, Alert, Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner, Breadcrumbs, EntityList, ErrorIndicator, LeftNavigation, MainLayout, SearchBar, TextField, Select, DatePicker, AutoSaveTextField, AutoSaveSelectField, KeyboardDatePicker, MobileDatePicker, ButtonWithConfirm, EditableTable, TableSelect, TableMultipleSelect, NonEditableField, TableDateInput as TableDatePicker, TableTextInput as TableTextField, tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableCheckbox, didCellValueChange, useDebounceEffect, useInterval, useWhyDidYouUpdate, AlphabeticalList, NumberFormatField, NavbarLayout, OptionalTooltip, FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_DELETING, };
+export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, FormStatuses, };