@campxdev/campx-web-utils 0.5.4 → 0.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@campxdev/campx-web-utils",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "main": "./export.ts",
   "private": false,
   "peerDependencies": {

package/src/layout/AppLayout/AppLayout.tsx

@@ -8,7 +8,6 @@ import { ChangePasswordDialog } from '../../components/ChangePassword';
 import { axios } from '../../config/axios';
 import { ErrorBoundary } from '../../context/export';
 import HelpDocs from './components/HelpDocs';
-import { helpDocsConfig } from './components/helpDocsConfig';
 
 type Props = {
   actions?: ReactNode[];
@@ -21,6 +20,10 @@ type Props = {
   designation?: string;
   clientName?: string;
   institutionData?: any[];
+  helpDocsConfig?: Record<
+    string,
+    { actions: { name: string; onClick: () => void }[] }
+  >;
 };
 
 export const AppLayout: React.FC<Props> = ({
@@ -34,6 +37,7 @@ export const AppLayout: React.FC<Props> = ({
   userName = '',
   designation = '',
   clientName = '',
+  helpDocsConfig,
 }) => {
   const [collapsed, setCollapsed] = useState(true);
   const theme = useTheme();
@@ -57,7 +61,7 @@ export const AppLayout: React.FC<Props> = ({
   const pathSegments = fullPath.split('/').filter(Boolean);
   const actualPath = pathSegments.slice(1).join('/');
   const normalizedPath = actualPath.replace(/\/\d+/g, '/:id');
-  const helpDocsActions = helpDocsConfig[`/${normalizedPath}`]?.actions || [];
+  const helpDocsActions = helpDocsConfig?.[`/${normalizedPath}`]?.actions || [];
 
   return (
     <AppLayoutContainer>
@@ -87,8 +91,11 @@ export const AppLayout: React.FC<Props> = ({
             profileSx: { width: 32, height: 32, fontSize: '12px' },
           })}
         />
-        {helpDocsActions.length > 0 && <HelpDocs actions={helpDocsActions} />}
-        <OuletContainer
+        {helpDocsConfig && helpDocsActions.length > 0 && (
+          <HelpDocs actions={helpDocsActions} />
+        )}
+
+        <OutletContainer
           sx={{
             margin: '12px 0px 0px 0px',
             backgroundColor: theme.palette.surface.paperBackground,
@@ -101,7 +108,7 @@ export const AppLayout: React.FC<Props> = ({
           <Suspense fallback={<Spinner />}>
             <ErrorBoundary>{children}</ErrorBoundary>
           </Suspense>
-        </OuletContainer>
+        </OutletContainer>
       </motion.div>
     </AppLayoutContainer>
   );
@@ -114,13 +121,17 @@ const AppLayoutContainer = styled(Stack)(({ theme }: { theme?: any }) => ({
   [theme.breakpoints.down('md')]: { flexWrap: 'wrap' },
 }));
 
-const OuletContainer = styled(Box)(({ theme }: { theme?: any }) => ({
+const OutletContainer = styled(Box)(({ theme }: { theme?: any }) => ({
   borderRadius: '8px',
   height: 'calc(100vh - 96px)',
   overflowY: 'scroll',
   width: '100%',
 
-  '&::-webkit-scrollbar': { width: '0.5em', height: '0.2em' },
+  '&::-webkit-scrollbar': {
+    width: '0.5em',
+    height: '0.2em',
+    backgroundColor: theme.palette.surface.defaultBackground,
+  },
 
   '&::-webkit-scrollbar-thumb': {
     backgroundColor: theme.palette.primary.light,

package/src/layout/AppLayout/components/helpDocsConfig.ts

@@ -1,89 +0,0 @@
-export const helpDocsConfig: Record<
-  string,
-  { actions: { name: string; onClick: () => void }[] }
-> = {
-  '/payments/exam-fees': {
-    actions: [
-      {
-        name: 'Know how to collect exam fee',
-        onClick: () =>
-          window.open('https://docs.campx.in/Workflows/collect_fee/', '_blank'),
-      },
-    ],
-  },
-  '/payments/student-permissions': {
-    actions: [
-      {
-        name: 'Know how to manage permissions',
-        onClick: () =>
-          window.open('https://docs.campx.in/Workflows/collect_fee/', '_blank'),
-      },
-    ],
-  },
-  '/exams/blocked-students': {
-    actions: [
-      {
-        name: 'Know how to block students',
-        onClick: () =>
-          window.open('https://docs.campx.in/Workflows/collect_fee/', '_blank'),
-      },
-    ],
-  },
-  '/ums/settings/assessments/assessment-types': {
-    actions: [
-      {
-        name: 'Know how to setup Assessment rules',
-        onClick: () =>
-          window.open(
-            'https://docs.campx.in/Workflows/assessment_rules/',
-            '_blank',
-          ),
-      },
-    ],
-  },
-  '/ums/settings/assessments/assessment-templates': {
-    actions: [
-      {
-        name: 'Know how to setup Assessment rules',
-        onClick: () =>
-          window.open(
-            'https://docs.campx.in/Workflows/assessment_rules/',
-            '_blank',
-          ),
-      },
-    ],
-  },
-  '/ums/classrooms/:id/timetable': {
-    actions: [
-      {
-        name: 'Know how to suspend a class',
-        onClick: () =>
-          window.open(
-            'https://docs.campx.in/Workflows/suspending-a-class/',
-            '_blank',
-          ),
-      },
-    ],
-  },
-
-  '/exams/examinations/:id/bundle-subjects': {
-    actions: [
-      {
-        name: 'Learn about Scanning & Bundling',
-        onClick: () =>
-          window.open(
-            'https://docs.campx.in/Workflows/scanningbundling_booklets/',
-            '_blank',
-          ),
-      },
-      {
-        name: 'Know how to upload digital booklets',
-        onClick: () =>
-          window.open(
-            'https://docs.campx.in/Workflows/digital_booklets/',
-            '_blank',
-          ),
-      },
-    ],
-  },
-};