@oc-digital/react-component-library 2.1.8 → 2.1.9-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.
- package/README.md +94 -94
- package/build/DatePicker/DatePicker.types.d.ts +4 -2
- package/build/EditableTable/defaultCells.d.ts +1 -1
- package/build/KeyboardDatePicker/KeyboardDatePicker.types.d.ts +4 -2
- package/build/Select/Select.types.d.ts +1 -1
- package/build/TextField/TextField.types.d.ts +1 -1
- package/build/index.d.ts +2 -3
- package/build/index.js +147 -1
- package/build/index.js.map +1 -1
- package/build/styles/font.d.ts +1 -1
- package/build/styles/layout.d.ts +1 -1
- package/build/styles/spacing.d.ts +1 -1
- package/build/styles/theme.d.ts +1 -0
- package/package.json +139 -130
- package/build/NavbarLayout/Navbar.d.ts +0 -12
- package/build/NavbarLayout/NavbarLayout.d.ts +0 -16
- package/build/NavbarLayout/index.d.ts +0 -2
package/README.md
CHANGED
|
@@ -1,94 +1,94 @@
|
|
|
1
|
-
# Optimal Compliance React Component Library
|
|
2
|
-
|
|
3
|
-
React component library used in Optimal Compliance React projects
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
Use [npm](https://www.npmjs.com/) to install.
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install @oc-digital/react-component-library
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
or [yarn](https://yarnpkg.com/)
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
yarn add @oc-digital/react-component-library
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Peer dependencies
|
|
20
|
-
|
|
21
|
-
```json
|
|
22
|
-
"react": ">=17.0.0",
|
|
23
|
-
"react-dom": ">=17.0.0",
|
|
24
|
-
"@material-ui/core": "=4.12.3",
|
|
25
|
-
"@material-ui/icons": "=4.11.2",
|
|
26
|
-
"react-router-dom": ">=5.0.0",
|
|
27
|
-
"@date-io/date-fns": "=1.3.13",
|
|
28
|
-
"date-fns": "=2.25.0",
|
|
29
|
-
"react-number-format": "=4.8.0",
|
|
30
|
-
"@material-ui/pickers": "=3.3.10",
|
|
31
|
-
"yup": "=0.32.11",
|
|
32
|
-
"react-table": "=7.7.0",
|
|
33
|
-
"@material-ui/lab": ">=4.0.0-alpha.60",
|
|
34
|
-
"lodash": "^4.17.21",
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
## Usage
|
|
38
|
-
|
|
39
|
-
```jsx
|
|
40
|
-
import React from "react";
|
|
41
|
-
import { Button } from "@oc-digital/react-component-library";
|
|
42
|
-
|
|
43
|
-
const ReactComponent = () => (
|
|
44
|
-
<Button onClick={() => console.log("Clicked me!")}>Click Me!</Button>
|
|
45
|
-
);
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Local Usage
|
|
49
|
-
|
|
50
|
-
1. increment the package version and add -beta.0 (e.g. 2.0.6 => 2.0.7-beta.0) and run npm install
|
|
51
|
-
1a. if you need to further increment and publish use -beta.1, -beta.2 and so on
|
|
52
|
-
1b. you can use this all in one command for the above - npm version 2.0.7-beta.0
|
|
53
|
-
2. publish the component library with command - npm publish --tag beta
|
|
54
|
-
3. pin the version in the receiving library to "=2.0.7-beta.0" and run npm install
|
|
55
|
-
4. once happy with the changes remove -beta.0 part and part and publish component library
|
|
56
|
-
4a. update the version in the receiving library to "^2.0.7"
|
|
57
|
-
|
|
58
|
-
## Building and publishing
|
|
59
|
-
|
|
60
|
-
To publish new version login using `npm login`, increment version in `package.json` and run `npm publish`. Subsequently it will build the library to `build` folder and push it's contents to the npm.
|
|
61
|
-
|
|
62
|
-
## Local Usage(OLD DEPRECATED)
|
|
63
|
-
|
|
64
|
-
You can use this library locally, however few steps are required:
|
|
65
|
-
|
|
66
|
-
In the root of component library:
|
|
67
|
-
|
|
68
|
-
1. install `npm install` and build `npm run build` component library
|
|
69
|
-
2. remove `node_modules` folder
|
|
70
|
-
3. run `npm link`
|
|
71
|
-
|
|
72
|
-
In the receiving project:
|
|
73
|
-
4. run `npm link @oc-digital/react-component-library` <br /> 5. start the project `npm start` - this should compile project with local version of component library <br /> 6. wait for `npm start` to finish and run `npm i` inside component react-component-library to restore node modules (this prevents numerous typing issues in the receiving project)
|
|
74
|
-
|
|
75
|
-
To make further adjustments in the component library:
|
|
76
|
-
|
|
77
|
-
1. run `npm install`
|
|
78
|
-
2. make code adjustments
|
|
79
|
-
3. run `npm build`
|
|
80
|
-
|
|
81
|
-
When finished with adjustments you need to unlink local component library with:
|
|
82
|
-
`npm unlink @oc-digital/react-component-library --no-save`
|
|
83
|
-
|
|
84
|
-
Helper Scripts available in the project:
|
|
85
|
-
`npm run useLocalLib` - does initial step 1 to 4
|
|
86
|
-
`npm run unlinkLib` - does unlinking
|
|
87
|
-
|
|
88
|
-
## Playground
|
|
89
|
-
|
|
90
|
-
Use storybook to explore components
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
npm run storybook
|
|
94
|
-
```
|
|
1
|
+
# Optimal Compliance React Component Library
|
|
2
|
+
|
|
3
|
+
React component library used in Optimal Compliance React projects
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Use [npm](https://www.npmjs.com/) to install.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @oc-digital/react-component-library
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
or [yarn](https://yarnpkg.com/)
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
yarn add @oc-digital/react-component-library
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Peer dependencies
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
"react": ">=17.0.0",
|
|
23
|
+
"react-dom": ">=17.0.0",
|
|
24
|
+
"@material-ui/core": "=4.12.3",
|
|
25
|
+
"@material-ui/icons": "=4.11.2",
|
|
26
|
+
"react-router-dom": ">=5.0.0",
|
|
27
|
+
"@date-io/date-fns": "=1.3.13",
|
|
28
|
+
"date-fns": "=2.25.0",
|
|
29
|
+
"react-number-format": "=4.8.0",
|
|
30
|
+
"@material-ui/pickers": "=3.3.10",
|
|
31
|
+
"yup": "=0.32.11",
|
|
32
|
+
"react-table": "=7.7.0",
|
|
33
|
+
"@material-ui/lab": ">=4.0.0-alpha.60",
|
|
34
|
+
"lodash": "^4.17.21",
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
```jsx
|
|
40
|
+
import React from "react";
|
|
41
|
+
import { Button } from "@oc-digital/react-component-library";
|
|
42
|
+
|
|
43
|
+
const ReactComponent = () => (
|
|
44
|
+
<Button onClick={() => console.log("Clicked me!")}>Click Me!</Button>
|
|
45
|
+
);
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Local Usage
|
|
49
|
+
|
|
50
|
+
1. increment the package version and add -beta.0 (e.g. 2.0.6 => 2.0.7-beta.0) and run npm install
|
|
51
|
+
1a. if you need to further increment and publish use -beta.1, -beta.2 and so on
|
|
52
|
+
1b. you can use this all in one command for the above - npm version 2.0.7-beta.0
|
|
53
|
+
2. publish the component library with command - npm publish --tag beta
|
|
54
|
+
3. pin the version in the receiving library to "=2.0.7-beta.0" and run npm install
|
|
55
|
+
4. once happy with the changes remove -beta.0 part and part and publish component library
|
|
56
|
+
4a. update the version in the receiving library to "^2.0.7"
|
|
57
|
+
|
|
58
|
+
## Building and publishing
|
|
59
|
+
|
|
60
|
+
To publish new version login using `npm login`, increment version in `package.json` and run `npm publish`. Subsequently it will build the library to `build` folder and push it's contents to the npm.
|
|
61
|
+
|
|
62
|
+
## Local Usage(OLD DEPRECATED)
|
|
63
|
+
|
|
64
|
+
You can use this library locally, however few steps are required:
|
|
65
|
+
|
|
66
|
+
In the root of component library:
|
|
67
|
+
|
|
68
|
+
1. install `npm install` and build `npm run build` component library
|
|
69
|
+
2. remove `node_modules` folder
|
|
70
|
+
3. run `npm link`
|
|
71
|
+
|
|
72
|
+
In the receiving project:
|
|
73
|
+
4. run `npm link @oc-digital/react-component-library` <br /> 5. start the project `npm start` - this should compile project with local version of component library <br /> 6. wait for `npm start` to finish and run `npm i` inside component react-component-library to restore node modules (this prevents numerous typing issues in the receiving project)
|
|
74
|
+
|
|
75
|
+
To make further adjustments in the component library:
|
|
76
|
+
|
|
77
|
+
1. run `npm install`
|
|
78
|
+
2. make code adjustments
|
|
79
|
+
3. run `npm build`
|
|
80
|
+
|
|
81
|
+
When finished with adjustments you need to unlink local component library with:
|
|
82
|
+
`npm unlink @oc-digital/react-component-library --no-save`
|
|
83
|
+
|
|
84
|
+
Helper Scripts available in the project:
|
|
85
|
+
`npm run useLocalLib` - does initial step 1 to 4
|
|
86
|
+
`npm run unlinkLib` - does unlinking
|
|
87
|
+
|
|
88
|
+
## Playground
|
|
89
|
+
|
|
90
|
+
Use storybook to explore components
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npm run storybook
|
|
94
|
+
```
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import { DatePickerProps } from "@
|
|
1
|
+
import { DatePickerProps } from "@mui/x-date-pickers";
|
|
2
2
|
import { IAuthoriserProp } from "../globals";
|
|
3
|
-
|
|
3
|
+
declare type InputDate = any;
|
|
4
|
+
export interface IDatePickerProps extends IAuthoriserProp, DatePickerProps<InputDate, InputDate> {
|
|
4
5
|
styling?: string;
|
|
5
6
|
}
|
|
7
|
+
export {};
|
|
@@ -4,7 +4,7 @@ export declare const TableTextField: React.FC<IEssentialRenderFnProps>;
|
|
|
4
4
|
export declare const tableTextField: (tableProps: ICustomRenderFnProps) => JSX.Element;
|
|
5
5
|
export declare const tableNumericStringField: (tableProps: ICustomRenderFnProps) => JSX.Element;
|
|
6
6
|
export declare const tableNumericStringFixedDecimalField: (tableProps: ICustomRenderFnProps) => JSX.Element;
|
|
7
|
-
export declare const SelectionCheckbox: React.
|
|
7
|
+
export declare const SelectionCheckbox: React.JSXElementConstructor<Omit<import("@mui/material").CheckboxProps, "classes"> & import("@mui/styles/withStyles").StyledComponentProps<"root">>;
|
|
8
8
|
interface ITableDatePicker extends IEssentialRenderFnProps {
|
|
9
9
|
fullDate?: boolean;
|
|
10
10
|
}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DatePickerProps } from "@mui/x-date-pickers";
|
|
2
2
|
import { IAuthoriserProp } from "../globals";
|
|
3
|
-
|
|
3
|
+
declare type InputDate = any;
|
|
4
|
+
export interface IKeyboardDatePickerProps extends IAuthoriserProp, DatePickerProps<InputDate, InputDate> {
|
|
4
5
|
styling?: string;
|
|
5
6
|
}
|
|
7
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { OutlinedTextFieldProps } from "@material
|
|
1
|
+
import { OutlinedTextFieldProps } from "@mui/material";
|
|
2
2
|
import { IAuthoriserProp } from "../globals";
|
|
3
3
|
export interface ITextFieldProps extends IAuthoriserProp, Omit<OutlinedTextFieldProps, "variant"> {
|
|
4
4
|
styling?: string;
|
package/build/index.d.ts
CHANGED
|
@@ -25,6 +25,5 @@ import ImageDisplayAndUpload from "./ImageDisplayAndUpload/ImageDisplayAndUpload
|
|
|
25
25
|
import Alert from "./Alert/Alert";
|
|
26
26
|
import AlphabeticalList from "./AlphabeticalList/AlphabeticalList";
|
|
27
27
|
import { ISelectProps } from "./Select/Select.types";
|
|
28
|
-
|
|
29
|
-
export {
|
|
30
|
-
export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, NavbarLayoutTabs, };
|
|
28
|
+
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, };
|
|
29
|
+
export type { FieldConfig, RowData, ITableHeader, TableCellValues, SynchCellWithStateFn, ICustomRenderFnProps, IEssentialRenderFnProps, ISelectProps, IEntity, INavigationLink, ISecondaryNavigationItem, ISecondaryNavigationSubItem, };
|