@oc-digital/react-component-library 1.0.1 → 1.0.5

package/README.md

@@ -0,0 +1,51 @@
+# Optimal Compliance React Component Library
+
+React component library used in Optimal Compliance React projects
+
+## Installation
+
+Use [npm](https://www.npmjs.com/) to install.
+
+```bash
+npm install @oc-digital/react-component-library
+```
+
+or [yarn](https://yarnpkg.com/)
+
+```bash
+yarn add @oc-digital/react-component-library
+```
+
+## Peer dependencies
+
+```json
+ "react": ">=17.0.0",
+ "react-dom": ">=17.0.0",
+ "@material-ui/core": "=4.12.3",
+ "@fortawesome/fontawesome-svg-core": ">=1.2.36",
+ "@fortawesome/free-solid-svg-icons": ">=5.15.4",
+ "@fortawesome/react-fontawesome": ">=0.1.15"
+```
+
+## Usage
+
+```jsx
+import React from "react";
+import { Button } from "@oc-digital/react-component-library";
+
+const ReactComponent = () => (
+  <Button onClick={() => console.log("Clicked me!")}>Click Me!</Button>
+);
+```
+
+## Playground
+
+Use storybook to explore components
+
+```bash
+npm run storybook
+```
+
+## Building and publishing
+
+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.

package/build/Button/Button.d.ts

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

package/build/Button/Button.types.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-export interface IMaterialButtonProps {
+export interface IButtonProps {
     [key: string]: any;
     loading?: boolean;
     children: React.ReactNode;

package/build/ContentBox/ContentBox.d.ts

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

package/build/ContentBox/ContentBox.types.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export interface IContentBoxProps {
+    children: React.ReactNode;
+    limitWidth?: boolean;
+}

package/build/ContentLabel/ContentLabel.d.ts

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

package/build/ContentLabel/ContentLabel.types.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export interface IContentLabelProps {
+    children: React.ReactNode;
+    styling?: null | string;
+}

package/build/LoadingSpinner/LoadingSpinner.d.ts

@@ -0,0 +1,4 @@
+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

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

package/build/StaticTable/StaticTable.d.ts

@@ -0,0 +1,4 @@
+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

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

package/build/globals/index.d.ts

@@ -1,4 +1,5 @@
 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";

package/build/index.d.ts

@@ -1,2 +1,6 @@
 import Button from "./Button/Button";
-export { Button };
+import ContentLabel from "./ContentLabel/ContentLabel";
+import ContentBox from "./ContentBox/ContentBox";
+import StaticTable from "./StaticTable/StaticTable";
+import LoadingSpinner from "./LoadingSpinner/LoadingSpinner";
+export { Button, ContentLabel, ContentBox, StaticTable, LoadingSpinner };