@oc-digital/react-component-library 2.2.0-beta.1 → 2.2.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,18 +1,18 @@
1
1
  import { ReactNode } from "react";
2
- type BreadcrumbSlot = {
2
+ declare type BreadcrumbSlot = {
3
3
  name: string;
4
4
  link: string;
5
5
  };
6
- type BreadCrumbKeys = "first" | "second" | "third";
7
- type IBreadcrumbs = {
6
+ declare type BreadCrumbKeys = "first" | "second" | "third";
7
+ declare type IBreadcrumbs = {
8
8
  [K in BreadCrumbKeys]?: BreadcrumbSlot;
9
9
  };
10
- type colorOptions = {
10
+ declare type colorOptions = {
11
11
  background?: string;
12
12
  color?: string;
13
13
  };
14
- type ColorKeys = "primary" | "secondary" | "tertiary";
15
- export type IBreadcrumbColors = {
14
+ declare type ColorKeys = "primary" | "secondary" | "tertiary";
15
+ export declare type IBreadcrumbColors = {
16
16
  [K in ColorKeys]?: colorOptions;
17
17
  };
18
18
  export interface IBreadcrumbsProps {
@@ -10,5 +10,5 @@ export interface IButtonProps extends IAuthoriserProp {
10
10
  disabled?: boolean;
11
11
  variant?: "outlined" | "contained" | "text";
12
12
  styling?: string;
13
- color?: any;
13
+ color?: "default" | "primary" | "secondary" | "inherit";
14
14
  }
@@ -1,7 +1,5 @@
1
- import { DatePickerProps } from "@mui/x-date-pickers";
1
+ import { DatePickerProps } from "@material-ui/pickers";
2
2
  import { IAuthoriserProp } from "../globals";
3
- type InputDate = any;
4
- export interface IDatePickerProps extends IAuthoriserProp, DatePickerProps<InputDate, InputDate> {
3
+ export interface IDatePickerProps extends IAuthoriserProp, DatePickerProps {
5
4
  styling?: string;
6
5
  }
7
- export {};
@@ -2,18 +2,18 @@ import { CellProps, HeaderGroup, Row, TableBodyPropGetter, TableBodyProps, Table
2
2
  import { SchemaOf } from "yup";
3
3
  import React from "react";
4
4
  import { VirtualItem } from "react-virtual/types";
5
- export type IAlignment = "left" | "right" | "inherit" | "center" | "justify";
6
- export type RowData = {
5
+ export declare type IAlignment = "left" | "right" | "inherit" | "center" | "justify";
6
+ export declare type RowData = {
7
7
  [key: string]: any;
8
8
  };
9
- export type ITableHeader = {
9
+ export declare type ITableHeader = {
10
10
  Header: string | JSX.Element;
11
11
  accessor: string;
12
12
  textAlign?: IAlignment;
13
13
  };
14
- export type TableCellValues = null | undefined | string | number | Date | boolean | string[];
15
- export type SynchCellWithStateFn = (rowIndex: number, columnId: string, value: TableCellValues, errorStatus: boolean, forceUpdate?: boolean) => void;
16
- export type FieldConfig = {
14
+ export declare type TableCellValues = null | undefined | string | number | Date | boolean | string[];
15
+ export declare type SynchCellWithStateFn = (rowIndex: number, columnId: string, value: TableCellValues, errorStatus: boolean, forceUpdate?: boolean) => void;
16
+ export declare type FieldConfig = {
17
17
  [key: string]: {
18
18
  validationRule?: SchemaOf<any>;
19
19
  dependentValidationRule?: (values: {
@@ -60,7 +60,7 @@ export interface IEditableTableProps {
60
60
  includeGlobalSearch?: boolean;
61
61
  disableHeaderSelect?: boolean;
62
62
  }
63
- type AdditionalCellProps = Pick<IEditableTableProps, "fieldConfig" | "syncCellWithState" | "setRows">;
63
+ declare type AdditionalCellProps = Pick<IEditableTableProps, "fieldConfig" | "syncCellWithState" | "setRows">;
64
64
  export interface ExtendedCellProps extends AdditionalCellProps, CellProps<RowData> {
65
65
  disabled: boolean;
66
66
  }
@@ -1,17 +1,17 @@
1
1
  import React, { ReactChild, ReactNode } from "react";
2
2
  import { ICustomRenderFnProps, IEssentialRenderFnProps } from "./EditableTable.types";
3
3
  export declare const TableTextField: React.FC<IEssentialRenderFnProps>;
4
- export declare const tableTextField: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
5
- export declare const tableNumericStringField: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
6
- export declare const tableNumericStringFixedDecimalField: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
7
- export declare const SelectionCheckbox: React.JSXElementConstructor<Omit<import("@mui/material").CheckboxProps, "classes"> & import("@mui/styles/withStyles").StyledComponentProps<"root">>;
4
+ export declare const tableTextField: (tableProps: ICustomRenderFnProps) => JSX.Element;
5
+ export declare const tableNumericStringField: (tableProps: ICustomRenderFnProps) => JSX.Element;
6
+ export declare const tableNumericStringFixedDecimalField: (tableProps: ICustomRenderFnProps) => JSX.Element;
7
+ export declare const SelectionCheckbox: React.ComponentType<Pick<import("@material-ui/core").CheckboxProps, "color" | "translate" | "hidden" | "size" | "style" | "icon" | "disabled" | "value" | "onBlur" | "onChange" | "prefix" | "checked" | "indeterminate" | "checkedIcon" | "className" | "innerRef" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "id" | "lang" | "placeholder" | "slot" | "spellCheck" | "tabIndex" | "title" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlurCapture" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "ref" | "form" | "key" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "name" | "disableFocusRipple" | "edge" | "action" | "buttonRef" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "onFocusVisible" | "TouchRippleProps" | "inputProps" | "inputRef" | "readOnly" | "required" | "indeterminateIcon"> & import("@material-ui/core").StyledComponentProps<"root">>;
8
8
  interface ITableDatePicker extends IEssentialRenderFnProps {
9
9
  fullDate?: boolean;
10
10
  }
11
11
  export declare const TableDatePicker: React.FC<ITableDatePicker>;
12
- export declare const tableDateField: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
13
- export declare const tableInvoiceDateField: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
14
- export declare const tableCheckbox: (tableProps: ICustomRenderFnProps) => React.JSX.Element;
12
+ export declare const tableDateField: (tableProps: ICustomRenderFnProps) => JSX.Element;
13
+ export declare const tableInvoiceDateField: (tableProps: ICustomRenderFnProps) => JSX.Element;
14
+ export declare const tableCheckbox: (tableProps: ICustomRenderFnProps) => JSX.Element;
15
15
  interface INonEditableField extends Pick<IEssentialRenderFnProps, "numberField" | "prefix" | "suffix" | "textAlign" | "fixedDecimalScale"> {
16
16
  text: React.ReactText;
17
17
  }
@@ -1,7 +1,5 @@
1
- import { DatePickerProps } from "@mui/x-date-pickers";
1
+ import { KeyboardDatePickerProps } from "@material-ui/pickers";
2
2
  import { IAuthoriserProp } from "../globals";
3
- type InputDate = any;
4
- export interface IKeyboardDatePickerProps extends IAuthoriserProp, DatePickerProps<InputDate, InputDate> {
3
+ export interface IKeyboardDatePickerProps extends IAuthoriserProp, KeyboardDatePickerProps {
5
4
  styling?: string;
6
5
  }
7
- export {};
@@ -6,7 +6,7 @@ export interface INavigationLink {
6
6
  Icon: React.FC<ISvgComponentProps>;
7
7
  hasSecondary?: boolean;
8
8
  }
9
- export type IExpandedOptions = {
9
+ export declare type IExpandedOptions = {
10
10
  view: string;
11
11
  expanded: boolean;
12
12
  };
@@ -1,6 +1,6 @@
1
- import React, { FC } from "react";
1
+ import { FC } from "react";
2
2
  import { ISvgComponentProps } from "../SvgComponents/types";
3
- export type NavbarProps = {
3
+ export declare type NavbarProps = {
4
4
  tabs: Array<{
5
5
  Icon: FC<ISvgComponentProps>;
6
6
  field: string;
@@ -8,5 +8,5 @@ export type NavbarProps = {
8
8
  separate?: boolean;
9
9
  }>;
10
10
  };
11
- declare const Navbar: ({ tabs }: NavbarProps) => React.JSX.Element;
11
+ declare const Navbar: ({ tabs }: NavbarProps) => JSX.Element;
12
12
  export default Navbar;
@@ -1,16 +1,16 @@
1
1
  import React, { FC } from "react";
2
2
  import { ISvgComponentProps } from "../SvgComponents/types";
3
- export type NavbarLayoutTabs = Array<{
3
+ export declare type NavbarLayoutTabs = Array<{
4
4
  Icon: FC<ISvgComponentProps>;
5
5
  field: string;
6
6
  path: string;
7
7
  separate?: boolean;
8
8
  }>;
9
- export type NavbarLayoutProps = {
9
+ export declare type NavbarLayoutProps = {
10
10
  tabs: NavbarLayoutTabs;
11
11
  hideTabs?: boolean;
12
12
  leaveHeightForMenu?: boolean;
13
13
  children: React.ReactNode;
14
14
  };
15
- declare const NavbarLayout: ({ tabs, hideTabs, leaveHeightForMenu, children, }: NavbarLayoutProps) => React.JSX.Element;
15
+ declare const NavbarLayout: ({ tabs, hideTabs, leaveHeightForMenu, children, }: NavbarLayoutProps) => JSX.Element;
16
16
  export default NavbarLayout;
@@ -1,4 +1,4 @@
1
- import { OutlinedTextFieldProps } from "@mui/material";
1
+ import { OutlinedTextFieldProps } from "@material-ui/core";
2
2
  import { IAuthoriserProp } from "../globals";
3
3
  export interface IStyleProps {
4
4
  background: string;
@@ -1,6 +1,6 @@
1
1
  /// <reference types="react" />
2
- export type cellAlignmentOptions = "centerJustify" | "leftJustify" | "rightJustify";
3
- export type headerColours = {
2
+ export declare type cellAlignmentOptions = "centerJustify" | "leftJustify" | "rightJustify";
3
+ export declare type headerColours = {
4
4
  background?: string;
5
5
  border?: string;
6
6
  text?: string;
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { NumberFormatProps } from "react-number-format";
2
+ import NumberFormat, { NumberFormatProps } from "react-number-format";
3
3
  import { ITextFieldProps } from "./TextField.types";
4
4
  declare const TextField: React.FC<ITextFieldProps>;
5
5
  export default TextField;
@@ -10,7 +10,7 @@ interface INumberFormatProps extends Omit<NumberFormatProps, "onChange"> {
10
10
  value: string;
11
11
  };
12
12
  }) => void;
13
- inputRef: any;
13
+ inputRef: (instance: NumberFormat | null) => void;
14
14
  fixedDecimalScale: boolean;
15
15
  }
16
- export declare const NumberFormatField: (props: INumberFormatProps) => React.JSX.Element;
16
+ export declare const NumberFormatField: (props: INumberFormatProps) => JSX.Element;
@@ -1,4 +1,4 @@
1
- import { OutlinedTextFieldProps } from "@mui/material";
1
+ import { OutlinedTextFieldProps } from "@material-ui/core";
2
2
  import { IAuthoriserProp } from "../globals";
3
3
  export interface ITextFieldProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
4
4
  styling?: string;
@@ -14,7 +14,8 @@ export declare const FORM_ERROR = "error";
14
14
  export declare const FORM_LOADING = "loading";
15
15
  export declare const FORM_ENABLED = "enabled";
16
16
  export declare const FORM_WARNING = "warning";
17
- export type FormStatuses = typeof FORM_SUCCESS | typeof FORM_ERROR | typeof FORM_LOADING | typeof FORM_ENABLED | typeof FORM_WARNING;
17
+ export declare const FORM_DELETING = "deleting";
18
+ export declare type FormStatuses = typeof FORM_SUCCESS | typeof FORM_ERROR | typeof FORM_LOADING | typeof FORM_ENABLED | typeof FORM_WARNING | typeof FORM_DELETING;
18
19
  export declare const READ_LEVEL = "read";
19
20
  export declare const WRITE_LEVEL = "write";
20
21
  export declare const NO_ACCESS_LEVEL = "noAccess";
package/build/index.d.ts CHANGED
@@ -26,5 +26,6 @@ import Alert from "./Alert/Alert";
26
26
  import AlphabeticalList from "./AlphabeticalList/AlphabeticalList";
27
27
  import { ISelectProps } from "./Select/Select.types";
28
28
  import { NavbarLayout, NavbarLayoutTabs } from "./NavbarLayout";
29
- export { ImageDisplayAndUpload, Alert, Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner, Breadcrumbs, EntityList, ErrorIndicator, LeftNavigation, MainLayout, SearchBar, TextField, Select, DatePicker, KeyboardDatePicker, ButtonWithConfirm, EditableTable, TableTextField, TableSelect, TableMultipleSelect, NonEditableField, TableDatePicker, tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableInvoiceDateField, tableCheckbox, didCellValueChange, useDebounceEffect, useInterval, useWhyDidYouUpdate, AlphabeticalList, NumberFormatField, NavbarLayout, };
30
- export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, };
29
+ import { FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_DELETING, FormStatuses } from "./globals";
30
+ export { ImageDisplayAndUpload, Alert, Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner, Breadcrumbs, EntityList, ErrorIndicator, LeftNavigation, MainLayout, SearchBar, TextField, Select, DatePicker, KeyboardDatePicker, ButtonWithConfirm, EditableTable, TableTextField, TableSelect, TableMultipleSelect, NonEditableField, TableDatePicker, tableNumericStringField, tableNumericStringFixedDecimalField, tableDateField, tableInvoiceDateField, tableCheckbox, didCellValueChange, useDebounceEffect, useInterval, useWhyDidYouUpdate, AlphabeticalList, NumberFormatField, NavbarLayout, FORM_SUCCESS, FORM_ERROR, FORM_LOADING, FORM_ENABLED, FORM_WARNING, FORM_DELETING, };
31
+ export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, FormStatuses, };