@asaleh37/ui-base 1.2.25 → 1.2.27

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 ADDED
@@ -0,0 +1,52 @@
1
+ **UI Base** is a React JS template designed for quickly scaffolding robust, production-ready Enterprise Applications Interface. It incorporates enterprise-grade architectural patterns and integrates a suite of essential features to accelerate development, including:
2
+
3
+ - A modular, layered architecture with a clean separation of concerns and industry-standard project structure.
4
+
5
+ - [ ] Create new react project using vite.
6
+
7
+ ```javascript
8
+ npm create vite@latest YOUR_APP_NAME //choose typescript as template
9
+ cd YOUR_APP_NAME
10
+ npm install
11
+ ```
12
+
13
+ - [ ] Install the UI Base Dependency.
14
+
15
+ ```javascript
16
+ npm install @asaleh37/ui-base --force
17
+ ```
18
+
19
+ - [ ] replace the content of the file src/main.tsx
20
+
21
+ ```javascript
22
+ import { BaseApp } from "@asaleh37/ui-base";
23
+ import { createRoot } from "react-dom/client";
24
+
25
+ createRoot(document.getElementById("root")!).render(
26
+   <BaseApp
27
+     apiBaseUrl="YOUR_API_URL"
28
+     appLogo={"YOUR_APP_LOGO_PATH"}
29
+     appName="YOUR_APP_NAME"
30
+     appVersion="YOUR_APP_VERSION"
31
+     businessCommonStoresMetaData={{}}
32
+     businessNavigationItems={[]}
33
+     businessReduxReducers={{}}
34
+     businessRoutes={[]}
35
+     documentTitle="YOUR_HTML_DOCUMENT_TITLE"
36
+     enableAdministrationModule={true} // to enable administration module or not
37
+ /* // To Change APP Coloring Theme modify the following colors
38
+     appTheme={{
39
+       dark: { primaryColor: "#b3a10c", secondaryColor: "#2b3c46" },
40
+       light: { primaryColor: "#2b3c46", secondaryColor: "#b3a10c" },
41
+     }}
42
+ */
43
+   muiPremiumKey="YOUR_MUI_PREMIUM_KEY"
44
+   />
45
+ );
46
+ ```
47
+
48
+ - [ ] then go to the root of your project and then run the following command
49
+
50
+ ```javascript
51
+ npm run dev
52
+ ```
package/dist/index.d.ts CHANGED
@@ -427,6 +427,8 @@ type attachment = {
427
427
  docType: string;
428
428
  fileName: string;
429
429
  refKey: string;
430
+ allowDelete?: boolean;
431
+ downloadAuthorityKey?: string;
430
432
  remark: string;
431
433
  };
432
434
  declare const AttachmentCard: React.FC<attachment>;
@@ -437,6 +439,7 @@ type AttachmentImageViewerProps = {
437
439
  refKey?: string;
438
440
  category?: string;
439
441
  showAsAvatar?: boolean;
442
+ style?: SxProps;
440
443
  };
441
444
  declare const AttachmentImageViewer: React.FC<AttachmentImageViewerProps>;
442
445
 
@@ -462,6 +465,7 @@ type workflowDocumentActionHistory = {
462
465
  documentActionEnName: string;
463
466
  employeeArName: string;
464
467
  employeeEnName: string;
468
+ personId: number;
465
469
  };
466
470
  declare const WorkflowDocumentPanel: React.FC<WorkflowDocumentPanelProps>;
467
471