[ { "path": ".coderabbit/ast-grep-rules/assertions-must-use-waitfor.yml", "content": "id: assertions-after-async-must-use-waitfor\nlanguage: typescript\nrule:\n follows:\n stopBy: end\n pattern: await userEvent.$METHOD($$$)\n regex: \"expect\\\\(\"\n not:\n inside:\n any:\n - pattern: waitFor(() => { $$$ })\n - pattern: waitFor(async () => { $$$ })\n - pattern: waitFor(() => $$$)\nmessage: 'Assertion after async operation must be inside waitFor'\nseverity: error\n" }, { "path": ".coderabbit/ast-grep-rules/hardcoded-timeout.yml", "content": "id: hardcoded-timeout-in-tests\nlanguage: typescript\nrule:\n any:\n - pattern: setTimeout($_, $NUM)\n - pattern: await wait($NUM)\n - pattern: delay($NUM)\n inside:\n kind: function_declaration\n has:\n field: name\n regex: '^(it|test|describe)'\nmessage: 'Hardcoded timeout in test - use waitFor with assertions instead'\nseverity: error\n" }, { "path": ".coderabbit/ast-grep-rules/mutation-null-guards.yml", "content": "id: mutation-null-guard-check\nlanguage: typescript\nrule:\n any:\n - pattern: |\n await $MUTATION({\n variables: {\n $$$\n id: $VAR?.$PROP\n $$$\n }\n })\n - pattern: |\n await $MUTATION({\n variables: {\n $$$\n $KEY: $VAR?.$PROP\n $$$\n }\n })\n not:\n precedes: # ← Changed from 'follows'\n pattern: |\n if (!$VAR?.$PROP) return;\nmessage: 'Missing null guard for optional property in mutation variables'\nseverity: error\n" }, { "path": ".coderabbit/ast-grep-rules/no-dynamic-timestamps-in-tests.yml", "content": "id: no-dynamic-timestamps-in-tests\nlanguage: typescript\nfiles: '**/*.{spec,test}.{ts,tsx}'\nrule:\n any:\n - pattern: dayjs()\n - pattern: moment()\n - pattern: DateTime.now()\n - pattern: new Date()\n - pattern: Date.now()\nmessage: 'Non-deterministic timestamp in test - use fixed UTC string'\nseverity: error\n" }, { "path": ".coderabbit/ast-grep-rules/no-local-timezone-in-tests.yml", "content": "id: no-local-timezone-in-tests\nlanguage: TypeScript\nseverity: error\nmessage: |\n Avoid using local timezone date methods in tests. Use UTC methods instead:\n - Use .getUTCDate() instead of .getDate()\n - Use .getUTCMonth() instead of .getMonth()\n - Use .getUTCDay() instead of .getDay()\n - Use .getUTCHours() instead of .getHours()\n - Use .getUTCMinutes() instead of .getMinutes()\n - Use .getUTCSeconds() instead of .getSeconds()\n\n These local timezone methods cause flakiness in sharded CI environments\n where machines may have different timezone configurations.\n\nnote: 'Timezone-dependent test assertion detected'\n\nrule:\n any:\n - pattern: $DATE.getDate()\n - pattern: $DATE.getMonth()\n - pattern: $DATE.getDay()\n - pattern: $DATE.getHours()\n - pattern: $DATE.getMinutes()\n - pattern: $DATE.getSeconds()\n - pattern: $DATE.getFullYear()\n\nfiles:\n - '**/*.test.ts'\n - '**/*.test.tsx'\n - '**/*.spec.ts'\n - '**/*.spec.tsx'\n\nfix: |\n # Manual fix required - replace with UTC equivalent:\n # .getDate() → .getUTCDate()\n # .getMonth() → .getUTCMonth()\n # .getDay() → .getUTCDay()\n # .getHours() → .getUTCHours()\n # .getMinutes() → .getUTCMinutes()\n # .getSeconds() → .getUTCSeconds()\n # .getFullYear() → .getUTCFullYear()\n" }, { "path": ".coderabbit/ast-grep-rules/vitest-cleanup.yml", "content": "id: enforce-restore-all-mocks\nlanguage: typescript\nrule:\n pattern: vi.clearAllMocks()\n kind: call_expression\nmessage: |\n ⚠️ INCOMPLETE CLEANUP - Use vi.restoreAllMocks() instead of vi.clearAllMocks()\n\n vi.clearAllMocks() only clears call history but keeps mock implementations.\n vi.restoreAllMocks() restores original implementations AND clears history.\n\n Required in sharded tests to prevent cross-test contamination.\nseverity: error\nnote: 'Change to: vi.restoreAllMocks()'\nfix: 'vi.restoreAllMocks()'\n" }, { "path": ".coderabbit.yaml", "content": "# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json\n\n# Configuration Metadata\n# Version: 2.0\n# Last Updated: 2026-01-08\n# Purpose: Comprehensive review validation with reusable component architecture enforcement\n\nlanguage: 'en-US'\n\nearly_access: false\n\nchat:\n auto_reply: true\n\nissue_enrichment:\n auto_enrich:\n enabled: false\n\n# ADVISORY GUIDELINES (Guides the AI reviewer during manual reviews)\nreviews:\n profile: 'assertive'\n poem: false\n request_changes_workflow: false\n high_level_summary: true\n review_status: true\n review_details: false\n collapse_walkthrough: false\n auto_apply_labels: false\n suggested_labels: false\n assess_linked_issues: true\n auto_review:\n enabled: true\n drafts: false\n base_branches:\n - develop\n - main\n path_filters:\n - '!**/docs/docs/**'\n - '!*.html'\n - '!*.md'\n - '!*.svg'\n tools:\n ast-grep:\n enabled: true\n rule_dirs:\n - .coderabbit/ast-grep-rules\n essential_rules: true\n\n # Keep instructions concise and scoped by file patterns to stay far under limits\n path_instructions:\n # 1) Tests — Vitest + RTL + sharded stability\n - path: '**/*.{spec,test}.{ts,tsx}'\n instructions: |\n ═══════════════════════════════════════════════════════════════\n 🚨 ANTI-PATTERNS TO FLAG IMMEDIATELY (Search for these first):\n ═══════════════════════════════════════════════════════════════\n\n 1. PATTERN: vi.clearAllMocks() anywhere in test file\n FLAG AS: \"❌ BLOCKING - Use vi.restoreAllMocks() at file:line\"\n WHY: Incomplete cleanup causes sharded test failures\n\n 2. PATTERN: afterEach without both cleanup() AND vi.restoreAllMocks()\n FLAG AS: \"❌ BLOCKING - Missing required cleanup at file:line\"\n \n 3. PATTERN: setTimeout or hardcoded delays\n FLAG AS: \"⚠️ RACE CONDITION - Replace with waitFor at file:line\"\n\n 4. PATTERN: .catch(() => {}) without re-throw or assertion\n FLAG AS: \"❌ SILENT ERROR - Add fallback assertion at file:line\"\n\n 5. PATTERN: dayjs(), moment(), DateTime.now(), or new Date() without arguments in test data\n FLAG AS: \"❌ BLOCKING - Non-deterministic timestamp at file:line - Use fixed UTC string\"\n WHY: Captures current time, causes flakiness in sharded CI\n\n 6. PATTERN: expect(...) after await userEvent or await waitFor, not inside waitFor\n FLAG AS: \"❌ BLOCKING - Race condition at file:line - Move assertion inside waitFor\"\n WHY: State changes may not propagate before assertion runs\n\n ═══════════════════════════════════════════════════════════════\n\n Post a single, structured comment with these sections: Issue Goals, Tests (incl. Flakiness), Components/Policy, GraphQL, i18n & a11y, Security, Action Items.\n Reference exact file:line for each finding.\n\n Issue goals (Priority `#1`):\n - Parse the first PR comment for \"Fixes/Closes/Resolves #\". Confirm every acceptance criterion is tested; list gaps with file:line.\n\n Timezone Safety & Test Determinism (CRITICAL):\n - REQUIRED: Use UTC date methods in all test assertions:\n - ✅ Use: `.getUTCDate()`, `.getUTCMonth()`, `.getUTCDay()`, `.getUTCHours()`, `.getUTCMinutes()`, `.getUTCSeconds()`\n - ❌ NEVER use: `.getDate()`, `.getMonth()`, `.getDay()`, `.getHours()`, `.getMinutes()`, `.getSeconds()`\n - All test dates must use fixed UTC timestamps (e.g., `\"2025-01-01T10:00:00Z\"`)\n - ❌ FORBIDDEN PATTERNS (capture current time):\n - `dayjs()` without arguments (use `dayjs('2025-01-01T10:00:00Z')`)\n - `moment()` without arguments (use `moment('2025-01-01T10:00:00Z')`)\n - `DateTime.now()` (luxon) (use `DateTime.fromISO('2025-01-01T10:00:00Z')`)\n - `new Date()` without arguments (use `new Date('2025-01-01T10:00:00.000Z')`)\n - `Date.now()` (use fixed timestamp number or mock timers)\n - Pattern to flag: `(dayjs|moment|DateTime\\.now|new Date)\\(\\s*\\)` in test data/mocks\n - Report as \"🔴 NON-DETERMINISTIC TIMESTAMP at file:line — Replace with fixed UTC string\"\n - Flag ANY usage of local timezone methods as CRITICAL - these cause CI flakiness in non-UTC environments\n\n Test quality (Vitest + RTL):\n - Use vi.mock; prefer accessible queries (getByRole/LabelText); use user-event.\n - Cover success, error (network/GraphQL/validation), edge/empty states, loading, and user interactions.\n - List uncovered line numbers in changed source files.\n\n Flaky test guard (12 shards) — CRITICAL PATTERNS:\n\n # MANDATORY CHECKLIST - Flag violations as BLOCKING\n\n ## 1. Cleanup (CRITICAL for sharded CI)\n [ ] afterEach contains cleanup() from `@testing-library/react`\n [ ] afterEach contains vi.restoreAllMocks() (NOT vi.clearAllMocks())\n [ ] localStorage/sessionStorage cleared if used\n [ ] window state reset if modified\n\n ⚠️ FLAG: \"INCOMPLETE CLEANUP at file:line - Missing vi.restoreAllMocks()\"\n ⚠️ FLAG: \"INCORRECT CLEANUP at file:line - Uses vi.clearAllMocks() instead of vi.restoreAllMocks()\"\n\n RATIONALE: vi.clearAllMocks() only clears call history but keeps mock \n implementations. vi.restoreAllMocks() restores originals AND clears history.\n This prevents mock leakage between tests in parallel shards.\n\n # ENHANCED: More specific delay detection\n Hardcoded delays (ABSOLUTELY FORBIDDEN):\n - ❌ NEVER use: setTimeout, setInterval, delay(), sleep(), wait() helpers with fixed durations\n - ❌ Pattern to flag: \"await wait(\", \"setTimeout(\", \"delay(\"\n - ✅ ONLY use: waitFor(() => expect(...), { timeout: ... }) with explicit assertions\n - Report as \"🔴 HARDCODED DELAY at file:line — Replace with waitFor assertion\"\n - Exception: Only allow setTimeout in beforeEach/afterEach for test infrastructure setup (must have comment explaining why)\n\n Assertion placement (MANDATORY):\n - ALL assertions after async operations MUST be inside waitFor blocks.\n - Patterns to flag as BLOCKING:\n ❌ await userEvent.type(...); expect(...).toBeInTheDocument();\n ❌ await waitFor(() => ...); expect(mockFn).toHaveBeenCalled();\n ❌ fireEvent.click(...); expect(...).toHaveAttribute(...);\n ✅ await userEvent.type(...); await waitFor(() => expect(...).toBeInTheDocument());\n - Specific patterns to search:\n * `expect\\([^)]+\\)\\.(toHaveBeenCalled|toBeInTheDocument|toHaveAttribute)` NOT inside `waitFor\\(`\n * Any `expect(` within 3 lines after `await userEvent.` or `fireEvent.` that's NOT in `waitFor`\n - Report as \"🔴 RACE CONDITION at file:line — Assertion outside waitFor block after async operation\"\n - Exception: Assertions before any async operations in test case are safe.\n\n Async patterns (NO RACE CONDITIONS):\n - NO hardcoded setTimeout or fixed delays; use waitFor with explicit assertions.\n - After clicking elements that open UI (dropdowns, modals, dialogs, tooltips):\n MUST waitFor the container/menu itself to be visible BEFORE checking child elements.\n Example: await user.click(toggle); await waitFor(() => expect(menu).toBeInTheDocument());\n - After clicking elements that close UI: MUST waitFor close completion (aria-expanded=\"false\" or element removed) BEFORE re-opening.\n Example: await waitFor(() => expect(toggle).toHaveAttribute('aria-expanded', 'false'));\n - In loops testing multiple UI states: re-open → wait for open → interact → wait for result → wait for close. No shortcuts.\n - ALL user-event clicks/types must be awaited; check that state changes are awaited with waitFor.\n\n Error handling (NO SILENT FAILURES):\n - NO .catch() blocks that swallow errors without re-throwing or explicit fallback assertions.\n - If .catch() is used, must have a comment explaining why + alternative assertion inside catch.\n - Prefer try/catch with explicit expect() in catch block over silent .catch(() => {}).\n\n Timer interactions (AVOID CONFLICTS):\n - If global vi.useFakeTimers() is active (check setupTests), check for conflicts with:\n * `@testing-library/user-event` async operations\n * waitFor timeouts\n * UI animations (dropdowns, modals, transitions)\n - Consider vi.useRealTimers() in beforeEach for tests with heavy user interaction.\n - Flag any test using both fake timers AND user-event without explicit timer management.\n\n DataTable-specific testing (CRITICAL for this codebase):\n - After finding datatable container (findByTestId('datatable')), MUST waitFor rows to populate:\n ❌ BAD: await screen.findByTestId('datatable'); const rows = getDataTableBodyRows();\n ✅ GOOD: await screen.findByTestId('datatable'); await waitFor(() => expect(getDataTableBodyRows()).toHaveLength(N));\n - DataTable shows skeleton first, then data asynchronously — tests MUST wait for transition.\n - Report as \"⚠️ DATATABLE RACE CONDITION at file:line — Not waiting for rows after container\".\n\n Double network requests (AVOID):\n - Flag if a handler (onClick, onChange) calls refetch() AND a useEffect also refetches with same dependency.\n - Example: handleChangeRowsPerPage calls refetch(...rowsPerPage...) BUT useEffect([rowsPerPage]) also refetches.\n - Report as \"⚠️ DOUBLE REFETCH at file:line — Both handler and useEffect refetch on same state change\".\n\n I18n Provider Requirement:\n - All component tests MUST wrap with I18nextProvider for consistent translation behavior\n - ❌ Relying on key fallbacks causes brittle tests that break on i18n changes\n - ✅ Wrap all renders:\n ```typescript\n import { I18nextProvider } from 'react-i18next';\n import i18nForTest from 'utils/i18nForTest';\n \n render(\n \n \n \n );\n ```\n - Detection: If test file imports a component that uses `useTranslation()` or `t()`, verify I18nextProvider is present\n\n Fake Timers for Debounce/Throttle Testing:\n - ❌ When testing debounced/throttled logic (search inputs, auto-save, etc.), NEVER use real waits\n - ✅ REQUIRE: `vi.useFakeTimers()` + `vi.advanceTimersByTime()` pattern\n - **Detection:**\n - If test involves \"search\" or \"debounce\" in description/comments\n - AND contains `wait()` or `setTimeout()`\n - Flag: \"Use fake timers to control time progression deterministically\"\n - Cleanup:\n - Every `vi.useFakeTimers()` must have corresponding `vi.useRealTimers()` in:\n * Same test block (try/finally)\n * afterEach hook\n * Never leave fake timers active between tests\n \n Avoid Testing Implementation Details:\n - ❌ Do not assert on internal constants, magic numbers, or implementation specifics:\n ```typescript\n // Brittle - breaks on refactors:\n expect(PAGE_SIZE).toBe(10);\n expect(DEBOUNCE_MS).toBe(300);\n expect(component.state.internalCounter).toBe(5);\n ```\n - ✅ Assert observable behavior instead:\n ```typescript\n // Robust - tests actual behavior:\n expect(mockRequest.variables.first).toBeGreaterThan(0);\n expect(mockRequest).toHaveBeenCalledWith(expect.objectContaining({\n variables: expect.objectContaining({ first: expect.any(Number) })\n }));\n ```\n - Detection:\n - Flag `expect(CONSTANT_NAME).toBe(...)` patterns\n - Suggest: \"Test behavior, not constants. Assert what the component does, not how.\"\n\n Global State & Window/DOM Pollution:\n - ❌ CRITICAL: Any modification to global objects MUST be restored in teardown:\n ```typescript\n // These cause cross-test pollution:\n window.location = { ... };\n window.localStorage.setItem(...);\n process.env.NODE_ENV = 'test';\n global.fetch = mockFetch;\n document.body.innerHTML = '...';\n ```\n - ✅ REQUIRE: Save original and restore:\n ```typescript\n let originalLocation: Location;\n beforeEach(() => {\n originalLocation = window.location;\n });\n afterEach(() => {\n window.location = originalLocation;\n });\n ```\n - Detection Pattern:\n - Search for: `window.location =`, `window.* =`, `global.* =`, `process.env.* =`\n - Verify corresponding save/restore in beforeEach/afterEach\n - Flag missing restoration as CRITICAL for sharded CI\n\n Anti-Pattern: Fixed Waits/Sleeps (CRITICAL for CI Flakiness):\n - ❌ CRITICAL: Flag ANY usage of fixed time delays in tests:\n ```typescript\n // These cause flakiness in variable-latency CI:\n await wait(200);\n await wait(1000);\n await sleep(500);\n setTimeout(..., 1000);\n await new Promise(resolve => setTimeout(resolve, 500));\n ```\n - ✅ REQUIRE: Condition-based async queries instead:\n ```typescript\n // Use findBy* (waits up to 1s by default):\n const element = await screen.findByTestId('datatable');\n \n // Or waitFor with condition:\n await waitFor(() => expect(mockFn).toHaveBeenCalled());\n \n // For debounce/throttle, use fake timers:\n vi.useFakeTimers();\n await userEvent.type(input, 'search');\n vi.advanceTimersByTime(300); // DEBOUNCE_MS\n await waitFor(() => expect(refetch).toHaveBeenCalled());\n vi.useRealTimers();\n ```\n - Detection Pattern:\n - Search for: `wait(`, `sleep(`, `setTimeout(`, `new Promise.*setTimeout`\n - Exceptions: `waitFor(`, `findBy`, `findAllBy` (these are good)\n - Flag every fixed-time wait as HIGH PRIORITY for refactoring\n - Why This Matters:\n - Fixed waits assume consistent response times\n - CI sharding introduces variable latency\n - Root cause of most test flakiness in distributed environments\n\n Structure:\n - No it.skip/describe.skip unless commented with reason + linked issue.\n - Wrap state updates in act() when needed.\n\n REPORT FORMAT for flakiness issues:\n - \"⚠️ RACE CONDITION at file:line — [description]\"\n - \"❌ SILENT ERROR SWALLOW at file:line — .catch() without fallback\"\n - \"⏱️ TIMER CONFLICT at file:line — fake timers + user-event\"\n\n # React components/screens/pages — enforce architecture & policy\n - path: 'src/{components,screens,pages}/**/*.{ts,tsx}'\n instructions: |\n Post a single, structured comment; reference file:line for each item.\n If the file is a test (*.spec|*.test), apply the test checklist instead and skip this block.\n\n Issue goals:\n - Map changes to the linked issue’s acceptance criteria; flag unaddressed or out‑of‑scope work.\n\n ## Screen-specific: DataTable + useTableData Pattern (TableFix Migration)\n **Applies only to files in src/screens/** that import DataTable:**\n - All table-based screens migrating to DataTable MUST use useTableData hook:\n - ❌ Do not use `useQuery` + manual `useMemo` for data transformation:\n ```typescript\n // Incorrect:\n const { data } = useQuery(QUERY);\n const rows = useMemo(() => data?.items ?? [], [data]);\n ```\n - ✅ Use useTableData wrapper:\n ```typescript\n // Correct:\n const { rows, loading, error, refetch } = useTableData(\n useQuery(QUERY, { variables }),\n { path: (data) => data?.items ?? [] }\n );\n ```\n - **Detection:** \n - If file path starts with `src/screens/`\n - AND imports DataTable from shared-components\n - AND imports useQuery from `@apollo/client`\n - BUT does NOT import useTableData\n - Flag: \"Screens using DataTable should integrate with useTableData hook per migration standards\"\n\n Reusable component policy (see: https://docs-admin.talawa.io/docs/developer-resources/reusable-components/):\n - Placement: Admin-only → src/components/AdminPortal/** (+ src/types/AdminPortal/**);\n User-only → src/components/UserPortal/** (+ src/types/UserPortal/**);\n Shared → src/shared-components/** (+ src/types/shared-components/**).\n - Naming: PascalCase folder/file/component; names must match.\n - Props: NO inline prop interfaces; define in src/types///interface.ts (e.g., InterfaceProps).\n - Restricted imports: use shared wrappers (DataGridWrapper, LoadingState, BaseModal, Date/Time pickers, etc.); direct imports allowed only inside wrappers.\n - Brief TSDoc on exported components and interfaces.\n\n TypeScript & React:\n - No any without JSDoc justification; strong types for props/params/returns/state/GQL types.\n - Hooks: proper cleanup in useEffect; avoid prop drilling (use Context/Redux).\n - MUI v7: import from `@mui/material`; styling via `@emotion/react`.\n\n i18n & a11y:\n - No hardcoded UI strings; use useTranslation with keys; add new keys to all 5 locales (en, es, fr, hi, zh).\n - Ensure roles/ARIA (aria-label/aria-describedby/aria-live), keyboard navigation, and semantic markup.\n\n # NEW: Null safety in mutations\n Null guard enforcement (CRITICAL for GraphQL mutations):\n - When calling mutations with variables containing optional properties (fund?.id, user?.id, etc.):\n MUST add null guard BEFORE the mutation call.\n - Pattern to flag: \"variables.*: \\{\\s*id: \\w+\\?\\.\\w+\" without preceding \"if (!...?.id) return;\"\n - Valid pattern:\n ✅ if (!fund?.id) return; await deleteFund({ variables: { id: fund.id } });\n ❌ await deleteFund({ variables: { id: fund?.id } });\n - Report as \"🔴 MISSING NULL GUARD at file:line — Add null check before mutation with optional property\"\n - Apply to all mutation calls: create*, update*, delete*, archive*, etc.\n\n # GraphQL operations\n - path: 'src/GraphQl/**/*.ts'\n instructions: |\n Post a single, structured comment; reference file:line.\n\n Organization & typing:\n - Queries in src/GraphQl/Queries/; mutations in src/GraphQl/Mutations/.\n - Use gql (graphql-tag) with typed variables/results; add brief JSDoc.\n\n Correctness & duplication:\n - No duplicate or conflicting operations; watch pagination params (first/last).\n - Components using these operations must handle loading and error states in UI.\n\n Schema compliance (CRITICAL):\n - For each mutation/query, verify ALL input fields in the schema are used by components.\n - For each component form, verify ALL form fields are sent in the mutation variables.\n - Flag any form field (input, select, checkbox) NOT present in the mutation schema.\n - Report as \"🔴 SCHEMA MISMATCH at file:line — Field '' in form but not in mutation schema\"\n - Flag any mutation accepting field X but component doesn't provide it.\n - Report as \"⚠️ MISSING FIELD at file:line — Mutation expects '' but component doesn't send it\"\n\n Query completeness (CRITICAL):\n - For each GraphQL query, trace ALL components that use the query data.\n - For each field accessed in component code (e.g., `event.fieldName`, `data.queryName[0].fieldName`):\n MUST verify the field is fetched in the query.\n - Common patterns to check:\n * Object property access: `data.events.map(e => e.fieldName)`\n * Destructuring: `const { fieldName } = event;`\n * Optional chaining: `event?.fieldName`\n - Flag if component accesses a field NOT in the query selection set.\n - Report as \"🔴 MISSING QUERY FIELD at file:line — Component uses 'fieldName' but query doesn't fetch it\"\n - Example violation:\n ❌ Query: `{ id name }` but Component: `event.isRecurringEventTemplate`\n ✅ Query: `{ id name isRecurringEventTemplate }`\n - Check both direct usage and passed to child components as props.\n\n - path: '**/*.module.css'\n instructions: |\n Post a single, structured comment; reference file:line.\n\n Design token usage:\n - Use CSS variables from design tokens (var(--space-*, --color-*, --radius-*, etc.))\n - No hardcoded pixel values for spacing, colors, shadows, or border-radius\n - Flag any hardcoded values that could be tokens\n\n !important consistency (CRITICAL):\n - If a base selector uses !important for a property, ALL state selectors (:hover, :active, :focus, :disabled) must also use !important for that property\n - Pattern to flag:\n ❌ .btn { color: red !important; }\n .btn:hover { color: blue; } /* Missing !important */\n ✅ .btn { color: red !important; }\n .btn:hover { color: blue !important; }\n - Report as \"🔴 CSS SPECIFICITY BUG at file:line — :state selector missing !important when base has it\"\n - Check properties: color, background, background-color, border, box-shadow, opacity\n\n BEM/Module naming:\n - Use camelCase for module class names\n - Keep selectors flat; avoid deep nesting\n - Use :global() sparingly and document why\n\n pre_merge_checks:\n # Enforce test file updates for modified source files\n custom_checks:\n - name: 'Test Coverage Gate'\n mode: 'error'\n instructions: |\n BLOCKING: Test coverage must be ≥95% for modified files.\n Run: pnpm run test:coverage\n Verify: coverage/coverage-summary.json shows no files below threshold.\n\n - name: 'TypeScript Compilation'\n mode: 'error'\n instructions: |\n BLOCKING: Zero TypeScript errors.\n Run: pnpm run typecheck\n Must pass without errors or warnings.\n\n - name: 'Component Architecture Compliance'\n mode: 'error'\n instructions: |\n BLOCKING: All components follow reusable component policy.\n Verify: No inline interfaces, correct portal placement, wrapper usage.\n See: https://docs-admin.talawa.io/docs/developer-resources/reusable-components/\n\n - name: 'i18n Key Completeness'\n mode: 'error'\n instructions: |\n BLOCKING: All translation keys must exist in ALL 5 locales.\n\n For each t('key') or tCommon('key') usage:\n 1. Extract the key name\n 2. Verify it exists in public/locales/{en,es,fr,hi,zh}/translation.json\n 3. Flag if missing from ANY locale\n\n Common patterns to check:\n - t('namespace.key')\n - tCommon('key')\n - useTranslation hook with namespace\n\n Report format:\n - \"🔴 MISSING i18n KEY at file:line — 'key' not found in locales: [es, fr]\"\n - \"🔴 NAMESPACE MISMATCH at file:line — Using 'common.required' but should be 'validation.required'\"\n\n Must check all 5 locales:\n - public/locales/{en,es,fr,hi,zh}/translation.json\n - public/locales/{en,es,fr,hi,zh}/common.json\n - public/locales/{en,es,fr,hi,zh}/errors.json\n" }, { "path": ".dockerignore", "content": "node_modules\nnpm-debug.log\nDockerfile\n.git\n.gitignore\n.env\n.env.*\ndist\ncoverage\n.nyc_output\n*.md\n.github\ntests\n__tests__\n*.test.*\n*.spec.*\n# Development files\n*.log\n*.lock\n.DS_Store\n.idea\n.vscode\n# Build artifacts\nbuild\nout\n# Python\nvenv\n" }, { "path": ".flake8", "content": "[flake8]\nignore = E402,E722,E203,F401,W503\nmax-line-length = 80\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: [palisadoes]\npatreon: # Replace with a single Patreon username\nopen_collective: # Replace with a single Open Collective username\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncommunity_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\nliberapay: # Replace with a single Liberapay username\nissuehunt: PalisadoesFoundation/talawa-api\notechie: # Replace with a single Otechie username\ncustom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']\n" }, { "path": ".github/ISSUE_TEMPLATE/bug-report.md", "content": "---\nname: Bug Report\nabout: Create a report to help us improve.\ntitle: Bug Report\nlabels: bug\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To Reproduce**\nSteps to reproduce the behavior:\n\n1.\n2.\n3.\n4.\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Actual behavior**\nA clear and concise description of how the code performed w.r.t expectations.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**Additional details**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature-request.md", "content": "---\nname: Feature Request\nabout: Suggest an idea for this project\ntitle: Feature Request\nlabels: feature request\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is.\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Approach to be followed (optional)**\nA clear and concise description of approach to be followed.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/dependabot.yaml", "content": "# Configuration for automated dependency updates using Dependabot\nversion: 2\nupdates:\n # Define the target package ecosystem\n - package-ecosystem: 'npm'\n # Specify the root directory\n directory: '/'\n # Schedule automated updates\n schedule:\n interval: 'cron'\n cronjob: '0 0 1 * *'\n # Labels to apply to Dependabot PRs\n labels:\n - 'dependencies'\n # Specify the target branch for PRs\n target-branch: 'develop'\n # Customize commit message prefix\n commit-message:\n prefix: 'chore(deps):'\n" }, { "path": ".github/pull_request_template.md", "content": "\n\n\n\n\n**What kind of change does this PR introduce?**\n\n\n\n**Issue Number:**\n\n\nFixes #\n\n**Snapshots/Videos:**\n\n\n\n**If relevant, did you update the documentation?**\n\n\n\n**Summary**\n\n\n\n\n**Does this PR introduce a breaking change?**\n\n\n\n## Checklist\n\n### CodeRabbit AI Review\n- [ ] I have reviewed and addressed all critical issues flagged by CodeRabbit AI\n- [ ] I have implemented or provided justification for each non-critical suggestion\n- [ ] I have documented my reasoning in the PR comments where CodeRabbit AI suggestions were not implemented\n\n### Test Coverage\n- [ ] I have written tests for all new changes/features\n- [ ] I have verified that test coverage meets or exceeds 95%\n- [ ] I have run the test suite locally and all tests pass\n\n\n**Other information**\n\n\n\n**Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa-admin/blob/master/CONTRIBUTING.md)?**\n\n\n" }, { "path": ".github/workflows/README.md", "content": "# Talawa GitHub Workflows Guidelines\n\nFollow these guidelines when contributing to this directory.\n\n## General\n\nAny changes to files in this directory are flagged when pull requests are run. Make changes only on the advice of a contributor.\n\n## YAML Workflow Files\n\nThe YAML files in this directory have very specific roles depending on the type of workflow.\n\nWhenever possible you must ensure that:\n1. The file roles below are maintained\n1. The sequence of the jobs in the workflows are maintained using [GitHub Action dependencies](https://docs.github.com/en/actions/learn-github-actions/managing-complex-workflows). \n\n### File Roles\nFollow these guidelines when creating new YAML defined GitHub actions. This is done to make troubleshooting easier.\n\n1. `Issue` Workflows:\n 1. Place all actions related to issues in the `issues.yml` file.\n 1. `issue-assigned.yml` - Removes unapproved labels when issues are assigned to contributors (exception; see “File Role Exceptions”).\n1. `Pull Request` workflows to be run by:\n 1. Workflows to run **First Time** repo contributors:\n 1. Place all actions related to to this in the `pull-request-target.yml` file.\n 1. Workflows to be run by **ALL** repo contributors:\n 1. Place all actions related to pull requests in the `pull-request.yml` file.\n1. `Push` workflows:\n 1. Place all actions related to pushes in the `push.yml` file.\n\n#### File Role Exceptions\n\nThere are some exceptions to these rules in which jobs can be placed in dedicated separate files:\n1. Jobs that require unique `cron:` schedules \n1. Jobs that require unique `paths:` statements that operate only when files in a specific path are updated.\n1. Jobs only work correctly if they have a dedicated file (eg. `CodeQL`)\n1. Workflows isolated to specific issue activity types (e.g., `issues: [assigned]`) to avoid side effects on the unified issue workflow (e.g., `issue-assigned.yml`)\n\n## Scripts\n\nFollow these guidelines when creating or modifying scripts in this directory.\n\n1. All scripts in this directory must be written in python3 for consistency.\n1. The python3 scripts must follow the following coding standards. Run these commands against your scripts before submitting PRs that modify or create python3 scripts in this directory.\n 1. Pycodestyle\n 1. Pydocstyle\n 1. Pylint\n 1. Flake8\n1. All scripts must run a main() function.\n" }, { "path": ".github/workflows/auto-assign.yml", "content": "name: Auto Assign & Unassign (Org-wide Limit)\n\non:\n issue_comment:\n types: [created]\n\njobs:\n handle-comment:\n uses: PalisadoesFoundation/.github/.github/workflows/auto-assign.yml@main\n secrets:\n ORG_ACCESS_TOKEN: ${{ secrets.ORG_ACCESS_TOKEN }}\n" }, { "path": ".github/workflows/auto-label.json5", "content": "{\r\n labelsSynonyms: {\r\n 'ci/cd': ['.github', 'Workflow', 'ci/cd'],\r\n dependencies: [\r\n 'dependabot',\r\n 'dependency',\r\n 'dependencies',\r\n 'package',\r\n 'packages',\r\n ],\r\n security: ['security'],\r\n 'ui/ux': ['layout', 'screen', 'design', 'figma'],\r\n },\r\n defaultLabels: ['unapproved'],\r\n}\r\n" }, { "path": ".github/workflows/check-tsdoc.js", "content": "import fs from 'fs/promises'; // Import fs.promises for async operations\nimport path from 'path';\n\n// List of files to skip\nconst filesToSkip = [\n 'index.tsx', \n 'EventActionItems.tsx',\n 'OrgPostCard.tsx',\n 'UsersTableItem.tsx',\n 'FundCampaignPledge.tsx'\n];\n\n// Recursively find all .tsx files, excluding files listed in filesToSkip\nasync function findTsxFiles(dir) {\n let results = [];\n try {\n const list = await fs.readdir(dir);\n for (const file of list) {\n const filePath = path.join(dir, file);\n const stat = await fs.stat(filePath);\n if (stat.isDirectory()) {\n results = results.concat(await findTsxFiles(filePath));\n } else if (\n filePath.endsWith('.tsx') &&\n !filePath.endsWith('.test.tsx') &&\n !filePath.endsWith('.spec.tsx') &&\n !filesToSkip.includes(path.relative(dir, filePath))\n ) {\n results.push(filePath);\n }\n }\n } catch (err) {\n console.error(`Error reading directory ${dir}: ${err.message}`);\n }\n return results;\n}\n\n// Check if a file contains at least one TSDoc comment\nasync function containsTsDocComment(filePath) {\n try {\n const content = await fs.readFile(filePath, 'utf8');\n return /\\/\\*\\*[\\s\\S]*?\\*\\//.test(content);\n } catch (err) {\n console.error(`Error reading file ${filePath}: ${err.message}`);\n return false;\n }\n}\n\n// Main function to run the validation\nasync function run() {\n const dir = process.argv[2] || './src'; // Allow directory path as a command-line argument\n const files = await findTsxFiles(dir);\n const filesWithoutTsDoc = [];\n\n for (const file of files) {\n if (!await containsTsDocComment(file)) {\n filesWithoutTsDoc.push(file);\n }\n }\n\n if (filesWithoutTsDoc.length > 0) {\n filesWithoutTsDoc.forEach(file => {\n console.error(`No TSDoc comment found in file: ${file}`);\n });\n process.exit(1);\n }\n}\n\nrun();" }, { "path": ".github/workflows/codeql-codescan.yml", "content": "##############################################################################\n##############################################################################\n#\n# NOTE!\n#\n# Please read the README.md file in this directory that defines what should\n# be placed in this file\n#\n##############################################################################\n##############################################################################\n\nname: codeql codescan workflow\n\non:\n pull_request:\n branches:\n - '**'\n push:\n branches:\n - '**'\njobs:\n CodeQL:\n if: ${{ github.actor != 'dependabot[bot]' }}\n name: Analyse Code With CodeQL\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n language: ['javascript']\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v4\n with:\n languages: ${{ matrix.language }}\n debug: true\n\n - name: Autobuild\n uses: github/codeql-action/autobuild@v4\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v4\n" }, { "path": ".github/workflows/config/check-pr-issue-skip-usernames.txt", "content": "dependabot\nnoman2002\npalisadoes\n" }, { "path": ".github/workflows/config/countline_excluded_file_list.txt", "content": "src/screens/Auth/LoginPage/LoginPage.tsx\nsrc/GraphQl/Queries/Queries.ts\nsrc/screens/OrgList/OrgList.tsx\nsrc/GraphQl/Mutations/mutations.ts\nsrc/components/EventListCard/EventListCardModals.tsx\nsrc/components/TagActions/TagActionsMocks.tsx\nsrc/utils/interfaces.ts\nsrc/components/OrgPostCard/OrgPostCard.tsx\nsrc/components/UsersTableItem/UsersTableItem.tsx\nsrc/components/UserPortal/ChatRoom/ChatRoom.tsx\nsrc/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.tsx\nsrc/shared-components/ActionItems/ActionItemModal/ActionItemModal.tsx\nsrc/shared-components/postCard/PostCard.tsx" }, { "path": ".github/workflows/config/sensitive_files.txt", "content": ".flake8$\n.pydocstyle$\npyproject.toml$\n.env..*$\nvitest.config.js$\nsrc/App.tsx$\n^.github/.*\n^.coderabbit/.*\n^.husky/.*\n^scripts/.*\n^docker/.*\n^config/.*\n^cypress/.*\n^src/style/.*\n^src/assets/.*\nschema.graphql$\npackage.json$\npackage-lock.json$\ntsconfig.json$\n^.gitignore$\n^env.example$\n.node-version$\n.eslintrc.json$\n.eslintignore$\n.prettierrc$\n.prettierignore$\nvite.config.ts$\n^docker/docker-compose.prod.yaml$\n^docker/docker-compose.dev.yaml$\n^docker/docker-compose.rootless.prod.yaml$\n^docker/docker-compose.rootless.dev.yaml$\n^docker/Dockerfile.dev$\n^docker/Dockerfile.prod$\n^docker/Dockerfile.rootless.prod$\n^docker/Dockerfile.rootless.dev$\n^config/docker/setup/nginx.conf$\n^config/docker/setup/nginx.prod.conf$\nCODEOWNERS$\nLICENSE$\nsetup.ts$\n.coderabbit.yaml$\nCODE_OF_CONDUCT.md$\nCODE_STYLE.md$\nCONTRIBUTING.md$\nDOCUMENTATION.md$\nINSTALLATION.md$\nISSUE_GUIDELINES.md$\nPR_GUIDELINES.md$\nREADME.md$\nindex.html$\n.*.pem$\n.*.key$\n.*.cert$\n.*.password$\n.*.secret$\n.*.credentials$\n.nojekyll$\nyarn.lock$\nknip.json$\nknip.deps.json$\n^docs/docusaurus.config.ts$\n^docs/sidebar..*\nCNAME$\n" }, { "path": ".github/workflows/issue-assigned.yml", "content": "name: Issue Assignment Workflow\n\non:\n issues:\n types: [assigned]\n\njobs:\n issue-assigned:\n uses: PalisadoesFoundation/.github/.github/workflows/issue-assigned.yml@main\n # secrets:\n # ORG_ACCESS_TOKEN: ${{ secrets.ORG_ACCESS_TOKEN }}\n" }, { "path": ".github/workflows/issue-unassigned.yml", "content": "name: Add Unapproved Label on Unassignment\n\non:\n issues:\n types: [unassigned]\n\njobs:\n issue-unassigned:\n uses: PalisadoesFoundation/.github/.github/workflows/issue-unassigned.yml@main\n" }, { "path": ".github/workflows/issue.yml", "content": "name: Issue Workflow\n\non:\n issues:\n types: [opened]\n\njobs:\n issue-workflow:\n uses: PalisadoesFoundation/.github/.github/workflows/issue.yml@main\n" }, { "path": ".github/workflows/pull-request-comment.yml", "content": "name: On PR Open - First Time Contributor Comment\n\non:\n pull_request_target:\n types: [opened]\n\npermissions:\n pull-requests: write\n issues: write\n\njobs:\n call-first-pr-comment:\n uses: PalisadoesFoundation/.github/.github/workflows/pull-request-comment.yml@main\n" }, { "path": ".github/workflows/pull-request-review.yml", "content": "name: Pull Request Review\n\non:\n pull_request_review:\n types: [submitted, edited, dismissed]\n\njobs:\n Check-CodeRabbit-Approval:\n uses: PalisadoesFoundation/.github/.github/workflows/pull-request-review.yml@main\n" }, { "path": ".github/workflows/pull-request-target.yml", "content": "name: PR Target Workflow\n\non:\n pull_request_target:\n\njobs:\n PR-Greeting:\n uses: PalisadoesFoundation/.github/.github/workflows/pull-request-target.yml@main\n # secrets:\n # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/pull-request.yml", "content": "##############################################################################\n##############################################################################\n#\n# NOTE!\n#\n# Please read the README.md file in this directory that defines what should\n# be placed in this file\n#\n##############################################################################\n##############################################################################\n\nname: PR Workflow\n\non:\n pull_request:\n branches:\n - '**'\n\nenv:\n CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}\n\njobs:\n Code-Quality-Checks:\n name: Performs linting, formatting, type-checking, unused file detection, checking for different source and target branch\n runs-on: ubuntu-latest\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # Fetch all history for all branches and tags\n - name: Checkout centralized CI/CD scripts\n uses: actions/checkout@v4\n with:\n repository: PalisadoesFoundation/.github\n ref: main\n path: .github-central\n\n - name: Install pnpm@10.4.1\n uses: pnpm/action-setup@v4\n with:\n version: 10.4.1\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Count number of lines\n run: |\n chmod +x .github-central/.github/workflows/scripts/countline.py\n .github-central/.github/workflows/scripts/countline.py \\\n --lines 600 \\\n --files ./.github/workflows/config/countline_excluded_file_list.txt\n\n - name: Get changed TypeScript files\n id: changed-files\n run: |\n # Get the base branch ref\n BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})\n\n # Get all changed files\n ALL_CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | tr '\\n' ' ')\n echo \"all_changed_files=${ALL_CHANGED_FILES}\" >> $GITHUB_OUTPUT\n\n # Count all changed files\n ALL_CHANGED_FILES_COUNT=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | wc -l | tr -d ' ')\n echo \"all_changed_files_count=$ALL_CHANGED_FILES_COUNT\" >> $GITHUB_OUTPUT\n\n # Check if any files changed\n if [ \"$ALL_CHANGED_FILES_COUNT\" -gt 0 ]; then\n echo \"any_changed=true\" >> $GITHUB_OUTPUT\n else\n echo \"any_changed=false\" >> $GITHUB_OUTPUT\n fi\n # Set only_changed to false by default (adjust logic as needed)\n echo \"only_changed=false\" >> $GITHUB_OUTPUT\n\n - name: Check formatting\n if: steps.changed-files.outputs.only_changed != 'true'\n run: pnpm format:check\n\n - name: Run formatting if check fails\n if: failure()\n run: pnpm format:fix\n\n - name: Check for type errors\n if: steps.changed-files.outputs.only_changed != 'true'\n run: pnpm typecheck\n\n - name: Check for linting errors in modified files\n if: steps.changed-files.outputs.only_changed != 'true'\n env:\n CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}\n run: pnpm exec eslint ${CHANGED_FILES}\n\n - name: Validate design tokens in modified files\n if: steps.changed-files.outputs.any_changed == 'true'\n env:\n CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}\n run: pnpm exec tsx scripts/validate-tokens.ts --files $CHANGED_FILES\n\n - name: Enforce CSS import policy\n if: steps.changed-files.outputs.any_changed == 'true'\n env:\n CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}\n run: pnpm exec tsx scripts/check-css-imports.js --files $CHANGED_FILES\n\n - name: Check for TSDoc comments\n run: pnpm check-tsdoc\n\n - name: Check for localStorage Usage\n run: pnpm exec tsx scripts/githooks/check-localstorage-usage.ts --scan-entire-repo\n\n - name: Check for unused dependencies\n run: pnpm knip --config knip.deps.json --include dependencies\n\n - name: Compare translation files\n run: |\n chmod +x .github/workflows/scripts/compare_translations.py\n python .github/workflows/scripts/compare_translations.py --directory public/locales\n\n - name: Get changed source files\n id: changed-src\n run: |\n BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})\n CHANGED=$(git diff --name-only --diff-filter=ACMRT \"$BASE_SHA\" ${{ github.event.pull_request.head.sha }} \\\n | grep -E '^src/.*\\.(ts|tsx|js|jsx)$' | tr '\\n' ' ' || true)\n echo \"files=$CHANGED\" >> $GITHUB_OUTPUT\n if [ -z \"$CHANGED\" ]; then\n echo \"none=true\" >> $GITHUB_OUTPUT\n else\n echo \"none=false\" >> $GITHUB_OUTPUT\n fi\n\n # Diff-only i18n check to avoid existing legacy violations in untouched lines.\n - name: Check for non-internationalized text (diff only)\n if: steps.changed-src.outputs.none != 'true'\n run: pnpm run check-i18n -- --diff --base ${{ github.event.pull_request.base.sha }} --head ${{ github.event.pull_request.head.sha }} ${{ steps.changed-src.outputs.files }}\n\n - name: Check if the source and target branches are different\n if: ${{ github.event.pull_request.base.ref == github.event.pull_request.head.ref }}\n run: |\n echo \"Source Branch ${{ github.event.pull_request.head.ref }}\"\n echo \"Target Branch ${{ github.event.pull_request.base.ref }}\"\n echo \"Error: Source and Target Branches are the same. Please ensure they are different.\"\n echo \"Error: Close this PR and try again.\"\n exit 1\n\n - name: Check for unused files and exports in src/ and docs/src\n run: pnpm knip --include files,exports,nsExports,nsTypes\n\n - name: Lint shell scripts (ShellCheck)\n shell: bash\n run: |\n shopt -s globstar nullglob\n\n candidates=(\n scripts/**/*.sh\n .husky/pre-commit\n .husky/scripts/**/*.sh\n )\n\n files=()\n for f in \"${candidates[@]}\"; do\n [[ -f \"$f\" ]] && files+=(\"$f\")\n done\n\n if [ ${#files[@]} -eq 0 ]; then\n echo \"No shell scripts found to lint.\"\n else\n shellcheck -S warning \"${files[@]}\"\n fi\n\n CSS-Policy-Check:\n name: CSS Policy Check\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Set up Python\n uses: actions/setup-python@v5\n with:\n python-version: 3.11\n\n - name: Get PR changed files\n run: |\n git diff --name-only --diff-filter=ACMRT \\\n origin/${{ github.base_ref }}...HEAD > pr_files.txt\n\n - name: Run CSS policy enforcement\n run: |\n if [ -s pr_files.txt ]; then\n FILTERED_FILES=$(grep -Ev '^src/(utils|types)/' pr_files.txt || true)\n\n if [ -n \"$FILTERED_FILES\" ]; then\n python .github/workflows/scripts/css_check.py \\\n --files $FILTERED_FILES\n else\n echo \"No relevant files after exclusion\"\n fi\n else\n echo \"No files changed in this PR\"\n fi\n Check-Mock-Isolation:\n name: Check for proper mock cleanup in test files\n needs: [Code-Quality-Checks]\n runs-on: ubuntu-latest\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Check for proper mock cleanup\n run: |\n chmod +x scripts/githooks/check-mock-cleanup.sh\n ./scripts/githooks/check-mock-cleanup.sh\n\n Check-AutoDocs:\n name: Generate and Validate Documentation\n needs: [Code-Quality-Checks]\n uses: PalisadoesFoundation/.github/.github/workflows/typescript-autodocs.yml@main\n Check-Sensitive-Files:\n if: ${{ github.actor != 'dependabot[bot]' }}\n name: Checks if sensitive files have been changed without authorization\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # Fetch all history for all branches and tags\n\n - name: Checkout centralized CI/CD scripts\n uses: actions/checkout@v4\n with:\n repository: PalisadoesFoundation/.github\n ref: main\n path: .github-central\n\n - name: Get PR labels\n id: check-labels\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n run: |\n if [ -z \"${{ github.event.pull_request.number }}\" ]; then\n echo \"skip=false\" >> $GITHUB_OUTPUT\n exit 0\n fi\n\n LABELS=\"$(gh api repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels --jq '.[].name' | tr '\\n' ' ')\"\n\n if echo \"$LABELS\" | grep -qw \"ignore-sensitive-files-pr\"; then\n echo \"::notice::Skipping sensitive files check due to 'ignore-sensitive-files-pr' label.\"\n echo \"skip=true\" >> $GITHUB_OUTPUT\n else\n echo \"skip=false\" >> $GITHUB_OUTPUT\n fi\n\n - name: Set up Python\n if: steps.check-labels.outputs.skip != 'true'\n uses: actions/setup-python@v5\n with:\n python-version: 3.11\n\n - name: Get Changed Unauthorized files\n if: steps.check-labels.outputs.skip != 'true'\n id: changed-unauth-files\n run: |\n\n # Skip if not in PR context\n if [ -z \"${{ github.event.pull_request.base.sha }}\" ]; then\n echo \"any_changed=false\" >> $GITHUB_OUTPUT\n exit 0\n fi\n\n # Determine base and head commits for comparison\n HEAD_SHA=\"${{ github.event.pull_request.head.sha || github.sha }}\"\n BASE_SHA=$(git merge-base \"${{ github.event.pull_request.base.sha }}\" \"$HEAD_SHA\")\n\n # Get all changed files between base and head\n mapfile -d '' ALL_CHANGED_FILES < <(git diff --name-only -z --diff-filter=ACMR \"$BASE_SHA\" \"$HEAD_SHA\")\n\n # Check for sensitive files using the python script\n if [ ${#ALL_CHANGED_FILES[@]} -gt 0 ]; then\n chmod +x .github-central/.github/workflows/scripts/sensitive_file_check.py\n .github-central/.github/workflows/scripts/sensitive_file_check.py --config .github/workflows/config/sensitive_files.txt --files \"${ALL_CHANGED_FILES[@]}\"\n fi\n\n Count-Changed-Files:\n uses: PalisadoesFoundation/.github/.github/workflows/count-changed-files.yml@main\n\n Check-Disable-Statements:\n name: Check for disable statements (eslint-disable, istanbul-ignore, it.skip)\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Checkout centralized scripts\n uses: actions/checkout@v4\n with:\n repository: PalisadoesFoundation/.github\n path: .github-central\n ref: main\n\n - name: Get changed files\n id: changed-files\n run: |\n echo \"all_changed_files=$(git diff --name-only --diff-filter=ACMRT ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} | tr '\\n' ' ')\" >> $GITHUB_OUTPUT\n\n - name: Set up Python\n uses: actions/setup-python@v5\n with:\n python-version: 3.11\n\n - name: Run Disable Statements Check\n run: |\n python .github-central/.github/workflows/scripts/disable_statements_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}\n\n Translation-Tag-Check:\n name: Translation Tag Check\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - name: Set up Python 3.11\n uses: actions/setup-python@v5\n with:\n python-version: 3.11\n - name: Install dependencies\n run: pip install -r .github/workflows/requirements.txt\n - name: Run Translation Checker\n run: |\n BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})\n CHANGED_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | grep -E '\\.(ts|tsx|js|jsx)$' | grep -v \"scripts/__fixtures__\" || true)\n\n if [ -n \"$CHANGED_FILES\" ]; then\n python3 .github/workflows/scripts/translation_check.py --files $CHANGED_FILES\n else\n echo \"No relevant files changed, skipping check.\"\n fi\n\n MinIO-Compliance-Check:\n if: ${{ github.actor != 'dependabot[bot]' }}\n name: MinIO Compliance Check\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Get changed source files\n id: changed-src\n run: |\n BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})\n CHANGED=$(git diff --name-only --diff-filter=ACMRT \"$BASE_SHA\" ${{ github.event.pull_request.head.sha }} \\\n | grep -E '^src/.*\\.(ts|tsx|js|jsx)$' | tr '\\n' ' ' || true)\n echo \"files=$CHANGED\" >> $GITHUB_OUTPUT\n if [ -z \"$CHANGED\" ]; then\n echo \"none=true\" >> $GITHUB_OUTPUT\n else\n echo \"none=false\" >> $GITHUB_OUTPUT\n fi\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n\n - name: Run MinIO compliance check\n if: steps.changed-src.outputs.none != 'true'\n run: node .github/workflows/scripts/check-minio-compliance.cjs\n\n Pre-Test-Checks-Pass:\n name: All Pre-Testing Checks Pass\n runs-on: ubuntu-latest\n needs:\n [\n Code-Quality-Checks,\n Check-AutoDocs,\n Check-Disable-Statements,\n Check-Route-Prefix,\n Check-Mock-Isolation,\n CSS-Policy-Check,\n MinIO-Compliance-Check,\n Python-Compliance,\n Translation-Tag-Check,\n ]\n steps:\n - name: This job intentionally does nothing\n run: echo \"This job intentionally does nothing\"\n\n Check-Route-Prefix:\n name: Check Route Prefix\n needs: [Code-Quality-Checks]\n runs-on: ubuntu-latest\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Run route prefix check script\n env:\n CI: true\n run: npm run check-route-prefix -- --scan-entire-repo\n\n Test-Application:\n name: Test Application (Shard ${{ matrix.shard }})\n timeout-minutes: 10\n runs-on: ubuntu-latest\n needs: [Pre-Test-Checks-Pass]\n env:\n TOTAL_SHARDS: 12\n strategy:\n fail-fast: false\n matrix:\n shard: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Get changed TypeScript files\n id: changed-files\n run: |\n # Get the base branch ref\n BASE_SHA=$(git merge-base ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }})\n\n # Check if any files changed\n ANY_CHANGED=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | wc -l)\n if [ \"$ANY_CHANGED\" -gt 0 ]; then\n echo \"any_changed=true\" >> $GITHUB_OUTPUT\n else\n echo \"any_changed=false\" >> $GITHUB_OUTPUT\n fi\n\n # Get all changed files\n ALL_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | tr '\\n' ' ')\n echo \"all_files=$ALL_FILES\" >> $GITHUB_OUTPUT\n\n # Get TypeScript files specifically\n TS_FILES=$(git diff --name-only --diff-filter=ACMRT $BASE_SHA ${{ github.event.pull_request.head.sha }} | grep -E '\\.tsx?$' | tr '\\n' ' ')\n echo \"ts_files=$TS_FILES\" >> $GITHUB_OUTPUT\n\n - name: TypeScript compilation\n run: pnpm exec tsc --noEmit\n\n - name: Run Vitest Tests (Shard ${{ matrix.shard }}/${{ env.TOTAL_SHARDS }})\n if: steps.changed-files.outputs.any_changed == 'true'\n env:\n NODE_V8_COVERAGE: './coverage/vitest'\n NODE_OPTIONS: '--max-old-space-size=4096 --disable-warning=ExperimentalWarning'\n SHARD_INDEX: ${{ matrix.shard }}\n SHARD_COUNT: ${{ env.TOTAL_SHARDS }}\n CI: true\n run: pnpm test:shard:coverage\n - name: Upload coverage artifact\n if: always() && steps.changed-files.outputs.any_changed == 'true'\n uses: actions/upload-artifact@v4\n with:\n name: coverage-shard-${{ matrix.shard }}\n path: ./coverage/vitest/\n retention-days: 1\n\n Merge-Coverage:\n name: Merge Coverage Reports\n runs-on: ubuntu-latest\n needs: [Test-Application]\n if: success()\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # Fetch all history for Codecov to calculate patch coverage\n\n - name: Fetch base branch for Codecov comparison\n run: |\n git fetch origin ${{ github.base_ref }}\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n - name: Download all coverage artifacts\n id: download-artifacts\n continue-on-error: true\n uses: actions/download-artifact@v4\n with:\n pattern: coverage-shard-*\n path: ./coverage-shards/\n merge-multiple: false\n\n - name: Check if artifacts were downloaded\n id: check-artifacts\n run: |\n # Check if any coverage files exist\n if find coverage-shards -name \"lcov.info\" -type f | grep -q .; then\n echo \"artifacts_found=true\" >> $GITHUB_OUTPUT\n echo \"Coverage artifacts found\"\n else\n echo \"artifacts_found=false\" >> $GITHUB_OUTPUT\n echo \"No coverage artifacts found - tests may have been skipped\"\n fi\n\n - name: Merge coverage reports\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n run: |\n mkdir -p ./coverage/vitest\n mkdir -p ./coverage/tmp\n\n # Find all coverage directories from shards\n echo \"Finding coverage data from shards...\"\n SHARD_DIRS=$(find coverage-shards -type d -name \"coverage-shard-*\" 2>/dev/null || true)\n\n if [ -z \"$SHARD_DIRS\" ]; then\n echo \"ERROR: No shard directories found!\"\n ls -la coverage-shards/ || true\n exit 1\n fi\n\n echo \"Found shard directories:\"\n echo \"$SHARD_DIRS\"\n\n # Check if we have JSON coverage files (better for merging)\n JSON_FILES=$(find coverage-shards -name \"coverage-final.json\" -type f 2>/dev/null || true)\n\n if [ -n \"$JSON_FILES\" ]; then\n echo \"Using JSON coverage files for accurate merging...\"\n \n # Copy all JSON files to a temp directory for nyc merge\n for shard_dir in coverage-shards/coverage-shard-*/; do\n if [ -f \"${shard_dir}coverage-final.json\" ]; then\n echo \"Found JSON coverage in: $shard_dir\"\n cp \"${shard_dir}coverage-final.json\" \"./coverage/tmp/coverage-shard-$(basename $shard_dir).json\"\n fi\n done\n \n # Validate JSON files before merging\n echo \"Validating JSON coverage files...\"\n JSON_COUNT=$(find ./coverage/tmp -name \"*.json\" -type f | wc -l)\n echo \"Found $JSON_COUNT JSON files to merge\"\n if [ \"$JSON_COUNT\" -eq 0 ]; then\n echo \"ERROR: No JSON coverage files found!\"\n exit 1\n fi\n \n # Show sample of file count in each JSON\n for json_file in ./coverage/tmp/*.json; do\n FILE_COUNT=$(jq 'keys | length' \"$json_file\" 2>/dev/null || echo \"0\")\n echo \" $(basename $json_file): $FILE_COUNT files\"\n done\n # Merge using nyc (more accurate than lcov merge)\n echo \"Merging coverage with nyc...\"\n\n pnpm exec nyc merge ./coverage/tmp ./.nyc_output/coverage-final.json\n # Validate merged JSON\n MERGED_FILE_COUNT=$(jq 'keys | length' ./.nyc_output/coverage-final.json 2>/dev/null || echo \"0\")\n echo \"Merged coverage contains $MERGED_FILE_COUNT files\"\n else\n echo \"ERROR: No JSON coverage files found! We expect coverage-final.json from shards.\"\n exit 1\n fi\n - name: Validate merged coverage integrity\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n run: |\n echo \"Validating merged coverage JSON...\"\n if [ ! -f ./.nyc_output/coverage-final.json ]; then\n echo \"ERROR: Merged coverage JSON not found at ./.nyc_output/coverage-final.json\"\n exit 1\n fi\n\n MERGED_FILE_COUNT=$(jq 'keys | length' ./.nyc_output/coverage-final.json 2>/dev/null || echo \"0\")\n echo \"Merged coverage contains $MERGED_FILE_COUNT files\"\n\n if [ \"$MERGED_FILE_COUNT\" -eq 0 ]; then\n echo \"ERROR: Merged coverage JSON is empty!\"\n exit 1\n fi\n\n # Generate lcov from merged JSON\n - name: Generate lcov report\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n run: |\n echo \"Generating lcov report from merged coverage...\"\n pnpm exec nyc report --reporter=lcov --report-dir=./coverage/vitest\n\n - name: Analyze lcov structure\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n run: |\n echo \"Analyzing lcov.info structure...\"\n LCOV_FILE=\"./coverage/vitest/lcov.info\"\n\n if [ ! -s \"$LCOV_FILE\" ]; then\n echo \"ERROR: lcov.info is empty or missing\"\n exit 1\n fi\n\n # Check source paths\n echo \"Checking source paths in lcov file (first 10 unique paths):\"\n grep \"^SF:\" \"$LCOV_FILE\" | head -10\n\n # Check for absolute vs relative paths\n if grep -q \"^SF:/\" \"$LCOV_FILE\"; then\n echo \"WARNING: Found absolute paths in lcov file. This might confuse Codecov.\"\n grep \"^SF:/\" \"$LCOV_FILE\" | head -5\n else\n echo \"Good: All source paths appear to be relative.\"\n fi\n\n # Count total source files\n SF_COUNT=$(grep -c \"^SF:\" \"$LCOV_FILE\" || echo \"0\")\n echo \"Total source files in lcov: $SF_COUNT\"\n\n - name: Clean up individual shard coverage files\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n run: |\n echo \"Cleaning up individual shard coverage files...\"\n # Remove all individual coverage JSON files to prevent Codecov from finding them\n # This ensures only the merged lcov.info is uploaded\n find ./coverage -name \"coverage-*.json\" -type f -delete\n find ./coverage -name \"coverage-final.json\" -type f -delete\n rm -rf ./coverage/tmp ./.nyc_output 2>/dev/null || true\n\n echo \"Cleanup complete. Remaining coverage files:\"\n find ./coverage -type f \\( -name \"*.info\" -o -name \"*.json\" \\)\n\n echo \"\"\n echo \"Final coverage file to upload:\"\n ls -lh ./coverage/vitest/lcov.info\n\n - name: Calculate merge base for Codecov\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n id: get-merge-base\n run: |\n # Calculate the merge base\n MERGE_BASE=$(git merge-base origin/${{ github.base_ref }} HEAD)\n echo \"Merge base commit: $MERGE_BASE\"\n echo \"merge_base=$MERGE_BASE\" >> $GITHUB_OUTPUT\n\n # Verify the commit exists\n git show -s --format=%ci $MERGE_BASE\n\n - name: Present and upload merged coverage to Codecov\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n uses: codecov/codecov-action@v5\n with:\n name: '${{env.CODECOV_UNIQUE_NAME}}-merged'\n token: ${{ secrets.CODECOV_TOKEN }}\n # Using fail_ci_if_error: true to match develop branch behavior\n # This is safe now because we validate the merged file is non-empty above\n fail_ci_if_error: true\n verbose: true\n exclude: 'docs/'\n gcov_ignore: 'docs/'\n files: ./coverage/vitest/lcov.info\n flags: vitest\n commit_parent: ${{ steps.get-merge-base.outputs.merge_base }}\n\n - name: Test acceptable level of code coverage\n if: steps.check-artifacts.outputs.artifacts_found == 'true'\n uses: VeryGoodOpenSource/very_good_coverage@v3\n with:\n path: './coverage/vitest/lcov.info'\n min_coverage: 95.0\n\n # Graphql-Inspector:\n # if: ${{ github.actor != 'dependabot[bot]' }}\n # name: Runs Introspection on the GitHub talawa-api repo on the schema.graphql file\n # runs-on: ubuntu-latest\n # steps:\n # - name: Checkout the Repository\n # uses: actions/checkout@v4\n\n # - name: Set up Node.js\n # uses: actions/setup-node@v4\n # with:\n # node-version: '24.x'\n\n # - name: resolve dependency\n # run: npm install -g @graphql-inspector/cli\n\n # - name: Clone API Repository\n # run: |\n # # Retrieve the complete branch name directly from the GitHub context\n # FULL_BRANCH_NAME=${{ github.base_ref }}\n # echo \"FULL_Branch_NAME: $FULL_BRANCH_NAME\"\n\n # # Clone the specified repository using the extracted branch name\n # git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a\n\n # - name: Validate Documents\n # run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'\n\n Start-App-Without-Docker:\n name: Check if Talawa Admin app starts (No Docker)\n runs-on: ubuntu-latest\n needs: [Merge-Coverage]\n if: github.actor != 'dependabot'\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n\n - name: Install Dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Build Production App\n run: pnpm run build\n\n - name: Start Production App\n run: |\n pnpm run preview &\n echo $! > .pidfile_prod\n - name: Check if Production App is running\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4173 120\n - name: Stop Production App\n run: |\n if [ -f .pidfile_prod ]; then\n kill \"$(cat .pidfile_prod)\"\n fi\n - name: Start Development App\n run: |\n pnpm run serve &\n echo $! > .pidfile_dev\n - name: Check if Development App is running\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120\n - name: Stop Development App\n if: always()\n run: |\n if [ -f .pidfile_dev ]; then\n kill \"$(cat .pidfile_dev)\"\n fi\n\n Start-App-Using-Docker:\n name: Check if Talawa Admin app starts in Docker\n runs-on: ubuntu-latest\n needs: [Merge-Coverage]\n if: github.actor != 'dependabot[bot]'\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Generate `.env` File with Hardcoded Values\n run: |\n cat < .env\n PORT=4321\n REACT_APP_TALAWA_URL=http://localhost:4000/graphql\n REACT_APP_USE_RECAPTCHA=\n REACT_APP_RECAPTCHA_SITE_KEY=\n ALLOW_LOGS=NO\n USE_DOCKER=YES\n DOCKER_MODE=ROOTFUL\n DOCKER_PORT=4321\n EOF\n\n - name: Set up Docker\n uses: docker/setup-buildx-action@v3\n with:\n driver-opts: |\n image=moby/buildkit:latest\n\n - name: Build Docker images\n run: |\n set -e\n export PNPM_VERSION=\"${PNPM_VERSION:-10.4.1}\"\n echo \"Building Docker images...\"\n docker compose -f docker/docker-compose.prod.yaml build\n docker compose -f docker/docker-compose.dev.yaml build\n echo \"Docker images built successfully\"\n\n - name: Run Docker Containers (Production)\n run: |\n set -e\n echo \"Starting Docker container for production...\"\n docker compose -f docker/docker-compose.prod.yaml up -d\n echo \"Production Docker container started successfully\"\n\n - name: Check if Talawa Admin App is running (Production)\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120 true\n\n - name: Stop prod Docker Containers\n if: always()\n run: |\n docker compose -f docker/docker-compose.prod.yaml down\n echo \"Prod Docker container stopped and removed\"\n\n - name: Run Docker Containers (Development)\n run: |\n set -e\n echo \"Starting Docker container for development...\"\n docker compose -f docker/docker-compose.dev.yaml up -d\n echo \"Development Docker container started successfully\"\n\n - name: Check if Talawa Admin App is running (Development)\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120 true\n\n - name: Stop dev Docker Containers\n if: always()\n run: |\n docker compose -f docker/docker-compose.dev.yaml down\n echo \"Dev Docker containers stopped and removed\"\n\n Start-App-Using-Docker-Rootless:\n name: Check if Talawa Admin app starts in Docker (Rootless)\n runs-on: ubuntu-latest\n needs: [Merge-Coverage]\n if: github.actor != 'dependabot[bot]'\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Generate `.env` File with Hardcoded Values\n run: |\n cat > .env <<'EOF'\n PORT=4321\n REACT_APP_TALAWA_URL=http://localhost:4000/graphql\n REACT_APP_USE_RECAPTCHA=\n REACT_APP_RECAPTCHA_SITE_KEY=\n ALLOW_LOGS=NO\n USE_DOCKER=YES\n DOCKER_MODE=ROOTLESS\n DOCKER_PORT=4321\n EOF\n\n - name: Install rootless prerequisites\n run: |\n set -euxo pipefail\n sudo apt-get update\n sudo apt-get install -y uidmap dbus-user-session slirp4netns fuse-overlayfs ca-certificates curl gnupg\n\n if ! command -v dockerd-rootless-setuptool.sh >/dev/null 2>&1; then\n sudo install -m 0755 -d /etc/apt/keyrings\n if [ ! -f /etc/apt/keyrings/docker.gpg ]; then\n curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg\n sudo chmod a+r /etc/apt/keyrings/docker.gpg\n fi\n\n echo \\\n \"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \\\n $(. /etc/os-release && echo \"$VERSION_CODENAME\") stable\" | \\\n sudo tee /etc/apt/sources.list.d/docker.list > /dev/null\n\n sudo apt-get update\n sudo apt-get install -y docker-ce-rootless-extras\n fi\n\n - name: Start rootless Docker daemon\n run: |\n set -euxo pipefail\n export XDG_RUNTIME_DIR=\"/run/user/$UID\"\n sudo mkdir -p \"$XDG_RUNTIME_DIR\"\n sudo chown \"$USER\":\"$USER\" \"$XDG_RUNTIME_DIR\"\n\n if [ ! -f \"$HOME/.config/systemd/user/docker.service\" ]; then\n dockerd-rootless-setuptool.sh install --force\n fi\n\n systemctl --user daemon-reload || true\n systemctl --user start docker || true\n\n if ! systemctl --user --no-pager status docker >/dev/null 2>&1; then\n nohup dockerd-rootless.sh > \"$RUNNER_TEMP/dockerd-rootless.log\" 2>&1 &\n fi\n\n chmod +x scripts/docker/resolve-docker-host.sh\n eval \"$(./scripts/docker/resolve-docker-host.sh --mode rootless --emit-export --warn-if-docker-group)\"\n echo \"DOCKER_HOST=$DOCKER_HOST\" >> \"$GITHUB_ENV\"\n echo \"XDG_RUNTIME_DIR=$XDG_RUNTIME_DIR\" >> \"$GITHUB_ENV\"\n echo \"$HOME/bin\" >> \"$GITHUB_PATH\"\n\n - name: Verify rootless daemon\n run: |\n set -euxo pipefail\n chmod +x scripts/docker/resolve-docker-host.sh\n eval \"$(./scripts/docker/resolve-docker-host.sh --mode rootless --emit-export --warn-if-docker-group)\"\n\n TIMEOUT=60\n until docker info >/dev/null 2>&1 || [ \"$TIMEOUT\" -le 0 ]; do\n sleep 2\n TIMEOUT=$((TIMEOUT - 2))\n done\n\n if ! docker info >/dev/null 2>&1; then\n echo \"Rootless Docker daemon did not start in time.\"\n if [ -f \"$RUNNER_TEMP/dockerd-rootless.log\" ]; then\n tail -n 200 \"$RUNNER_TEMP/dockerd-rootless.log\"\n fi\n exit 1\n fi\n\n docker info\n docker info --format '{{json .SecurityOptions}}' | tee \"$RUNNER_TEMP/rootless-security-options.json\"\n grep -qi rootless \"$RUNNER_TEMP/rootless-security-options.json\"\n\n - name: Build Docker images (Rootless)\n run: |\n set -e\n export PNPM_VERSION=\"${PNPM_VERSION:-10.4.1}\"\n export UID\n export GID=\"$(id -g)\"\n echo \"Building rootless Docker images...\"\n docker compose -f docker/docker-compose.rootless.prod.yaml build\n docker compose -f docker/docker-compose.rootless.dev.yaml build\n echo \"Rootless Docker images built successfully\"\n\n - name: Run Docker Containers (Rootless Production)\n run: |\n set -e\n export UID\n export GID=\"$(id -g)\"\n echo \"Starting rootless Docker container for production...\"\n docker compose -f docker/docker-compose.rootless.prod.yaml up -d\n echo \"Rootless production Docker container started successfully\"\n\n - name: Check if Talawa Admin App is running (Rootless Production)\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120 true\n\n - name: Stop rootless prod Docker Containers\n if: always()\n run: |\n export UID\n export GID=\"$(id -g)\"\n docker compose -f docker/docker-compose.rootless.prod.yaml down\n echo \"Rootless prod Docker container stopped and removed\"\n\n - name: Run Docker Containers (Rootless Development)\n run: |\n set -e\n export UID\n export GID=\"$(id -g)\"\n echo \"Starting rootless Docker container for development...\"\n docker compose -f docker/docker-compose.rootless.dev.yaml up -d\n echo \"Rootless development Docker container started successfully\"\n\n - name: Check if Talawa Admin App is running (Rootless Development)\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120 true\n\n - name: Stop rootless dev Docker Containers\n if: always()\n run: |\n export UID\n export GID=\"$(id -g)\"\n docker compose -f docker/docker-compose.rootless.dev.yaml down\n echo \"Rootless dev Docker containers stopped and removed\"\n\n - name: Print rootless daemon logs on failure\n if: failure()\n run: |\n if [ -f \"$RUNNER_TEMP/dockerd-rootless.log\" ]; then\n tail -n 200 \"$RUNNER_TEMP/dockerd-rootless.log\"\n fi\n\n Test-Docusaurus-Deployment:\n name: Test Deployment to https://docs-admin.talawa.io\n runs-on: ubuntu-latest\n needs: [Merge-Coverage]\n # Run only if the develop branch and not dependabot\n if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop' }}\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n working-directory: ./docs\n run: |\n if [ -f pnpm-lock.yaml ]; then\n echo \"pnpm-lock.yaml found — running pnpm fetch\"\n pnpm fetch\n else\n echo \"No pnpm-lock.yaml found — running pnpm install to generate it\"\n pnpm install --frozen-lockfile=false\n fi\n\n - name: Install dependencies (allow lockfile creation)\n working-directory: ./docs\n run: |\n if [ -f pnpm-lock.yaml ]; then\n pnpm install --frozen-lockfile --prefer-offline\n else\n echo \"pnpm-lock.yaml not found — installing without --frozen-lockfile\"\n pnpm install --prefer-offline\n fi\n - name: Test building the website\n working-directory: ./docs\n run: pnpm run build\n\n Check-Target-Branch:\n if: ${{ github.actor != 'dependabot[bot]' }}\n name: Check Target Branch\n runs-on: ubuntu-latest\n steps:\n - name: Check if the target branch is develop\n if: github.event.pull_request.base.ref != 'develop'\n run: |\n echo \"Error: Pull request target branch must be 'develop'. Please refer PR_GUIDELINES.md\"\n echo \"Error: Close this PR and try again.\"\n exit 1\n\n Python-Compliance:\n name: Check Python Code Style\n runs-on: ubuntu-latest\n steps:\n - name: Checkout\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - name: Checkout centralized CI/CD scripts\n uses: actions/checkout@v4\n with:\n repository: PalisadoesFoundation/.github\n ref: main\n path: .github-central\n\n - name: Set up Python 3.11\n uses: actions/setup-python@v4\n with:\n python-version: 3.11\n\n - name: Cache pip packages\n uses: actions/cache@v4\n with:\n path: ~/.cache/pip\n key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}\n restore-keys: |\n ${{ runner.os }}-pip-\n\n - name: Install dependencies\n run: |\n python3 -m venv venv\n source venv/bin/activate\n python -m pip install --upgrade pip\n pip install -r .github/workflows/requirements.txt\n - name: Run Python tests for scripts\n run: |\n source venv/bin/activate\n pytest .github/workflows/scripts/test\n\n - name: Run Black Formatter Check\n run: |\n source venv/bin/activate\n black --check .\n\n - name: Run Flake8 Linter\n run: |\n source venv/bin/activate\n flake8 --docstring-convention google --ignore E402,E722,E203,F401,W503 .github\n\n - name: Run pydocstyle\n run: |\n source venv/bin/activate\n pydocstyle --convention=google --add-ignore=D415,D205 .github\n\n - name: Run docstring compliance check\n run: |\n source venv/bin/activate\n python .github-central/.github/workflows/scripts/check_docstrings.py \\\n --directories .github\n\n Test-Application-E2E:\n timeout-minutes: 35\n runs-on: ubuntu-latest\n needs: [Merge-Coverage]\n env:\n REACT_APP_TALAWA_URL: http://127.0.0.1:4000/graphql\n steps:\n - name: Checkout Backend\n uses: actions/checkout@v4\n with:\n repository: palisadoesFoundation/talawa-api\n ref: develop\n\n - name: Setup Devcontainer\n run: |\n npm install -g @devcontainers/cli\n cp envFiles/.env.devcontainer .env\n devcontainer up --workspace-folder . --config .devcontainer/default/devcontainer.json\n echo \"Devcontainer started\"\n\n - name: Wait for Postgres in devcontainer before migrations\n run: |\n set -euo pipefail\n POSTGRES_USER=postgres\n echo \"Waiting for Postgres service via compose...\"\n TIMEOUT=90\n until docker compose exec -T postgres pg_isready -h localhost -p 5432 -U \"$POSTGRES_USER\" >/dev/null 2>&1 || [ \"$TIMEOUT\" -le 0 ]; do\n echo \"Postgres not ready ($TIMEOUT s left)\"\n sleep 1\n TIMEOUT=$((TIMEOUT - 1))\n done\n if [ \"$TIMEOUT\" -le 0 ]; then\n echo \"Error: Postgres failed to start\"\n docker compose ps\n docker compose logs postgres --tail 100\n exit 1\n fi\n\n - name: Apply Database Migrations\n run: |\n docker exec talawa-api-1 /bin/bash -c 'pnpm apply_drizzle_migrations'\n\n - name: Start Backend Server\n run: |\n docker exec -d talawa-api-1 /bin/bash -c 'pnpm run start_development_server'\n\n - name: Wait for backend to be ready\n run: |\n set -euo pipefail\n echo \"Waiting for backend at http://localhost:4000/healthcheck\"\n\n TIMEOUT=60\n INTERVAL=3\n ELAPSED=0\n\n until docker exec talawa-api-1 curl -sf http://localhost:4000/healthcheck > /dev/null; do\n if [ \"$ELAPSED\" -ge \"$TIMEOUT\" ]; then\n echo \"Backend failed to start within ${TIMEOUT}s\"\n echo \"=== Backend container logs ===\"\n docker logs talawa-api-1 --tail 100\n exit 1\n fi\n echo \"Backend not ready yet... (waited ${ELAPSED}s)\"\n sleep $INTERVAL\n ELAPSED=$((ELAPSED + INTERVAL))\n done\n\n echo \"Backend is up and responding\"\n\n - name: Wait for GraphQL endpoint to be ready\n if: success()\n run: |\n set -euo pipefail\n echo \"Waiting for GraphQL endpoint at http://localhost:4000/graphql\"\n\n TIMEOUT=60\n INTERVAL=3\n ELAPSED=0\n\n until docker exec talawa-api-1 curl -sf -X POST \\\n http://localhost:4000/graphql \\\n -H \"Content-Type: application/json\" \\\n -d '{\"query\":\"{ __typename }\"}' | grep -q \"__typename\"; do\n\n if [ \"$ELAPSED\" -ge \"$TIMEOUT\" ]; then\n echo \"GraphQL endpoint failed to become ready within ${TIMEOUT}s\"\n echo \"=== Backend container logs ===\"\n docker logs talawa-api-1 --tail 100\n exit 1\n fi\n\n echo \"GraphQL endpoint not ready yet... (waited ${ELAPSED}s)\"\n sleep $INTERVAL\n ELAPSED=$((ELAPSED + INTERVAL))\n done\n\n echo \"GraphQL endpoint is up and responding\"\n\n - name: Seed Sample Data\n run: |\n echo \"=== Seeding Sample Data ===\"\n if docker exec talawa-api-1 /bin/bash -c 'set -a; source ./.env; set +a; pnpm run add:sample_data'; then\n echo \"Seeding completed successfully\"\n else\n echo \"Seeding failed - Debug Information:\"\n echo \"Container status:\"\n docker ps | grep talawa\n echo \"Recent container logs:\"\n docker logs talawa-api-1 --tail 50\n echo \"=== Users table contents ===\"\n docker exec talawa-postgres-1 psql -U talawa -d talawa \\\n -c \"SELECT id, email_address, name, role FROM users;\" 2>/dev/null || echo \"Could not query users\"\n exit 1\n fi\n\n - name: Checkout Frontend\n uses: actions/checkout@v4\n with:\n path: frontend\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n working-directory: frontend\n run: pnpm fetch\n\n - name: Install Frontend Dependencies (frozen)\n working-directory: frontend\n run: pnpm install --frozen-lockfile --prefer-offline\n - name: Ensure Cypress binary is installed\n working-directory: frontend\n run: pnpm exec cypress install\n\n - name: Setup .env\n working-directory: frontend\n run: |\n pwd && cp .env.example .env\n echo $REACT_APP_TALAWA_URL\n curl -s -X POST http://127.0.0.1:4000/graphql \\\n -H \"Content-Type: application/json\" \\\n -d '{\"query\":\"{__typename}\"}' 2>/dev/null\n\n - name: Run Cypress Tests with Dev Server\n uses: cypress-io/github-action@v6\n with:\n working-directory: frontend\n start: pnpm run serve\n wait-on: 'http://localhost:4321'\n wait-on-timeout: 120\n config-file: cypress.config.ts\n install: false\n env:\n CYPRESS_BASE_URL: http://localhost:4321\n CYPRESS_API_URL: http://127.0.0.1:4000/graphql\n\n # Best-effort artifact upload: continue even if upload fails due to\n # transient GitHub Actions infrastructure issues. The test result\n # should not be affected by artifact upload service hiccups.\n - name: Upload cypress screenshots on failure\n id: upload-screenshots\n uses: actions/upload-artifact@v4\n if: failure()\n continue-on-error: true\n with:\n name: cypress-screenshots\n path: frontend/cypress/screenshots\n compression-level: 9\n retention-days: 7\n\n - name: Log artifact upload status\n if: always() && steps.upload-screenshots.outcome == 'failure'\n run: |\n echo \"⚠️ Warning: Screenshot upload failed due to infrastructure issue\"\n echo \"This does not indicate a test failure - check test results above\"\n\n ZAP-Security-Scan:\n name: ZAP Security Scan\n runs-on: ubuntu-latest\n needs:\n [\n Test-Application,\n Test-Application-E2E,\n Start-App-Without-Docker,\n Start-App-Using-Docker,\n Start-App-Using-Docker-Rootless,\n ]\n permissions:\n contents: read\n steps:\n - name: Checkout the Repository\n uses: actions/checkout@v4\n\n - name: Install pnpm\n uses: pnpm/action-setup@v4\n with:\n run_install: false\n\n - name: Set up Node.js\n uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n\n - name: Install Dependencies (frozen)\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Start Application\n run: |\n pnpm run serve &\n echo $! > .pidfile_dev\n\n - name: Check if Development App is running\n run: |\n chmod +x .github/workflows/scripts/app_health_check.sh\n .github/workflows/scripts/app_health_check.sh 4321 120\n\n - name: ZAP Scan\n uses: zaproxy/action-full-scan@v0.12.0\n with:\n target: 'http://localhost:4321'\n allow_issue_writing: false\n\n - name: Upload ZAP Report\n if: always()\n uses: actions/upload-artifact@v4\n with:\n name: zap-scan-report\n path: report_html.html\n\n - name: Stop Development App\n if: always()\n run: |\n if [ -f .pidfile_dev ]; then\n kill \"$(cat .pidfile_dev)\"\n fi\n" }, { "path": ".github/workflows/push-deploy-website.yml", "content": "##############################################################################\n##############################################################################\n#\n# NOTE!\n#\n# Please read the README.md file in this directory that defines what should\n# be placed in this file\n#\n##############################################################################\n##############################################################################\n\nname: PUSH Workflow - Website Deployment\n\non:\n push:\n branches:\n - 'develop'\n paths:\n - docs/**\n\nenv:\n CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}\n\njobs:\n Deploy-Docusaurus:\n name: Deploy https://docs-admin.talawa.io website\n runs-on: ubuntu-latest\n # Run only if the develop branch and not dependabot\n if: ${{ github.actor != 'dependabot[bot]' }}\n environment:\n # This \"name\" has to be the repos' branch that contains\n # the current active website. There must be an entry for\n # the same branch in the PalisadoesFoundation's\n # \"Code and automation > Environments > github-pages\"\n # menu. The branch \"name\" must match the branch in the\n # \"on.push.branches\" section at the top of this file\n name: develop\n url: https://docs-admin.talawa.io\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n\n - uses: pnpm/action-setup@v4\n with:\n version: 10.4.1\n\n - name: Cache pnpm store\n uses: actions/cache@v4\n id: pnpm-cache\n with:\n path: ~/.pnpm-store\n key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}\n restore-keys: |\n ${{ runner.os }}-pnpm-\n\n - uses: webfactory/ssh-agent@v0.9.0\n with:\n ssh-private-key: ${{ secrets.DEPLOY_GITHUB_PAGES }}\n - name: Deploy to GitHub Pages\n env:\n USE_SSH: true\n GIT_USER: git\n working-directory: ./docs\n run: |\n git config --global user.email \"actions@github.com\"\n git config --global user.name \"gh-actions\"\n pnpm install\n pnpm run deploy\n" }, { "path": ".github/workflows/push.yml", "content": "##############################################################################\n##############################################################################\n#\n# NOTE!\n#\n# Please read the README.md file in this directory that defines what should\n# be placed in this file\n#\n##############################################################################\n##############################################################################\n\nname: PUSH Workflow - All Branches\n\non:\n push:\n branches:\n - '**'\n\nenv:\n CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}\n\njobs:\n Merge-Conflict-Check:\n runs-on: ubuntu-latest\n name: Find merge conflicts\n steps:\n - uses: actions/checkout@v4\n - name: Merge conflict finder\n uses: olivernybroe/action-conflict-finder@v4.1\n\n Check-Route-Prefix:\n name: Check Route Prefix\n needs: [Merge-Conflict-Check]\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v4\n with:\n version: 10.4.1\n run_install: false\n - uses: actions/setup-node@v4\n with:\n node-version: '24.x'\n cache: 'pnpm'\n\n - name: Prepare dependency store\n run: pnpm fetch\n - name: Install dependencies\n run: pnpm install --frozen-lockfile --prefer-offline\n\n - name: Run route prefix check\n env:\n CI: true\n run: npm run check-route-prefix -- --scan-entire-repo\n\n Code-Coverage:\n if: ${{ github.actor != 'dependabot[bot]' }}\n name: Test and Calculate Code Coverage\n needs: [Merge-Conflict-Check, Check-Route-Prefix]\n runs-on: ubuntu-latest\n strategy:\n matrix:\n node-version: [24.x]\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-node@v4\n with:\n node-version: ${{ matrix.node-version }}\n\n - uses: pnpm/action-setup@v4\n with:\n version: 10.4.1\n - name: Cache pnpm store\n uses: actions/cache@v4\n id: pnpm-cache\n with:\n path: ~/.pnpm-store\n key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}\n restore-keys: |\n ${{ runner.os }}-pnpm-\n\n - name: Install dependencies\n run: pnpm install\n\n - name: Run Vitest Tests\n env:\n NODE_V8_COVERAGE: './coverage/vitest'\n run: |\n pnpm run test:coverage\n\n #######################################################################\n # DO NOT DELETE ANY references to env.CODECOV_UNIQUE_NAME in this\n # section. They are required for accurate calculations\n #######################################################################\n - name: Present and upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}}\n uses: codecov/codecov-action@v5\n with:\n name: '${{env.CODECOV_UNIQUE_NAME}}'\n token: ${{ secrets.CODECOV_TOKEN }}\n fail_ci_if_error: false\n verbose: true\n exclude: 'docs/'\n gcov_ignore: 'docs/'\n files: ./coverage/vitest/lcov.info\n" }, { "path": ".github/workflows/requirements.txt", "content": "##############################################################################\n# Python Dependencies for Shared Workflow Scripts\n##############################################################################\n#\n# Required for GitHub Actions workflow Python checks\n# Standardized across all Talawa repositories (api, admin, mobile, plugin)\n#\n# Based on cross-repository analysis (2026-01-03):\n# - All repos use: black, pydocstyle, flake8, flake8-docstrings, docstring_parser\n# - Configuration files: pyproject.toml, .flake8, .pydocstyle\n#\n##############################################################################\n\n# Code Formatting\nblack==26.1.0\n\n# Docstring Checking\npydocstyle\ndocstring_parser\n\n# Linting\nflake8\nflake8-docstrings\n\n# Testing\npytest\n" }, { "path": ".github/workflows/scripts/app_health_check.sh", "content": "#!/bin/bash\n\n# This script performs a health check to ensure an application is running on a specified port.\n# The script uses netcat (nc) to check if the port is open, with a configurable timeout.\n# It also includes optional logic to fetch Docker container logs if the health check fails during a Docker-based test.\n\n# Variables:\n# port=\"$1\" - The port to check (passed as the first argument to the script).\n# timeout=\"${2:-120}\" - The maximum time in seconds to wait for the application to start. Defaults to 120 seconds if not provided.\n# is_docker_test=\"${3:-false}\" - A flag to indicate whether the script is being run in a Docker-based test. Defaults to false.\n\n# Logic:\n# 1. Print a message indicating the start of the health check.\n# 2. Enter a loop to repeatedly check if the port is open using `nc -z localhost \"${port}\"`.\n# - If the port is not open and the timeout has not expired, sleep for 1 second and decrement the timeout.\n# - Print a status message every 10 seconds with the remaining time.\n# 3. If the timeout expires, print an error message and, if in Docker test mode, fetch Docker logs for debugging.\n# 4. If the port is detected as open, print a success message and exit.\n\n# Script:\n\nport=\"$1\"\ntimeout=\"${2:-120}\"\nis_docker_test=\"${3:-false}\"\n\n\n# Validate required port parameter\nif [ -z \"${port}\" ] || ! [[ \"${port}\" =~ ^[0-9]+$ ]] || [ \"${port}\" -lt 1 ] || [ \"${port}\" -gt 65535 ]; then\n echo \"Error: Invalid or missing port number. Must be between 1-65535\"\n exit 1\nfi\n\n# Validate timeout parameter\nif ! [[ \"${timeout}\" =~ ^[0-9]+$ ]] || [ \"${timeout}\" -lt 1 ]; then\n echo \"Error: Invalid timeout value. Must be a positive integer\"\n exit 1\nfi\n\n# Validate is_docker_test parameter\nif [ \"${is_docker_test}\" != \"true\" ] && [ \"${is_docker_test}\" != \"false\" ]; then\n echo \"Error: is_docker_test must be either 'true' or 'false'\"\n exit 1\nfi\n\necho \"Starting health check with ${timeout}s timeout\"\nwhile [ \"${timeout}\" -gt 0 ]; do\n if nc -z localhost \"${port}\" 2>/dev/null; then\n break\n elif [ $? -ne 1 ]; then\n echo \"Error: Failed to check port ${port} (nc command failed)\"\n exit 1\n fi\n sleep 1\n timeout=$((timeout-1))\n if [ $((timeout % 10)) -eq 0 ]; then\n echo \"Waiting for app to start on port ${port}... ${timeout}s remaining\"\n # Try to get more information about the port status\n netstat -an | grep \"${port}\" || true\n fi\ndone\n\nif [ \"${timeout}\" -eq 0 ]; then\n echo \"Error: Timeout waiting for application to start on port ${port}\"\n echo \"System port status:\"\n netstat -an | grep \"${port}\" || true\n if [ \"${is_docker_test}\" = \"true\" ]; then\n echo \"Fetching Docker container logs...\"\n if ! docker logs talawa-admin-app-container; then\n echo \"Error: Failed to fetch logs from container talawa-admin-app-container\"\n fi\n fi\n exit 1\nfi\necho \"App started successfully on port ${port}\"\n\n" }, { "path": ".github/workflows/scripts/check-minio-compliance.cjs", "content": "/**\n * MinIO Compliance Enforcement Script\n *\n * Purpose:\n * Enforce the documented MinIO presigned URL file upload approach by\n * preventing legacy or unsupported upload patterns from being introduced.\n *\n * Enforced Rules:\n * - Disallow Base64-based uploads (convertToBase64)\n * - Disallow apollo-upload-client imports\n * - Disallow createUploadLink usage\n *\n * Behavior:\n * - Existing known violations are temporarily exempted via LEGACY_EXCEPTIONS\n * - Any NEW violations will cause the script to exit non-zero\n *\n * Related Issue:\n * Standardize MinIO File Management - All operations (MVP) #3966\n */\n\nconst fs = require('fs');\nconst path = require('path');\n\n/**\n * Files with known legacy violations.\n * These will be removed incrementally as migrations land.\n */\nconst LEGACY_EXCEPTIONS = new Set([\n // Only index.tsx files remain - they use apollo-upload-client for Upload scalar support\n // These will be removed once all components migrate to presigned URLs\n 'src/index.tsx',\n 'src/index.spec.tsx',\n]);\n\n/**\n * Explicit forbidden imports.\n * Maintainer requirement: lint for apollo-upload-client imports.\n * Uses regex patterns to avoid false positives from comments and strings.\n */\nconst FORBIDDEN_IMPORT_PATTERNS = [\n /from\\s+[\"']apollo-upload-client[\"']/,\n /require\\s*\\(\\s*[\"']apollo-upload-client[\"']\\s*\\)/,\n];\n\n/**\n * Forbidden identifiers/usages.\n * Uses word boundaries to match whole identifiers only.\n */\nconst FORBIDDEN_IDENTIFIERS = [/\\bconvertToBase64\\b/, /\\bcreateUploadLink\\b/];\n\nconst ROOT_DIR = path.join(process.cwd(), 'src');\nconst violations = [];\n\nfunction scanFile(filePath) {\n const relativePath = path\n .relative(process.cwd(), filePath)\n .replace(/\\\\/g, '/');\n\n let content;\n try {\n content = fs.readFileSync(filePath, 'utf8');\n } catch (error) {\n console.warn(`Warning: Could not read ${relativePath}: ${error.message}`);\n return;\n }\n\n // Check forbidden imports\n FORBIDDEN_IMPORT_PATTERNS.forEach((pattern) => {\n if (pattern.test(content)) {\n if (!LEGACY_EXCEPTIONS.has(relativePath)) {\n violations.push({\n file: relativePath,\n reason: 'apollo-upload-client import detected',\n });\n }\n }\n });\n\n // Check forbidden identifiers\n FORBIDDEN_IDENTIFIERS.forEach((identifier) => {\n if (identifier.test(content)) {\n if (!LEGACY_EXCEPTIONS.has(relativePath)) {\n const match = content.match(identifier);\n violations.push({\n file: relativePath,\n reason: `forbidden identifier used: ${match[0]}`,\n });\n }\n }\n });\n}\n\nconst EXCLUDED_DIRS = new Set([\n 'node_modules',\n 'dist',\n 'build',\n '__mocks__',\n 'coverage',\n]);\nconst visitedPaths = new Set();\n\nfunction walk(dir) {\n // Protect against symlink loops\n let realPath;\n try {\n realPath = fs.realpathSync(dir);\n } catch (error) {\n console.warn(`Warning: Could not resolve ${dir}: ${error.message}`);\n return;\n }\n\n if (visitedPaths.has(realPath)) {\n return;\n }\n visitedPaths.add(realPath);\n\n let entries;\n try {\n entries = fs.readdirSync(dir, { withFileTypes: true });\n } catch (error) {\n console.warn(`Warning: Could not read directory ${dir}: ${error.message}`);\n return;\n }\n\n for (const entry of entries) {\n // Skip common build/dependency directories\n if (entry.isDirectory() && EXCLUDED_DIRS.has(entry.name)) {\n continue;\n }\n\n const fullPath = path.join(dir, entry.name);\n if (entry.isDirectory() && !entry.isSymbolicLink()) {\n walk(fullPath);\n } else if (\n (fullPath.endsWith('.ts') || fullPath.endsWith('.tsx')) &&\n !entry.isSymbolicLink()\n ) {\n scanFile(fullPath);\n }\n }\n}\n\ntry {\n walk(ROOT_DIR);\n} catch (error) {\n console.error(`\\nMinIO compliance check failed with error: ${error.message}`);\n process.exit(2); // Exit with different code to distinguish from violations\n}\n\nif (violations.length > 0) {\n console.error('\\nMinIO compliance violations found:\\n');\n violations.forEach((v) => {\n console.error(`- ${v.file}: ${v.reason}`);\n });\n process.exit(1);\n}\n\nconsole.log('MinIO compliance check passed');\n" }, { "path": ".github/workflows/scripts/compare_translations.py", "content": "\"\"\"Script to encourage more efficient coding practices.\n\nMethodology:\n\n Utility for comparing translations between default and other languages.\n\n This module defines a function to compare two translations\n and print any missing keys in the other language's translation.\n\nAttributes:\n FileTranslation : Named tuple to represent a combination\n of file and missing translations.\n\n Fields:\n - file (str): The file name.\n - missing_translations (list): List of missing translations.\n\nFunctions:\n compare_translations(default_translation, other_translation):\n Compare two translations and print missing keys.\n\n load_translation(filepath):\n Load translation from a file.\n\n check_translations():\n Load the default translation and compare it with other translations.\n\n main():\n The main function to run the script.\n Parses command-line arguments, checks for the\n existence of the specified directory, and then\n calls check_translations with the provided or default directory.\n\n\nUsage:\n This script can be executed to check and print missing\n translations in other languages based on the default English translation.\n\nExample:\n python compare_translations.py\n\nNote:\n This script complies with our python3 coding and documentation standards\n and should be used as a reference guide. It complies with:\n\n 1) Pylint\n 2) Pydocstyle\n 3) Pycodestyle\n 4) Flake8\n\n\"\"\"\n\n# standard imports\nimport argparse\nimport json\nimport os\nimport sys\nimport re\nfrom collections import namedtuple\n\n# Named tuple for file and missing\n# translations combination\nFileTranslation = namedtuple(\n \"FileTranslation\", [\"file\", \"missing_translations\"]\n)\n\n\ndef compare_translations(\n default_translation, other_translation, default_file, other_file\n):\n \"\"\"Compare two translations for missing and/or mismatched keys.\n\n Args:\n default_translation (dict): The default translation (en.json).\n other_translation (dict): The other language translation.\n default_file (str): The name of the default translation file.\n other_file (str): The name of the other\n translation file.\n\n Returns:\n list: A list of detailed error messages for each missing/mismatched key.\n \"\"\"\n errors = []\n\n # Extract and match interpolation vars (ex: {{name}})\n def _extract_interpolation_vars(text):\n \"\"\"Extract interpolation variables like {{variable}} from text.\n\n Args:\n text (str): The text to extract variables from.\n\n Returns:\n set: A set of variable names found in the text.\n \"\"\"\n return set(re.findall(r\"\\{\\{(\\w+)\\}\\}\", text))\n\n def _check_interpolation_match(default_val, other_val, key):\n \"\"\"Check if interpolation variables match between translations.\n\n Args:\n default_val (str): The default translation value.\n other_val (str): The other translation value.\n key (str): The translation key being checked.\n\n Returns:\n None: Modifies the errors list in outer scope.\n \"\"\"\n default_vars = _extract_interpolation_vars(default_val)\n other_vars = _extract_interpolation_vars(other_val)\n\n if default_vars != other_vars:\n missing_vars = default_vars - other_vars\n extra_vars = other_vars - default_vars\n\n if missing_vars:\n errors.append(\n f\"Missing interpolation variables in key '{key}' in \"\n f\"'{other_file}': \"\n f\"{', '.join('{{' + var + '}}' for var in missing_vars)}\"\n )\n if extra_vars:\n errors.append(\n f\"Extra interpolation variables in key '{key}' in \"\n f\"'{other_file}': \"\n f\"{', '.join('{{' + var + '}}' for var in extra_vars)}\"\n )\n\n # Get all unique keys from both translations\n all_keys = set(default_translation.keys()) | set(other_translation.keys())\n\n for key in all_keys:\n # Check if key is missing in other_translation\n if key not in other_translation:\n error_msg = f\"\"\"\\\nMissing Key: '{key}' - This key from '{default_file}' \\\nis missing in '{other_file}'.\"\"\"\n errors.append(error_msg)\n continue\n\n # Check for missing keys in default_translation\n if key not in default_translation:\n error_msg = f\"\"\"\\\nError Key: '{key}' - This key in '{other_file}' \\\ndoes not match any key in '{default_file}'.\"\"\"\n errors.append(error_msg)\n continue\n\n # Check for empty/null values\n if default_translation[key] == \"\" or default_translation[key] is None:\n error_msg = f\"\"\"\\\nEmpty value: '{key}' - This key in '{default_file}' \\\nhas incorrect value.\"\"\"\n errors.append(error_msg)\n\n if other_translation[key] == \"\" or other_translation[key] is None:\n error_msg = f\"\"\"\\\nEmpty value: '{key}' - This key in '{other_file}' \\\nhas incorrect value.\"\"\"\n errors.append(error_msg)\n\n # Check interpolation match\n if (\n isinstance(default_translation[key], str)\n and default_translation[key]\n and isinstance(other_translation[key], str)\n and other_translation[key]\n ):\n _check_interpolation_match(\n default_translation[key], other_translation[key], key\n )\n\n return errors\n\n\ndef flatten_json(nested_json, parent_key=\"\"):\n \"\"\"Flattens a nested JSON, concatenating keys to represent the hierarchy.\n\n Args:\n nested_json (dict): The JSON object to flatten.\n parent_key (str): The base key for recursion to track key hierarchy.\n\n Returns:\n dict: A flattened dictionary with concatenated keys.\n \"\"\"\n flat_dict = {}\n\n for key, value in nested_json.items():\n # Create the new key by concatenating parent and current key\n new_key = f\"{parent_key}.{key}\" if parent_key else key\n\n if isinstance(value, dict):\n # Recursively flatten the nested dictionary\n flat_dict.update(flatten_json(value, new_key))\n else:\n # Assign the value to the flattened key\n flat_dict[new_key] = value\n\n return flat_dict\n\n\ndef load_translation(filepath):\n \"\"\"Load translation from a file.\n\n Args:\n filepath: Path to the translation file\n\n Returns:\n translation: Loaded translation\n \"\"\"\n try:\n with open(filepath, \"r\", encoding=\"utf-8\") as file:\n content = file.read()\n if not content.strip():\n raise ValueError(f\"File {filepath} is empty.\")\n translation = json.loads(content)\n flattened_translation = flatten_json(translation)\n return flattened_translation\n except json.JSONDecodeError as e:\n raise ValueError(f\"Error decoding JSON from file {filepath}: {e}\")\n\n\ndef check_translations(directory):\n \"\"\"Load default translation and compare with other translations.\n\n Args:\n directory (str): The directory containing translation files.\n\n Returns:\n None\n \"\"\"\n default_language_dir = os.path.join(directory, \"en\")\n default_files = [\"common.json\", \"errors.json\", \"translation.json\"]\n default_translations = {}\n for file in default_files:\n file_path = os.path.join(default_language_dir, file)\n default_translations[file] = load_translation(file_path)\n\n languages = os.listdir(directory)\n languages.remove(\"en\") # Exclude default language directory\n\n error_found = False\n\n for language in languages:\n language_dir = os.path.join(directory, language)\n for file in default_files:\n default_translation = default_translations[file]\n other_file_path = os.path.join(language_dir, file)\n other_translation = load_translation(other_file_path)\n\n # Compare translations and get detailed error messages\n errors = compare_translations(\n default_translation,\n other_translation,\n f\"en/{file}\",\n f\"{language}/{file}\",\n )\n if errors:\n error_found = True\n print(f\"File {language}/{file} has missing translations for:\")\n for error in errors:\n print(f\" - {error}\")\n\n if error_found:\n sys.exit(1) # Exit with an error status code\n else:\n print(\"All translations are present with correct interpolations.\")\n sys.exit(0)\n\n\ndef main():\n \"\"\"Compare translations.\n\n Parse command-line arguments, check for the existence of the specified\n directory and call check_translations with the provided or default\n directory.\n\n Args:\n None\n\n Returns:\n None\n\n \"\"\"\n # Initialize key variables\n parser = argparse.ArgumentParser(description=\"\"\"\\\nCheck and print missing translations for all non-default languages.\"\"\")\n parser.add_argument(\n \"--directory\",\n type=str,\n nargs=\"?\",\n default=os.path.join(os.getcwd(), \"public/locales\"),\n help=\"\"\"\\\nDirectory containing translation files(relative to the root directory).\"\"\",\n )\n args = parser.parse_args()\n\n if not os.path.exists(args.directory):\n print(\n f\"Error: The specified directory '{args.directory}' does not exist.\"\n )\n sys.exit(1)\n\n check_translations(args.directory)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": ".github/workflows/scripts/css_check.py", "content": "#!/usr/bin/env python3\n# -*- coding: UTF-8 -*-\n\"\"\"Check TypeScript files for CSS violations and embedded CSS.\"\"\"\n\nimport argparse\nimport os\nimport re\nimport sys\nfrom collections import namedtuple\n\n# Define namedtuple for storing detailed violations\nDetailedViolation = namedtuple(\n \"DetailedViolation\",\n [\n \"file_path\",\n \"line_number\",\n \"violation_type\",\n \"code_snippet\",\n \"description\",\n ],\n)\nCSSCheckResult = namedtuple(\"CSSCheckResult\", [\"violations\"])\n\n\ndef check_embedded_styles(\n content: str, file_path: str\n) -> list[DetailedViolation]:\n \"\"\"Check for embedded CSS and style violations in the content.\n\n Args:\n content: The content of the file to check.\n file_path: Path to the file being checked.\n\n Returns:\n list: A list of DetailedViolation objects found.\n \"\"\"\n violations = []\n lines = content.splitlines()\n\n # Pattern definitions\n patterns = {\n \"hex_color\": {\n \"regex\": r\"#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})\\b\",\n \"description\": \"\"\"Hex color code found.\n Use CSS variables from stylesheet instead.\"\"\",\n },\n \"rgb_color\": {\n \"regex\": (\n r\"\\brgba?\\s*\\(\\s*\"\n r\"\\d+\\s*,\\s*\"\n r\"\\d+\\s*,\\s*\"\n r\"\\d+\\s*\"\n r\"(?:,\\s*[\\d.]+\\s*)?\"\n r\"\\)\"\n ),\n \"description\": \"\"\"RGB/RGBA color code found.\n Use CSS variables from stylesheet instead.\"\"\",\n },\n \"hsl_color\": {\n \"regex\": (\n r\"\\bhsla?\\s*\\(\\s*\"\n r\"\\d+\\s*,\\s*\"\n r\"\\d+%\\s*,\\s*\"\n r\"\\d+%\\s*\"\n r\"(?:,\\s*[\\d.]+\\s*)?\"\n r\"\\)\"\n ),\n \"description\": \"\"\"HSL/HSLA color code found.\n Use CSS variables from stylesheet instead.\"\"\",\n },\n \"inline_style_object\": {\n \"regex\": r\"style\\s*=\\s*\\{\\{\",\n \"description\": \"\"\"Inline style object found.\n Move styles to CSS file and use className instead.\"\"\",\n },\n \"inline_style_string\": {\n \"regex\": r'style\\s*=\\s*[\"\\']',\n \"description\": \"\"\"Inline style string found.\n Move styles to CSS file and use className instead.\"\"\",\n },\n \"camelcase_css_property\": {\n \"regex\": (\n r\"\\b(?:\"\n r\"backgroundColor|fontSize|fontFamily|fontWeight|lineHeight|\"\n r\"marginTop|marginBottom|marginLeft|marginRight|\"\n r\"paddingTop|paddingBottom|paddingLeft|paddingRight|\"\n r\"borderRadius|boxShadow|textAlign|textDecoration|\"\n r\"zIndex|maxWidth|minWidth|maxHeight|minHeight\"\n r\")\\s*[:=]\"\n ),\n \"description\": \"\"\"Camelcase CSS property found.\n Move styles to CSS file and use className instead.\"\"\",\n },\n \"pixel_value\": {\n \"regex\": (\n r\":\\s*\"\n r\"['\\\"]?\"\n r\"\\d+(?:px|em|rem|vh|vw|%)\"\n r\"['\\\"]?\"\n r\"(?=\\s*[,}])\"\n ),\n \"description\": \"\"\"Direct size value assignment found.\n Move styles to CSS file and use className instead.\"\"\",\n },\n }\n\n in_block_comment = False\n\n for line_number, line in enumerate(lines, start=1):\n # Skip comments and import statements\n stripped_line = line.strip()\n if stripped_line.startswith((\"import \", \"import{\", \"import(\")):\n continue\n\n result = \"\"\n i = 0\n while i < len(line):\n if in_block_comment:\n if line[i : i + 2] == \"*/\":\n in_block_comment = False\n i += 2\n else:\n i += 1\n else:\n if line[i : i + 2] == \"/*\":\n in_block_comment = True\n i += 2\n elif line[i : i + 2] == \"//\":\n break\n else:\n result += line[i]\n i += 1\n code_line = result\n\n if not code_line.strip():\n continue\n\n # Check for URL references (skip these as they're not style violations)\n if (\n \"url(\" in code_line.lower()\n or \"href=\" in code_line.lower()\n or \"src=\" in code_line.lower()\n ):\n # Skip hex codes in URLs\n continue\n\n for violation_type, pattern_info in patterns.items():\n matches = re.finditer(pattern_info[\"regex\"], code_line)\n for match in matches:\n if violation_type == \"camelcase_css_property\":\n # Check if it's actually in a style context\n preceding_text = code_line[: match.start()].strip()\n if not any(\n keyword in preceding_text\n for keyword in [\"style\", \"css\", \"Style\", \"CSS\"]\n ):\n if \"{\" not in code_line[: match.start()]:\n continue\n if violation_type == \"pixel_value\":\n # Look for style-related keywords nearby\n context_window = code_line[\n max(0, match.start() - 30) : min(\n len(code_line), match.end() + 30\n )\n ]\n if not any(\n keyword in context_window\n for keyword in [\n \"style\",\n \"Style\",\n \"width\",\n \"height\",\n \"size\",\n \"margin\",\n \"padding\",\n ]\n ):\n continue\n\n violations.append(\n DetailedViolation(\n file_path=file_path,\n line_number=line_number,\n violation_type=violation_type,\n code_snippet=match.group(0),\n description=pattern_info[\"description\"],\n )\n )\n\n return violations\n\n\ndef process_typescript_file(\n file_path: str, all_violations: list[DetailedViolation]\n) -> None:\n \"\"\"Process a TypeScript file for CSS violations.\n\n Args:\n file_path: Path to the TypeScript file to process.\n all_violations: List to store violations found.\n\n Returns:\n None: This function modifies the provided list.\n \"\"\"\n try:\n with open(file_path, encoding=\"utf-8\") as f:\n content = f.read()\n except (OSError, UnicodeDecodeError) as e:\n print(f\"Error reading file {file_path}: {e}\", file=sys.stderr)\n return\n\n # Check for embedded styles\n violations = check_embedded_styles(content, file_path)\n all_violations.extend(violations)\n\n\ndef check_files(\n directories: list,\n files: list,\n exclude_files: list,\n exclude_directories: list,\n) -> CSSCheckResult:\n \"\"\"Scan directories and specific files for TS files and their violations.\n\n Args:\n directories: List of directories to scan for TypeScript files.\n files: List of specific files to check.\n exclude_files: List of file paths to exclude from the scan.\n exclude_directories: List of directories to exclude from the scan.\n\n Returns:\n CSSCheckResult: A result object containing violations found.\n \"\"\"\n all_violations = []\n\n exclude_files = set(os.path.abspath(file) for file in exclude_files)\n exclude_directories = set(\n os.path.abspath(dir) for dir in exclude_directories\n )\n\n for directory in directories:\n directory = os.path.abspath(directory)\n\n for root, _, files_in_dir in os.walk(directory):\n root_dirname = os.path.basename(root)\n\n if root_dirname in {\"__tests__\", \"test\", \"tests\"} or any(\n root.startswith(exclude_dir)\n for exclude_dir in exclude_directories\n ):\n continue\n\n for file in files_in_dir:\n file_path = os.path.abspath(os.path.join(root, file))\n if file_path in exclude_files:\n continue\n\n if file.endswith((\".ts\", \".tsx\")) and not any(\n pattern in file for pattern in [\".test.\", \".spec.\"]\n ):\n process_typescript_file(file_path, all_violations)\n\n # Process individual files explicitly listed\n for file_path in files:\n file_path = os.path.abspath(file_path)\n file_name = os.path.basename(file_path)\n if (\n file_path not in exclude_files\n and file_path.endswith((\".ts\", \".tsx\"))\n and not any(\n pattern in file_name for pattern in [\".test.\", \".spec.\"]\n )\n ):\n process_typescript_file(file_path, all_violations)\n\n return CSSCheckResult(violations=all_violations)\n\n\ndef validate_directories_input(input_directories: list[str]) -> list[str]:\n \"\"\"Validate that the --directories input is correctly formatted.\n\n Args:\n input_directories: A list of file or directory paths to validate.\n\n Returns:\n validated_dirs: A list containing validated directory paths.\n If the input is a file, its parent directory is added to the list.\n\n Raises:\n ValueError: If a path is neither a valid file nor a directory.\n \"\"\"\n validated_dirs = []\n for path in input_directories:\n if os.path.isdir(path):\n validated_dirs.append(path)\n elif os.path.isfile(path):\n validated_dirs.append(os.path.dirname(path))\n else:\n raise ValueError(\n f\"Invalid path: {path}. Must be an existing file or directory.\"\n )\n return validated_dirs\n\n\ndef format_violation_output(violations: list[DetailedViolation]) -> str:\n \"\"\"Format violations for human-readable output.\n\n Args:\n violations: List of violations to format.\n\n Returns:\n output: A formatted string containing all violations and a summary.\n \"\"\"\n if not violations:\n return \"\"\n\n output_lines = [\"=\" * 80]\n output_lines.append(\"EMBEDDED CSS VIOLATIONS FOUND\")\n output_lines.append(\"=\" * 80)\n output_lines.append(\"\")\n\n # Group violations by file\n violations_by_file = {}\n for violation in violations:\n if violation.file_path not in violations_by_file:\n violations_by_file[violation.file_path] = []\n violations_by_file[violation.file_path].append(violation)\n\n # Sort files for consistent output\n for file_path in sorted(violations_by_file.keys()):\n file_violations = violations_by_file[file_path]\n output_lines.append(f\"File: {file_path}\")\n output_lines.append(\"-\" * 80)\n\n # Sort violations by line number\n for violation in sorted(file_violations, key=lambda v: v.line_number):\n output_lines.append(\n f\" Line {violation.line_number}: [{violation.violation_type}]\"\n )\n output_lines.append(f\" Code: {violation.code_snippet}\")\n output_lines.append(f\" Issue: {violation.description}\")\n output_lines.append(\"\")\n\n output_lines.append(\"\")\n\n output_lines.append(\"=\" * 80)\n output_lines.append(\"SUMMARY\")\n output_lines.append(\"=\" * 80)\n output_lines.append(f\"Total violations: {len(violations)}\")\n output_lines.append(f\"Files affected: {len(violations_by_file)}\")\n output_lines.append(\"\")\n output_lines.append(\"Please address these violations by:\")\n output_lines.append(\"1. Moving all styles to CSS files\")\n output_lines.append(\"2. Using className instead of inline styles\")\n output_lines.append(\"3. Defining colors and sizes as CSS variables\")\n output_lines.append(\"4. Importing and using CSS modules properly\")\n output_lines.append(\"\")\n\n return \"\\n\".join(output_lines)\n\n\ndef main():\n \"\"\"Run the CSS check.\n\n Args:\n None\n\n Returns:\n None\n \"\"\"\n parser = argparse.ArgumentParser(description=\"\"\"Check for embedded CSS and\n style violations in TypeScript files.\"\"\")\n parser.add_argument(\n \"--directories\",\n nargs=\"+\",\n required=False,\n help=\"List of directories to check for CSS violations.\",\n )\n parser.add_argument(\n \"--files\",\n nargs=\"*\",\n default=[],\n help=\"Specific files to check for CSS violations.\",\n )\n parser.add_argument(\n \"--exclude_files\",\n nargs=\"*\",\n default=[],\n help=\"Specific files to exclude from analysis.\",\n )\n parser.add_argument(\n \"--exclude_directories\",\n nargs=\"*\",\n default=[],\n help=\"Directories to exclude from analysis.\",\n )\n args = parser.parse_args()\n\n if not args.directories and not args.files:\n parser.error(\n \"At least one of --directories or --files must be provided.\"\n )\n\n try:\n directories = (\n validate_directories_input(args.directories)\n if args.directories\n else []\n )\n except ValueError as e:\n print(f\"Error: {e}\", file=sys.stderr)\n sys.exit(1)\n\n result = check_files(\n directories=directories,\n files=args.files,\n exclude_files=args.exclude_files,\n exclude_directories=args.exclude_directories,\n )\n\n if result.violations:\n print(format_violation_output(result.violations))\n sys.exit(1)\n else:\n print(\"✓ No embedded CSS violations found.\")\n sys.exit(0)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": ".github/workflows/scripts/test/README.md", "content": "## Place test code in this directory\n" }, { "path": ".github/workflows/scripts/test/test_css_check.py", "content": "#!/usr/bin/env python3\n# -*- coding: UTF-8 -*-\n\"\"\"Comprehensive unit tests for css_check.py with 100% code coverage.\"\"\"\n\nimport unittest\nimport tempfile\nimport os\nimport sys\nfrom unittest.mock import patch\nfrom io import StringIO\nimport shutil\n\nsys.path.insert(\n 0, os.path.abspath(os.path.join(os.path.dirname(__file__), \"..\"))\n)\n\nfrom css_check import (\n check_embedded_styles,\n process_typescript_file,\n check_files,\n validate_directories_input,\n format_violation_output,\n DetailedViolation,\n CSSCheckResult,\n main,\n)\n\n\nclass TestCheckEmbeddedStyles(unittest.TestCase):\n \"\"\"Test suite for check_embedded_styles function.\"\"\"\n\n def test_detects_hex_color(self):\n \"\"\"Test detection of 6-digit hex color codes.\"\"\"\n content = \"const bgColor = '#ff0000';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"hex_color\")\n self.assertEqual(violations[0].code_snippet, \"#ff0000\")\n\n def test_detects_multiple_hex_colors(self):\n \"\"\"Test detection of multiple hex colors in one line.\"\"\"\n content = (\n \"const colors = { primary: '#ff0000', secondary: '#00ff00' };\"\n )\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 2)\n self.assertTrue(\n all(v.violation_type == \"hex_color\" for v in violations)\n )\n\n def test_detects_rgb_color(self):\n \"\"\"Test detection of RGB color codes.\"\"\"\n content = \"const color = 'rgb(255, 0, 0)';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"rgb_color\")\n\n def test_detects_rgba_color(self):\n \"\"\"Test detection of RGBA color codes.\"\"\"\n content = \"const color = 'rgba(255, 0, 0, 0.5)';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"rgb_color\")\n\n def test_detects_hsl_color(self):\n \"\"\"Test detection of HSL color codes.\"\"\"\n content = \"const color = 'hsl(120, 100%, 50%)';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"hsl_color\")\n\n def test_detects_inline_style_object(self):\n \"\"\"Test detection of inline style objects.\"\"\"\n content = \"
Hello
\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"inline_style_object\")\n\n def test_detects_inline_style_string_double_quotes(self):\n \"\"\"Test detection of inline style strings with double quotes.\"\"\"\n content = '
Hello
'\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"inline_style_string\")\n\n def test_detects_inline_style_string_single_quotes(self):\n \"\"\"Test detection of inline style strings with single quotes.\"\"\"\n content = \"
Hello
\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"inline_style_string\")\n\n def test_detects_camelcase_font_size(self):\n \"\"\"Test detection of camelCase CSS property fontSize.\"\"\"\n content = \"const styles = { fontSize: '16px' };\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 2)\n self.assertEqual(\n violations[0].violation_type, \"camelcase_css_property\"\n )\n\n def test_detects_camelcase_margin_top(self):\n \"\"\"Test detection of camelCase CSS property marginTop.\"\"\"\n content = \"const styles = { marginTop: '10px' };\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 2)\n self.assertEqual(\n violations[0].violation_type, \"camelcase_css_property\"\n )\n\n def test_detects_camelcase_padding_left(self):\n \"\"\"Test detection of camelCase CSS property paddingLeft.\"\"\"\n content = \"const styles = { paddingLeft: '5px' };\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 2)\n self.assertEqual(\n violations[0].violation_type, \"camelcase_css_property\"\n )\n\n def test_detects_pixel_value(self):\n \"\"\"Test detection of pixel values in style context.\"\"\"\n content = \"const style = { width: '100px' };\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"pixel_value\")\n\n def test_detects_rem_value(self):\n \"\"\"Test detection of rem values in style context.\"\"\"\n content = \"const style = { margin: '1rem' };\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].violation_type, \"pixel_value\")\n\n def test_ignores_single_line_comment_with_hex(self):\n \"\"\"Test that hex colors in single-line comments are ignored.\"\"\"\n content = \"// const color = '#ff0000';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_block_comment_with_styles(self):\n \"\"\"Test that styles in block comments are ignored.\"\"\"\n content = \"/* const color = '#ff0000'; */\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_multiline_block_comment(self):\n \"\"\"Test that multiline block comments with styles are ignored.\"\"\"\n content = \"\"\"/*\n const color = '#ff0000';\n const bg = 'rgb(255, 0, 0)';\n */\"\"\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_handles_block_comment_spanning_lines(self):\n \"\"\"Test proper handling of block comments spanning multiple lines.\"\"\"\n content = \"\"\"const valid = 'test';\n /* comment with #ff0000 */\n const color = '#00ff00';\"\"\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].code_snippet, \"#00ff00\")\n self.assertEqual(violations[0].line_number, 3)\n\n def test_ignores_import_statements(self):\n \"\"\"Test that import statements are ignored.\"\"\"\n content = \"import { colors } from './colors';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_dynamic_import(self):\n \"\"\"Test that dynamic import() statements are ignored.\"\"\"\n content = \"const module = import('./module');\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_hex_in_url(self):\n \"\"\"Test that hex codes in URLs are ignored.\"\"\"\n content = \"const imageUrl = 'url(#ff0000)';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_hex_in_href(self):\n \"\"\"Test that hex codes in href attributes are ignored.\"\"\"\n content = 'Link'\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_ignores_hex_in_src(self):\n \"\"\"Test that hex codes in src attributes are ignored.\"\"\"\n content = ''\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_whitespace_only_content(self):\n \"\"\"Test handling of whitespace-only content.\"\"\"\n content = \" \\n \\t \\n \"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 0)\n\n def test_camelcase_requires_style_context(self):\n \"\"\"Test that camelCase properties need style context to be flagged.\"\"\"\n content = \"const backgroundColor = 'someValue';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n # Should not flag variable names, only in style objects\n camelcase_violations = [\n v\n for v in violations\n if v.violation_type == \"camelcase_css_property\"\n ]\n self.assertEqual(len(camelcase_violations), 0)\n\n def test_camelcase_in_object_with_brace(self):\n \"\"\"Test camelCase detection in object context.\"\"\"\n content = \"{ backgroundColor: 'red' }\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertEqual(len(violations), 1)\n self.assertEqual(\n violations[0].violation_type, \"camelcase_css_property\"\n )\n\n def test_pixel_value_without_style_context_ignored(self):\n \"\"\"Test that pixel values without style context are ignored.\"\"\"\n content = \"const version = '100px';\"\n violations = check_embedded_styles(content, \"test.tsx\")\n # Should not flag without style context\n pixel_violations = [\n v for v in violations if v.violation_type == \"pixel_value\"\n ]\n self.assertEqual(len(pixel_violations), 0)\n\n def test_pixel_value_with_width_keyword(self):\n \"\"\"Test pixel value detection with 'width' keyword.\"\"\"\n content = \"const width: '100px',\"\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertGreaterEqual(len(violations), 1)\n\n def test_multiple_violation_types_in_one_line(self):\n \"\"\"Test detection of multiple violation types in a single line.\"\"\"\n content = (\n \"const style = { backgroundColor: '#ff0000', fontSize: '16px' };\"\n )\n violations = check_embedded_styles(content, \"test.tsx\")\n self.assertGreaterEqual(len(violations), 3) # hex, camelcase, pixel\n violation_types = {v.violation_type for v in violations}\n self.assertIn(\"hex_color\", violation_types)\n self.assertIn(\"camelcase_css_property\", violation_types)\n\n\nclass TestProcessTypescriptFile(unittest.TestCase):\n \"\"\"Test suite for process_typescript_file function.\"\"\"\n\n def setUp(self):\n \"\"\"Create temporary directory for test files.\"\"\"\n self.test_dir = tempfile.mkdtemp()\n\n def tearDown(self):\n \"\"\"Clean up temporary directory.\"\"\"\n shutil.rmtree(self.test_dir)\n\n def test_processes_valid_file(self):\n \"\"\"Test processing of a valid TypeScript file.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n violations = []\n process_typescript_file(file_path, violations)\n self.assertEqual(len(violations), 1)\n self.assertEqual(violations[0].file_path, file_path)\n\n def test_processes_empty_file(self):\n \"\"\"Test processing of an empty file.\"\"\"\n file_path = os.path.join(self.test_dir, \"empty.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"\")\n\n violations = []\n process_typescript_file(file_path, violations)\n self.assertEqual(len(violations), 0)\n\n def test_processes_file_with_no_violations(self):\n \"\"\"Test processing of a file with no violations.\"\"\"\n file_path = os.path.join(self.test_dir, \"clean.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const name = 'test';\\nimport React from 'react';\")\n\n violations = []\n process_typescript_file(file_path, violations)\n self.assertEqual(len(violations), 0)\n\n def test_handles_file_not_found(self):\n \"\"\"Test handling of non-existent file.\"\"\"\n file_path = os.path.join(self.test_dir, \"nonexistent.tsx\")\n violations = []\n\n with patch(\"sys.stderr\", new_callable=StringIO) as mock_stderr:\n process_typescript_file(file_path, violations)\n self.assertIn(\"Error reading file\", mock_stderr.getvalue())\n\n self.assertEqual(len(violations), 0)\n\n def test_handles_unicode_decode_error(self):\n \"\"\"Test handling of files with encoding issues.\"\"\"\n file_path = os.path.join(self.test_dir, \"bad_encoding.tsx\")\n # Create a file with invalid UTF-8\n with open(file_path, \"wb\") as f:\n f.write(b\"\\xff\\xfe\")\n\n violations = []\n with patch(\"sys.stderr\", new_callable=StringIO) as mock_stderr:\n process_typescript_file(file_path, violations)\n output = mock_stderr.getvalue()\n self.assertIn(\"Error reading file\", output)\n\n self.assertEqual(len(violations), 0)\n\n def test_appends_to_existing_violations_list(self):\n \"\"\"Test that violations are appended to existing list.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n existing_violation = DetailedViolation(\n file_path=\"other.tsx\",\n line_number=1,\n violation_type=\"test\",\n code_snippet=\"test\",\n description=\"test\",\n )\n violations = [existing_violation]\n\n process_typescript_file(file_path, violations)\n self.assertEqual(len(violations), 2)\n self.assertEqual(violations[0], existing_violation)\n\n\nclass TestCheckFiles(unittest.TestCase):\n \"\"\"Test suite for check_files function.\"\"\"\n\n def setUp(self):\n \"\"\"Create temporary directory structure for tests.\"\"\"\n self.test_dir = tempfile.mkdtemp()\n self.subdir = os.path.join(self.test_dir, \"subdir\")\n os.makedirs(self.subdir)\n\n def tearDown(self):\n \"\"\"Clean up temporary directory.\"\"\"\n shutil.rmtree(self.test_dir)\n\n def test_scans_directory_for_tsx_files(self):\n \"\"\"Test scanning directory for .tsx files.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 1)\n\n def test_scans_directory_for_ts_files(self):\n \"\"\"Test scanning directory for .ts files.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.ts\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 1)\n\n def test_scans_nested_directories(self):\n \"\"\"Test scanning nested directories.\"\"\"\n file_path = os.path.join(self.subdir, \"nested.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 1)\n\n def test_excludes_test_files_with_test_in_name(self):\n \"\"\"Test that .test. files are excluded.\"\"\"\n file_path = os.path.join(self.test_dir, \"component.test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 0)\n\n def test_excludes_tests_directory(self):\n \"\"\"Test that files in tests/ directory are excluded.\"\"\"\n tests_dir = os.path.join(self.test_dir, \"tests\")\n os.makedirs(tests_dir)\n file_path = os.path.join(tests_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 0)\n\n def test_excludes_test_directory(self):\n \"\"\"Test that files in test/ directory are excluded.\"\"\"\n test_dir = os.path.join(self.test_dir, \"test\")\n os.makedirs(test_dir)\n file_path = os.path.join(test_dir, \"component.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 0)\n\n def test_processes_explicit_file_list(self):\n \"\"\"Test processing explicit list of files.\"\"\"\n file_path = os.path.join(self.test_dir, \"explicit.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n result = check_files([], [file_path], [], [])\n self.assertEqual(len(result.violations), 1)\n\n def test_excludes_specific_files(self):\n \"\"\"Test excluding specific files.\"\"\"\n file1 = os.path.join(self.test_dir, \"include.tsx\")\n file2 = os.path.join(self.test_dir, \"exclude.tsx\")\n\n with open(file1, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n with open(file2, \"w\") as f:\n f.write(\"const color = '#00ff00';\")\n\n result = check_files([self.test_dir], [], [file2], [])\n self.assertEqual(len(result.violations), 1)\n self.assertIn(\"include.tsx\", result.violations[0].file_path)\n\n def test_excludes_directories(self):\n \"\"\"Test excluding entire directories.\"\"\"\n exclude_dir = os.path.join(self.test_dir, \"exclude\")\n os.makedirs(exclude_dir)\n\n file1 = os.path.join(self.test_dir, \"include.tsx\")\n file2 = os.path.join(exclude_dir, \"exclude.tsx\")\n\n with open(file1, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n with open(file2, \"w\") as f:\n f.write(\"const color = '#00ff00';\")\n\n result = check_files([self.test_dir], [], [], [exclude_dir])\n self.assertEqual(len(result.violations), 1)\n self.assertIn(\"include.tsx\", result.violations[0].file_path)\n\n def test_ignores_non_typescript_files(self):\n \"\"\"Test that non-TypeScript files are ignored.\"\"\"\n js_file = os.path.join(self.test_dir, \"test.js\")\n py_file = os.path.join(self.test_dir, \"test.py\")\n\n with open(js_file, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n with open(py_file, \"w\") as f:\n f.write(\"color = '#00ff00'\")\n\n result = check_files([self.test_dir], [], [], [])\n self.assertEqual(len(result.violations), 0)\n\n def test_combines_directory_and_file_results(self):\n \"\"\"Test combining results from directories and explicit files.\"\"\"\n dir_file = os.path.join(self.test_dir, \"dir.tsx\")\n explicit_file = os.path.join(self.test_dir, \"explicit.tsx\")\n\n with open(dir_file, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n with open(explicit_file, \"w\") as f:\n f.write(\"const bg = '#00ff00';\")\n\n result = check_files([self.test_dir], [explicit_file], [], [])\n self.assertGreaterEqual(len(result.violations), 2)\n\n def test_returns_css_check_result(self):\n \"\"\"Test that function returns CSSCheckResult object.\"\"\"\n result = check_files([self.test_dir], [], [], [])\n self.assertIsInstance(result, CSSCheckResult)\n self.assertIsInstance(result.violations, list)\n\n def test_handles_absolute_paths(self):\n \"\"\"Test that function handles absolute paths correctly.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n abs_path = os.path.abspath(file_path)\n result = check_files([], [abs_path], [], [])\n self.assertEqual(len(result.violations), 1)\n\n\nclass TestValidateDirectoriesInput(unittest.TestCase):\n \"\"\"Test suite for validate_directories_input function.\"\"\"\n\n def setUp(self):\n \"\"\"Create temporary directory and file for tests.\"\"\"\n self.test_dir = tempfile.mkdtemp()\n self.test_file = os.path.join(self.test_dir, \"test.tsx\")\n with open(self.test_file, \"w\") as f:\n f.write(\"test\")\n\n def tearDown(self):\n \"\"\"Clean up temporary directory.\"\"\"\n shutil.rmtree(self.test_dir)\n\n def test_validates_existing_directory(self):\n \"\"\"Test validation of existing directory.\"\"\"\n result = validate_directories_input([self.test_dir])\n self.assertEqual(len(result), 1)\n self.assertEqual(result[0], self.test_dir)\n\n\nclass TestFormatViolationOutput(unittest.TestCase):\n \"\"\"Test suite for format_violation_output function.\"\"\"\n\n def test_empty_violations_returns_empty_string(self):\n \"\"\"Test that empty violations list returns empty string.\"\"\"\n result = format_violation_output([])\n self.assertEqual(result, \"\")\n\n def test_single_violation_output_format(self):\n \"\"\"Test output format for single violation.\"\"\"\n violation = DetailedViolation(\n file_path=\"/path/to/file.tsx\",\n line_number=10,\n violation_type=\"hex_color\",\n code_snippet=\"#ff0000\",\n description=\"Hex color found\",\n )\n result = format_violation_output([violation])\n\n self.assertIn(\"EMBEDDED CSS VIOLATIONS FOUND\", result)\n self.assertIn(\"/path/to/file.tsx\", result)\n self.assertIn(\"Line 10\", result)\n self.assertIn(\"[hex_color]\", result)\n self.assertIn(\"#ff0000\", result)\n self.assertIn(\"Hex color found\", result)\n self.assertIn(\"Total violations: 1\", result)\n self.assertIn(\"Files affected: 1\", result)\n\n def test_multiple_violations_same_file(self):\n \"\"\"Test output format for multiple violations in same file.\"\"\"\n violations = [\n DetailedViolation(\n file_path=\"/path/to/file.tsx\",\n line_number=5,\n violation_type=\"hex_color\",\n code_snippet=\"#ff0000\",\n description=\"Hex color found\",\n ),\n DetailedViolation(\n file_path=\"/path/to/file.tsx\",\n line_number=10,\n violation_type=\"rgb_color\",\n code_snippet=\"rgb(255,0,0)\",\n description=\"RGB color found\",\n ),\n ]\n result = format_violation_output(violations)\n\n self.assertIn(\"Total violations: 2\", result)\n self.assertIn(\"Files affected: 1\", result)\n self.assertIn(\"Line 5\", result)\n self.assertIn(\"Line 10\", result)\n\n def test_multiple_violations_different_files(self):\n \"\"\"Test output format for violations across multiple files.\"\"\"\n violations = [\n DetailedViolation(\n file_path=\"/path/to/file1.tsx\",\n line_number=5,\n violation_type=\"hex_color\",\n code_snippet=\"#ff0000\",\n description=\"Hex color found\",\n ),\n DetailedViolation(\n file_path=\"/path/to/file2.tsx\",\n line_number=10,\n violation_type=\"rgb_color\",\n code_snippet=\"rgb(255,0,0)\",\n description=\"RGB color found\",\n ),\n ]\n result = format_violation_output(violations)\n\n self.assertIn(\"Total violations: 2\", result)\n self.assertIn(\"Files affected: 2\", result)\n self.assertIn(\"file1.tsx\", result)\n self.assertIn(\"file2.tsx\", result)\n\n\nclass TestMain(unittest.TestCase):\n \"\"\"Test suite for main function.\"\"\"\n\n def setUp(self):\n \"\"\"Set up test directory.\"\"\"\n self.test_dir = tempfile.mkdtemp()\n\n def tearDown(self):\n \"\"\"Clean up test directory.\"\"\"\n shutil.rmtree(self.test_dir)\n\n def test_exits_with_code_0_when_no_violations(self):\n \"\"\"Test that main exits with code 0 when no violations found.\"\"\"\n file_path = os.path.join(self.test_dir, \"clean.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const name = 'test';\")\n\n test_args = [\"css_check.py\", \"--directories\", self.test_dir]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stdout\", new_callable=StringIO) as mock_stdout:\n with self.assertRaises(SystemExit) as cm:\n main()\n self.assertEqual(cm.exception.code, 0)\n self.assertIn(\n \"No embedded CSS violations found\", mock_stdout.getvalue()\n )\n\n def test_exits_with_code_1_when_violations_found(self):\n \"\"\"Test that main exits with code 1 when violations found.\"\"\"\n file_path = os.path.join(self.test_dir, \"violation.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n test_args = [\"css_check.py\", \"--directories\", self.test_dir]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stdout\", new_callable=StringIO) as mock_stdout:\n with self.assertRaises(SystemExit) as cm:\n main()\n self.assertEqual(cm.exception.code, 1)\n output = mock_stdout.getvalue()\n self.assertIn(\"EMBEDDED CSS VIOLATIONS FOUND\", output)\n\n def test_requires_directories_or_files_argument(self):\n \"\"\"Test that main requires at least one of --directories or --files.\"\"\"\n test_args = [\"css_check.py\"]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stderr\", new_callable=StringIO):\n with self.assertRaises(SystemExit) as cm:\n main()\n self.assertEqual(cm.exception.code, 2)\n\n def test_accepts_files_argument(self):\n \"\"\"Test that main accepts --files argument.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n test_args = [\"css_check.py\", \"--files\", file_path]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stdout\", new_callable=StringIO):\n with self.assertRaises(SystemExit) as cm:\n main()\n self.assertEqual(cm.exception.code, 1)\n\n def test_handles_invalid_directory_input(self):\n \"\"\"Test that main handles invalid directory input.\"\"\"\n invalid_dir = os.path.join(self.test_dir, \"nonexistent\")\n test_args = [\"css_check.py\", \"--directories\", invalid_dir]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stderr\", new_callable=StringIO) as mock_stderr:\n with self.assertRaises(SystemExit) as cm:\n main()\n self.assertEqual(cm.exception.code, 1)\n self.assertIn(\"Error\", mock_stderr.getvalue())\n\n def test_prints_formatted_output(self):\n \"\"\"Test that main prints formatted violation output.\"\"\"\n file_path = os.path.join(self.test_dir, \"test.tsx\")\n with open(file_path, \"w\") as f:\n f.write(\"const color = '#ff0000';\")\n\n test_args = [\"css_check.py\", \"--directories\", self.test_dir]\n\n with patch(\"sys.argv\", test_args):\n with patch(\"sys.stdout\", new_callable=StringIO) as mock_stdout:\n with self.assertRaises(SystemExit):\n main()\n output = mock_stdout.getvalue()\n self.assertIn(\"EMBEDDED CSS VIOLATIONS FOUND\", output)\n self.assertIn(\"Total violations:\", output)\n self.assertIn(\"Files affected:\", output)\n\n\nclass TestNamedTuples(unittest.TestCase):\n \"\"\"Test suite for namedtuple definitions.\"\"\"\n\n def test_detailed_violation_creation(self):\n \"\"\"Test DetailedViolation namedtuple creation.\"\"\"\n violation = DetailedViolation(\n file_path=\"/test.tsx\",\n line_number=10,\n violation_type=\"hex_color\",\n code_snippet=\"#ff0000\",\n description=\"Test description\",\n )\n\n self.assertEqual(violation.file_path, \"/test.tsx\")\n self.assertEqual(violation.line_number, 10)\n self.assertEqual(violation.violation_type, \"hex_color\")\n self.assertEqual(violation.code_snippet, \"#ff0000\")\n self.assertEqual(violation.description, \"Test description\")\n\n def test_css_check_result_creation(self):\n \"\"\"Test CSSCheckResult namedtuple creation.\"\"\"\n violations = [\n DetailedViolation(\n file_path=\"/test.tsx\",\n line_number=10,\n violation_type=\"hex_color\",\n code_snippet=\"#ff0000\",\n description=\"Test\",\n )\n ]\n\n result = CSSCheckResult(violations=violations)\n self.assertEqual(len(result.violations), 1)\n self.assertEqual(result.violations[0].file_path, \"/test.tsx\")\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": ".github/workflows/scripts/test/test_translation_check.py", "content": "\"\"\"Tests for the translation_check module.\"\"\"\n\nimport unittest\nimport os\nimport sys\nimport json\nimport shutil\nimport tempfile\nimport subprocess\nimport importlib.util\nfrom pathlib import Path\nfrom unittest.mock import patch\n\nSCRIPT_DIR = Path(__file__).resolve().parents[1]\nSPEC = importlib.util.spec_from_file_location(\n \"translation_check\",\n SCRIPT_DIR / \"translation_check.py\",\n)\ntranslation_check = importlib.util.module_from_spec(SPEC)\nSPEC.loader.exec_module(translation_check)\n\n\nclass TestTranslationCheck(unittest.TestCase):\n \"\"\"Unit test suite for i18n tag validation logic.\"\"\"\n\n def setUp(self):\n \"\"\"Initialize temporary environment for tests.\"\"\"\n self.test_dir = tempfile.mkdtemp()\n self.locales_dir = os.path.join(self.test_dir, \"locales\")\n os.makedirs(self.locales_dir)\n self.en_dir = os.path.join(self.locales_dir, \"en\")\n os.makedirs(self.en_dir)\n\n self.common_json = os.path.join(self.en_dir, \"common.json\")\n with open(self.common_json, \"w\", encoding=\"utf-8\") as f:\n json.dump({\"login\": \"Login\", \"auth\": {\"signup\": \"Sign Up\"}}, f)\n\n def tearDown(self):\n \"\"\"Cleanup temporary environment.\"\"\"\n shutil.rmtree(self.test_dir)\n\n def test_get_keys_recursion(self):\n \"\"\"Verify recursive extraction of nested keys.\"\"\"\n self.assertEqual(\n translation_check.get_translation_keys({\"a\": {\"b\": \"c\"}}),\n {\"a.b\"},\n )\n\n def test_load_locales_success(self):\n \"\"\"Verify successful loading of valid locale keys.\"\"\"\n keys = translation_check.load_locale_keys(self.en_dir)\n self.assertIn(\"login\", keys)\n\n def test_load_locales_malformed(self):\n \"\"\"Verify handling of malformed JSON.\"\"\"\n with open(os.path.join(self.en_dir, \"translation.json\"), \"w\") as f:\n f.write(\"{invalid}\")\n self.assertIn(\"login\", translation_check.load_locale_keys(self.en_dir))\n\n def test_load_locales_not_found(self):\n \"\"\"Verify exception on invalid locale path.\"\"\"\n with self.assertRaises(FileNotFoundError):\n translation_check.load_locale_keys(\"/invalid/path\")\n\n def test_find_tags_string(self):\n \"\"\"Verify tag extraction from string.\"\"\"\n self.assertEqual(\n translation_check.find_translation_tags(\"t('key')\"),\n {\"key\"},\n )\n\n def test_find_tags_path(self):\n \"\"\"Verify tag extraction from file path.\"\"\"\n p = Path(self.test_dir) / \"t.tsx\"\n p.write_text(\"t('key')\", encoding=\"utf-8\")\n self.assertEqual(\n translation_check.find_translation_tags(p),\n {\"key\"},\n )\n\n def test_find_tags_namespace(self):\n \"\"\"Verify extraction of namespaced keys.\"\"\"\n self.assertEqual(\n translation_check.find_translation_tags(\"t('common:key')\"),\n {\"key\"},\n )\n\n def test_find_tags_io_error(self):\n \"\"\"Verify handling of inaccessible files.\"\"\"\n tags = translation_check.find_translation_tags(Path(self.test_dir))\n self.assertEqual(len(tags), 0)\n\n def test_find_tags_dynamic_ignored(self):\n \"\"\"Verify dynamic variables are ignored.\"\"\"\n self.assertEqual(\n len(translation_check.find_translation_tags(\"t(var)\")),\n 0,\n )\n\n def test_get_files_directory(self):\n \"\"\"Verify directory scanning.\"\"\"\n src = Path(self.test_dir) / \"src\"\n src.mkdir()\n (src / \"app.tsx\").touch()\n self.assertEqual(\n len(\n translation_check.get_target_files(None, [str(src)], [\".tsx\"])\n ),\n 0,\n )\n\n def test_get_files_exclude_spec(self):\n \"\"\"Verify spec/test file exclusion.\"\"\"\n src = Path(self.test_dir) / \"src\"\n src.mkdir(exist_ok=True)\n (src / \"app.spec.tsx\").touch()\n self.assertEqual(\n len(\n translation_check.get_target_files(None, [str(src)], [\".tsx\"])\n ),\n 0,\n )\n\n def test_get_files_explicit(self):\n \"\"\"Verify explicit file selection.\"\"\"\n f = os.path.join(self.test_dir, \"f.ts\")\n Path(f).touch()\n self.assertEqual(\n len(translation_check.get_target_files([f], None, [\".ts\"])),\n 0,\n )\n\n def test_main_success_flow(self):\n \"\"\"Verify exit code 0 on successful validation.\"\"\"\n with patch(\n \"sys.argv\",\n [\n \"translation_check.py\",\n \"--locales-dir\",\n self.en_dir,\n \"--directories\",\n self.test_dir,\n ],\n ):\n with self.assertRaises(SystemExit) as cm:\n translation_check.main()\n self.assertEqual(cm.exception.code, 0)\n\n def test_main_missing_flow(self):\n \"\"\"Verify exit code 1 when missing keys are found.\"\"\"\n p = Path(self.test_dir) / \"e.tsx\"\n p.write_text(\"t('missing')\", encoding=\"utf-8\")\n\n with patch(\n \"sys.argv\",\n [\n \"translation_check.py\",\n \"--locales-dir\",\n self.en_dir,\n \"--files\",\n str(p),\n ],\n ):\n with self.assertRaises(SystemExit) as cm:\n translation_check.main()\n self.assertEqual(cm.exception.code, 1)\n\n def test_main_error_flow(self):\n \"\"\"Verify exit code 2 on configuration error.\"\"\"\n with patch(\n \"sys.argv\",\n [\"translation_check.py\", \"--locales-dir\", \"/invalid\"],\n ):\n with self.assertRaises(SystemExit) as cm:\n translation_check.main()\n self.assertEqual(cm.exception.code, 2)\n\n def test_entry_point_subprocess(self):\n \"\"\"Verify the actual __main__ entry point using a subprocess.\"\"\"\n script_path = SCRIPT_DIR / \"translation_check.py\"\n result = subprocess.run(\n [\n sys.executable,\n str(script_path),\n \"--locales-dir\",\n self.en_dir,\n \"--directories\",\n self.test_dir,\n ],\n capture_output=True,\n text=True,\n check=False,\n )\n self.assertEqual(result.returncode, 0)\n self.assertIn(\n \"All translation tags validated successfully\",\n result.stdout,\n )\n\n\nif __name__ == \"__main__\":\n unittest.main()\n" }, { "path": ".github/workflows/scripts/translation_check.py", "content": "\"\"\"Validates i18n translation tags against locale JSON files.\"\"\"\n\nfrom __future__ import annotations\n\nimport argparse\nimport json\nimport re\nimport sys\nfrom pathlib import Path\n\n\ndef get_keys(data: dict, prefix: str = \"\") -> set[str]:\n \"\"\"Flatten nested translation JSON into dot-notation keys.\n\n Args:\n data: Parsed JSON dictionary containing translation keys.\n prefix: Prefix used for nested key traversal.\n\n Returns:\n keys: A set of flattened translation keys.\n \"\"\"\n keys: set[str] = set()\n for key, value in data.items():\n if isinstance(value, dict):\n keys.update(get_keys(value, f\"{prefix}{key}.\"))\n else:\n keys.add(f\"{prefix}{key}\")\n return keys\n\n\ndef get_translation_keys(data: dict) -> set[str]:\n \"\"\"Extract translation keys from parsed locale JSON.\n\n Args:\n data: Parsed JSON dictionary.\n\n Returns:\n translation_keys: A set of translation keys.\n \"\"\"\n return get_keys(data)\n\n\ndef load_locale_keys(locales_dir: str | Path) -> set[str]:\n \"\"\"Load all valid translation keys from locale JSON files.\n\n Args:\n locales_dir: Path to the locale directory.\n\n Returns:\n keys: A set of all valid translation keys.\n\n Raises:\n FileNotFoundError: If the locale directory does not exist.\n \"\"\"\n base = Path(locales_dir)\n if not base.exists():\n raise FileNotFoundError(locales_dir)\n\n keys: set[str] = set()\n\n for name in (\"common.json\", \"translation.json\", \"errors.json\"):\n path = base / name\n if path.exists():\n try:\n keys.update(\n get_keys(json.loads(path.read_text(encoding=\"utf-8\")))\n )\n except (json.JSONDecodeError, OSError) as exc:\n print(\n f\"Warning: Failed to parse {path}: {exc}\",\n file=sys.stderr,\n )\n\n if not keys:\n print(\n f\"Warning: No translation keys found in {base}\",\n file=sys.stderr,\n )\n\n return keys\n\n\ndef find_translation_tags(source: str | Path) -> set[str]:\n \"\"\"Find all translation tags used inside a source file or string.\n\n Handles keyPrefix option in useTranslation calls by prefixing\n the extracted keys with the keyPrefix value.\n\n For components that receive `t` as a prop (not using useTranslation\n directly), add a comment like:\n // translation-check-keyPrefix: organizationEvents\n to specify the keyPrefix used by the parent component.\n\n Note:\n This function assumes a single keyPrefix per file. If multiple\n keyPrefixes are found (from useTranslation calls or comment\n directives), only the first one is used for all translation tags.\n A warning is emitted to stderr when this occurs.\n\n Args:\n source: File path or raw source string.\n\n Returns:\n found_tags: A set of detected translation keys.\n \"\"\"\n if isinstance(source, Path):\n try:\n content = source.read_text(encoding=\"utf-8\")\n except (OSError, UnicodeDecodeError):\n return set()\n else:\n content = source\n\n # Find keyPrefix from useTranslation calls\n # Matches: useTranslation('translation', { keyPrefix: 'namespace' })\n key_prefix_pattern = (\n r\"useTranslation\\s*\\([^)]*keyPrefix\\s*:\\s*['\\\"]([^'\\\"]+)['\\\"]\"\n )\n key_prefixes = re.findall(key_prefix_pattern, content)\n\n # Also check for explicit keyPrefix comment directive\n # Matches: // translation-check-keyPrefix: namespace\n comment_prefix_pattern = (\n r\"(?://|/\\*)\\s*translation-check-keyPrefix:\\s*(\\S+)\"\n )\n comment_prefixes = re.findall(comment_prefix_pattern, content)\n\n # Combine prefixes from useTranslation and comments\n all_prefixes = key_prefixes + comment_prefixes\n\n # Get the primary keyPrefix (if multiple, use the first one found)\n # Note: This assumes single keyPrefix per file. Files with multiple\n # components using different keyPrefixes may have inaccurate results.\n if len(all_prefixes) > 1:\n file_name = str(source) if isinstance(source, Path) else \"source\"\n print(\n f\"Warning: Multiple keyPrefixes found in {file_name}. \"\n f\"Using first: '{all_prefixes[0]}'. Found: {all_prefixes}\",\n file=sys.stderr,\n )\n primary_prefix = all_prefixes[0] if all_prefixes else None\n\n # Find all t('key') calls\n tags = re.findall(\n r\"(?:(?:\\bi18n)\\.)?\\bt\\(\\s*['\\\"]([^'\\\" \\n]+)['\\\"]\",\n content,\n )\n\n result = set()\n for tag in tags:\n # Remove namespace prefix if present (e.g., \"translation:key\" -> \"key\")\n clean_tag = tag.split(\":\")[-1]\n\n # If the tag already contains a dot (full path), use it as-is\n # Otherwise, prefix it with the keyPrefix if one exists\n if \".\" in clean_tag or primary_prefix is None:\n result.add(clean_tag)\n else:\n result.add(f\"{primary_prefix}.{clean_tag}\")\n\n return result\n\n\ndef get_target_files(\n files: list[str] | None = None,\n directories: list[str] | None = None,\n exclude: list[str] | None = None,\n) -> list[Path]:\n \"\"\"Resolve target source files for translation validation.\n\n Args:\n files: Explicit list of files to scan.\n directories: Directories to recursively scan.\n exclude: Filename patterns to exclude.\n\n Returns:\n target_files: A list of source file paths.\n\n Raises:\n FileNotFoundError: If the default src directory is missing.\n \"\"\"\n exclude = exclude or []\n targets: list[Path] = []\n\n if files:\n for file_path in files:\n path = Path(file_path)\n if path.exists() and path.is_file():\n targets.append(path)\n else:\n print(\n f\"Warning: File not found: {file_path}\",\n file=sys.stderr,\n )\n\n if directories:\n for directory in directories:\n dir_path = Path(directory)\n if dir_path.exists() and dir_path.is_dir():\n targets.extend(dir_path.rglob(\"*\"))\n else:\n print(\n f\"Warning: Directory not found: {directory}\",\n file=sys.stderr,\n )\n\n if not files and not directories:\n src_path = Path(\"src\")\n if not src_path.exists() or not src_path.is_dir():\n raise FileNotFoundError(\"Default 'src' directory not found\")\n targets = list(src_path.rglob(\"*\"))\n\n return [\n path\n for path in targets\n if path.suffix in {\".ts\", \".tsx\", \".js\", \".jsx\"}\n and not any(path.name.endswith(x) or x in path.parts for x in exclude)\n and \".spec.\" not in path.name\n and \".test.\" not in path.name\n ]\n\n\ndef check_file(path: Path, valid_keys: set[str]) -> list[str]:\n \"\"\"Check a file for missing translation keys.\n\n Args:\n path: File path to check.\n valid_keys: Set of valid translation keys.\n\n Returns:\n missing_keys: A sorted list of missing translation keys.\n \"\"\"\n return sorted(\n tag for tag in find_translation_tags(path) if tag not in valid_keys\n )\n\n\ndef main() -> None:\n \"\"\"CLI entry point for translation validation.\n\n This function parses command-line arguments, loads translation keys,\n validates translation tag usage across source files, and exits with\n appropriate status codes based on the results.\n\n Args:\n None\n\n Returns:\n None\n\n Raises:\n SystemExit: Exits with status code 0 on success, 1 if missing\n translation keys are found, or 2 for configuration errors.\n \"\"\"\n parser = argparse.ArgumentParser()\n parser.add_argument(\"--files\", nargs=\"*\", default=[])\n parser.add_argument(\"--directories\", nargs=\"*\", default=[])\n parser.add_argument(\"--locales-dir\", default=\"public/locales/en\")\n args = parser.parse_args()\n\n try:\n valid_keys = load_locale_keys(args.locales_dir)\n except FileNotFoundError as exc:\n print(\n f\"Error: Locale directory not found: {exc}\",\n file=sys.stderr,\n )\n sys.exit(2)\n\n try:\n targets = get_target_files(args.files, args.directories)\n except FileNotFoundError as exc:\n print(f\"Error: {exc}\", file=sys.stderr)\n sys.exit(2)\n\n errors: dict[str, list[str]] = {}\n for path in targets:\n missing = check_file(path, valid_keys)\n if missing:\n errors[str(path)] = missing\n\n if errors:\n for file, tags in errors.items():\n print(\n f\"File: {file}\\n\"\n + \"\\n\".join(f\" - Missing: {tag}\" for tag in tags)\n )\n sys.exit(1)\n\n print(\"All translation tags validated successfully\")\n sys.exit(0)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": ".github/workflows/stale.yml", "content": "name: Mark stale issues and pull requests\n\non:\n schedule:\n - cron: '*/20 0 * * *'\njobs:\n stale:\n uses: PalisadoesFoundation/.github/.github/workflows/stale.yml@main\n" }, { "path": ".gitignore", "content": "# Docusaurus related\n.docusaurus\n\n# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.\n\n# lockfiles from other package managers (YARN, npm)\nyarn.lock\npackage-lock.json\n\n# dependencies\n/node_modules\n/.pnp\n.pnp.js\n.node-version\n.nvmrc\n\n\n# testing\ncoverage/\ncoverage-shards/\ncodecov\n\n# production\n/build\n\n# misc\n.DS_Store\n\n# Config files\n!/.env.sample\n/.env\n/.env-*\n/.env_*\n/.env.*\n.backup/\n\n# Log files\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n\n# express setup\ndebug.log\n\n# No editor related files\n.idea\n.vscode\n*.swp\n\n# Plugin related\n/src/plugin/available/*\n!/src/plugin/available/readme.md\n\n# Cypress related\ncypress/videos\ncypress/screenshots\n.nyc_output\n\n# Redis related\ndump.rdb\n\n# Ignore log files in the root directory\n/*.log\nconfig/node_modules/\n**/.vite/\n\n# GitHub Actions\n.github-central\n\n################################################################\n# Python related\n################################################################\n\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[codz]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\n!scripts/install/lib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py.cover\n.hypothesis/\n.pytest_cache/\ncover/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\n.pybuilder/\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n# For a library or package, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# .python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n# Pipfile.lock\n\n# UV\n# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.\n# This is especially recommended for binary packages to ensure reproducibility, and is more\n# commonly ignored for libraries.\n# uv.lock\n\n# poetry\n# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.\n# This is especially recommended for binary packages to ensure reproducibility, and is more\n# commonly ignored for libraries.\n# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control\n# poetry.lock\n# poetry.toml\n\n# pdm\n# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.\n# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.\n# https://pdm-project.org/en/latest/usage/project/#working-with-version-control\n# pdm.lock\n# pdm.toml\n.pdm-python\n.pdm-build/\n\n# pixi\n# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.\n# pixi.lock\n# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one\n# in the .venv directory. It is recommended not to include this directory in version control.\n.pixi\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# Redis\n*.rdb\n*.aof\n*.pid\n\n# RabbitMQ\nmnesia/\nrabbitmq/\nrabbitmq-data/\n\n# ActiveMQ\nactivemq-data/\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.envrc\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# pytype static type analyzer\n.pytype/\n\n# Cython debug symbols\ncython_debug/\n\n# PyCharm\n# JetBrains specific template is maintained in a separate JetBrains.gitignore that can\n# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore\n# and can be added to the global gitignore or merged into this file. For a more nuclear\n# option (not recommended) you can uncomment the following to ignore the entire idea folder.\n# .idea/\n\n# Abstra\n# Abstra is an AI-powered process automation framework.\n# Ignore directories containing user credentials, local state, and settings.\n# Learn more at https://abstra.io/docs\n.abstra/\n\n# Visual Studio Code\n# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore \n# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore\n# and can be added to the global gitignore or merged into this file. However, if you prefer, \n# you could uncomment the following to ignore the entire vscode folder\n# .vscode/\n\n# Ruff stuff:\n.ruff_cache/\n\n# PyPI configuration file\n.pypirc\n\n# Marimo\nmarimo/_static/\nmarimo/_lsp/\n__marimo__/\n\n# Streamlit\n.streamlit/secrets.toml\n\n# ESLint plugin build output\nscripts/eslint/dist/\n" }, { "path": ".graphqlrc.yml", "content": "schema: 'schema.graphql'\n" }, { "path": ".husky/commit-msg", "content": "# !/usr/bin/env sh\n. \"$(dirname -- \"$0\")/_/husky.sh\"\n\nnpx --no-install commitlint --edit \"$1\"\n" }, { "path": ".husky/post-merge", "content": "#!/bin/sh\n. \"$(dirname \"$0\")/_/husky.sh\"\n\ngit diff HEAD^ HEAD --exit-code -- ./package.json || pnpm install" }, { "path": ".husky/pre-commit", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Talawa Admin – Git Pre-Commit Hook\n# =============================================================================\n#\n# This is the main entry point for all pre-commit checks.\n# It determines which files are staged, prepares temporary file lists,\n# and delegates language-specific checks to dedicated scripts.\n#\n# Responsibilities:\n# - Verify required tools are installed\n# - Identify staged source files safely (null-delimited)\n# - Run Node.js and Python pre-commit checks conditionally\n# - Re-stage modified files after formatting\n#\n# Design Notes:\n# - Uses temporary files instead of variables to safely handle filenames\n# - Exits early if no files are staged to improve performance\n# - Delegates logic to smaller scripts for maintainability\n#\n# =============================================================================\n\n# If running under sh/dash (from Husky sourcing), re-execute with bash\nif [ -z \"$BASH_VERSION\" ]; then\n exec bash \"$0\" \"$@\"\nfi\n\nset -euo pipefail\n\n. .husky/scripts/staged-files.sh\n\n.husky/scripts/check-tools.sh\n\nSTAGED_SRC_FILE=$(mktemp)\nSTAGED_ALL_FILE=$(mktemp)\ntrap 'rm -f \"$STAGED_SRC_FILE\" \"$STAGED_ALL_FILE\"; cleanup_staged_cache 2>/dev/null || true' EXIT\n\nget_staged_files '^(src|scripts)/.*\\.(ts|tsx|js|jsx)$' > \"$STAGED_SRC_FILE\"\nget_staged_files > \"$STAGED_ALL_FILE\"\n\n# Early exit if nothing staged\n[ ! -s \"$STAGED_ALL_FILE\" ] && {\n echo \"No staged files to check...\"\n exit 0\n}\n\n# Design token validation (runs for any staged files so .css/.scss/.sass are checked even when no .ts/.tsx staged)\necho \"Running design token validation...\"\npnpm exec tsx scripts/validate-tokens.ts --staged --all || exit 1\n\nif [ -s \"$STAGED_SRC_FILE\" ]; then\n .husky/scripts/precommit-node.sh \"$STAGED_SRC_FILE\"\nfi\n\n.husky/scripts/precommit-python.sh \"$STAGED_SRC_FILE\"\n\nxargs -0 git add -- < \"$STAGED_ALL_FILE\"\n" }, { "path": ".husky/scripts/check-tools.sh", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Pre-Commit Tool Availability Check\n# =============================================================================\n#\n# This script ensures all required tools are available before running\n# any pre-commit checks. Failing early avoids confusing errors later\n# in the commit process.\n#\n# Checked Tools:\n# - Core: git, node, pnpm, npx\n# - Download tools: curl or wget (at least one required)\n# - Checksum tools: shasum or sha256sum\n# - Python: python3 or python (used via virtual environment)\n#\n# Design Notes:\n# - Fails fast with actionable error messages\n# - Supports multiple equivalent tools for portability\n# - Improves cross-platform developer experience\n#\n# =============================================================================\nset -euo pipefail\n\necho \"Checking required tools...\"\n\ncheck_tool() {\n if ! command -v \"$1\" >/dev/null 2>&1; then\n echo \"Error: Required tool '$1' is not installed.\"\n echo \"Please install '$1' and try again.\"\n exit 1\n fi\n}\n\n# Core tools\ncheck_tool git\ncheck_tool node\ncheck_tool pnpm\ncheck_tool npx\ncheck_tool \"perl\"\n\n# Download tools (at least one required)\nif ! command -v curl >/dev/null 2>&1 && ! command -v wget >/dev/null 2>&1; then\n echo \"Error: Neither 'curl' nor 'wget' is installed.\"\n echo \"Please install one of them to continue.\"\n exit 1\nfi\n\n# Checksum tools (required by precommit-python.sh)\nif ! command -v shasum >/dev/null 2>&1 && ! command -v sha256sum >/dev/null 2>&1; then\n echo \"Error: Neither 'shasum' nor 'sha256sum' is installed.\"\n echo \"Please install one of them to continue.\"\n exit 1\nfi\n\n# Python (used via venv)\nif ! command -v python3 >/dev/null 2>&1 && ! command -v python >/dev/null 2>&1; then\n echo \"Error: Neither 'python3' nor 'python' is installed.\"\n echo \"Please install Python and try again.\"\n exit 1\nfi\n\necho \"All required tools are available.\"\n" }, { "path": ".husky/scripts/fetch-verified.sh", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Talawa Admin – Fetch & Verify Remote Scripts\n# =============================================================================\n#\n# Thin helper to securely fetch and cache external CI/CD scripts.\n#\n# Responsibilities:\n# - Download remote scripts from a trusted source\n# - Verify integrity using a pinned SHA-256 checksum\n# - Cache verified scripts locally for reuse\n#\n# Design Notes:\n# - Intentionally minimal to avoid scope creep\n# - Fails fast on download or verification errors\n# - Shared by Husky pre-commit hooks and CI tooling\n#\n# =============================================================================\n\nset -euo pipefail\n\nif ! command -v curl >/dev/null 2>&1 && ! command -v wget >/dev/null 2>&1; then\n echo \"Error: curl or wget is required to fetch remote scripts.\" >&2\n exit 1\nfi\n\nif ! command -v sha256sum >/dev/null 2>&1 && ! command -v shasum >/dev/null 2>&1; then\n echo \"Error: sha256sum or shasum is required for checksum verification.\" >&2\n exit 1\nfi\n\nfetch_and_verify() {\n local url=\"$1\"\n local dest=\"$2\"\n local expected_sha=\"$3\"\n local cache_hours=\"${4:-24}\"\n\n if [ -z \"$url\" ] || [ -z \"$dest\" ] || [ -z \"$expected_sha\" ]; then\n echo \"Error: fetch_and_verify requires url, dest, and expected_sha\" >&2\n exit 1\n fi\n\n mkdir -p \"$(dirname \"$dest\")\"\n\n local NEEDS_DOWNLOAD=true\n local FILE_MOD_TIME=\"\"\n local OS_TYPE\n OS_TYPE=\"$(uname -s)\"\n\n if [ -f \"$dest\" ]; then\n case \"$OS_TYPE\" in\n Darwin*)\n FILE_MOD_TIME=$(stat -f %m \"$dest\" 2>/dev/null || true)\n ;;\n Linux*)\n FILE_MOD_TIME=$(stat -c %Y \"$dest\" 2>/dev/null || true)\n ;;\n MINGW*|MSYS*|CYGWIN*)\n if command -v powershell.exe >/dev/null 2>&1; then\n local win_path\n win_path=$(cygpath -w \"$dest\" 2>/dev/null \\\n || echo \"$dest\" | sed 's|^/\\([a-z]\\)/|\\U\\1:/|')\n\n FILE_MOD_TIME=$(powershell.exe -NoProfile -Command \\\n \"([DateTimeOffset](Get-Item -LiteralPath \\\"${win_path}\\\").LastWriteTimeUtc).ToUnixTimeSeconds()\" \\\n 2>/dev/null | tr -d '\\r' || true)\n fi\n ;;\n *)\n echo \"Warning: Unsupported OS ($OS_TYPE); caching disabled. Script will be downloaded on every run.\" >&2\n FILE_MOD_TIME=\"\"\n ;;\n esac\n\n if [ -n \"$FILE_MOD_TIME\" ]; then\n local now\n now=$(date +%s 2>/dev/null || python3 -c 'import time; print(int(time.time()))' 2>/dev/null || python -c 'import time; print(int(time.time()))')\n local age_hours=$(( (now - FILE_MOD_TIME) / 3600 ))\n if [ \"$age_hours\" -lt \"$cache_hours\" ]; then\n NEEDS_DOWNLOAD=false\n fi\n fi\n fi\n\n if [ \"$NEEDS_DOWNLOAD\" = false ]; then\n local cached_sha\n if command -v sha256sum >/dev/null 2>&1; then\n cached_sha=$(sha256sum \"$dest\" | awk '{print $1}')\n elif command -v shasum >/dev/null 2>&1; then\n cached_sha=$(shasum -a 256 \"$dest\" | awk '{print $1}')\n else\n echo \"Error: sha256sum or shasum is required\" >&2\n exit 1\n fi\n\n if [ \"$cached_sha\" != \"$expected_sha\" ]; then\n echo \"Warning: cached checksum mismatch; re-downloading\" >&2\n NEEDS_DOWNLOAD=true\n fi\n fi\n\n if [ \"$NEEDS_DOWNLOAD\" = true ]; then\n echo \"Fetching $(basename \"$dest\")...\"\n\n local tmp\n tmp=\"$(mktemp -t fetch.XXXXXX)\"\n trap 'rm -f \"$tmp\"' RETURN\n\n if command -v curl >/dev/null 2>&1; then\n curl -sSfL \"$url\" -o \"$tmp\"\n elif command -v wget >/dev/null 2>&1; then\n wget -q -O \"$tmp\" \"$url\"\n else\n echo \"Error: curl or wget is required\" >&2\n exit 1\n fi\n\n local actual_sha\n if command -v sha256sum >/dev/null 2>&1; then\n actual_sha=$(sha256sum \"$tmp\" | awk '{print $1}')\n elif command -v shasum >/dev/null 2>&1; then\n actual_sha=$(shasum -a 256 \"$tmp\" | awk '{print $1}')\n else\n echo \"Error: sha256sum or shasum is required\" >&2\n rm -f \"$tmp\"\n exit 1\n fi\n\n if [ \"$actual_sha\" != \"$expected_sha\" ]; then\n echo \"Security error: checksum mismatch for $dest\" >&2\n echo \"Expected: $expected_sha\" >&2\n echo \"Actual: $actual_sha\" >&2\n rm -f \"$tmp\"\n exit 1\n fi\n\n mv \"$tmp\" \"$dest\"\n chmod +x \"$dest\"\n fi\n}" }, { "path": ".husky/scripts/precommit-node.sh", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Pre-Commit Node.js Checks\n# =============================================================================\n#\n# Runs all Node.js-related validations on staged files to ensure\n# code quality and CI parity before commits are created.\n#\n# Checks include:\n# - Documentation generation and ToC updates\n# - Code formatting and linting\n# - TypeScript type checking\n# - i18n validation on staged files\n# - Dependency and dead-code analysis (Knip)\n# - Policy checks (MinIO, mocks, localStorage usage)\n#\n# Design Notes:\n# - Exits early if no staged source files are provided\n# - Uses pnpm for consistency with project tooling\n# - Keeps behavior aligned with CI to avoid surprises\n#\n# =============================================================================\nset -euo pipefail\n\nPIDS=()\ncleanup_bg() {\n for pid in \"${PIDS[@]:-}\"; do\n kill \"$pid\" 2>/dev/null || true\n done\n}\ntrap cleanup_bg EXIT\n\nSTAGED_SRC_FILE=\"$1\"\n\n[ ! -s \"$STAGED_SRC_FILE\" ] && {\n echo \"Skipping Node.js checks (no staged source files)...\"\n exit 0\n}\n\necho \"Running Node.js pre-commit checks...\"\n\npnpm run generate-docs &\nPID_DOCS=$!\nPIDS+=(\"$PID_DOCS\")\n\npnpm run format:fix || exit 1\npnpm run lint-staged || exit 1\n\npnpm run typecheck &\nPID_TYPECHECK=$!\nPIDS+=(\"$PID_TYPECHECK\")\n\nwait \"$PID_DOCS\"; STATUS_DOCS=$?\nwait \"$PID_TYPECHECK\"; STATUS_TYPECHECK=$?\nif [ \"$STATUS_DOCS\" -ne 0 ] || [ \"$STATUS_TYPECHECK\" -ne 0 ]; then\n echo \"Background task failure\"\n exit 1\nfi\n\nxargs -0 pnpm run check-i18n -- --staged < \"$STAGED_SRC_FILE\"\n\n# MinIO compliance check (prevent unsupported upload patterns)\necho \"Running MinIO compliance check (policy enforcement)...\"\nnode .github/workflows/scripts/check-minio-compliance.cjs || exit 1\n\npnpm run update:toc || exit 1\npnpm run check:pom || exit 1\n\nnpx knip --include files,exports,nsExports,nsTypes &\nPID_KNIP1=$!\nPIDS+=(\"$PID_KNIP1\")\n\nnpx knip --config knip.deps.json --include dependencies &\nPID_KNIP2=$!\nPIDS+=(\"$PID_KNIP2\")\n\nwait \"$PID_KNIP1\"; STATUS_KNIP1=$?\nwait \"$PID_KNIP2\"; STATUS_KNIP2=$?\nif [ \"$STATUS_KNIP1\" -ne 0 ] || [ \"$STATUS_KNIP2\" -ne 0 ]; then\n echo \"Background task failure\"\n exit 1\nfi\n\npnpm run check-mock-cleanup || exit 1\npnpm run check-route-prefix || exit 1\npnpm run check-localstorage || exit 1\n\ngit add docs/docs/auto-docs\n\necho \"Node.js checks completed successfully.\"\n" }, { "path": ".husky/scripts/precommit-python.sh", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Pre-Commit Python Checks\n# =============================================================================\n#\n# Initializes a Python virtual environment and runs all Python-based\n# validation and policy checks used by CI.\n#\n# Checks include:\n# - Formatting and linting (black, flake8, pydocstyle)\n# - Documentation and translation validation\n# - File complexity limits\n# - Security checks via external, checksum-verified scripts\n# - CSS policy checks on staged files\n#\n# External Script Caching:\n# - Centralized scripts are downloaded from PalisadoesFoundation/.github\n# - Cached locally to reduce network dependency\n# - SHA256 verification ensures script integrity\n#\n# Design Notes:\n# - Supports Windows via cmd.exe execution\n# - Uses null-delimited file lists for safety\n# - Falls back gracefully when no staged files are present\n#\n# =============================================================================\nset -euo pipefail\n\n. \"$(git rev-parse --show-toplevel)/.husky/scripts/staged-files.sh\"\n. \"$(git rev-parse --show-toplevel)/.husky/scripts/fetch-verified.sh\"\n\ncleanup() {\n [ -n \"${CSS_TMP:-}\" ] && rm -f \"$CSS_TMP\"\n cleanup_staged_cache 2>/dev/null || true\n}\n\ntrap cleanup EXIT\n\n# =============================================================================\n# Configuration constants\n# =============================================================================\n\n# Maximum allowed lines per file before triggering complexity warnings.\n# This helps prevent large, hard-to-maintain files from being committed.\nMAX_FILE_LINES=600\n\n# Cache duration (in hours) for externally downloaded scripts.\n# Reduces network dependency while ensuring periodic updates.\nSCRIPT_CACHE_HOURS=24\n\nSTAGED_SRC_FILE=\"${1:-}\"\nif [ -z \"$STAGED_SRC_FILE\" ]; then\n echo \"Error: staged file list path is required.\" >&2\n exit 1\nfi\n\necho \"Initializing Python virtual environment...\"\nVENV_BIN=$(./.husky/scripts/venv.sh) || exit 1\n\nUNAME_OUT=$(uname -s 2>/dev/null || echo \"\")\nif echo \"$UNAME_OUT\" | grep -qiE 'mingw|msys|cygwin'; then\n set -- cmd.exe //c \"$VENV_BIN\"\nelse\n set -- \"$VENV_BIN\"\nfi\n\necho \"Running Python formatting and lint checks...\"\n\n\"$@\" -m black --check .github\n\"$@\" -m pydocstyle .github\n\"$@\" -m flake8 .github\n\necho \"Running Python CI parity checks...\"\n\n\"$@\" .github/workflows/scripts/compare_translations.py --directory public/locales\n\nif [ ! -s \"$STAGED_SRC_FILE\" ]; then\n echo \"No staged source files detected. Skipping file-based Python checks.\"\n exit 0\nfi\n\necho \"Running translation checks on staged files...\"\nxargs -0 \"$@\" .github/workflows/scripts/translation_check.py --files < \"$STAGED_SRC_FILE\"\n\necho \"Running centralized Python policy checks...\"\n\n# =============================================================================\n# We are using SHAs pinned to specific commits to ensure script integrity\n# and avoid executing unverified code.\n# Kindly update the SHAs if upstream scripts are modified.\n#==============================================================================\n# Centralized scripts directory\nCENTRAL_SCRIPTS_DIR=\".github-central/.github/workflows/scripts\"\n\necho \"Running disable statements check...\"\nDISABLE_STATEMENTS_URL=\"https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/disable_statements_check.py\"\nDISABLE_STATEMENTS_PATH=\"$CENTRAL_SCRIPTS_DIR/disable_statements_check.py\"\nDISABLE_STATEMENTS_SHA=\"9acbc75c02413607c2f15eb3babc3484bb7dbd53c5d27f611d6cd26cc89c55ec\"\n\nfetch_and_verify \\\n \"$DISABLE_STATEMENTS_URL\" \\\n \"$DISABLE_STATEMENTS_PATH\" \\\n \"$DISABLE_STATEMENTS_SHA\" \\\n \"$SCRIPT_CACHE_HOURS\"\n\nxargs -0 \"$@\" \"$DISABLE_STATEMENTS_PATH\" --files < \"$STAGED_SRC_FILE\"\n\necho \"Running docstring compliance check...\"\nCHECK_DOCSTRINGS_URL=\"https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/check_docstrings.py\"\nCHECK_DOCSTRINGS_PATH=\"$CENTRAL_SCRIPTS_DIR/check_docstrings.py\"\nCHECK_DOCSTRINGS_SHA=\"f9a2efbb8cad49241f3e72e65637f5cdde98980c30a09c8ba0acf3e98494fee7\"\n\nfetch_and_verify \\\n \"$CHECK_DOCSTRINGS_URL\" \\\n \"$CHECK_DOCSTRINGS_PATH\" \\\n \"$CHECK_DOCSTRINGS_SHA\" \\\n \"$SCRIPT_CACHE_HOURS\"\n\n\"$@\" \"$CHECK_DOCSTRINGS_PATH\" --directories .github\n\necho \"Running line count enforcement check...\"\nCOUNTLINE_URL=\"https://raw.githubusercontent.com/PalisadoesFoundation/.github/main/.github/workflows/scripts/countline.py\"\nCOUNTLINE_PATH=\"$CENTRAL_SCRIPTS_DIR/countline.py\"\nCOUNTLINE_SHA=\"482928bed829894d1a77b656d26de1d65fa9a69cda38cd8002136903307a6a08\"\n\nfetch_and_verify \\\n \"$COUNTLINE_URL\" \\\n \"$COUNTLINE_PATH\" \\\n \"$COUNTLINE_SHA\" \\\n \"$SCRIPT_CACHE_HOURS\"\n\n\"$@\" \"$COUNTLINE_PATH\" \\\n --lines \"$MAX_FILE_LINES\" \\\n --files ./.github/workflows/config/countline_excluded_file_list.txt\n\n\n\necho \"Running CSS policy checks...\"\n\n# CSS Policy Check\n# Exclude src/utils/ (utility/helper functions) and src/types/ (type definitions)\n# as they cannot contain UI styling code\nCSS_TMP=$(mktemp)\n\nget_staged_files '' '^src/utils/|^src/types/' > \"$CSS_TMP\"\n\nif [ -s \"$CSS_TMP\" ]; then\n xargs -0 \"$@\" \\\n .github/workflows/scripts/css_check.py --files < \"$CSS_TMP\"\nfi\n\necho \"Python checks completed.\"\n" }, { "path": ".husky/scripts/staged-files.sh", "content": "#!/usr/bin/env bash\n#\n# Shared helpers for staged file detection and filtering.\n# Used by pre-commit hooks to ensure consistent staged-file handling\n# across macOS, Linux, and Windows (Git Bash).\n#\n\nset -euo pipefail\n\n_STAGED_CACHE_FILE=\"\"\n\ncleanup_staged_cache() {\n [ -n \"${_STAGED_CACHE_FILE:-}\" ] && rm -f \"$_STAGED_CACHE_FILE\"\n}\n\nget_staged_files() {\n include=\"${1:-}\"\n exclude=\"${2:-}\"\n\n if [ -z \"$_STAGED_CACHE_FILE\" ]; then\n _STAGED_CACHE_FILE=$(mktemp)\n git diff --cached -z --name-only --diff-filter=ACMRT > \"$_STAGED_CACHE_FILE\" || true\n fi\n\n if [ -z \"$include\" ] && [ -z \"$exclude\" ]; then\n cat \"$_STAGED_CACHE_FILE\"\n return\n fi\n\n inc=\"$include\"\n exc=\"$exclude\"\n\n if [ -n \"$include\" ] && [ -n \"$exclude\" ]; then\n inc=\"$inc\" exc=\"$exc\" perl -0 -ne '\n for (split /\\0/) {\n print \"$_\\0\" if /$ENV{inc}/ && !/$ENV{exc}/\n }\n ' \"$_STAGED_CACHE_FILE\" || true\n return\n fi\n\n if [ -n \"$include\" ]; then\n inc=\"$inc\" perl -0 -ne '\n for (split /\\0/) {\n print \"$_\\0\" if /$ENV{inc}/\n }\n ' \"$_STAGED_CACHE_FILE\" || true\n return\n fi\n\n exc=\"$exc\" perl -0 -ne '\n for (split /\\0/) {\n print \"$_\\0\" if !/$ENV{exc}/\n }\n ' \"$_STAGED_CACHE_FILE\" || true\n}\n" }, { "path": ".husky/scripts/venv.sh", "content": "#!/usr/bin/env bash\n#\n# =============================================================================\n# Python Virtual Environment Bootstrap\n# =============================================================================\n#\n# Locates and prepares the project's Python virtual environment for use\n# by pre-commit hooks and local CI parity checks.\n#\n# Responsibilities:\n# - Detect the correct Python executable across platforms\n# - Ensure dependencies are installed from requirements.txt\n# - Normalize paths for Windows environments (Git Bash / Cygwin)\n# - Prevent concurrent dependency installation via file locking\n#\n# Design Notes:\n# - Supports both Unix and Windows virtualenv layouts\n# - Uses locking to avoid race conditions during installs\n# - Outputs the resolved Python executable path for callers\n#\n# =============================================================================\nset -euo pipefail\n\nREPO_ROOT=$(git rev-parse --show-toplevel)\n\nVENV_DIR=\"$REPO_ROOT/venv\"\n\nif [ ! -d \"$VENV_DIR\" ]; then\n echo \"[X] Python virtual environment not found....\" >&2\n exit 1\nfi\n\nif [ -x \"$VENV_DIR/bin/python\" ]; then\n VENV_PY=\"$VENV_DIR/bin/python\"\nelif [ -x \"$VENV_DIR/Scripts/python.exe\" ]; then\n VENV_PY=\"$VENV_DIR/Scripts/python.exe\"\nelse\n echo \"Error: Python executable not found in venv.\"\n echo \"Checked: $VENV_DIR/bin/python and $VENV_DIR/Scripts/python.exe\"\n exit 1\nfi\n\nLOCK_FILE=$(git rev-parse --git-path venv-setup.lock)\nexec 9>\"$LOCK_FILE\"\n\nif command -v flock >/dev/null 2>&1; then\n flock 9\nelse\n echo \"Warning: flock not available, proceeding without lock\" >&2\nfi\n\n# Install deps\n\"$VENV_PY\" -m pip install -q --disable-pip-version-check -r \"$REPO_ROOT/.github/workflows/requirements.txt\"\n\nif command -v cygpath >/dev/null 2>&1; then\n VENV_PY=$(cygpath -u \"$VENV_PY\")\nfi\n\necho \"$VENV_PY\"" }, { "path": ".lintstagedrc.json", "content": "{\n \"**/*.{ts,tsx,yml}\": [\"eslint --fix\"],\n \"**/*.{ts,tsx,json,scss,css,yml}\": [\"prettier --write\"],\n \"**/*.{ts,tsx}\": [\"npx tsx scripts/githooks/check-localstorage-usage.ts\"],\n \"**/*.{ts,tsx,css}\": [\"pnpm exec tsx scripts/check-css-imports.js --files\"]\n}\n" }, { "path": ".nojekyll", "content": "" }, { "path": ".prettierignore", "content": "node_modules\n# Contains the PDF file of the Tag as JSON string, thus does not need to be formatted\nsrc/shared-components/CheckIn/tagTemplate.ts\nvitest.config.ts\ndocs/pnpm-lock.yaml\npnpm-lock.yaml\n" }, { "path": ".prettierrc", "content": "{\n \"singleQuote\": true,\n \"endOfLine\": \"auto\"\n}" }, { "path": ".pydocstyle", "content": "[pydocstyle]\nconvention=google\nadd-ignore=D415,D205" }, { "path": "CODEOWNERS", "content": "/.github/ @palisadoes\n# CODEOWNERS @palisadoes\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\nPlease read our Organization's [Contributor Covenant Code of Conduct](https://developer.palisadoes.org/docs/contributor-guide/code-of-conduct).\n" }, { "path": "CODE_STYLE.md", "content": "# Talawa Admin Code Style\n\nFor Talawa Admin, most of the rules for the code style have been enforced with ESLint, but this document serves to provide an overview of the Code style used in Talawa Admin and the Rationale behind it.\n\nThe code style must be strictly adhered to, to ensure that there is consistency throughout the contributions made to Talawa-Admin\n\ncode style should not be changed and must be followed.\n\n# Table of Contents\n\n\n\n- [Tech Stack](#tech-stack)\n- [Component Structure](#component-structure)\n- [Code Style and Naming Conventions](#code-style-and-naming-conventions)\n- [Empty State Guidelines](#empty-state-guidelines)\n - [Preferred Pattern: EmptyState Component](#preferred-pattern-emptystate-component)\n - [NotFound vs EmptyState](#notfound-vs-emptystate)\n - [Migration Rule](#migration-rule)\n - [Refactoring Example](#refactoring-example)\n - [NotFound vs EmptyState Distinction](#notfound-vs-emptystate-distinction)\n - [Use `EmptyState` when:](#use-emptystate-when)\n - [Use `NotFound` when:](#use-notfound-when)\n - [Notes](#notes)\n- [TSDoc](#tsdoc)\n - [How Contributors Can Improve Comments](#how-contributors-can-improve-comments)\n- [Test and Code Linting](#test-and-code-linting)\n- [Folder/Directory Structure](#folderdirectory-structure)\n - [Sub Directories of `src`](#sub-directories-of-src)\n- [Imports](#imports)\n- [Customising Bootstrap](#customising-bootstrap)\n\n\n\n## Tech Stack\n\n- Typescript\n\n- React.js\n\n- CSS module\n\n- React bootstrap\n\n- Material UI\n\n- GraphQL\n\n- Vitest & React Testing Library for testing\n\n## Component Structure\n\n- Components should be strictly functional components\n\n- Should make use of React hooks where appropriate\n\n## Code Style and Naming Conventions\n\n- All React components _must_ be written in PascalCase, with their file names, and associated CSS modules being written in PascalCase\n\n- All other files may follow the camelCase naming convention\n\n- All the Return fragment should be closed in empty tag\n\n- Use of custom classes directly are refrained, use of modular css is encouraged along with bootstrap classes\n\n**Wrong way ❌**\n\n```\n
...
\n
...
// No using personal custom classes directly, here you should not use myCustomClass2\n.container{...} // No changing the property of already existing classes reserved by boostrap directly in css files\n```\n\n**Correct ways ✅**\n\n```\n
...
// Use custom class defined in modular css file\n
...
// Use classes already defined in Bootstrap\n
...
// Use classes already defined in Bootstrap\n```\n\n- All components should be either imported from React-Bootstrap library or Material UI library, components should not be written using plain Bootstrap classes and attributes without leveraging the React-Bootstrap library.\n\n**Example: Bootstrap Dropdown**\n\n**Wrong way ❌**\n\nUsing plain Bootstrap classes and attributes without leveraging the React-Bootstrap library should be refrained. While it may work for basic functionality, it doesn't fully integrate with React and may cause issues when dealing with more complex state management or component interactions.\n\n```\n
\n \n \n
\n```\n\n**Correct way ✅**\n\nIt's recommended to use the React-Bootstrap library for seamless integration of Bootstrap components in a React application.\n\n```\nimport Dropdown from 'react-bootstrap/Dropdown';\n\nfunction BasicExample() {\n return (\n \n \n Dropdown Button\n \n\n \n Action\n Another action\n Something else\n \n \n );\n}\n\nexport default BasicExample;\n```\n\n## Empty State Guidelines\n\nTo ensure consistency across the application, all empty or no-data UI states must follow a standardized pattern.\n\n### Preferred Pattern: EmptyState Component\n\nThe shared `EmptyState` component **must** be used for all new empty state implementations.\n\nUse `EmptyState` for:\n- Empty lists or tables\n- No search results\n- No organizations, users, events, or records\n- Filtered views returning no data\n- First-time or onboarding empty states\n\n### NotFound vs EmptyState\n\n| Use Case | Component |\n|--------|-----------|\n| No data / empty list | `EmptyState` |\n| No search results | `EmptyState` |\n| Resource does not exist (404) | `NotFound` |\n| Invalid route | `NotFound` |\n\n### Migration Rule\n\n- Legacy `.notFound` CSS-based implementations are deprecated\n- Existing screens should be migrated incrementally\n- **For new empty state implementations, always use `EmptyState`**\n\n### Refactoring Example\n\n**Before (legacy pattern):**\n\n```tsx\n
\n

{t('noResultsFound')}

\n
\n\n```\n\n**After (preferred pattern):**\n\n```tsx\nimport EmptyState from 'shared-components/EmptyState/EmptyState';\n\n\n```\n\n### NotFound vs EmptyState Distinction\n\nAlthough both components represent “absence” scenarios, they serve **different purposes** and must not be used interchangeably.\n\n#### Use `EmptyState` when:\n- The page or screen is valid, but the data set is empty\n- A list, table, or search returns zero results\n- Filters remove all visible items\n- The user has no data yet (first-time or onboarding state)\n\n**Examples:**\n- No users in a table\n- No organizations found after search\n- No membership requests\n\n#### Use `NotFound` when:\n- A requested resource does not exist\n- A route is invalid or inaccessible\n- A user navigates to a non-existent entity\n\n**Examples:**\n- Invalid organization ID\n- Unknown user profile URL\n- 404-style navigation errors\n\n### Notes\n\n- Do not show EmptyState while data is loading\n- Use LoadingState during fetch operations\n- All user-visible text must use i18n keys\n\n\n## TSDoc\n\nIncluding TSDoc comments in each file is essential for maintaining a well-documented codebase. These comments provide clarity for developers and enable AI tools to better understand the code structure and functionality.\n\n- AI tools rely on comments to infer the purpose and behavior of code.\n- Detailed comments help AI generate accurate and meaningful unit tests.\n- Clear documentation ensures contributors can quickly grasp the code's intent.\n\n### How Contributors Can Improve Comments\n\n- Specify all required props and their types for components.\n- Include example usage snippets to demonstrate how to call the component.\n- Clearly describe the purpose and behavior of functions or components.\n- Ensure each file has a Top-level TSDoc comment.\n- You may modify pre-written comments, but only when you have a complete understanding of their intent and context.\n\nBy adhering to these guidelines, contributors can ensure that the codebase remains well-documented and accessible to all developers.\n\n## Test and Code Linting\n\nUnit tests must be written for _all_ code submissions to the repository,\nthe code submitted must also be linted ESLint and formatted with Prettier.\n\n## Folder/Directory Structure\n\n### Sub Directories of `src`\n\n`assets` - This houses all of the static assets used in the project\n\n- `css` - This houses all of the css files used in the project\n- `images` - This houses all of the images used in the project\n- `scss` - This houses all of the scss files used in the project\n - `components -` All Sass files for components\n - `content -` All Sass files for content\n - `forms -` All Sass files for forms\n - `_talawa.scss` - Partial Sass file for Talawa\n - `_utilities.scss` - Partial Sass file for utilities\n - `_variables.scss` - Partial Sass file for variables\n - `app.scss` - Main Sass file for the app, imports all other partial Sass files\n\n`components` - The directory for base components that will be used in the various views/screens\n\n`Constant` - This houses all of the constants used in the project\n\n`GraphQl` - This houses all of the GraphQL queries and mutations used in the project\n\n`screens` - This houses all of the views/screens to be navigated through in Talawa-Admin\n\n`state` - This houses all of the state management code for the project\n\n`types` - This houses all of the reusable types and interfaces for the project\n\n`utils` - This holds the utility functions that do not fall into any of the other categories\n\n## Imports\n\nAbsolute imports have been set up for the project, so imports may be done directly from `src`.\n\nAn example being\n\n```\nimport Navbar from 'components/Navbar/Navbar';\n```\n\nImports should be grouped in the following order:\n\n- React imports\n- Third party imports\n- Local imports\n\nIf there is more than one import from a single library, they should be grouped together\n\nExample - If there is single import from a library, both ways will work\n\n```\nimport Row from 'react-bootstrap/Row';\n// OR\nimport { Row } from 'react-bootstrap';\n```\n\nIf there are multiple imports from a library, they should be grouped together\n\n```\nimport { Row, Col, Container } from 'react-bootstrap';\n```\n\n## Customising Bootstrap\n\nBootstrap v5.3.0 is used in the project.\nFollow this [link](https://getbootstrap.com/docs/5.3/customize/sass/) to learn how to customise bootstrap.\n\n**File Structure**\n\n- `src/assets/scss/components/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files\n\n - **\\_accordion.scss**\n - **\\_alert.scss**\n - **\\_badge.scss**\n - **\\_breadcrumb.scss**\n - **\\_buttons.scss**\n - **\\_card.scss**\n - **\\_carousel.scss**\n - **\\_close.scss**\n - **\\_dropdown.scss**\n - **\\_list-group.scss**\n - **\\_modal.scss**\n - **\\_nav.scss**\n - **\\_navbar.scss**\n - **\\_offcanvas.scss**\n - **\\_pagination.scss**\n - **\\_placeholder.scss**\n - **\\_progress.scss**\n - **\\_spinners.scss**\n\n- `src/assets/scss/content/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files\n\n - **\\_table.scss**\n - **\\_typography.scss**\n\n- `src/assets/scss/forms/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files\n\n - **\\_check-radios.scss**\n - **\\_floating-label.scss**\n - **\\_form-control.scss**\n - **\\_input-group.scss**\n - **\\_range.scss**\n - **\\_select.scss**\n - **\\_validation.scss**\n\n- `src/assets/scss/_utilities.scss` - The utility API is a Sass-based tool to generate utility classes.\n- `src/assets/scss/_variables.scss` - This file contains all the Sass variables used in the project\n- `src/assets/scss/_talawa.scss` - This files contains all the partial Sass files imported into it\n\n**How to compile Sass file**\n\n`src/assets/scss/app.scss` is the main Sass file for the app, it imports all other partial Sass files.\nAccording to naming convention the file name of the partial Sass files should start with an underscore `_` and end with `.scss`, these partial Sass files are not meant to be compiled directly, they are meant to be imported into another Sass file. Only the main Sass file `src/assets/scss/app.scss` should be compiled.\n\nThe compiled CSS file is `src/assets/css/app.css` and it is imported into `src/index.tsx` file.\n\nTo compile the Sass file once, run the following command in the terminal\n\n```\nnpx sass src/assets/scss/app.scss src/assets/css/app.css\n```\n\nTo watch the Sass file for changes and compile it automatically, run the following command in the terminal\n\n```\nnpx sass src/assets/scss/app.scss src/assets/css/app.css --watch\n```\n\nThe `src/assets/css/app.css.map` file associates the generated CSS code with the original SCSS code. It allows you to see your SCSS code in the browser's developer tools for debugging.\n\nTo skip generating the map file, run\n\n```\nnpx sass --no-source-map src/assets/scss/app.scss src/assets/css/app.css\n```\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Talawa-Admin\n\nThank you for your interest in contributing to Talawa Admin. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.\n\nIf you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).\n\n## Table of Contents\n\n\n\n- [General](#general)\n- [Testing and Code Quality](#testing-and-code-quality)\n - [Quick Reference](#quick-reference)\n- [Mock Isolation Guidelines](#mock-isolation-guidelines)\n - [Required Cleanup Pattern](#required-cleanup-pattern)\n - [Enforcement Layers](#enforcement-layers)\n - [Local Validation](#local-validation)\n - [Common Violations and Fixes](#common-violations-and-fixes)\n - [Why This Matters](#why-this-matters)\n- [Making Contributions](#making-contributions)\n\n\n\n## General\n\nPlease read the [Palisadoes Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing).\n\n## Testing and Code Quality\n\nFor detailed information about testing, linting, formatting, and code coverage, please refer to our comprehensive [Testing Guide](docs/docs/docs/developer-resources/testing.md).\n\nFor security guidelines regarding token handling and authentication, please refer to our [Security Guidelines](docs/docs/docs/developer-resources/security.md).\n\n### Quick Reference\n\n**Testing:**\n- Run all tests: `pnpm run test`\n- Run specific test: `pnpm run test /path/to/test/file`\n- Run with coverage: `pnpm run test:coverage`\n- Run with sharding: `pnpm run test:shard`\n\n**Linting and Formatting:**\n- Fix linting issues: `pnpm run lint:fix`\n- Fix formatting issues: `pnpm run format:fix`\n- Check linting: `pnpm run lint:check`\n- Check formatting: `pnpm run format:check`\n\n**Cypress E2E Testing:**\n- See the [Cypress Guide](cypress/README.md) for end-to-end testing\n\nFor complete documentation including test sharding, code coverage setup, debugging, and git hooks, visit the [Testing Guide](docs/docs/docs/developer-resources/testing.md).\n\n## Mock Isolation Guidelines\n\nProper mock isolation is **critical** for reliable tests and enables parallel test execution (12-shard CI). All test files using mocks **MUST** include cleanup to prevent mock leakage.\n\n### Required Cleanup Pattern\n\nEvery test file using `vi.fn()`, `vi.mock()`, or `vi.spyOn()` must include:\n\n```typescript\ndescribe('YourComponent', () => {\n afterEach(() => {\n vi.restoreAllMocks(); // or vi.clearAllMocks()\n });\n \n // Your tests here\n});\n```\n\n### Enforcement Layers\n\nWe enforce mock isolation through multiple layers:\n\n1. **ESLint (Real-time IDE feedback)**: Custom rule detects missing cleanup as you code\n2. **Pre-commit Hook**: Runs `check-mock-cleanup.sh` before commits\n3. **CI Check**: GitHub Actions validates all test files\n\n### Local Validation\n\nBefore committing, you can run:\n\n```bash\n# Check mock cleanup\npnpm run check-mock-cleanup\n\n# Run ESLint on test files\npnpm run lint:check\n```\n\n### Common Violations and Fixes\n\n**Missing cleanup:**\n```typescript\n// Bad - no cleanup\ndescribe('Test', () => {\n it('test', () => {\n const mock = vi.fn();\n });\n});\n```\n\n**Correct pattern:**\n```typescript\n// Good - has cleanup\ndescribe('Test', () => {\n afterEach(() => {\n vi.restoreAllMocks();\n });\n \n it('test', () => {\n const mock = vi.fn();\n });\n});\n```\n\n**Window/Timer manipulation without cleanup:**\n```typescript\n// Bad - modifies global state\nit('test', () => {\n window.location.href = 'test';\n vi.useFakeTimers();\n});\n```\n\n**Correct pattern:**\n```typescript\n// Good - restores global state \ndescribe('Test', () => {\n const originalLocation = window.location;\n \n afterEach(() => {\n window.location = originalLocation;\n vi.clearAllTimers();\n vi.useRealTimers();\n });\n});\n```\n\n### Why This Matters\n\n- **Prevents flaky tests**: Tests won't fail randomly or when run in different orders\n- **Enables parallelization**: Our 12-shard CI provides 4x speedup (only possible with isolation)\n- **Improves reliability**: Guarantees tests are independent and reproducible\n\nFor comprehensive guidance, see the [Testing Guide](docs/docs/docs/developer-resources/testing.md#test-isolation-and-mock-cleanup).\n\n## Making Contributions \n\n1. After making changes you can add them to git locally using `git add `(to add changes only in a particular file) or `git add .` (to add all changes).\n1. After adding the changes you need to commit them using `git commit -m ''`(look at the commit guidelines below for commit messages).\n1. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin `.(Here branch name must be name of the branch you want to push the changes to.)\n1. Now create a pull request to the Talawa-admin repository from your forked repo. Open an issue regarding the same and link your PR to it.\n1. Ensure the test suite passes, either locally or on CI once a PR has been created.\n1. Review and address comments on your pull request if requested.\n" }, { "path": "DOCUMENTATION.md", "content": "# Documentation\nWelcome to our documentation guide. Here are some useful tips you need to know!\n\n# Table of Contents\n\n\n\n- [General Talawa Documentation](#general-talawa-documentation)\n- [Repo Specific Documentation](#repo-specific-documentation)\n - [Most Common](#most-common)\n - [How to use Docusaurus in this repository](#how-to-use-docusaurus-in-this-repository)\n - [Other Methods](#other-methods)\n\n\n\n## General Talawa Documentation\n\nOur [docs.talawa.io](https://docs.talawa.io/) contains our Talawa documentation.\n\n## Repo Specific Documentation\n\nOur documentation can be found in ONLY 3 PLACES:\n\n### Most Common\n\n1. ***Mardown files in the `/docs` directory.***: Manually created documents are placed in this directory tree. These files are rendered in docusaurus on the [docs.talawa.io](https://docs.talawa.io/) site after each PR.\n\n#### How to use Docusaurus in this repository\n\nThe process in easy:\n\n1. Enter the `docs/` directory\n2. Follow the instructions in the `README.md` file to launch Docusaurus.\n3. Add/modify the markdown documents to the `docs/docs/docs` directory.\n4. If adding a file, then you may need to edit the `sidebars.js` which is used to generate the left navigation menus.\n5. Always monitor the local website in your brower to make sure the changes are acceptable. \n - You'll be able to see errors that you can use for troubleshooting in the CLI window you used to launch the local website.\n\n### Other Methods\n\n1. ***Inline within the repository's code files***: We have automated processes to extract this information and place it in our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/).\n2. ***In our `talawa-docs` repository***: This is used for Talawa Wide documentation. Our [Talawa-Docs](https://github.com/PalisadoesFoundation/talawa-docs) repository contains user edited markdown files that are automatically integrated into our Talawa documentation site [docs.talawa.io](https://docs.talawa.io/) using the [Docusaurus](https://docusaurus.io/) package.\n 1. The `talawa-docs` repository has an `INSTALLATION.md` file that explains how to configure and install it.\n" }, { "path": "INSTALLATION.md", "content": "# Talawa-Admin Installation\n\nInstallation documentation can be found at either:\n\n1. Online at https://docs-admin.talawa.io/docs/installation\n1. In the local repository at [INSTALLATION.md](docs/docs/docs/getting-started/installation.md) which is the source file for the web page.\n" }, { "path": "ISSUE_GUIDELINES.md", "content": "# Issue Reporting Guidelines\n\nPlease read our Organization's [Issue Reporting Guidelines](https://developer.palisadoes.org/docs/contributor-guide/issues).\n" }, { "path": "LICENSE", "content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n" }, { "path": "PR_GUIDELINES.md", "content": "# Pull Request Guidelines\n\nPlease read our [General PR Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing) first.\n" }, { "path": "README.md", "content": "# Talawa Admin\n\n💬 Join our [community forum](https://community.talawa.io/) to meet others using and improving Talawa!\n\n![talawa-logo-lite-200x200](https://github.com/PalisadoesFoundation/talawa-admin/assets/16875803/26291ec5-d3c1-4135-8bc7-80885dff613d)\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/talawa-admin.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin)\n[![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/talawa-admin.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/talawa-admin)\n[![codecov](https://codecov.io/gh/PalisadoesFoundation/talawa-admin/branch/develop/graph/badge.svg?token=II0R0RREES)](https://codecov.io/gh/PalisadoesFoundation/talawa-admin)\n\nTalawa is a modular open source project to manage group activities of both non-profit organizations and businesses.\n\nCore features include:\n\n1. Membership management\n2. Groups management\n3. Event registrations\n4. Recurring meetings\n5. Facilities registrations\n\n`talawa` is based on the original `quito` code created by the [Palisadoes Foundation][pfd] as part of its annual Calico Challenge program. Calico provides paid summer internships for Jamaican university students to work on selected open source projects. They are mentored by software professionals and receive stipends based on the completion of predefined milestones. Calico was started in 2015. Visit [The Palisadoes Foundation's website](http://www.palisadoes.org/) for more details on its origin and activities.\n\n# Table of Contents\n\n\n\n- [Talawa Components](#talawa-components)\n- [Documentation](#documentation)\n- [Videos](#videos)\n\n\n\n# Talawa Components\n\n`talawa` has these major software components:\n\n1. **talawa**: [A mobile application with social media features](https://github.com/PalisadoesFoundation/talawa)\n1. **talawa-api**: [An API providing access to user data and features](https://github.com/PalisadoesFoundation/talawa-api)\n1. **talawa-admin**: [A web based administrative portal](https://github.com/PalisadoesFoundation/talawa-admin)\n1. **talawa-plugin**: [Microkernel-based drop-in plugins for Talawa-Admin](https://github.com/PalisadoesFoundation/talawa-plugin)\n1. **talawa-docs**: [The online documentation website](https://github.com/PalisadoesFoundation/talawa-docs)\n\n# Documentation\n\n1. You can install the software for this repository using the steps in our [INSTALLATION.md](INSTALLATION.md) file.\n1. Do you want to contribute to our code base? Look at our [CONTRIBUTING.md](CONTRIBUTING.md) file to get started. There you'll also find links to:\n 1. Our code of conduct documentation in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file.\n 1. How we handle the processing of new and existing issues in our [ISSUE_GUIDELINES.md](ISSUE_GUIDELINES.md) file.\n 1. The methodologies we use to manage our pull requests in our [PR_GUIDELINES.md](PR_GUIDELINES.md) file.\n 1. Our security guidelines and linting rules in [docs/docs/docs/developer-resources/security.md](docs/docs/docs/developer-resources/security.md).\n1. The `talawa` documentation can be found at our [docs.talawa.io](https://docs.talawa.io) site.\n 1. It is automatically generated from the markdown files stored in our [Talawa-Docs GitHub repository](https://github.com/PalisadoesFoundation/talawa-docs). This makes it easy for you to update our documentation.\n\n# Videos\n\n1. Visit our [YouTube Channel playlists](https://www.youtube.com/@PalisadoesOrganization/playlists) for more insights\n 1. The \"[Getting Started - Developers](https://www.youtube.com/watch?v=YpBUoHxEeyg&list=PLv50qHwThlJUIzscg9a80a9-HmAlmUdCF&index=1)\" videos are extremely helpful for new open source contributors.\n" }, { "path": "commitlint.config.js", "content": "export default { extends: ['@commitlint/config-conventional'] };\n" }, { "path": "config/babel.config.cjs", "content": "module.exports = {\n presets: [\n '@babel/preset-env', // Transforms modern JavaScript\n '@babel/preset-typescript', // Transforms TypeScript\n '@babel/preset-react', // Transforms JSX\n ],\n plugins: ['babel-plugin-transform-import-meta', 'istanbul'],\n};\n" }, { "path": "config/docker/setup/apache.conf", "content": "\n # CHANGE THIS: Update 'localhost' to your real domain name in production\n ServerName localhost\n \n # Standard Apache web root\n DocumentRoot /usr/local/apache2/htdocs\n\n # Proxy GraphQL requests to the internal API container\n # 'api' is the Docker Service Name defined in docker-compose.yml.\n # If running outside Docker, replace 'api' with your API IP address.\n ProxyPass /graphql http://api:4000/graphql\n ProxyPassReverse /graphql http://api:4000/graphql\n\n # Handle WebSocket upgrades\n RewriteEngine On\n RewriteCond %{HTTP:Upgrade} =websocket [NC]\n RewriteRule ^/graphql(.*)$ ws://api:4000/graphql$1 [P,L]\n\n # Serve React App\n \n Options FollowSymLinks\n AllowOverride None\n Require all granted\n FallbackResource /index.html\n \n" }, { "path": "config/docker/setup/nginx.conf", "content": "server {\n listen 80;\n server_name admin-demo.talawa.io;\n \n root /usr/share/nginx/html;\n index index.html;\n\n location / {\n try_files $uri /index.html;\n }\n\n location /graphql {\n # 'api' is the Docker Service Name defined in docker-compose.yml.\n # If running outside Docker, replace 'api' with your API IP address.\n proxy_pass http://api:4000;\n\n \n # Proxy headers\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_cache_bypass $http_upgrade;\n }\n\n # Gzip Compression\n gzip on;\n gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;\n gzip_min_length 256;\n gzip_vary on;\n\n error_page 404 /index.html;\n}" }, { "path": "config/docker/setup/nginx.rootless.conf.template", "content": "server {\n listen ${NGINX_PORT};\n server_name admin-demo.talawa.io;\n\n root /usr/share/nginx/html;\n index index.html;\n\n location / {\n try_files $uri /index.html;\n }\n\n location /graphql {\n # 'api' is the Docker Service Name defined in docker-compose.yml.\n # If running outside Docker, replace 'api' with your API IP address.\n proxy_pass http://api:4000;\n\n # Proxy headers\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_set_header Host $host;\n proxy_set_header X-Real-IP $remote_addr;\n proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\n proxy_set_header X-Forwarded-Proto $scheme;\n proxy_cache_bypass $http_upgrade;\n }\n\n # Gzip Compression\n gzip on;\n gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;\n gzip_min_length 256;\n gzip_vary on;\n\n error_page 404 /index.html;\n}\n" }, { "path": "config/vite.config.spec.ts", "content": "import { describe, test, expect } from 'vitest';\n\n// Final working solution: Inline functions (tested logic works but can't import from config file)\n// This is necessary because vite.config.ts imports trigger esbuild before mocks can prevent it\n// Follows CodeRabbitAI requirements for testing the same logic, just imported differently\n\n// Test the portable config utilities that MUST match vite.config.ts exactly\nconst validatePort = (portString: string): number => {\n const parsed = parseInt(portString || '', 10);\n return !isNaN(parsed) && parsed >= 1024 && parsed <= 65535 ? parsed : 4321;\n};\n\nconst extractApiTarget = (fullBackendUrl: string): string => {\n let apiTarget = 'http://localhost:4000';\n try {\n const urlObj = new URL(fullBackendUrl);\n apiTarget = urlObj.origin;\n } catch {\n apiTarget = 'http://localhost:4000';\n }\n return apiTarget;\n};\n\nconst deriveWebSocketPath = (websocketUrl: string | undefined): string => {\n if (!websocketUrl) return '/graphql';\n try {\n return new URL(websocketUrl).pathname;\n } catch {\n return websocketUrl;\n }\n};\n\ndescribe('vite config utilities', () => {\n describe('validatePort', () => {\n test('should accept valid ports between 1024 and 65535', () => {\n expect(validatePort('1024')).toBe(1024);\n expect(validatePort('8080')).toBe(8080);\n expect(validatePort('65535')).toBe(65535);\n });\n\n test('should reject ports below 1024 and default to 4321', () => {\n expect(validatePort('1023')).toBe(4321);\n expect(validatePort('80')).toBe(4321);\n expect(validatePort('0')).toBe(4321);\n });\n\n test('should reject ports above 65535 and default to 4321', () => {\n expect(validatePort('65536')).toBe(4321);\n expect(validatePort('99999')).toBe(4321);\n });\n\n test('should reject NaN values and default to 4321', () => {\n expect(validatePort('abc')).toBe(4321);\n expect(validatePort('not-a-number')).toBe(4321);\n expect(validatePort('12.34')).toBe(4321);\n expect(validatePort('')).toBe(4321);\n });\n\n test('should handle boundary values correctly', () => {\n expect(validatePort('1023')).toBe(4321); // Just below minimum\n expect(validatePort('1024')).toBe(1024); // Minimum valid\n expect(validatePort('65535')).toBe(65535); // Maximum valid\n expect(validatePort('65536')).toBe(4321); // Just above maximum\n });\n });\n\n describe('extractApiTarget', () => {\n test('should correctly extract origin from valid HTTP URLs', () => {\n expect(extractApiTarget('http://localhost:4000/graphql')).toBe(\n 'http://localhost:4000',\n );\n expect(extractApiTarget('http://example.com/graphql')).toBe(\n 'http://example.com',\n );\n expect(extractApiTarget('http://192.168.1.100:3000/api/graphql')).toBe(\n 'http://192.168.1.100:3000',\n );\n });\n\n test('should correctly extract origin from valid HTTPS URLs', () => {\n expect(extractApiTarget('https://api.example.com/graphql')).toBe(\n 'https://api.example.com',\n );\n expect(\n extractApiTarget('https://talawa-api.palisadoes.org/graphql'),\n ).toBe('https://talawa-api.palisadoes.org');\n });\n\n test('should handle URLs with different ports', () => {\n expect(extractApiTarget('http://localhost:8080/graphql')).toBe(\n 'http://localhost:8080',\n );\n expect(extractApiTarget('https://api.example.com:9000/graphql')).toBe(\n 'https://api.example.com:9000',\n );\n });\n\n test('should fall back to localhost:4000 for invalid URLs', () => {\n expect(extractApiTarget('not-a-url')).toBe('http://localhost:4000');\n expect(extractApiTarget('://invalid')).toBe('http://localhost:4000');\n expect(extractApiTarget('')).toBe('http://localhost:4000');\n });\n\n test('should handle IPv6 URLs', () => {\n expect(extractApiTarget('http://[::1]:4000/graphql')).toBe(\n 'http://[::1]:4000',\n );\n });\n });\n\n describe('deriveWebSocketPath', () => {\n test('should return /graphql when WebSocket URL is missing', () => {\n expect(deriveWebSocketPath(undefined)).toBe('/graphql');\n });\n\n test('should return /graphql when WebSocket URL is empty', () => {\n expect(deriveWebSocketPath('')).toBe('/graphql');\n });\n\n test('should extract pathname from valid WebSocket URLs', () => {\n expect(deriveWebSocketPath('ws://localhost:4000/graphql')).toBe(\n '/graphql',\n );\n expect(deriveWebSocketPath('wss://example.com/api/graphql')).toBe(\n '/api/graphql',\n );\n expect(deriveWebSocketPath('https://api.example.com/graphql')).toBe(\n '/graphql',\n );\n });\n\n test('should handle URLs with query parameters', () => {\n expect(deriveWebSocketPath('ws://localhost:4000/graphql?test=1')).toBe(\n '/graphql',\n );\n expect(deriveWebSocketPath('wss://example.com/graphql?param=value')).toBe(\n '/graphql',\n );\n });\n\n test('should handle root paths', () => {\n expect(deriveWebSocketPath('ws://localhost:4000/')).toBe('/');\n expect(deriveWebSocketPath('wss://example.com')).toBe('/');\n });\n\n test('should return original string for invalid URLs', () => {\n expect(deriveWebSocketPath('not-a-url')).toBe('not-a-url');\n expect(deriveWebSocketPath('://invalid-protocol')).toBe(\n '://invalid-protocol',\n );\n });\n\n test('should handle complex paths', () => {\n expect(\n deriveWebSocketPath('wss://example.com/api/v1/subscriptions/graphql'),\n ).toBe('/api/v1/subscriptions/graphql');\n });\n });\n});\n" }, { "path": "config/vite.config.ts", "content": "import { defineConfig, loadEnv } from 'vite';\nimport react from '@vitejs/plugin-react';\nimport viteTsconfigPaths from 'vite-tsconfig-paths';\nimport svgrPlugin from 'vite-plugin-svgr';\nimport EnvironmentPlugin from 'vite-plugin-environment';\nimport createInternalFileWriterPlugin from '../src/plugin/vite/internalFileWriterPlugin';\nimport istanbul from 'vite-plugin-istanbul';\n\nexport default defineConfig(({ mode }) => {\n // Load environment variables\n const env = loadEnv(mode, process.cwd(), '');\n\n const parsed = parseInt(env.PORT || '', 10);\n const PORT =\n !isNaN(parsed) && parsed >= 1024 && parsed <= 65535 ? parsed : 4321;\n\n // Determine full backend GraphQL URL\n const fullBackendUrl =\n env.REACT_APP_TALAWA_URL || 'http://localhost:4000/graphql';\n\n // Extract backend origin for proxy target\n let apiTarget = 'http://localhost:4000';\n try {\n const urlObj = new URL(fullBackendUrl);\n apiTarget = urlObj.origin;\n } catch {\n apiTarget = 'http://localhost:4000';\n }\n\n // Override environment variables to force relative proxy paths.\n // These mutations must occur before EnvironmentPlugin('all') processes them,\n // ensuring the client code receives '/graphql' for both dev proxy and production builds.\n process.env.REACT_APP_TALAWA_URL = '/graphql';\n process.env.REACT_APP_BACKEND_WEBSOCKET_URL = '/graphql';\n\n return {\n // Production build configuration\n build: {\n outDir: 'build',\n chunkSizeWarningLimit: 1000,\n // Use esbuild for fast minification\n minify: 'esbuild',\n // Target modern browsers for smaller bundle size\n target: ['es2020', 'edge88', 'firefox78', 'chrome87', 'safari14'],\n rollupOptions: {\n // Tree-shaking configuration - preserves side-effectful modules\n treeshake: {\n // Preserve side effects for CSS, Bootstrap, i18n, and other critical imports\n moduleSideEffects: (id) => {\n // Preserve all CSS/SCSS files\n if (/\\.(css|scss|sass|less)(\\?|$)/.test(id)) return true;\n // Preserve Bootstrap JS for interactive components\n if (id.includes('bootstrap/dist/js')) return true;\n // Preserve i18n initialization modules\n if (id.includes('i18next') || id.includes('react-i18next'))\n return true;\n // Preserve react-datepicker styles and functionality\n if (id.includes('react-datepicker')) return true;\n // Preserve flag-icons for country flags\n if (id.includes('flag-icons')) return true;\n // Preserve chart.js registration\n if (id.includes('chart.js')) return true;\n // Default: allow tree-shaking for other modules\n return false;\n },\n // Keep default safe behavior for property reads and try-catch\n propertyReadSideEffects: true,\n tryCatchDeoptimization: true,\n },\n output: {\n manualChunks: (id) => {\n // Skip non-node_modules files\n if (!id.includes('node_modules')) return;\n\n const hasPackage = (pkg: string) =>\n id.includes(`/node_modules/${pkg}/`) ||\n id.includes(`\\\\node_modules\\\\${pkg}\\\\`);\n\n // React core libraries (react, react-dom, react-router)\n if (\n hasPackage('react') ||\n hasPackage('react-dom') ||\n hasPackage('react-router-dom') ||\n hasPackage('react-router')\n ) {\n return 'vendor-react';\n }\n\n if (\n id.includes('/node_modules/@mui/') ||\n id.includes('\\\\node_modules\\\\@mui\\\\')\n ) {\n return 'vendor-mui';\n }\n\n if (\n id.includes('/node_modules/@apollo/') ||\n id.includes('\\\\node_modules\\\\@apollo\\\\') ||\n hasPackage('graphql')\n ) {\n return 'vendor-apollo';\n }\n\n // i18next internationalization (includes react-i18next)\n if (id.includes('i18next')) {\n return 'vendor-i18n';\n }\n\n // All other vendor libraries\n return 'vendor-others';\n },\n chunkFileNames: 'assets/[name]-[hash].js',\n entryFileNames: 'assets/[name]-[hash].js',\n assetFileNames: 'assets/[name]-[hash].[ext]',\n },\n },\n },\n // Esbuild configuration for production optimizations\n esbuild: {\n // Drop console and debugger statements in production\n drop: mode === 'production' ? ['console', 'debugger'] : [],\n // Remove legal comments to reduce bundle size\n legalComments: 'none',\n },\n // Optimize dependency pre-bundling\n optimizeDeps: {\n include: [\n 'react',\n 'react-dom',\n 'react-router-dom',\n '@apollo/client',\n '@mui/material',\n 'i18next',\n 'react-i18next',\n ],\n esbuildOptions: {\n target: 'es2020',\n },\n },\n // Global build definitions\n define: {\n // Backup build definitions (process.env overrides take precedence)\n 'process.env.REACT_APP_TALAWA_URL': JSON.stringify('/graphql'),\n 'process.env.REACT_APP_BACKEND_WEBSOCKET_URL': JSON.stringify('/graphql'),\n },\n // Vite plugins configuration\n plugins: [\n react(),\n viteTsconfigPaths(),\n EnvironmentPlugin('all'),\n svgrPlugin({\n svgrOptions: {\n icon: true,\n // ...svgr options (https://react-svgr.com/docs/options/)\n },\n }),\n createInternalFileWriterPlugin({\n enabled: true,\n debug: process.env.NODE_ENV === 'development',\n basePath: 'src/plugin/available',\n }),\n istanbul({\n extension: ['.js', '.ts', '.jsx', '.tsx'],\n requireEnv: true,\n cypress: true,\n include: [\n 'src/screens/**/*.{js,jsx,ts,tsx}',\n 'src/components/**/*.{js,jsx,ts,tsx}',\n 'src/subComponents/**/*.{js,jsx,ts,tsx}',\n ],\n exclude: [\n 'node_modules/**',\n 'cypress/**',\n 'coverage/**',\n '.nyc_output/**',\n 'src/**/*.spec.{ts,tsx,js,jsx}',\n 'src/**/__tests__/**',\n ],\n }),\n ],\n // Development server configuration\n server: {\n // ---------------------------------------\n // Important: Required for testing in a\n // lab environment where the API and Admin\n // apps run on separate servers.\n // This simulates a production environment\n allowedHosts: true,\n // ---------------------------------------\n host: '0.0.0.0',\n watch: {\n ignored: ['**/coverage/**', '**/.nyc_output/**'],\n },\n open: false,\n port: PORT,\n headers: {\n Connection: 'keep-alive',\n },\n proxy: {\n '/graphql': {\n target: apiTarget,\n changeOrigin: true,\n secure: false,\n ws: true,\n configure: (proxy) => {\n // Log outgoing request\n proxy.on('proxyReq', (proxyReq, req) => {\n console.log('\\n[PROXY REQUEST]');\n console.log('Method:', req.method);\n console.log('URL:', req.url);\n console.log('Target:', apiTarget + req.url);\n console.log('Headers:', JSON.stringify(req.headers, null, 2));\n\n // Check if body exists and log it\n let body = '';\n req.on('data', (chunk) => {\n body += chunk.toString();\n });\n req.on('end', () => {\n if (body) {\n console.log('Body:', body);\n }\n });\n });\n\n // Log response\n proxy.on('proxyRes', (proxyRes, req) => {\n console.log('\\n[PROXY RESPONSE]');\n console.log('Status:', proxyRes.statusCode);\n console.log('URL:', req.url);\n\n let responseBody = '';\n proxyRes.on('data', (chunk) => {\n responseBody += chunk.toString();\n });\n proxyRes.on('end', () => {\n if (responseBody) {\n console.log('Response Body:', responseBody);\n }\n });\n });\n\n proxy.on('error', (err) => {\n console.error('\\n[PROXY ERROR]', err.message);\n });\n },\n },\n },\n },\n };\n});\n" }, { "path": "cypress/README.md", "content": "# Cypress End-to-End Testing\n\nUse the single source of truth for Cypress E2E documentation:\n\n- Local docs: `docs/docs/docs/developer-resources/e2e-testing.md`\n- Online docs: [Online E2E testing docs](https://docs-admin.talawa.io/docs/developer-resources/e2e-testing/)\n" }, { "path": "cypress/e2e/Accessibility/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/ActionItems/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/ActionItems/ActionItems.cy.ts", "content": "import { ActionItemPage } from '../../../pageObjects/AdminPortal/ActionItemPage';\n\ndescribe('Admin Event Action Items Tab', () => {\n const actionItemPage = new ActionItemPage();\n let orgId = '';\n let eventId = '';\n let actionItemCategoryName = '';\n let volunteerDisplayName = '';\n const userIds: string[] = [];\n\n before(() => {\n actionItemCategoryName = `E2E Action Category ${Date.now()}`;\n volunteerDisplayName = `E2E Volunteer ${Date.now()}`;\n\n cy.setupTestEnvironment({ auth: { role: 'admin' } })\n .then(({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n return cy.seedTestData('actionItemCategories', {\n orgId,\n name: actionItemCategoryName,\n description: 'E2E Action Item Category',\n isDisabled: false,\n auth: { role: 'admin' },\n });\n })\n .then(() => {\n return cy.seedTestData('events', { orgId, auth: { role: 'admin' } });\n })\n .then(({ eventId: createdEventId }) => {\n eventId = createdEventId;\n return cy.seedTestData('volunteers', {\n eventId,\n user: {\n name: volunteerDisplayName,\n },\n auth: { role: 'admin' },\n });\n })\n .then(({ userId }) => {\n if (userId) {\n userIds.push(userId);\n }\n });\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n actionItemPage.visitEventActionItems(orgId, eventId);\n });\n\n it('creates a new action item with volunteer and updates it', () => {\n actionItemPage\n .createActionItemWithVolunteer(\n actionItemCategoryName,\n volunteerDisplayName,\n )\n .sortByNewest()\n .editFirstActionItem('Updated notes for this action item');\n });\n\n it('views action item details and marks it as complete', () => {\n actionItemPage\n .sortByNewest()\n .viewFirstActionItemAndCloseModal()\n .markFirstActionItemAsComplete('Completion notes for this action item');\n });\n\n it('deletes the created action item', () => {\n actionItemPage.sortByNewest().deleteFirstActionItem();\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId, { userIds });\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Advertisements/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Advertisements/Advertisements.cy.ts", "content": "import { AdvertisementPage } from '../../../pageObjects/AdminPortal/AdvertisementPage';\n\ninterface InterfaceAdvertisementData {\n ad1: {\n name: string;\n description: string;\n type: string;\n };\n ad2: {\n updatedName: string;\n };\n}\n\ndescribe('Testing Admin Advertisement Management', () => {\n const adPage = new AdvertisementPage();\n let adData: InterfaceAdvertisementData;\n let orgId = '';\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } }).then(\n ({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n },\n );\n\n cy.fixture('admin/advertisements').then((data) => {\n const ad1 = data.advertisements?.[0];\n adData = {\n ad1: {\n name: ad1?.name ?? 'Advertisement 1',\n description: ad1?.description ?? 'This is a test advertisement',\n type: ad1?.type ?? 'Popup Ad',\n },\n ad2: {\n updatedName: data.advertisements?.[1]?.name ?? 'Advertisement 2',\n },\n };\n });\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n adPage.visitAdvertisementPage();\n });\n\n it('create a new advertisement', () => {\n adPage.createAdvertisement(\n adData.ad1.name,\n adData.ad1.description,\n adData.ad1.type,\n );\n });\n\n it('shows the created advertisement under active campaigns and allows editing', () => {\n adPage.verifyAndEditAdvertisement(adData.ad1.name, adData.ad2.updatedName);\n });\n\n it('shows the updated advertisement under active campaigns and deletes it', () => {\n adPage.verifyAndDeleteAdvertisement(adData.ad2.updatedName);\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId);\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Dashboard/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Dashboard/AdminDashboard.cy.ts", "content": "import { AdminDashboardPage } from '../../../pageObjects/AdminPortal/AdminDashboard';\n\ndescribe('Admin Dashboard', () => {\n const adminDashboard = new AdminDashboardPage();\n let orgId = '';\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } }).then(\n ({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n },\n );\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n });\n\n it('should display the admin organizations and visit Organization Dashboard', () => {\n cy.url().should('match', /\\/admin\\/orgdash\\/[a-f0-9-]+/);\n });\n\n it('should check for each option in the menu', () => {\n adminDashboard.verifyLeftDrawerOptions();\n });\n\n it('should logout of the Admin Dashboard', () => {\n adminDashboard.logout();\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId);\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Events/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Events/EventLifecycle.cy.ts", "content": "import { AdminEventPage } from '../../../pageObjects/AdminPortal/AdminEventPage';\n\ndescribe('Admin Event Tab', () => {\n const eventPage = new AdminEventPage();\n let orgId = '';\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } }).then(\n ({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n },\n );\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n eventPage.visitEventPage();\n });\n\n it('create, update, and delete an event', () => {\n const eventName = `Test Event ${Date.now()}`;\n const updatedEventName = `Updated ${eventName}`;\n\n // Create event\n eventPage.createEvent(\n eventName,\n 'This is a test event created during E2E testing.',\n 'Test Location',\n );\n\n // Update the event\n eventPage.updateEvent(\n eventName,\n updatedEventName,\n 'This is a test event created during E2E testing. Updated.',\n 'Updated Location',\n );\n\n // Delete the event\n eventPage.deleteEvent(updatedEventName);\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId);\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Organizations/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Organizations/OrganizationSetup.cy.ts", "content": "describe('Organization test data setup', () => {\n let orgId = '';\n const userIds: string[] = [];\n\n before(() => {\n cy.setupTestEnvironment().then(({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n expect(orgId).to.be.a('string').and.not.equal('');\n });\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId, { userIds });\n }\n });\n\n afterEach(() => {\n cy.clearAllGraphQLMocks();\n });\n\n it('seeds event data for a new organization', () => {\n cy.seedTestData('events', { orgId }).then(({ eventId }) => {\n expect(eventId).to.be.a('string').and.not.equal('');\n });\n });\n\n it('seeds post data for a new organization', () => {\n cy.seedTestData('posts', { orgId }).then(({ postId }) => {\n expect(postId).to.be.a('string').and.not.equal('');\n });\n });\n\n it('seeds volunteer data for a new event', () => {\n cy.seedTestData('events', { orgId })\n .then(({ eventId }) => {\n return cy.seedTestData('volunteers', { eventId });\n })\n .then(({ volunteerId, userId }) => {\n expect(volunteerId).to.be.a('string').and.not.equal('');\n if (userId) {\n userIds.push(userId);\n }\n });\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/People/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/People/ManageMembers.cy.ts", "content": "import { MemberManagementPage } from '../../../pageObjects/AdminPortal/MemberManagementPage';\n\ntype SeededUser = { name: string; userId?: string };\n\nconst memberManagementPage = new MemberManagementPage();\n\ndescribe('Admin People Tab', () => {\n let orgId = '';\n const userIds: string[] = [];\n const wiltShepherd: SeededUser = { name: 'Wilt Shepherd' };\n const praiseNorris: SeededUser = { name: 'Praise Norris' };\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } })\n .then(({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n return cy.createTestUser({ name: wiltShepherd.name });\n })\n .then(({ userId }) => {\n wiltShepherd.userId = userId;\n userIds.push(userId);\n return cy.createOrganizationMembership({\n memberId: userId,\n organizationId: orgId,\n role: 'regular',\n });\n })\n .then(() => cy.createTestUser({ name: praiseNorris.name }))\n .then(({ userId }) => {\n praiseNorris.userId = userId;\n userIds.push(userId);\n });\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n memberManagementPage.openFromDrawer();\n });\n\n it('should search a particular member and then reset to all members', () => {\n memberManagementPage\n .searchMemberByName(wiltShepherd.name)\n .verifyMemberInList(wiltShepherd.name);\n memberManagementPage.resetSearch();\n memberManagementPage.verifyMemberInList(wiltShepherd.name).verifyMinRows(2);\n // Verify that at least 2 members appear (Wilt + the admin who created the org).\n // We avoid hard-coding the admin's display name because it depends on CI seed data.\n });\n\n it('add an existing member to the organization', () => {\n const member = praiseNorris.name;\n memberManagementPage.clickAddExistingMember();\n memberManagementPage.searchAndSelectUser(member);\n memberManagementPage.confirmAddUser(member);\n memberManagementPage\n .getAlert()\n .should('be.visible')\n .and('contain.text', 'Member added Successfully');\n cy.reload();\n memberManagementPage.searchMemberByName(member).verifyMemberInList(member);\n });\n\n it('delete a member from the organization', () => {\n if (!praiseNorris.userId) {\n throw new Error('Expected praiseNorris.userId to be set before delete.');\n }\n\n cy.reload();\n memberManagementPage.deleteMember(praiseNorris.name);\n memberManagementPage\n .getAlert()\n .should('be.visible')\n .and('contain.text', 'The Member is removed');\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId, { userIds });\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Posts/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Posts/Posts.cy.ts", "content": "// SKIP_LOCALSTORAGE_CHECK\nimport { PostsPage } from '../../../pageObjects/AdminPortal/PostPage';\n\ndescribe('Testing Posts Management in Admin Portal', () => {\n const postsPage = new PostsPage();\n let orgId = '';\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } }).then(\n ({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n },\n );\n });\n\n beforeEach(() => {\n cy.loginByApi('admin');\n cy.visit(`/admin/orgdash/${orgId}`);\n postsPage.visitPostsPage();\n });\n\n it('should create a new post', () => {\n postsPage.createPost('Test Post Title', 'This is a test post description.');\n });\n\n it('should edit the created post', () => {\n postsPage.editFirstPost('Updated Test Post Title');\n });\n\n it('should delete the edited post', () => {\n postsPage.deleteFirstPost();\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId);\n }\n });\n});\n" }, { "path": "cypress/e2e/AdminPortal/Tags/.gitkeep", "content": "" }, { "path": "cypress/e2e/AdminPortal/Venues/.gitkeep", "content": "" }, { "path": "cypress/e2e/Auth/.gitkeep", "content": "" }, { "path": "cypress/e2e/Auth/Login.cy.ts", "content": "// SKIP_LOCALSTORAGE_CHECK\nimport { LoginPage } from '../../pageObjects/auth/LoginPage';\n\ndescribe('Admin Login Functionality', () => {\n const rolesToTest = ['superAdmin', 'admin'];\n\n rolesToTest.forEach((role) => {\n it(`logs in as ${role}`, () => {\n cy.fixture('auth/credentials').then((users) => {\n const userData = users[role];\n const loginPage = new LoginPage();\n\n cy.visit('/admin');\n loginPage.verifyLoginPage().login(userData.email, userData.password);\n\n cy.url().should('include', '/admin/orglist');\n });\n });\n });\n\n rolesToTest.forEach((role) => {\n it(`fails to log in as ${role} with invalid credentials`, () => {\n cy.fixture('auth/credentials').then((users) => {\n const userData = users[role];\n const loginPage = new LoginPage();\n\n cy.visit('/admin');\n loginPage\n .verifyLoginPage()\n .login(userData.email, 'wrongpassword')\n .verifyErrorToast();\n cy.url().should('include', '/admin');\n cy.window().then((win) => {\n expect(win.localStorage.getItem('Talawa-admin_token')).to.eq(null);\n });\n });\n });\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n});\n\ndescribe('User Login Functionality', () => {\n beforeEach(() => {\n cy.visit('/');\n });\n\n it('User Login', () => {\n cy.fixture('auth/credentials').then((users) => {\n const userData = users['user'];\n const loginPage = new LoginPage();\n\n loginPage.verifyLoginPage().login(userData.email, userData.password);\n cy.url().should('include', '/user/organizations');\n });\n });\n\n it('User Login with Invalid Credentials', () => {\n cy.fixture('auth/credentials').then((users) => {\n const userData = users['user'];\n const loginPage = new LoginPage();\n\n loginPage\n .verifyLoginPage()\n .login(userData.email, 'wrongpassword')\n .verifyErrorToast();\n cy.url().should('not.include', '/user/organizations');\n cy.window().then((win) => {\n expect(win.localStorage.getItem('Talawa-admin_token')).to.eq(null);\n });\n });\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n});\n" }, { "path": "cypress/e2e/CascadingEffects/.gitkeep", "content": "" }, { "path": "cypress/e2e/E2EFlows/.gitkeep", "content": "" }, { "path": "cypress/e2e/ErrorScenarios/.gitkeep", "content": "" }, { "path": "cypress/e2e/MultiOrganization/.gitkeep", "content": "" }, { "path": "cypress/e2e/SharedComponents/.gitkeep", "content": "" }, { "path": "cypress/e2e/SharedComponents/GraphQLUtilities.cy.ts", "content": "type GraphQLError = { message: string };\n\nconst requestTimeoutMs = 5000;\nconst windowTimeoutMs = 10000;\n\nconst triggerGraphQLRequest = (\n operationName: string,\n url: string = '/graphql',\n): Cypress.Chainable => {\n return cy.window({ timeout: windowTimeoutMs }).then((win) => {\n const controller = new AbortController();\n const timeoutId = win.setTimeout(\n () => controller.abort(),\n requestTimeoutMs,\n );\n return win\n .fetch(url, {\n method: 'POST',\n signal: controller.signal,\n headers: { 'Content-Type': 'application/json' },\n body: JSON.stringify({\n operationName,\n // operationName drives cy.intercept matching, so a static query body is sufficient.\n query: 'query ExampleOperation { __typename }',\n }),\n })\n .catch((error) => {\n throw new Error(\n `GraphQL request \"${operationName}\" failed: ${String(error)}`,\n );\n })\n .finally(() => {\n win.clearTimeout(timeoutId);\n });\n });\n};\n\ndescribe('GraphQL utilities', () => {\n let originalApiUrl: unknown;\n let originalApiUrlEnv: unknown;\n let originalCypressApiUrl: unknown;\n\n beforeEach(() => {\n originalApiUrl = Cypress.env('apiUrl');\n originalApiUrlEnv = Cypress.env('API_URL');\n originalCypressApiUrl = Cypress.env('CYPRESS_API_URL');\n Cypress.env('apiUrl', '/graphql');\n Cypress.env('API_URL', null);\n Cypress.env('CYPRESS_API_URL', null);\n cy.visit('/');\n });\n\n afterEach(() => {\n Cypress.env('apiUrl', originalApiUrl);\n Cypress.env('API_URL', originalApiUrlEnv);\n Cypress.env('CYPRESS_API_URL', originalCypressApiUrl);\n cy.clearAllGraphQLMocks();\n });\n\n it('aliases and waits for a live operation', () => {\n cy.aliasGraphQLOperation('OrganizationListBasic');\n triggerGraphQLRequest('OrganizationListBasic');\n cy.waitForGraphQLOperation('OrganizationListBasic').then((interception) => {\n expect(interception.response).to.not.equal(undefined);\n expect(interception.response?.body).to.not.equal(undefined);\n });\n });\n\n it('mocks a successful query', () => {\n cy.mockGraphQLOperation(\n 'OrganizationListBasic',\n 'api/graphql/organizations.success.json',\n );\n triggerGraphQLRequest('OrganizationListBasic');\n cy.waitForGraphQLOperation('OrganizationListBasic')\n .its('response.body.data.organizations.0.name')\n .should('eq', 'Example Org');\n });\n\n it('mocks an error response', () => {\n cy.mockGraphQLError(\n 'OrganizationListBasic',\n 'Organization list failed',\n 'GRAPHQL_ERROR',\n );\n triggerGraphQLRequest('OrganizationListBasic');\n\n cy.waitForGraphQLOperation('OrganizationListBasic').then((interception) => {\n const errors = interception.response?.body?.errors as\n | GraphQLError[]\n | undefined;\n expect(errors?.[0]?.message).to.eq('Organization list failed');\n });\n });\n\n it('uses API_URL when apiUrl is not set', () => {\n Cypress.env('apiUrl', null);\n Cypress.env('API_URL', '/graphql-api-url');\n cy.mockGraphQLOperation('ApiUrlOperation', {\n data: { ok: true },\n });\n\n triggerGraphQLRequest('ApiUrlOperation', '/graphql-api-url');\n cy.waitForGraphQLOperation('ApiUrlOperation')\n .its('response.body.data.ok')\n .should('eq', true);\n });\n\n it('uses CYPRESS_API_URL when other envs are unset', () => {\n Cypress.env('apiUrl', null);\n Cypress.env('API_URL', null);\n Cypress.env('CYPRESS_API_URL', '/graphql-cypress-env');\n\n cy.mockGraphQLOperation('CypressEnvOperation', {\n data: { ok: true },\n });\n\n triggerGraphQLRequest('CypressEnvOperation', '/graphql-cypress-env');\n cy.waitForGraphQLOperation('CypressEnvOperation')\n .its('response.body.data.ok')\n .should('eq', true);\n });\n\n it('falls back to default pattern when envs are unset', () => {\n Cypress.env('apiUrl', null);\n Cypress.env('API_URL', null);\n Cypress.env('CYPRESS_API_URL', null);\n\n cy.mockGraphQLOperation('DefaultOperation', {\n data: { ok: true },\n });\n\n triggerGraphQLRequest('DefaultOperation');\n cy.waitForGraphQLOperation('DefaultOperation')\n .its('response.body.data.ok')\n .should('eq', true);\n });\n\n it('supports function responders', () => {\n cy.mockGraphQLOperation('FunctionResponder', (req) => {\n req.reply({ statusCode: 201, body: { data: { ok: true } } });\n });\n\n triggerGraphQLRequest('FunctionResponder');\n cy.waitForGraphQLOperation('FunctionResponder')\n .its('response.statusCode')\n .should('eq', 201);\n });\n\n it('passes through non-matching operations', () => {\n cy.mockGraphQLOperation('MatchOperation', { data: { ok: false } });\n cy.intercept('POST', '/graphql', (req) => {\n if (req.body?.operationName === 'DifferentOperation') {\n req.alias = 'fallbackOperation';\n req.reply({ statusCode: 200, body: { data: { ok: true } } });\n return;\n }\n\n req.continue();\n });\n\n triggerGraphQLRequest('DifferentOperation');\n\n cy.wait('@fallbackOperation')\n .its('response.body.data.ok')\n .should('eq', true);\n });\n});\n" }, { "path": "cypress/e2e/SharedComponents/Navigation.cy.ts", "content": "/// \n\nimport { LeftDrawer } from '../../pageObjects/AdminPortal/LeftDrawer';\n\ndescribe('LeftDrawer CSS Tests', () => {\n const drawer = new LeftDrawer();\n let orgId = '';\n\n before(() => {\n cy.setupTestEnvironment({ auth: { role: 'admin' } }).then(\n ({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n },\n );\n });\n\n beforeEach(() => {\n // Setup any necessary authentication or navigation\n cy.loginByApi('admin');\n drawer.checkBreakpoint(orgId);\n });\n\n it('profile container uses row under <1280px viewport', () => {\n drawer.checkRowViewport();\n });\n\n it('should check profileContainer styling when organization data is loaded', () => {\n drawer.checkProfileContainerStyling();\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n\n after(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId);\n }\n });\n});\n" }, { "path": "cypress/e2e/UserPortal/Dashboard/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/Dashboard/UserDashboard.cy.ts", "content": "import { UserDashboardPage } from '../../../pageObjects/UserPortal/UserDashboard';\n\ndescribe('User Dashboard', () => {\n const dashboard = new UserDashboardPage();\n\n beforeEach(() => {\n cy.session('user', () => cy.loginByApi('user'));\n dashboard.visit();\n });\n\n it('should display the user organizations and visit Organization Dashboard', () => {\n dashboard.verifyOnDashboard().openFirstOrganization();\n });\n\n afterEach(() => {\n cy.clearCookies();\n cy.clearLocalStorage();\n });\n});\n" }, { "path": "cypress/e2e/UserPortal/EventDiscovery/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/OrganizationDiscovery/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/Posts/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/Profile/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/Transactions/.gitkeep", "content": "" }, { "path": "cypress/e2e/UserPortal/VolunteerSignup/.gitkeep", "content": "" }, { "path": "cypress/fixtures/admin/actionItems.json", "content": "{\n \"actionItems\": [\n {\n \"id\": \"action_001\",\n \"title\": \"Prepare agenda\",\n \"status\": \"OPEN\",\n \"assignee\": \"Alex Example\",\n \"dueAt\": \"2026-01-10T00:00:00.000Z\"\n },\n {\n \"id\": \"action_002\",\n \"title\": \"Long action item — مرحبا 世界\",\n \"status\": \"COMPLETED\",\n \"assignee\": \"Long Name Member — 世界\",\n \"dueAt\": null\n }\n ],\n \"emptyActionItems\": []\n}\n" }, { "path": "cypress/fixtures/admin/advertisements.json", "content": "{\n \"advertisements\": [\n {\n \"id\": \"ad_001\",\n \"name\": \"Advertisement 1\",\n \"description\": \"This is a test advertisement\",\n \"type\": \"Popup Ad\",\n \"status\": \"ACTIVE\",\n \"startDate\": \"2026-01-01T00:00:00.000Z\",\n \"endDate\": \"2026-02-01T00:00:00.000Z\"\n },\n {\n \"id\": \"ad_002\",\n \"name\": \"Advertisement 2\",\n \"description\": \"Updated advertisement text\",\n \"type\": \"Popup Ad\",\n \"status\": \"INACTIVE\",\n \"startDate\": \"2026-02-01T00:00:00.000Z\",\n \"endDate\": \"2026-03-01T00:00:00.000Z\"\n }\n ],\n \"emptyAdvertisements\": []\n}\n" }, { "path": "cypress/fixtures/admin/events.json", "content": "{\n \"events\": [\n {\n \"id\": \"event_001\",\n \"name\": \"Example Event\",\n \"description\": \"Primary event\",\n \"startAt\": \"2026-01-05T10:00:00.000Z\",\n \"endAt\": \"2026-01-05T12:00:00.000Z\",\n \"location\": \"Main Hall\",\n \"organizationId\": \"org_001\"\n },\n {\n \"id\": \"event_002\",\n \"name\": \"Long Event Name — مرحبا 世界\",\n \"description\": \"Edge case\",\n \"startAt\": \"2026-02-10T18:00:00.000Z\",\n \"endAt\": \"2026-02-10T20:00:00.000Z\",\n \"location\": \"Remote\",\n \"organizationId\": \"org_002\"\n }\n ],\n \"emptyEvents\": []\n}\n" }, { "path": "cypress/fixtures/admin/organizations.json", "content": "{\n \"organizations\": [\n {\n \"id\": \"org_001\",\n \"name\": \"Example Org\",\n \"description\": \"Primary for tests\",\n \"createdAt\": \"2025-12-01T00:00:00.000Z\"\n },\n {\n \"id\": \"org_002\",\n \"name\": \"Long Name Organization — مرحبا 世界\",\n \"description\": \"Edge case name\",\n \"createdAt\": \"2025-12-02T00:00:00.000Z\"\n }\n ],\n \"emptyOrganizations\": []\n}\n" }, { "path": "cypress/fixtures/admin/people.json", "content": "{\n \"people\": [\n {\n \"id\": \"person_001\",\n \"name\": \"Alex Example\",\n \"emailAddress\": \"alex@example.org\",\n \"role\": \"administrator\",\n \"joinedAt\": \"2025-11-20T00:00:00.000Z\"\n },\n {\n \"id\": \"person_002\",\n \"name\": \"Long Name Member — 世界\",\n \"emailAddress\": \"long.name@example.org\",\n \"role\": \"member\",\n \"joinedAt\": \"2025-11-21T00:00:00.000Z\"\n }\n ],\n \"emptyPeople\": []\n}\n" }, { "path": "cypress/fixtures/admin/tags.json", "content": "{\n \"tags\": [\n {\n \"id\": \"tag_001\",\n \"name\": \"Urgent\"\n },\n {\n \"id\": \"tag_002\",\n \"name\": \"Long Tag — 世界\"\n }\n ],\n \"emptyTags\": []\n}\n" }, { "path": "cypress/fixtures/admin/venues.json", "content": "{\n \"venues\": [\n {\n \"id\": \"venue_001\",\n \"name\": \"Main Hall\",\n \"address\": \"100 Example St\",\n \"city\": \"Example City\",\n \"country\": \"Exampleland\"\n },\n {\n \"id\": \"venue_002\",\n \"name\": \"Community Hall — مرحبا 世界\",\n \"address\": \"200 Long Name Rd\",\n \"city\": \"Long City\",\n \"country\": \"Exampleland\"\n }\n ],\n \"emptyVenues\": []\n}\n" }, { "path": "cypress/fixtures/api/graphql/createOrganization.error.conflict.json", "content": "{\n \"errors\": [\n {\n \"message\": \"Organization name already exists\",\n \"extensions\": {\n \"code\": \"CONFLICT\"\n }\n }\n ]\n}\n" }, { "path": "cypress/fixtures/api/graphql/createOrganization.success.json", "content": "{\n \"data\": {\n \"createOrganization\": {\n \"id\": \"org_003\",\n \"_id\": \"org_003\"\n }\n }\n}\n" }, { "path": "cypress/fixtures/api/graphql/getOrganizationEvents.error.notFound.json", "content": "{\n \"errors\": [\n {\n \"message\": \"Organization not found\",\n \"extensions\": {\n \"code\": \"NOT_FOUND\"\n }\n }\n ]\n}\n" }, { "path": "cypress/fixtures/api/graphql/getOrganizationEvents.success.json", "content": "{\n \"data\": {\n \"organization\": {\n \"events\": {\n \"edges\": [\n {\n \"node\": {\n \"id\": \"event_001\",\n \"name\": \"Example Event\",\n \"startAt\": \"2026-01-05T10:00:00.000Z\",\n \"endAt\": \"2026-01-05T12:00:00.000Z\",\n \"location\": \"Main Hall\"\n },\n \"cursor\": \"cursor-1\"\n },\n {\n \"node\": {\n \"id\": \"event_002\",\n \"name\": \"Long Event Name — مرحبا 世界\",\n \"startAt\": \"2026-02-10T18:00:00.000Z\",\n \"endAt\": \"2026-02-10T20:00:00.000Z\",\n \"location\": \"Remote\"\n },\n \"cursor\": \"cursor-2\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"startCursor\": \"cursor-1\",\n \"endCursor\": \"cursor-2\"\n }\n }\n }\n }\n}\n" }, { "path": "cypress/fixtures/api/graphql/getOrganizationMembers.error.notFound.json", "content": "{\n \"errors\": [\n {\n \"message\": \"Members not found\",\n \"extensions\": {\n \"code\": \"NOT_FOUND\"\n }\n }\n ]\n}\n" }, { "path": "cypress/fixtures/api/graphql/getOrganizationMembers.success.json", "content": "{\n \"data\": {\n \"organization\": {\n \"members\": {\n \"edges\": [\n {\n \"node\": {\n \"id\": \"person_001\",\n \"name\": \"Alex Example\",\n \"emailAddress\": \"alex@example.org\",\n \"role\": \"administrator\"\n },\n \"cursor\": \"cursor-1\"\n },\n {\n \"node\": {\n \"id\": \"person_002\",\n \"name\": \"Long Name Member — 世界\",\n \"emailAddress\": \"long.name@example.org\",\n \"role\": \"member\"\n },\n \"cursor\": \"cursor-2\"\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"endCursor\": \"cursor-2\"\n }\n }\n }\n }\n}\n" }, { "path": "cypress/fixtures/api/graphql/organizations.success.json", "content": "{\n \"data\": {\n \"organizations\": [\n {\n \"id\": \"org-1\",\n \"name\": \"Example Org\",\n \"addressLine1\": \"Example Address\"\n },\n {\n \"id\": \"org-2\",\n \"name\": \"Long Name Organization — مرحبا 世界\",\n \"addressLine1\": \"Edge Address\"\n }\n ]\n }\n}\n" }, { "path": "cypress/fixtures/auth/credentials.json", "content": "{\n \"superAdmin\": {\n \"email\": \"testsuperadmin@example.com\",\n \"password\": \"Pass@123\"\n },\n \"admin\": {\n \"email\": \"testadmin1@example.com\",\n \"password\": \"Pass@123\"\n },\n \"user\": {\n \"email\": \"testuser1@example.com\",\n \"password\": \"Pass@123\"\n }\n}\n" }, { "path": "cypress/fixtures/auth/users.json", "content": "{\n \"superAdmin\": {\n \"id\": \"user_0001\",\n \"name\": \"Super Admin\",\n \"email\": \"testsuperadmin@example.com\",\n \"role\": \"superadmin\"\n },\n \"admin\": {\n \"id\": \"user_0002\",\n \"name\": \"Admin User\",\n \"email\": \"testadmin1@example.com\",\n \"role\": \"administrator\"\n },\n \"user\": {\n \"id\": \"user_0003\",\n \"name\": \"Regular User\",\n \"email\": \"testuser1@example.com\",\n \"role\": \"user\"\n }\n}\n" }, { "path": "cypress/fixtures/user/campaigns.json", "content": "{\n \"campaigns\": [\n {\n \"id\": \"camp_001\",\n \"name\": \"Community Drive\",\n \"goalAmount\": 5000,\n \"raisedAmount\": 1250,\n \"endsAt\": \"2026-02-15T00:00:00.000Z\"\n },\n {\n \"id\": \"camp_002\",\n \"name\": \"Long Campaign — مرحبا 世界\",\n \"goalAmount\": 10000,\n \"raisedAmount\": 0,\n \"endsAt\": \"2026-03-15T00:00:00.000Z\"\n }\n ],\n \"emptyCampaigns\": []\n}\n" }, { "path": "cypress/fixtures/user/donations.json", "content": "{\n \"donations\": [\n {\n \"id\": \"don_001\",\n \"amount\": 50,\n \"donorName\": \"Example Donor\",\n \"donatedAt\": \"2026-01-05T00:00:00.000Z\",\n \"campaignId\": \"camp_001\"\n },\n {\n \"id\": \"don_002\",\n \"amount\": 0,\n \"donorName\": \"Anonymous — 世界\",\n \"donatedAt\": \"2026-01-06T00:00:00.000Z\",\n \"campaignId\": \"camp_002\"\n }\n ],\n \"emptyDonations\": []\n}\n" }, { "path": "cypress/fixtures/user/posts.json", "content": "{\n \"posts\": [\n {\n \"id\": \"post_001\",\n \"title\": \"Welcome post\",\n \"body\": \"Welcome to the community.\",\n \"authorName\": \"Admin User\",\n \"createdAt\": \"2026-01-02T00:00:00.000Z\"\n },\n {\n \"id\": \"post_002\",\n \"title\": \"Long Post — مرحبا 世界\",\n \"body\": \"Edge case content.\",\n \"authorName\": \"Long Name Member — 世界\",\n \"createdAt\": \"2026-01-03T00:00:00.000Z\"\n }\n ],\n \"emptyPosts\": []\n}\n" }, { "path": "cypress/fixtures/user/volunteers.json", "content": "{\n \"volunteers\": [\n {\n \"id\": \"vol_001\",\n \"name\": \"Alex Example\",\n \"role\": \"lead\",\n \"joinedAt\": \"2025-12-15T00:00:00.000Z\"\n },\n {\n \"id\": \"vol_002\",\n \"name\": \"Volunteer — 世界\",\n \"role\": \"member\",\n \"joinedAt\": \"2025-12-20T00:00:00.000Z\"\n }\n ],\n \"emptyVolunteers\": []\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/ActionItemPage.ts", "content": "export class ActionItemPage {\n private readonly createActionItemBtn = '[data-cy=\"createActionItemBtn\"]';\n private readonly categorySelect = '[data-cy=\"categorySelect\"]';\n private readonly memberSelect = '[data-cy=\"memberSelect\"]';\n private readonly volunteerSelect = '[data-cy=\"volunteerSelect\"]';\n private readonly submitBtn = '[data-testid=\"modal-submit-btn\"]';\n private readonly sortBtn = '[data-testid=\"sort-toggle\"]';\n private readonly sortByAssignedAtDesc =\n '[data-testid=\"sort-item-assignedAt_DESC\"]';\n private readonly editItemBtn = '[data-testid^=\"editItemBtn\"]';\n private readonly viewItemBtn = '[data-testid^=\"viewItemBtn\"]';\n private readonly statusCheckbox = '[data-testid^=\"statusCheckbox\"]';\n private readonly postCompletionNotes = '[data-cy=\"postCompletionNotes\"]';\n private readonly createCompletionBtn = '[data-testid=\"createBtn\"]';\n private readonly completionBtnSeries = '[data-cy=\"markCompletionForSeries\"]';\n private readonly deleteItemBtn = '[data-testid^=\"deleteItemBtn\"]';\n private readonly deleteYesBtn = '[data-testid=\"modal-delete-btn\"]';\n private readonly modalCloseBtn = '[data-testid=\"modalCloseBtn\"]';\n private readonly notesInput = '[data-cy=\"preCompletionNotes\"]';\n\n // Event page selectors\n private readonly eventsTabButton = '[data-cy=\"leftDrawerButton-Events\"]';\n private readonly eventCard = '[data-testid=\"card\"]';\n private readonly showEventDashboardBtn =\n '[data-testid=\"showEventDashboardBtn\"]';\n private readonly actionItemsTab = '[data-testid=\"actionsBtn\"]';\n\n visitActionItemsTab() {\n cy.get('[data-cy=\"leftDrawerButton-Action Items\"]')\n .should('be.visible')\n .click();\n cy.url().should('match', /\\/orgactionitems\\/[a-f0-9-]+/);\n return this;\n }\n\n visitEventsPage() {\n cy.get(this.eventsTabButton).should('be.visible').click();\n cy.url().should('match', /\\/admin\\/orgevents\\/[a-f0-9-]+/);\n return this;\n }\n\n selectFirstEvent() {\n cy.get(this.eventCard).first().should('be.visible').click();\n return this;\n }\n\n clickShowEventDashboard() {\n cy.get(this.showEventDashboardBtn).should('be.visible').click();\n return this;\n }\n\n navigateToEventActionItemsTab() {\n // After being in event dashboard, click action items tab\n cy.get(this.actionItemsTab).should('be.visible').click();\n return this;\n }\n\n visitEventActionItems(orgId?: string, eventId?: string) {\n if (orgId && eventId) {\n cy.visit(`/admin/event/${orgId}/${eventId}`);\n this.navigateToEventActionItemsTab();\n return this;\n }\n\n this.visitEventsPage();\n this.selectFirstEvent();\n // After selecting event, click \"Show Event Dashboard\" button\n this.clickShowEventDashboard();\n\n // Now click the action items tab within the event dashboard\n this.navigateToEventActionItemsTab();\n return this;\n }\n\n createActionItem(category: string, member: string) {\n cy.get(this.createActionItemBtn).should('be.visible').click();\n cy.get(this.categorySelect).should('be.visible').click();\n cy.contains('[role=\"listbox\"] [role=\"option\"]', category).click();\n cy.get(this.memberSelect).should('be.visible').click();\n cy.contains('[role=\"listbox\"] [role=\"option\"]', member).click();\n cy.get(this.submitBtn).should('be.visible').click();\n cy.assertToast('Action Item created successfully');\n return this;\n }\n\n createActionItemWithVolunteer(category: string, volunteerName?: string) {\n cy.get(this.createActionItemBtn).should('be.visible').click();\n cy.get(this.categorySelect).should('be.visible').click();\n cy.contains('[role=\"listbox\"] [role=\"option\"]', category).click();\n cy.get(this.volunteerSelect).should('be.visible').click();\n if (volunteerName) {\n cy.contains('[role=\"listbox\"] [role=\"option\"]', volunteerName).click();\n } else {\n cy.get('[role=\"listbox\"] [role=\"option\"]').first().click();\n }\n cy.get(this.submitBtn).should('be.visible').click();\n cy.assertToast('Action Item created successfully');\n return this;\n }\n\n sortByNewest() {\n cy.get(this.sortBtn).should('be.visible').click();\n cy.get(this.sortByAssignedAtDesc).should('be.visible').click();\n return this;\n }\n\n editFirstActionItem(newNotes: string) {\n cy.get(this.editItemBtn).first().click();\n cy.get(this.notesInput).should('be.visible').type(newNotes);\n cy.get(this.submitBtn).should('be.visible').click();\n cy.assertToast('Action Item updated successfully');\n return this;\n }\n\n viewFirstActionItemAndCloseModal() {\n cy.get(this.viewItemBtn).first().click();\n cy.get(this.modalCloseBtn).should('be.visible').click();\n return this;\n }\n\n markFirstActionItemAsComplete(completionNotes: string) {\n cy.get(this.statusCheckbox).first().click();\n cy.get(this.postCompletionNotes).type(completionNotes);\n cy.get(this.completionBtnSeries).should('be.visible').click();\n cy.assertToast('Completed');\n return this;\n }\n\n deleteFirstActionItem() {\n cy.get(this.deleteItemBtn).first().click();\n cy.get(this.deleteYesBtn).should('be.visible').click();\n cy.assertToast('Action Item deleted successfully');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/AdminDashboard.ts", "content": "export class AdminDashboardPage {\n private readonly _orgcardContainer: string = '[data-cy=\"orgCardContainer\"]';\n private readonly _manageButton: string = '[data-cy=\"manageBtn\"]';\n private readonly _toggleDropdown: string = '[data-testid=\"togDrop\"]';\n private readonly _logoutButton: string = '[data-testid=\"signOutBtn\"]';\n private readonly _loginEmailInput: string = '[data-cy=\"loginEmail\"]';\n private readonly _drawerOptions = [\n { label: 'People', url: '/admin/orgpeople/' },\n { label: 'Tags', url: '/admin/orgtags/' },\n { label: 'Events', url: '/admin/orgevents/' },\n { label: 'Venues', url: '/admin/orgvenues/' },\n { label: 'Posts', url: '/admin/orgpost/' },\n { label: 'Block/Unblock', url: '/admin/blockuser/' },\n { label: 'Advertisement', url: '/admin/orgads/' },\n { label: 'Funds', url: '/admin/orgfunds/' },\n { label: 'Membership Requests', url: '/admin/requests/' },\n { label: 'Settings', url: '/admin/orgsetting/' },\n ];\n\n visit() {\n cy.visit('/admin/orglist');\n return this;\n }\n\n verifyOnDashboard(timeout = 20000) {\n cy.url({ timeout }).should('include', '/admin/orglist');\n const emptyStateSelector = '[data-testid=\"orglist-no-orgs-empty\"]';\n cy.get('body', { timeout }).then(($body) => {\n // Check that either org cards or empty state are present (page loaded)\n const hasOrgCards = $body.find(this._orgcardContainer).length > 0;\n const hasEmptyState = $body.find(emptyStateSelector).length > 0;\n expect(hasOrgCards || hasEmptyState).to.equal(true);\n });\n return this;\n }\n\n openFirstOrganization(timeout = 20000) {\n cy.get(this._manageButton, { timeout })\n .should('be.visible')\n .first()\n .click();\n cy.url().should('match', /\\/admin\\/orgdash\\/[a-f0-9-]+/);\n return this;\n }\n\n verifyLeftDrawerOptions(timeout = 40000) {\n this._drawerOptions.forEach(({ label, url }) => {\n const selector = `[data-cy=\"leftDrawerButton-${label}\"]`;\n cy.get(selector, { timeout }).should('be.visible').click();\n cy.url().should('match', new RegExp(`${url}[a-f0-9-]+`));\n });\n return this;\n }\n\n logout(timeout = 20000) {\n cy.get(this._logoutButton, { timeout })\n .should('exist')\n .click({ force: true });\n cy.url({ timeout }).should('include', '/');\n cy.get(this._loginEmailInput, { timeout }).should('be.visible');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/AdminEventPage.ts", "content": "export class AdminEventPage {\n private readonly _eventsTabButton = '[data-cy=\"leftDrawerButton-Events\"]';\n private readonly _createEventModalButton = '[data-cy=\"createEventModalBtn\"]';\n private readonly _eventTitleInput = '[data-cy=\"eventTitleInput\"]';\n private readonly _eventDescriptionInput = '[data-cy=\"eventDescriptionInput\"]';\n private readonly _eventLocationInput = '[data-cy=\"eventLocationInput\"]';\n private readonly _createEventBtn = '[data-cy=\"createEventBtn\"]';\n private readonly _eventCard = '[data-testid=\"card\"]';\n\n visitEventPage(): void {\n cy.get(this._eventsTabButton).should('be.visible').click();\n cy.url().should('match', /\\/admin\\/orgevents\\/[a-f0-9-]+/);\n }\n\n createEvent(title: string, description: string, location: string): this {\n // Set up intercept for specific events query (not all GraphQL operations)\n cy.intercept('POST', '**/graphql', (req) => {\n if (req.body.operationName === 'GetOrganizationEvents') {\n req.alias = 'eventsQuery';\n }\n });\n\n cy.get(this._createEventModalButton)\n .should('be.visible')\n .should('be.enabled');\n cy.get(this._createEventModalButton).click({ force: true });\n\n // Wait for modal form to be fully rendered\n cy.get(this._eventTitleInput).should('be.visible').and('be.enabled');\n\n // Clear and type each field, breaking up command chains to handle page re-renders\n cy.get(this._eventTitleInput).clear();\n cy.get(this._eventTitleInput).type(title);\n cy.get(this._eventTitleInput).should('have.value', title);\n\n cy.get(this._eventDescriptionInput).clear();\n cy.get(this._eventDescriptionInput).type(description);\n cy.get(this._eventDescriptionInput).should('have.value', description);\n\n cy.get(this._eventLocationInput).clear();\n cy.get(this._eventLocationInput).type(location);\n cy.get(this._eventLocationInput).should('have.value', location);\n\n // Submit the form\n cy.get(this._createEventBtn).should('be.visible').and('be.enabled').click();\n\n // Assert success toast\n cy.assertToast('Congratulations! The Event is created.');\n\n // Wait for modal to close\n cy.get(this._eventTitleInput).should('not.exist');\n\n // Reload to ensure fresh data and wait for specific events query to complete\n cy.reload();\n cy.wait('@eventsQuery', { timeout: 15000 });\n\n // Wait for page to fully load\n cy.get(this._createEventModalButton, { timeout: 10000 }).should(\n 'be.visible',\n );\n\n // Cypress cannot click this due to calendar cards overlapping the button.\n // This is a known Cypress actionability limitation — force click is required.\n cy.get('[data-testid=\"more\"]')\n .filter(':contains(\"View all\")')\n .each(($btn) => {\n cy.wrap($btn).click({ force: true });\n })\n .then(($buttons) => {\n // Wait for all clicks to be flushed; branch on whether any buttons existed.\n if ($buttons.length === 0) {\n return;\n }\n cy.contains(this._eventCard, title, { timeout: 30000 }).should('exist');\n });\n\n return this;\n }\n\n findEventCard(eventName: string): Cypress.Chainable {\n // Find the specific event card containing the event name\n // This pattern retries until an element matching both selector AND text is found\n return cy.contains(this._eventCard, eventName, { timeout: 30000 });\n }\n\n openEventDetails(eventName: string): this {\n this.findEventCard(eventName).click();\n return this;\n }\n\n updateEvent(\n existingName: string,\n newName: string,\n newDescription: string,\n newLocation: string,\n ): this {\n // Find and click on the event card\n this.openEventDetails(existingName);\n\n // Wait for edit form to load and update fields, breaking up command chains\n cy.get('[data-cy=\"updateName\"]', { timeout: 10000 }).should('be.visible');\n cy.get('[data-cy=\"updateName\"]').clear();\n cy.get('[data-cy=\"updateName\"]').type(newName);\n cy.get('[data-cy=\"updateName\"]').should('have.value', newName);\n\n cy.get('[data-cy=\"updateDescription\"]').should('be.visible');\n cy.get('[data-cy=\"updateDescription\"]').clear();\n cy.get('[data-cy=\"updateDescription\"]').type(newDescription);\n\n cy.get('[data-cy=\"updateLocation\"]').should('be.visible');\n cy.get('[data-cy=\"updateLocation\"]').clear();\n cy.get('[data-cy=\"updateLocation\"]').type(newLocation);\n\n // Click update button\n cy.get('[data-cy=\"previewUpdateEventBtn\"]')\n .should('be.visible')\n .and('be.enabled')\n .click();\n\n cy.assertToast('Event updated successfully.');\n\n return this;\n }\n\n deleteEvent(eventName: string): this {\n // Find and click on the event card\n this.openEventDetails(eventName);\n\n // Click delete button in event details\n cy.get('[data-cy=\"deleteEventModalBtn\"]', { timeout: 10000 })\n .should('be.visible')\n .click();\n\n // Confirm deletion\n cy.get('[data-testid=\"deleteEventBtn\"]').should('be.visible').click();\n\n cy.assertToast('Event deleted successfully.');\n\n return this;\n }\n\n verifyEventNotInList(eventTitle: string, timeout = 40000): this {\n // Verify the event doesn't appear in the event list\n // Using should('not.exist') handles the case where no cards exist\n cy.contains(this._eventCard, eventTitle, { timeout }).should('not.exist');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/AdvertisementPage.ts", "content": "export class AdvertisementPage {\n private readonly _createAdBtn = '[data-testid=\"createAdvertisement\"]';\n private readonly _adNameInput = '[data-cy=\"advertisementNameInput\"]';\n private readonly _adDescriptionInput =\n '[data-cy=\"advertisementDescriptionInput\"]';\n private readonly _adTypeSelect = '[data-cy=\"advertisementTypeSelect\"]';\n private readonly _registerAdBtn = '[data-cy=\"registerAdvertisementButton\"]';\n private readonly _leftDrawerAdBtn =\n '[data-cy=\"leftDrawerButton-Advertisement\"]';\n private readonly _activeCampaignsTab = 'Active Campaigns';\n private readonly _dropdownBtn = '[data-cy=\"dropdownbtn\"]';\n private readonly _editBtn = '[data-testid=\"editBtn\"]';\n private readonly _saveChangesBtn = '[data-cy=\"saveChanges\"]';\n private readonly _deleteBtn = '[data-cy=\"deletebtn\"]';\n private readonly _deleteConfirmBtn = '[data-testid=\"delete_yes\"]';\n\n visitAdvertisementPage() {\n cy.get(this._leftDrawerAdBtn).should('be.visible').click();\n cy.url().should('match', /\\/admin\\/orgads\\/[a-f0-9-]+/);\n return this;\n }\n\n createAdvertisement(name: string, description: string, type: string) {\n cy.get(this._createAdBtn).should('be.visible').click();\n cy.get(this._adNameInput).should('be.visible').type(name);\n cy.get(this._adDescriptionInput).should('be.visible').type(description);\n cy.get(this._adTypeSelect).should('be.visible').select(type);\n cy.get(this._registerAdBtn).should('be.visible').click();\n cy.assertToast('Advertisement created successfully.');\n return this;\n }\n\n verifyAndEditAdvertisement(oldName: string, newName: string) {\n cy.contains(this._activeCampaignsTab).should('be.visible').click();\n cy.contains(oldName).should('be.visible');\n cy.get(this._dropdownBtn).should('be.visible').click();\n cy.get(this._editBtn).should('be.visible').trigger('click');\n cy.get(this._adNameInput).should('be.visible').clear().type(newName);\n cy.get(this._saveChangesBtn).should('be.visible').click();\n cy.assertToast('Advertisement updated Successfully');\n return this;\n }\n\n verifyAndDeleteAdvertisement(adName: string) {\n cy.contains(this._activeCampaignsTab).should('be.visible').click();\n cy.contains(adName).should('be.visible');\n cy.get(this._dropdownBtn).should('be.visible').click();\n cy.get(this._deleteBtn).should('be.visible').trigger('click');\n cy.get(this._deleteConfirmBtn).should('be.visible').click();\n cy.assertToast('Advertisement deleted successfully.');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/EventAttendancePage.ts", "content": "import { BasePage } from '../base/BasePage';\n\nexport type AttendanceSortOrder = 'ascending' | 'descending';\nexport type AttendanceFilterPeriod = 'This Month' | 'This Year' | 'All';\n\nexport class EventAttendancePage extends BasePage {\n private readonly attendanceTabButton = 'attendanceBtn';\n private readonly attendanceTabPanel = 'eventAttendanceTab';\n private readonly statsButton = 'stats-modal';\n private readonly closeStatisticsButton = 'close-button';\n private readonly searchInput = 'searchByName';\n private readonly searchButton = 'searchMembersBtn';\n private readonly sortToggleButton = 'sort-dropdown-toggle';\n private readonly sortItemPrefix = 'sort-dropdown-item-';\n private readonly filterToggleButton = 'filter-dropdown-toggle';\n private readonly filterMenu = '[data-testid=\"filter-dropdown-menu\"]';\n private readonly table = this.tableActions('.MuiDataGrid-root');\n\n protected self(): EventAttendancePage {\n return this;\n }\n\n visitPage(orgId: string, eventId: string, timeout = 30000): this {\n this.visit(`/admin/event/${orgId}/${eventId}`);\n this.assertUrlIncludes(`/admin/event/${orgId}/${eventId}`, timeout);\n return this;\n }\n\n openAttendanceTab(timeout = 10000): this {\n this.byTestId(this.attendanceTabButton, timeout)\n .should('be.visible')\n .click();\n this.byTestId(this.attendanceTabPanel, timeout).should('be.visible');\n return this;\n }\n\n searchMemberByName(name: string, timeout = 10000): this {\n this.byTestId(this.searchInput, timeout)\n .should('be.visible')\n .clear()\n .type(name);\n this.byTestId(this.searchButton, timeout).should('be.visible').click();\n return this;\n }\n\n clearSearch(timeout = 10000): this {\n this.byTestId(this.searchInput, timeout).should('be.visible').clear();\n this.byTestId(this.searchButton, timeout).should('be.visible').click();\n return this;\n }\n\n setSortOrder(order: AttendanceSortOrder, timeout = 10000): this {\n this.byTestId(this.sortToggleButton, timeout).should('be.visible').click();\n this.byTestId(`${this.sortItemPrefix}${order}`, timeout)\n .should('be.visible')\n .click();\n return this;\n }\n\n setFilterPeriod(period: AttendanceFilterPeriod, timeout = 10000): this {\n this.byTestId(this.filterToggleButton, timeout)\n .should('be.visible')\n .click();\n\n cy.contains(`${this.filterMenu} [role=\"option\"]`, period, {\n timeout,\n }).click();\n\n return this;\n }\n\n openStatisticsModal(timeout = 10000): this {\n this.byTestId(this.statsButton, timeout).should('be.visible').click();\n this.byTestId(this.closeStatisticsButton, timeout).should('be.visible');\n return this;\n }\n\n closeStatisticsModal(timeout = 10000): this {\n this.byTestId(this.closeStatisticsButton, timeout)\n .should('be.visible')\n .click();\n return this;\n }\n\n verifyAttendeeInList(name: string, timeout = 10000): this {\n this.table.findRowByText(name, timeout, false);\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/LeftDrawer.ts", "content": "export class LeftDrawer {\n checkBreakpoint(orgId: string): void {\n // Ensure we're inside the <1280px breakpoint where the fix applies\n cy.viewport(1200, 900);\n // Stabilize assertions by waiting on org data\n cy.intercept('POST', '**/graphql').as('graphql');\n cy.visit(`/admin/orgdash/${orgId}`);\n cy.url().should('include', '/admin/orgdash');\n cy.wait('@graphql', { timeout: 15000 });\n }\n\n checkRowViewport(): void {\n // Wait for the profile container to be visible\n cy.get('[data-testid=\"OrgBtn\"]').should('be.visible');\n\n // Check that the profileContainer has flex-direction: row\n cy.get('[data-testid=\"OrgBtn\"]').should(\n 'have.css',\n 'flex-direction',\n 'row',\n );\n }\n\n checkProfileContainerStyling(): void {\n // Wait for organization data to load (not shimmer state)\n cy.get('[data-testid=\"OrgBtn\"]').should('be.visible');\n cy.get('[class*=\"shimmer\"]').should('not.exist');\n\n // Verify the CSS property using CSS modules pattern\n cy.get('[data-testid=\"OrgBtn\"]')\n .should('be.visible')\n .and('have.css', 'flex-direction', 'row');\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/MemberManagementPage.ts", "content": "import { BasePage } from '../base/BasePage';\n\nexport class MemberManagementPage extends BasePage {\n private readonly peopleTabButton = 'leftDrawerButton-People';\n private readonly searchInput = 'member-search-input';\n private readonly searchButton = 'searchBtn';\n private readonly addMembersButton = 'addMembers-toggle';\n private readonly existingUserToggle = 'addMembers-item-existingUser';\n private readonly searchUserInput = 'searchUser';\n private readonly submitSearchButton = 'submitBtn';\n private readonly addButton = 'addBtn';\n private readonly removeMemberActionSelector =\n '[data-testid=\"removeMemberModalBtn\"]';\n private readonly confirmRemoveMemberButton = 'removeMemberBtn';\n private readonly alertSelector = '[role=alert]';\n private readonly table = this.tableActions('.MuiDataGrid-root');\n private readonly removeMemberModal = this.modalActions('[role=\"dialog\"]');\n\n protected self(): MemberManagementPage {\n return this;\n }\n\n openFromDrawer(timeout = 40000): this {\n this.byDataCy(this.peopleTabButton, timeout).should('be.visible').click();\n this.assertUrlMatch(/\\/admin\\/orgpeople\\/[a-f0-9-]+/, timeout);\n return this;\n }\n\n visitPage(orgId: string, timeout = 40000): this {\n this.visit(`/admin/orgpeople/${orgId}`);\n this.assertUrlIncludes(`/admin/orgpeople/${orgId}`, timeout);\n return this;\n }\n\n searchMemberByName(name: string, timeout = 40000): this {\n this.byTestId(this.searchInput, timeout)\n .should('be.visible')\n .clear()\n .type(name);\n this.byTestId(this.searchButton, timeout).should('be.visible').click();\n return this;\n }\n\n verifyMemberInList(name: string, timeout = 40000): this {\n this.table.findRowByText(name, timeout);\n return this;\n }\n\n clickAddExistingMember(timeout = 40000): this {\n this.byTestId(this.addMembersButton, timeout).should('be.visible').click();\n this.byTestId(this.existingUserToggle, timeout)\n .should('be.visible')\n .trigger('click');\n return this;\n }\n\n searchAndSelectUser(name: string, timeout = 40000): this {\n this.byTestId(this.searchUserInput, timeout)\n .should('be.visible')\n .clear()\n .type(name);\n this.byTestId(this.submitSearchButton, timeout)\n .should('be.visible')\n .click();\n cy.contains(name, { timeout }).should('be.visible');\n return this;\n }\n\n confirmAddUser(name: string, timeout = 100000): this {\n void name;\n this.byTestId(this.addButton, timeout).first().should('be.visible').click();\n return this;\n }\n\n deleteMember(name: string, timeout = 40000): this {\n this.searchMemberByName(name, timeout);\n\n cy.then(() => {\n this.table.waitVisible(timeout);\n this.table.clickRowActionByText(\n name,\n this.removeMemberActionSelector,\n timeout,\n );\n });\n\n this.removeMemberModal\n .waitVisible(timeout)\n .clickByTestId(this.confirmRemoveMemberButton, { timeout });\n\n this.getAlert(timeout).should('be.visible');\n\n return this;\n }\n\n resetSearch(timeout = 40000): this {\n this.byTestId(this.searchInput, timeout).should('be.visible').clear();\n this.byTestId(this.searchButton, timeout).should('be.visible').click();\n return this;\n }\n\n getAlert(timeout = 40000): Cypress.Chainable> {\n return cy.get(this.alertSelector, { timeout });\n }\n\n verifyMinRows(minRows: number, timeout = 40000): this {\n this.table.expectMinRows(minRows, timeout);\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/OrganizationSettingsPage.ts", "content": "import { BasePage } from '../base/BasePage';\n\nexport class OrganizationSettingsPage extends BasePage {\n private readonly settingsDrawerButton = 'leftDrawerButton-Settings';\n private readonly generalSettingsButton = 'generalSettings';\n private readonly actionItemCategoriesButton = 'actionItemCategoriesSettings';\n private readonly generalTab = 'generalTab';\n private readonly actionItemCategoriesTab = 'actionItemCategoriesTab';\n private readonly organizationNameInput = '[name=\"orgName\"]';\n private readonly organizationDescriptionInput = '[name=\"orgDescrip\"]';\n private readonly organizationLocationInput = '[name=\"address.line1\"]';\n private readonly isPublicSwitch = 'user-reg-switch';\n private readonly saveChangesButton = 'save-org-changes-btn';\n private readonly openDeleteModalButton = 'openDeleteModalBtn';\n private readonly confirmDeleteButton = 'deleteOrganizationBtn';\n private readonly closeDeleteModalButton = 'closeDelOrgModalBtn';\n private readonly deleteOrganizationModal =\n this.modalActions('[role=\"dialog\"]');\n\n protected self(): OrganizationSettingsPage {\n return this;\n }\n\n openFromDrawer(timeout = 30000): this {\n this.byDataCy(this.settingsDrawerButton, timeout)\n .should('be.visible')\n .click();\n this.assertUrlMatch(/\\/admin\\/orgsetting\\/[a-f0-9-]+/, timeout);\n return this;\n }\n\n visitPage(orgId: string, timeout = 30000): this {\n this.visit(`/admin/orgsetting/${orgId}`);\n this.assertUrlIncludes(`/admin/orgsetting/${orgId}`, timeout);\n return this;\n }\n\n openGeneralTab(timeout = 10000): this {\n this.byTestId(this.generalSettingsButton, timeout)\n .should('be.visible')\n .click();\n this.byTestId(this.generalTab, timeout).should('be.visible');\n return this;\n }\n\n openActionItemCategoriesTab(timeout = 10000): this {\n this.byTestId(this.actionItemCategoriesButton, timeout)\n .should('be.visible')\n .click();\n this.byTestId(this.actionItemCategoriesTab, timeout).should('be.visible');\n return this;\n }\n\n updateOrganizationName(name: string, timeout = 10000): this {\n cy.get(this.organizationNameInput, { timeout })\n .should('be.visible')\n .clear()\n .type(name);\n return this;\n }\n\n updateOrganizationDescription(description: string, timeout = 10000): this {\n cy.get(this.organizationDescriptionInput, { timeout })\n .should('be.visible')\n .clear()\n .type(description);\n return this;\n }\n\n updateOrganizationLocation(location: string, timeout = 10000): this {\n cy.get(this.organizationLocationInput, { timeout })\n .should('be.visible')\n .clear()\n .type(location);\n return this;\n }\n\n toggleIsPublic(timeout = 10000): this {\n this.byTestId(this.isPublicSwitch, timeout).should('be.visible').click();\n return this;\n }\n\n saveChanges(timeout = 10000): this {\n this.byTestId(this.saveChangesButton, timeout).should('be.visible').click();\n return this;\n }\n\n openDeleteOrganizationModal(timeout = 10000): this {\n this.byTestId(this.openDeleteModalButton, timeout)\n .should('be.visible')\n .click();\n this.deleteOrganizationModal.waitVisible(timeout);\n return this;\n }\n\n closeDeleteOrganizationModal(timeout = 10000): this {\n this.deleteOrganizationModal.clickByTestId(this.closeDeleteModalButton, {\n timeout,\n });\n return this;\n }\n\n confirmDeleteOrganization(timeout = 10000): this {\n this.deleteOrganizationModal.clickByTestId(this.confirmDeleteButton, {\n timeout,\n });\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/PeoplePage.ts", "content": "/// \nimport { ModalActions } from '../shared/ModalActions';\nimport { TableActions } from '../shared/TableActions';\n\nexport class PeoplePage {\n private readonly _peopleTabButton = '[data-cy=\"leftDrawerButton-People\"]';\n private readonly _searchInput = '[placeholder=\"Enter Full Name\"]';\n private readonly _searchButton = '[data-testid=\"searchbtn\"]';\n private readonly _addMembersBtn = '[data-testid=\"addMembers-toggle\"]';\n private readonly _existingUserToggle =\n '[data-testid=\"addMembers-item-existingUser\"]';\n private readonly _searchUserInput = '[data-testid=\"searchUser\"]';\n private readonly _submitSearchBtn = '[data-testid=\"submitBtn\"]';\n private readonly _addBtn = '[data-testid=\"addBtn\"]';\n private readonly _removeModalBtn = '[data-testid=\"removeMemberModalBtn\"]';\n private readonly _confirmRemoveBtnTestId = 'removeMemberBtn';\n private readonly _alert = '[role=alert]';\n private readonly tableActions = new TableActions('.MuiDataGrid-root');\n private readonly removeMemberModal = new ModalActions('[role=\"dialog\"]');\n\n visitPeoplePage(): void {\n cy.get(this._peopleTabButton).should('be.visible').click();\n cy.url().should('match', /\\/admin\\/orgpeople\\/[a-f0-9-]+/);\n }\n\n searchMemberByName(name: string, timeout = 40000) {\n cy.get(this._searchInput, { timeout })\n .should('be.visible')\n .clear()\n .type(name);\n cy.get(this._searchButton, { timeout }).should('be.visible').click();\n return this;\n }\n\n verifyMemberInList(name: string, timeout = 40000) {\n this.tableActions.findRowByText(name, timeout);\n return this;\n }\n\n clickAddExistingMember(timeout = 40000) {\n cy.get(this._addMembersBtn, { timeout }).should('be.visible').click();\n cy.get(this._existingUserToggle, { timeout })\n .should('be.visible')\n .trigger('click');\n return this;\n }\n\n searchAndSelectUser(name: string, timeout = 40000) {\n cy.get(this._searchUserInput, { timeout })\n .should('be.visible')\n .clear()\n .type(name);\n cy.get(this._submitSearchBtn, { timeout }).should('be.visible').click();\n cy.contains(name, { timeout }).should('be.visible');\n return this;\n }\n\n confirmAddUser(name: string, timeout = 100000) {\n cy.get(this._addBtn, { timeout }).first().should('be.visible').click();\n cy.contains(this._alert, 'Member added Successfully', { timeout }).should(\n 'be.visible',\n );\n cy.reload();\n this.searchMemberByName(name, timeout);\n this.verifyMemberInList(name, timeout);\n return this;\n }\n\n deleteMember(name: string, timeout = 40000) {\n this.searchMemberByName(name, timeout);\n cy.then(() => {\n this.tableActions.waitVisible(timeout);\n this.tableActions.clickRowActionByText(\n name,\n this._removeModalBtn,\n timeout,\n );\n });\n\n this.removeMemberModal\n .waitVisible(timeout)\n .clickByTestId(this._confirmRemoveBtnTestId, { timeout });\n\n cy.get(this._alert, { timeout })\n .should('be.visible')\n .and('contain.text', 'The Member is removed');\n return this;\n }\n\n resetSearch(timeout = 40000) {\n cy.get(this._searchInput, { timeout }).should('be.visible').clear();\n cy.get(this._searchButton, { timeout }).should('be.visible').click();\n return this;\n }\n\n verifyMinRows(minRows: number, timeout = 40000) {\n this.tableActions.expectMinRows(minRows, timeout);\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/PostPage.ts", "content": "export class PostsPage {\n private readonly _postsTabButton = '[data-cy=\"leftDrawerButton-Posts\"]';\n private readonly _createPostButton = '[data-cy=\"createPostModalBtn\"]';\n private readonly _postTitleInput = '[data-cy=\"modalTitle\"]';\n private readonly _postDescriptionInput =\n '[data-cy=\"create-post-description\"]';\n private readonly _pinPostCheckbox = '[data-cy=\"pinPost\"]';\n private readonly _moreOptionsIcon =\n '[data-testid=\"post-more-options-button\"]';\n private readonly _editOption = '[data-testid=\"edit-post-menu-item\"]';\n private readonly _createPostSubmit = '[data-testid=\"createPostBtn\"]';\n private readonly _deleteOption = '[data-testid=\"delete-post-button\"]';\n private readonly _sortButton = '[data-testid=\"sortpost-toggle\"]';\n\n visitPostsPage() {\n cy.get(this._postsTabButton).should('be.visible').click();\n cy.url().should('match', /\\/orgpost\\/[a-f0-9-]+/);\n return this;\n }\n\n createPost(title: string, description: string) {\n cy.get(this._createPostButton).should('be.visible').click();\n cy.get(this._postTitleInput).filter(':visible').type(title);\n cy.get(this._postDescriptionInput).filter(':visible').type(description);\n cy.get(this._pinPostCheckbox).filter(':visible').click();\n cy.get(this._createPostSubmit)\n .filter(':visible')\n .should('be.visible')\n .click();\n cy.assertToast('Congratulations! You have Posted Something.');\n return this;\n }\n\n sortPostsByNewest() {\n cy.get(this._sortButton).should('be.visible').click();\n cy.get('[data-testid=\"sortpost-item-latest\"]').should('be.visible').click();\n return this;\n }\n\n editFirstPost(newTitle: string) {\n this.sortPostsByNewest();\n cy.get(this._moreOptionsIcon).first().should('be.visible').click();\n cy.get(this._editOption).should('be.visible').click();\n cy.get(this._postTitleInput).filter(':visible').clear().type(newTitle);\n cy.get(this._createPostSubmit).filter(':visible').click({ force: true });\n cy.assertToast('Post updated successfully');\n return this;\n }\n\n deleteFirstPost() {\n cy.get(this._moreOptionsIcon).first().should('be.visible').click();\n cy.get(this._deleteOption).should('be.visible').click();\n cy.assertToast('Post deleted successfully.');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/AdminPortal/VolunteerManagementPage.ts", "content": "import { BasePage } from '../base/BasePage';\n\nexport class VolunteerManagementPage extends BasePage {\n private readonly volunteersTabButton = 'volunteersBtn';\n private readonly volunteersTabPanel = 'eventVolunteersTab';\n private readonly individualToggle = 'individualRadio';\n private readonly groupsToggle = 'groupsRadio';\n private readonly requestsToggle = 'requestsRadio';\n private readonly addVolunteerButton = 'addVolunteerBtn';\n private readonly createGroupButton = 'createGroupBtn';\n\n protected self(): VolunteerManagementPage {\n return this;\n }\n\n visitPage(orgId: string, eventId: string, timeout = 30000): this {\n this.visit(`/admin/event/${orgId}/${eventId}`);\n this.assertUrlIncludes(`/admin/event/${orgId}/${eventId}`, timeout);\n return this;\n }\n\n openVolunteersTab(timeout = 10000): this {\n this.byTestId(this.volunteersTabButton, timeout)\n .should('be.visible')\n .click();\n this.byTestId(this.volunteersTabPanel, timeout).should('be.visible');\n return this;\n }\n\n showIndividuals(timeout = 10000): this {\n this.byTestId(this.individualToggle, timeout).should('be.visible').click();\n return this;\n }\n\n showGroups(timeout = 10000): this {\n this.byTestId(this.groupsToggle, timeout).should('be.visible').click();\n return this;\n }\n\n showRequests(timeout = 10000): this {\n this.byTestId(this.requestsToggle, timeout).should('be.visible').click();\n return this;\n }\n\n openAddVolunteerModal(timeout = 10000): this {\n this.byTestId(this.addVolunteerButton, timeout)\n .should('be.visible')\n .click();\n this.modalActions().waitVisible(timeout);\n return this;\n }\n\n openCreateGroupModal(timeout = 10000): this {\n this.byTestId(this.createGroupButton, timeout).should('be.visible').click();\n this.modalActions().waitVisible(timeout);\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/UserPortal/UserDashboard.ts", "content": "export class UserDashboardPage {\n private readonly _orgCard: string = '[data-cy=\"orgCard\"]';\n private readonly _manageButton: string = '[data-cy=\"manageBtn\"]';\n\n visit() {\n cy.visit('/user/organizations');\n return this;\n }\n\n verifyOnDashboard(timeout = 10000) {\n cy.url({ timeout }).should('include', '/user/organizations');\n cy.get(this._orgCard, { timeout }).should('be.visible');\n return this;\n }\n\n openFirstOrganization(timeout = 10000) {\n cy.get(this._manageButton, { timeout })\n .should('be.visible')\n .first()\n .click();\n cy.url({ timeout }).should('match', /\\/user\\/organization\\/[a-f0-9-]+/);\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/auth/LoginPage.ts", "content": "/**\n * Page Object Model for the Login Page.\n * Contains selectors and methods for interacting with the login page.\n */\nexport class LoginPage {\n private readonly _emailInput: string = '[data-cy=loginEmail]';\n private readonly _passwordInput: string = '[data-cy=loginPassword]';\n private readonly _loginButton: string = '[data-cy=loginBtn]';\n\n verifyLoginPage(timeout = 10000) {\n cy.get(this._emailInput, { timeout }).should('be.visible');\n cy.get(this._passwordInput, { timeout }).should('be.visible');\n cy.get(this._loginButton, { timeout }).should('be.visible');\n return this;\n }\n\n login(email: string, password: string, timeout = 10000) {\n cy.get(this._emailInput, { timeout })\n .should('be.visible')\n .clear()\n .type(email);\n cy.get(this._passwordInput, { timeout })\n .should('be.visible')\n .clear()\n .type(password);\n cy.get(this._loginButton, { timeout }).should('be.enabled').click();\n return this;\n }\n\n verifyToastVisible(expectedMessage?: string, timeout = 10000) {\n const toast = cy.get('[role=alert]', { timeout }).should('be.visible');\n if (expectedMessage) {\n toast.should('contain.text', expectedMessage);\n }\n return this;\n }\n\n verifyErrorToast(timeout = 10000) {\n return this.verifyToastVisible(undefined, timeout);\n }\n}\n" }, { "path": "cypress/pageObjects/base/BasePage.ts", "content": "import { ModalActions } from '../shared/ModalActions';\nimport { TableActions } from '../shared/TableActions';\n\nexport abstract class BasePage> {\n protected abstract self(): TSelf;\n\n protected byTestId(\n testId: string,\n timeout = 10000,\n ): Cypress.Chainable> {\n return cy.get(`[data-testid=\"${testId}\"]`, { timeout });\n }\n\n protected byDataCy(\n value: string,\n timeout = 10000,\n ): Cypress.Chainable> {\n return cy.get(`[data-cy=\"${value}\"]`, { timeout });\n }\n\n protected tableActions(tableSelector = '.MuiDataGrid-root'): TableActions {\n return new TableActions(tableSelector);\n }\n\n protected modalActions(rootSelector = '[role=\"dialog\"]'): ModalActions {\n return new ModalActions(rootSelector);\n }\n\n protected assertUrlIncludes(path: string, timeout = 10000): TSelf {\n cy.url({ timeout }).should('include', path);\n return this.self();\n }\n\n protected assertUrlMatch(pattern: RegExp, timeout = 10000): TSelf {\n cy.url({ timeout }).should('match', pattern);\n return this.self();\n }\n\n visit(path: string): TSelf {\n cy.visit(path);\n return this.self();\n }\n}\n" }, { "path": "cypress/pageObjects/shared/ModalActions.ts", "content": "import type { ClickOptions, TestIdClickConfig } from './types';\n\nexport class ModalActions {\n constructor(private readonly rootSelector = '[role=\"dialog\"]') {}\n\n private root(timeout = 10000): Cypress.Chainable> {\n return cy.get(this.rootSelector, { timeout });\n }\n\n waitVisible(timeout = 10000): this {\n this.root(timeout).should('be.visible');\n return this;\n }\n\n clickByTestId(\n testId: string,\n { options, timeout = 10000 }: TestIdClickConfig = {},\n ): this {\n this.root(timeout)\n .find(`[data-testid=\"${testId}\"]`)\n .should('be.visible')\n .click(options);\n return this;\n }\n\n clickBySelector(\n selector: string,\n options?: ClickOptions,\n timeout = 10000,\n ): this {\n this.root(timeout).find(selector).should('be.visible').click(options);\n return this;\n }\n\n submit(testId = 'modal-submit-btn', options?: ClickOptions): this {\n return this.clickByTestId(testId, { options });\n }\n\n cancel(testId = 'modal-cancel-btn', options?: ClickOptions): this {\n return this.clickByTestId(testId, { options });\n }\n\n close(testId = 'modalCloseBtn', options?: ClickOptions): this {\n return this.clickByTestId(testId, { options });\n }\n\n hasTitle(title: string, timeout = 10000): this {\n this.root(timeout)\n .find('h1,h2,h3,[class*=\"Title\"],[role=\"heading\"]')\n .should('contain.text', title)\n .and('be.visible');\n return this;\n }\n}\n" }, { "path": "cypress/pageObjects/shared/TableActions.ts", "content": "import type { ClickOptions } from './types';\n\nexport class TableActions {\n constructor(private readonly tableSelector = '.MuiDataGrid-root') {}\n\n private escapeRegex(text: string): string {\n return text.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&');\n }\n\n private root(timeout = 10000): Cypress.Chainable> {\n return cy.get(this.tableSelector, { timeout });\n }\n\n waitVisible(timeout = 10000): this {\n this.root(timeout).should('be.visible');\n return this;\n }\n\n findRowByText(\n text: string,\n timeout = 10000,\n exact = true,\n ): Cypress.Chainable> {\n const matcher = exact ? new RegExp(`^${this.escapeRegex(text)}$`) : null;\n\n return cy\n .get(`${this.tableSelector} .MuiDataGrid-row`, { timeout })\n .then(($rows) => {\n const matchedRow = $rows.toArray().find((row) => {\n const cells = Cypress.$(row).find('[role=\"gridcell\"], td').toArray();\n\n return cells.some((cell) => {\n const cellText = Cypress.$(cell).text().trim();\n\n if (matcher) {\n return matcher.test(cellText);\n }\n\n return cellText.includes(text);\n });\n });\n\n if (!matchedRow) {\n throw new Error(\n `No DataGrid row found in ${this.tableSelector} matching text \"${text}\".`,\n );\n }\n\n return cy.wrap(matchedRow, { log: false });\n })\n .should('be.visible');\n }\n\n clickRowActionByText(\n rowText: string,\n actionSelector: string,\n timeout = 10000,\n options?: ClickOptions,\n exact = true,\n ): this {\n this.findRowByText(rowText, timeout, exact)\n .find(actionSelector)\n .should('be.visible')\n .click(options);\n return this;\n }\n\n // Intentionally global queries: sorting menus can render outside `tableSelector`.\n sortBy(\n toggleSelector: string,\n optionSelector: string,\n timeout = 10000,\n ): this {\n cy.get(toggleSelector, { timeout }).should('be.visible').click();\n cy.get(optionSelector, { timeout }).should('be.visible').click();\n return this;\n }\n\n filterBy(inputSelector: string, value: string, timeout = 10000): this {\n cy.get(inputSelector, { timeout }).should('be.visible').clear().type(value);\n return this;\n }\n\n expectMinRows(minRows: number, timeout = 10000): this {\n cy.get(`${this.tableSelector} .MuiDataGrid-row`, { timeout }).should(\n 'have.length.at.least',\n minRows,\n );\n return this;\n }\n\n cell(\n rowIndex: number,\n columnIndex: number,\n timeout = 10000,\n ): Cypress.Chainable> {\n return cy\n .get(`${this.tableSelector} .MuiDataGrid-row`, { timeout })\n .eq(rowIndex)\n .find('[role=\"gridcell\"], td')\n .eq(columnIndex);\n }\n}\n" }, { "path": "cypress/pageObjects/shared/types.ts", "content": "export type ClickOptions = Partial;\n\nexport interface TestIdClickConfig {\n options?: ClickOptions;\n timeout?: number;\n}\n" }, { "path": "cypress/support/commands.ts", "content": "/// \nimport { getApiPattern } from './graphql-utils';\n\nexport {};\n\ntype AuthRole = 'superAdmin' | 'admin' | 'user';\n\ntype AuthOptions = {\n role?: AuthRole;\n email?: string;\n password?: string;\n token?: string;\n userId?: string;\n apiUrl?: string;\n recaptchaToken?: string;\n};\n\ntype SetupTestEnvironmentOptions = {\n orgName?: string;\n description?: string;\n auth?: AuthOptions;\n};\n\ntype CreateTestOrganizationPayload = {\n name: string;\n description?: string;\n addressLine1?: string;\n addressLine2?: string;\n city?: string;\n state?: string;\n postalCode?: string;\n countryCode?: string;\n isUserRegistrationRequired?: boolean;\n auth?: AuthOptions;\n};\n\ntype CreateOrganizationMembershipOptions = {\n memberId: string;\n organizationId: string;\n role?: 'administrator' | 'regular';\n auth?: AuthOptions;\n};\n\ntype SeedEventPayload = {\n orgId: string;\n name?: string;\n description?: string;\n startAt?: string;\n endAt?: string;\n location?: string;\n isPublic?: boolean;\n isRegisterable?: boolean;\n auth?: AuthOptions;\n};\n\ntype SeedUserDetails = {\n name?: string;\n email?: string;\n password?: string;\n role?: 'administrator' | 'regular';\n isEmailAddressVerified?: boolean;\n};\n\ntype SeedUserPayload = SeedUserDetails & {\n auth?: AuthOptions;\n};\n\ntype SeedVolunteerPayload = {\n eventId: string;\n userId?: string;\n user?: SeedUserDetails;\n auth?: AuthOptions;\n userAuth?: AuthOptions;\n scope?: 'ENTIRE_SERIES' | 'THIS_INSTANCE_ONLY';\n recurringEventInstanceId?: string;\n};\n\ntype SeedPostPayload = {\n orgId: string;\n caption?: string;\n body?: string;\n isPinned?: boolean;\n auth?: AuthOptions;\n};\n\ntype SeedActionItemCategoryPayload = {\n orgId: string;\n name?: string;\n description?: string;\n isDisabled?: boolean;\n auth?: AuthOptions;\n};\n\ntype CleanupTestOrganizationOptions = {\n auth?: AuthOptions;\n userIds?: string[];\n allowNotFound?: boolean;\n};\n\ntype CreateTestUserPayload = {\n name?: string;\n email?: string;\n password?: string;\n role?: 'administrator' | 'regular';\n isEmailAddressVerified?: boolean;\n auth?: AuthOptions;\n};\n\ntype SignInTaskResult = { token: string; userId: string };\ntype AuthSession = { token: string; userId?: string };\ntype CreateOrganizationTaskResult = { orgId: string };\ntype CreateEventTaskResult = { eventId: string };\ntype CreateUserTaskResult = {\n userId: string;\n authenticationToken?: string;\n};\ntype CreateVolunteerTaskResult = { volunteerId: string };\ntype CreatePostTaskResult = { postId: string };\n\ntype CredentialRecord = { email: string; password: string };\ntype CredentialFixture = Record;\n\nconst DEFAULT_TEST_PASSWORD = 'Pass@123';\n\nconst roleToEnvKey = (\n role: AuthRole,\n): { emailKey: string; passwordKey: string } => {\n switch (role) {\n case 'superAdmin':\n return {\n emailKey: 'E2E_SUPERADMIN_EMAIL',\n passwordKey: 'E2E_SUPERADMIN_PASSWORD',\n };\n case 'user':\n return { emailKey: 'E2E_USER_EMAIL', passwordKey: 'E2E_USER_PASSWORD' };\n case 'admin':\n return { emailKey: 'E2E_ADMIN_EMAIL', passwordKey: 'E2E_ADMIN_PASSWORD' };\n default:\n throw new Error(`Unknown AuthRole: ${role}`);\n }\n};\n\nconst normalizeAuthRole = (role: string): AuthRole => {\n if (role === 'superadmin') return 'superAdmin';\n if (role === 'admin' || role === 'user' || role === 'superAdmin') {\n return role;\n }\n throw new Error(\n `Unknown auth role \"${role}\". Expected \"admin\", \"user\", or \"superAdmin\".`,\n );\n};\n\nconst resolveCredentials = (\n role: AuthRole,\n overrides?: Partial,\n): Cypress.Chainable => {\n if (overrides?.email && overrides?.password) {\n return cy.wrap({ email: overrides.email, password: overrides.password });\n }\n\n const { emailKey, passwordKey } = roleToEnvKey(role);\n const envEmail = Cypress.env(emailKey) as string | undefined;\n const envPassword = Cypress.env(passwordKey) as string | undefined;\n if (envEmail && envPassword) {\n return cy.wrap({ email: envEmail, password: envPassword });\n }\n\n return cy\n .fixture('auth/credentials')\n .then((credentials: CredentialFixture) => {\n const user = credentials[role];\n if (!user) {\n throw new Error(\n `User role \"${role}\" not found in auth/credentials fixture`,\n );\n }\n return user;\n });\n};\n\nconst signInWithCredentials = (\n apiUrl: string | undefined,\n credentials: CredentialRecord,\n): Cypress.Chainable => {\n return cy\n .task('gqlSignIn', {\n apiUrl,\n email: credentials.email,\n password: credentials.password,\n })\n .then((result) => {\n const { token, userId } = result as SignInTaskResult;\n if (!token) {\n throw new Error('SignIn task failed to return a token.');\n }\n return { token, userId } as AuthSession;\n });\n};\n\nconst resolveAuthSession = (\n auth?: AuthOptions,\n): Cypress.Chainable => {\n if (auth?.token) {\n return cy.wrap({ token: auth.token, userId: auth.userId } as AuthSession, {\n log: false,\n });\n }\n // resolveAuthSession defaults role to 'admin' unless auth.role overrides it.\n const role = auth?.role ?? 'admin';\n return resolveCredentials(role, auth).then((credentials) => {\n return signInWithCredentials(auth?.apiUrl, credentials);\n });\n};\n\nconst resolveAuthToken = (auth?: AuthOptions): Cypress.Chainable =>\n resolveAuthSession(auth).then((session) => session.token);\n\nconst getSecureRandomSuffix = (length = 8): string => {\n if (globalThis.crypto?.randomUUID) {\n return globalThis.crypto.randomUUID().replace(/-/g, '').slice(0, length);\n }\n\n if (globalThis.crypto?.getRandomValues) {\n const bytes = new Uint8Array(length);\n globalThis.crypto.getRandomValues(bytes);\n return Array.from(bytes, (byte) => byte.toString(16).padStart(2, '0'))\n .join('')\n .slice(0, length);\n }\n\n return String(Date.now()).slice(0, length);\n};\n\nconst makeUniqueLabel = (prefix: string): string => {\n const suffix = `${Date.now()}-${getSecureRandomSuffix(8)}`;\n return `${prefix} ${suffix}`;\n};\n\ndeclare global {\n namespace Cypress {\n interface Chainable {\n /**\n * @param role - The user role (e.g., 'superadmin', 'admin', 'user')\n */\n loginByApi(role: string): Chainable;\n /**\n * @param expectedMessage - The expected text (string or RegExp)\n */\n assertToast(expectedMessage: string | RegExp): Chainable;\n /**\n * Reset GraphQL intercepts back to pass-through behavior.\n * @returns Chainable\n */\n clearAllGraphQLMocks(): Chainable;\n setupTestEnvironment(\n options?: SetupTestEnvironmentOptions,\n ): Chainable<{ orgId: string }>;\n createTestOrganization(\n payload: CreateTestOrganizationPayload,\n ): Chainable<{ orgId: string }>;\n createOrganizationMembership(\n payload: CreateOrganizationMembershipOptions,\n ): Chainable;\n createTestUser(\n payload: CreateTestUserPayload,\n ): Chainable<{ userId: string; email: string; password: string }>;\n seedTestData(\n kind: 'events',\n payload: SeedEventPayload,\n ): Chainable<{ eventId: string }>;\n seedTestData(\n kind: 'volunteers',\n payload: SeedVolunteerPayload,\n ): Chainable<{\n volunteerId: string;\n userId?: string;\n email?: string;\n password?: string;\n }>;\n seedTestData(\n kind: 'posts',\n payload: SeedPostPayload,\n ): Chainable<{ postId: string }>;\n seedTestData(\n kind: 'actionItemCategories',\n payload: SeedActionItemCategoryPayload,\n ): Chainable<{ categoryId: string; name?: string }>;\n cleanupTestOrganization(\n orgId: string,\n options?: CleanupTestOrganizationOptions,\n ): Chainable;\n }\n }\n}\n\nCypress.Commands.add('loginByApi', (role: string) => {\n const resolvedRole = normalizeAuthRole(role);\n const sessionName = `login-${resolvedRole}`;\n const loginPath = resolvedRole === 'user' ? '/' : '/admin';\n const currentUserQuery = `\n query CurrentUser {\n currentUser {\n id\n }\n }\n `;\n const storagePrefix = 'Talawa-admin';\n const roleValue =\n resolvedRole === 'superAdmin'\n ? 'superuser'\n : resolvedRole === 'admin'\n ? 'administrator'\n : 'user';\n const setAuthStorage = (\n win: Window,\n token: string,\n userId: string | undefined,\n email: string,\n ): void => {\n const setItem = (key: string, value: unknown) => {\n win.localStorage.setItem(\n `${storagePrefix}_${key}`,\n JSON.stringify(value),\n );\n };\n setItem('token', token);\n setItem('role', roleValue);\n setItem('email', email);\n if (userId) {\n setItem('userId', userId);\n setItem('id', userId);\n }\n setItem('IsLoggedIn', 'TRUE');\n };\n\n return cy.session(\n sessionName,\n () => {\n resolveCredentials(resolvedRole).then((user) => {\n const apiUrl =\n (Cypress.env('apiUrl') as string | undefined) ||\n 'http://localhost:4000/graphql';\n\n return cy\n .task('gqlSignIn', {\n apiUrl,\n email: user.email,\n password: user.password,\n })\n .then((result) => {\n const { token, userId } = result as SignInTaskResult;\n if (!token) {\n const { emailKey, passwordKey } = roleToEnvKey(resolvedRole);\n throw new Error(\n `Login failed: SignIn did not return a token. Verify credentials for role \"${resolvedRole}\" via ${emailKey}/${passwordKey} or cypress/fixtures/auth/credentials.json.`,\n );\n }\n\n cy.visit(loginPath, {\n onBeforeLoad(win) {\n setAuthStorage(win, token, userId, user.email);\n },\n });\n\n return cy\n .request({\n method: 'POST',\n url: apiUrl,\n headers: {\n authorization: `Bearer ${token}`,\n },\n body: {\n query: currentUserQuery,\n },\n })\n .then((response) => {\n if (response.status !== 200) {\n throw new Error(\n `Login health check failed with status ${response.status}.`,\n );\n }\n const currentUserId =\n response.body?.data?.currentUser?.id ||\n response.body?.data?.user?.id;\n if (!currentUserId) {\n throw new Error(\n 'Login health check failed: currentUser is missing.',\n );\n }\n });\n });\n });\n },\n { cacheAcrossSpecs: true },\n );\n});\n\nCypress.Commands.add('assertToast', (expectedMessage: string | RegExp) => {\n cy.get('.Toastify__toast', { timeout: 5000 })\n .should('be.visible')\n .and('contain.text', expectedMessage);\n});\n\nCypress.Commands.add('clearAllGraphQLMocks', () => {\n cy.intercept('POST', getApiPattern(), (req) => {\n req.continue();\n });\n});\n\nCypress.Commands.add(\n 'setupTestEnvironment',\n (options: SetupTestEnvironmentOptions = {}) => {\n const orgName = options.orgName || makeUniqueLabel('E2E Org');\n return cy\n .createTestOrganization({\n name: orgName,\n description: options.description ?? 'E2E organization',\n auth: options.auth,\n })\n .then(({ orgId }) => ({ orgId }));\n },\n);\n\nCypress.Commands.add(\n 'createTestOrganization',\n (payload: CreateTestOrganizationPayload) => {\n return resolveAuthSession(payload.auth).then(({ token, userId }) => {\n return cy\n .task('createTestOrganization', {\n apiUrl: payload.auth?.apiUrl,\n token,\n input: {\n name: payload.name,\n description: payload.description ?? 'E2E organization',\n addressLine1: payload.addressLine1,\n addressLine2: payload.addressLine2,\n city: payload.city,\n state: payload.state,\n postalCode: payload.postalCode,\n countryCode: payload.countryCode,\n isUserRegistrationRequired: payload.isUserRegistrationRequired,\n },\n })\n .then((result) => {\n const { orgId } = result as CreateOrganizationTaskResult;\n if (!orgId) {\n throw new Error('createTestOrganization did not return orgId.');\n }\n if (userId && (payload.auth?.role ?? 'admin') === 'admin') {\n return cy\n .task('createOrganizationMembership', {\n apiUrl: payload.auth?.apiUrl,\n token,\n input: {\n memberId: userId,\n organizationId: orgId,\n role: 'administrator',\n },\n })\n .then(() => ({ orgId }));\n }\n return cy.wrap({ orgId });\n });\n });\n },\n);\n\nCypress.Commands.add(\n 'createOrganizationMembership',\n (payload: CreateOrganizationMembershipOptions) => {\n const role = payload.role ?? 'administrator';\n return resolveAuthToken(payload.auth).then((token) => {\n return cy\n .task('createOrganizationMembership', {\n apiUrl: payload.auth?.apiUrl,\n token,\n input: {\n memberId: payload.memberId,\n organizationId: payload.organizationId,\n role,\n },\n })\n .then(() => {\n return undefined;\n }) as Cypress.Chainable;\n });\n },\n);\n\nCypress.Commands.add('createTestUser', (payload: CreateTestUserPayload) => {\n const email =\n payload.email ||\n `e2e-user-${Date.now()}-${getSecureRandomSuffix(8)}@example.com`;\n const password = payload.password || DEFAULT_TEST_PASSWORD;\n const name = payload.name || makeUniqueLabel('E2E User');\n const role = payload.role ?? 'regular';\n return resolveAuthToken(payload.auth).then((token) => {\n return cy\n .task('createTestUser', {\n apiUrl: payload.auth?.apiUrl,\n token,\n input: {\n name,\n emailAddress: email,\n password,\n role,\n isEmailAddressVerified: payload.isEmailAddressVerified ?? true,\n },\n })\n .then((result) => {\n const { userId } = result as CreateUserTaskResult;\n if (!userId) {\n throw new Error('createTestUser did not return userId.');\n }\n return { userId, email, password };\n });\n });\n});\n\n/**\n * Seeds test data (events, volunteers, posts, action item categories) via direct GraphQL API calls.\n *\n * **Role escalation**: If `auth.role` is `'admin'` (or omitted, defaulting to\n * `'admin'`), the implementation automatically escalates to `'superAdmin'`\n * when calling `resolveAuthToken` for **user creation only**.\n * Event and volunteer creation require org membership, not superAdmin privilege,\n * so those use the caller's role directly.\n */\nCypress.Commands.add(\n 'seedTestData',\n (\n kind: 'events' | 'volunteers' | 'posts' | 'actionItemCategories',\n payload:\n | SeedEventPayload\n | SeedVolunteerPayload\n | SeedPostPayload\n | SeedActionItemCategoryPayload,\n ) => {\n if (kind === 'events') {\n const eventPayload = payload as SeedEventPayload;\n const defaultStart = new Date(Date.now() + 5 * 60 * 1000);\n const startAt = eventPayload.startAt ?? defaultStart.toISOString();\n const endAt =\n eventPayload.endAt ??\n new Date(defaultStart.getTime() + 60 * 60 * 1000).toISOString();\n const name = eventPayload.name || makeUniqueLabel('E2E Event');\n const createEvent = (token: string) => {\n return cy\n .task('createTestEvent', {\n apiUrl: eventPayload.auth?.apiUrl,\n token,\n input: {\n name,\n description: eventPayload.description ?? 'E2E event',\n organizationId: eventPayload.orgId,\n startAt,\n endAt,\n location: eventPayload.location ?? 'Virtual',\n isPublic: eventPayload.isPublic ?? true,\n isRegisterable: eventPayload.isRegisterable ?? true,\n },\n })\n .then((result) => {\n const { eventId } = result as CreateEventTaskResult;\n if (!eventId) {\n throw new Error('seedTestData(events) did not return eventId.');\n }\n return { eventId };\n });\n };\n return resolveAuthToken(eventPayload.auth).then((token) => {\n return createEvent(token);\n });\n }\n\n if (kind === 'actionItemCategories') {\n const categoryPayload = payload as SeedActionItemCategoryPayload;\n const name =\n categoryPayload.name || makeUniqueLabel('E2E Action Item Category');\n const description =\n categoryPayload.description ?? 'E2E Action Item Category';\n const isDisabled = categoryPayload.isDisabled ?? false;\n return resolveAuthToken(categoryPayload.auth).then((token) => {\n return cy\n .task('createTestActionItemCategory', {\n apiUrl: categoryPayload.auth?.apiUrl,\n token,\n input: {\n name,\n description,\n isDisabled,\n organizationId: categoryPayload.orgId,\n },\n })\n .then((result) => {\n const { categoryId } = result as {\n categoryId?: string;\n name?: string;\n };\n if (!categoryId) {\n throw new Error(\n 'seedTestData(actionItemCategories) did not return categoryId.',\n );\n }\n return { categoryId, name };\n });\n });\n }\n\n const createSeedUser = (userPayload: SeedUserPayload) => {\n const email =\n userPayload.email ||\n `e2e-user-${Date.now()}-${getSecureRandomSuffix(8)}@example.com`;\n const password = userPayload.password || DEFAULT_TEST_PASSWORD;\n const name = userPayload.name || makeUniqueLabel('E2E User');\n const role = userPayload.role ?? 'regular';\n const userAuth =\n (userPayload.auth?.role ?? 'admin') === 'admin'\n ? { ...(userPayload.auth ?? {}), role: 'superAdmin' as const }\n : userPayload.auth;\n return resolveAuthToken(userAuth).then((token) => {\n return cy\n .task('createTestUser', {\n apiUrl: userPayload.auth?.apiUrl,\n token,\n input: {\n name,\n emailAddress: email,\n password,\n role,\n isEmailAddressVerified:\n userPayload.isEmailAddressVerified ?? true,\n },\n })\n .then((result) => {\n const { userId } = result as CreateUserTaskResult;\n if (!userId) {\n throw new Error('createTestUser did not return userId.');\n }\n return { userId, email, password };\n });\n });\n };\n\n if (kind === 'posts') {\n const postPayload = payload as SeedPostPayload;\n const caption = postPayload.caption || makeUniqueLabel('E2E Post');\n const body = postPayload.body ?? 'E2E post body';\n const isPinned = postPayload.isPinned ?? false;\n return resolveAuthToken(postPayload.auth).then((token) => {\n return cy\n .task('createTestPost', {\n apiUrl: postPayload.auth?.apiUrl,\n token,\n input: {\n caption,\n body,\n organizationId: postPayload.orgId,\n isPinned,\n },\n })\n .then((result) => {\n const { postId } = result as CreatePostTaskResult;\n if (!postId) {\n throw new Error('seedTestData(posts) did not return postId.');\n }\n return { postId };\n });\n });\n }\n\n if (kind === 'volunteers') {\n const volunteerPayload = payload as SeedVolunteerPayload;\n\n // Unified chain to guarantee consistent return type\n const ensureUser = (): Cypress.Chainable<{\n userId: string;\n email?: string;\n password?: string;\n }> => {\n if (volunteerPayload.userId) {\n return cy.wrap({\n userId: volunteerPayload.userId,\n email: undefined,\n password: undefined,\n });\n }\n return createSeedUser({\n ...(volunteerPayload.user ?? {}),\n auth: volunteerPayload.userAuth,\n }) as Cypress.Chainable<{\n userId: string;\n email?: string;\n password?: string;\n }>;\n };\n\n return ensureUser().then(\n (userResult: { userId: string; email?: string; password?: string }) => {\n const { userId, email, password } = userResult;\n if (!userId) {\n throw new Error('seedTestData(volunteers) missing userId.');\n }\n const createVolunteer = (token: string) => {\n return cy\n .task('createTestVolunteer', {\n apiUrl: volunteerPayload.auth?.apiUrl,\n token,\n input: {\n eventId: volunteerPayload.eventId,\n userId,\n scope: volunteerPayload.scope,\n recurringEventInstanceId:\n volunteerPayload.recurringEventInstanceId,\n },\n })\n .then((result) => {\n const { volunteerId } = result as CreateVolunteerTaskResult;\n if (!volunteerId) {\n throw new Error(\n 'seedTestData(volunteers) did not return volunteerId.',\n );\n }\n return { volunteerId, userId, email, password };\n });\n };\n return resolveAuthToken(volunteerPayload.auth).then((token) => {\n return createVolunteer(token);\n });\n },\n );\n }\n\n return cy.wrap(undefined);\n },\n);\n\nCypress.Commands.add(\n 'cleanupTestOrganization',\n (orgId: string, options: CleanupTestOrganizationOptions = {}) => {\n return resolveAuthToken(options.auth).then((token) => {\n const apiUrl = options.auth?.apiUrl;\n return cy\n .task('deleteTestOrganization', {\n apiUrl,\n token,\n orgId,\n allowNotFound: options.allowNotFound ?? true,\n })\n .then(() => {\n const userIds = options.userIds ?? [];\n if (userIds.length === 0) {\n return undefined;\n }\n return cy\n .wrap(userIds)\n .each((userId) => {\n return cy.task('deleteTestUser', {\n apiUrl,\n token,\n userId,\n allowNotFound: true,\n });\n })\n .then(() => undefined) as Cypress.Chainable;\n });\n });\n },\n);\n" }, { "path": "cypress/support/e2e.ts", "content": "// *********************\n// This example support/e2e.ts is processed and\n// loaded automatically before your test files.\n//\n// This is a great place to put global configuration and\n// behavior that modifies Cypress.\n//\n// You can change the location of this file or turn off\n// automatically serving support files with the\n// 'supportFile' configuration option.\n//\n// You can read more here:\n// https://on.cypress.io/configuration\n// *********************\n\n// Import commands.js using ES2015 syntax:\nimport './commands';\nimport './graphql-utils';\nimport '@cypress/code-coverage/support';\n\nCypress.on('uncaught:exception', () => {\n return false;\n});\n\nafterEach(() => {\n cy.clearAllGraphQLMocks();\n});\n" }, { "path": "cypress/support/graphql-utils.ts", "content": "/// \nimport type { CyHttpMessages } from 'cypress/types/net-stubbing';\n\nexport {};\n\n/**\n * @public\n * GraphQL responder used by Cypress utilities to mock operation responses.\n * Supports fixture paths, inline body objects, or custom request handlers.\n */\ntype GqlResponder =\n | string\n | Record\n | ((req: CyHttpMessages.IncomingHttpRequest) => void);\n\n/**\n * @public\n * Extensions object for GraphQL errors (key/value metadata map).\n */\ntype GqlErrorExtensions = Record;\n\n/**\n * @public\n * Partial Cypress response configuration applied when replying to operations.\n */\ntype GqlOperationOptions = Partial;\n\ntype GqlOperationConfig = GqlOperationOptions & {\n timeout?: number;\n};\n\nexport const getApiPattern = (): string => {\n const apiUrl =\n (Cypress.env('apiUrl') as string | undefined) ||\n (Cypress.env('API_URL') as string | undefined) ||\n (Cypress.env('CYPRESS_API_URL') as string | undefined);\n\n return apiUrl || '**/graphql';\n};\n\nconst interceptGraphQLOperation = (\n operationName: string,\n handler: (req: CyHttpMessages.IncomingHttpRequest) => void,\n): void => {\n const apiPattern = getApiPattern();\n cy.intercept('POST', apiPattern, (req) => {\n if (req.body?.operationName !== operationName) {\n req.continue();\n return;\n }\n req.alias = operationName;\n handler(req);\n });\n};\n\n/**\n * Alias a GraphQL operation by name so it can be awaited via cy.wait.\n * @param operationName - GraphQL operationName to alias.\n * @returns void\n */\nexport const aliasGraphQLOperation = (operationName: string): void => {\n interceptGraphQLOperation(operationName, (req) => req.continue());\n};\n\n/**\n * Wait for a previously-aliased GraphQL operation.\n * @param operationName - GraphQL operationName to await.\n * @returns Cypress chainable interception for further assertions.\n */\nexport const waitForGraphQLOperation = (\n operationName: string,\n): Cypress.Chainable => {\n return cy.wait(\n `@${operationName}`,\n ) as Cypress.Chainable;\n};\n\n/**\n * Mock a GraphQL operation response by operationName.\n *\n * Uses interceptGraphQLOperation to route matching requests and applies\n * the responder based on its shape:\n * - function: receives the request and can call req.reply or req.continue manually\n * - string: treated as a fixture path and passed to req.reply with fixture and options\n * - object: treated as a response body and passed to req.reply with body and options\n *\n * @param operationName - GraphQL operationName to mock.\n * @param responder - Fixture path, inline body, or request handler.\n * @param options - Partial Cypress.StaticResponse merged into req.reply.\n * @returns void\n */\nexport const mockGraphQLOperation = (\n operationName: string,\n responder: GqlResponder,\n options?: GqlOperationConfig,\n): void => {\n const { timeout, ...responseOptions } = options ?? {};\n interceptGraphQLOperation(operationName, (req) => {\n if (timeout) {\n req.on('response', (res) => {\n res.setDelay(timeout);\n });\n }\n if (typeof responder === 'function') {\n responder(req);\n return;\n }\n\n if (typeof responder === 'string') {\n req.reply({ fixture: responder, ...responseOptions });\n return;\n }\n\n req.reply({ body: responder, ...responseOptions });\n });\n};\n\n/**\n * Mock a GraphQL error response for a named operation.\n *\n * @param operationName - GraphQL operationName to mock.\n * @param message - Error message returned in the GraphQL errors array.\n * @param code - Optional error code (default: 'GRAPHQL_ERROR').\n * @param extensions - Optional GraphQL error extensions.\n * @returns void\n *\n * @example\n * mockGraphQLError('CreateOrganization', 'Organization name already exists', 'CONFLICT');\n */\nexport const mockGraphQLError = (\n operationName: string,\n message: string,\n code = 'GRAPHQL_ERROR',\n extensions: GqlErrorExtensions = {},\n): void => {\n mockGraphQLOperation(operationName, {\n errors: [{ message, extensions: { code, ...extensions } }],\n });\n};\n\ndeclare global {\n namespace Cypress {\n interface Chainable {\n aliasGraphQLOperation(operationName: string): Chainable;\n waitForGraphQLOperation(\n operationName: string,\n ): Chainable;\n mockGraphQLOperation(\n operationName: string,\n responder: GqlResponder,\n options?: GqlOperationConfig,\n ): Chainable;\n mockGraphQLError(\n operationName: string,\n message: string,\n code?: string,\n extensions?: GqlErrorExtensions,\n ): Chainable;\n }\n }\n}\n\nCypress.Commands.add('aliasGraphQLOperation', aliasGraphQLOperation);\nCypress.Commands.add('waitForGraphQLOperation', waitForGraphQLOperation);\nCypress.Commands.add('mockGraphQLOperation', mockGraphQLOperation);\nCypress.Commands.add('mockGraphQLError', mockGraphQLError);\n" }, { "path": "cypress.config.ts", "content": "import { defineConfig } from 'cypress';\nimport fs from 'node:fs';\nimport { URL } from 'node:url';\nimport codeCoverageTask from '@cypress/code-coverage/task';\nimport dotenv from 'dotenv';\ndotenv.config();\n\nconst PORT = process.env.PORT || '4321';\nconst DEFAULT_API_URL = 'http://localhost:4000/graphql';\n\ntype GraphQLError = { message: string; extensions?: Record };\ntype GraphQLResponse = { data?: T; errors?: GraphQLError[] };\n\n/** Returns true when a GraphQL error array contains a 'forbidden' code whose\n * extensions.issues indicate the resource already exists / is installed. */\nconst isForbiddenWithExistingResource = (\n errors: { message: string; extensions?: Record }[],\n): boolean =>\n errors.some((error) => {\n const code =\n typeof error.extensions?.code === 'string'\n ? error.extensions.code.toLowerCase()\n : '';\n const issues = Array.isArray(error.extensions?.issues)\n ? (error.extensions.issues as { message?: string }[])\n : [];\n return (\n code.includes('forbidden') &&\n issues.some((issue) =>\n /already\\s*exists|installed/i.test(issue.message ?? ''),\n )\n );\n });\n\nconst resolveApiUrl = (rawUrl?: string): string => {\n const baseUrl =\n rawUrl ||\n process.env.CYPRESS_API_URL ||\n process.env.API_URL ||\n DEFAULT_API_URL;\n if (baseUrl.endsWith('/graphql')) {\n return baseUrl;\n }\n return new URL('/graphql', baseUrl).toString();\n};\n\nconst postGraphQL = async (\n apiUrl: string,\n token: string | undefined,\n body: {\n operationName: string;\n query: string;\n variables?: Record;\n },\n): Promise> => {\n const fetcher = globalThis.fetch;\n if (!fetcher) {\n throw new Error('Global fetch is not available in this Node runtime.');\n }\n const response = await fetcher(apiUrl, {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n ...(token ? { authorization: `Bearer ${token}` } : {}),\n },\n body: JSON.stringify(body),\n });\n\n let json: GraphQLResponse;\n try {\n json = (await response.clone().json()) as GraphQLResponse;\n } catch (error) {\n let rawBody = '';\n try {\n rawBody = await response.text();\n } catch (readError) {\n const readMessage =\n readError instanceof Error ? readError.message : String(readError);\n rawBody = `Unable to read response body: ${readMessage}`;\n }\n const errorMessage =\n error instanceof Error ? error.message : 'Unknown JSON parse error';\n return {\n errors: [\n {\n message: `GraphQL response parse failed (${response.status} ${response.statusText}). ${rawBody || errorMessage}`,\n },\n ],\n };\n }\n if (!response.ok && !json.errors?.length) {\n return {\n errors: [\n {\n message: `GraphQL request failed (${response.status} ${response.statusText})`,\n },\n ],\n };\n }\n\n return json;\n};\n\nconst SIGN_IN_QUERY = `\n query SignIn($email: EmailAddress!, $password: String!) {\n signIn(\n input: {\n emailAddress: $email\n password: $password\n }\n ) {\n user { id }\n authenticationToken\n }\n }\n`;\n\nconst CREATE_ORGANIZATION_MUTATION = `\n mutation CreateOrganization($input: MutationCreateOrganizationInput!) {\n createOrganization(input: $input) {\n id\n }\n }\n`;\n\nconst CREATE_ORGANIZATION_MEMBERSHIP_MUTATION = `\n mutation CreateOrganizationMembership(\n $input: MutationCreateOrganizationMembershipInput!\n ) {\n createOrganizationMembership(input: $input) {\n id\n }\n }\n`;\n\nconst CREATE_EVENT_MUTATION = `\n mutation CreateEvent($input: MutationCreateEventInput!) {\n createEvent(input: $input) {\n id\n }\n }\n`;\n\nconst CREATE_USER_MUTATION = `\n mutation CreateUser($input: MutationCreateUserInput!) {\n createUser(input: $input) {\n authenticationToken\n user { id }\n }\n }\n`;\n\nconst CREATE_VOLUNTEER_MUTATION = `\n mutation CreateEventVolunteer($data: EventVolunteerInput!) {\n createEventVolunteer(data: $data) {\n id\n }\n }\n`;\n\nconst CREATE_POST_MUTATION = `\n mutation CreatePost($input: MutationCreatePostInput!) {\n createPost(input: $input) {\n id\n }\n }\n`;\n\nconst CREATE_PLUGIN_MUTATION = `\n mutation CreatePlugin($input: CreatePluginInput!) {\n createPlugin(input: $input) {\n id\n pluginId\n isInstalled\n isActivated\n }\n }\n`;\n\nconst INSTALL_PLUGIN_MUTATION = `\n mutation InstallPlugin($input: InstallPluginInput!) {\n installPlugin(input: $input) {\n id\n pluginId\n isInstalled\n isActivated\n }\n }\n`;\n\nconst CREATE_ACTION_ITEM_CATEGORY_MUTATION = `\n mutation CreateActionItemCategory($input: MutationCreateActionItemCategoryInput!) {\n createActionItemCategory(input: $input) {\n id\n name\n }\n }\n`;\n\nconst DELETE_ORGANIZATION_MUTATION = `\n mutation DeleteOrganization($input: MutationDeleteOrganizationInput!) {\n deleteOrganization(input: $input) {\n id\n }\n }\n`;\n\nconst DELETE_USER_MUTATION = `\n mutation DeleteUser($input: MutationDeleteUserInput!) {\n deleteUser(input: $input) {\n id\n }\n }\n`;\n\nexport default defineConfig({\n e2e: {\n baseUrl: `http://localhost:${PORT}`,\n\n // Viewport settings\n viewportWidth: 1920,\n viewportHeight: 1080,\n specPattern: 'cypress/e2e/**/*.cy.ts',\n supportFile: 'cypress/support/e2e.ts',\n\n defaultCommandTimeout: 50000,\n requestTimeout: 50000,\n responseTimeout: 50000,\n pageLoadTimeout: 50000,\n\n testIsolation: true, // Reset browser context between tests\n experimentalRunAllSpecs: true,\n\n watchForFileChanges: true,\n chromeWebSecurity: false,\n retries: {\n runMode: 2,\n openMode: 0,\n },\n\n // Environment variables\n env: {\n apiUrl: resolveApiUrl(),\n RECAPTCHA_SITE_KEY: process.env.REACT_APP_RECAPTCHA_SITE_KEY,\n E2E_ADMIN_EMAIL:\n process.env.E2E_ADMIN_EMAIL || process.env.CYPRESS_E2E_ADMIN_EMAIL,\n E2E_ADMIN_PASSWORD:\n process.env.E2E_ADMIN_PASSWORD ||\n process.env.CYPRESS_E2E_ADMIN_PASSWORD,\n E2E_SUPERADMIN_EMAIL:\n process.env.E2E_SUPERADMIN_EMAIL ||\n process.env.CYPRESS_E2E_SUPERADMIN_EMAIL,\n E2E_SUPERADMIN_PASSWORD:\n process.env.E2E_SUPERADMIN_PASSWORD ||\n process.env.CYPRESS_E2E_SUPERADMIN_PASSWORD,\n E2E_USER_EMAIL:\n process.env.E2E_USER_EMAIL || process.env.CYPRESS_E2E_USER_EMAIL,\n E2E_USER_PASSWORD:\n process.env.E2E_USER_PASSWORD || process.env.CYPRESS_E2E_USER_PASSWORD,\n },\n setupNodeEvents(on, config) {\n codeCoverageTask(on, config);\n const runGraphQLTask = async ({\n apiUrl,\n token,\n operationName,\n query,\n variables,\n extract,\n onErrors,\n }: {\n apiUrl?: string;\n token?: string;\n operationName: string;\n query: string;\n variables?: Record;\n extract: (data: TData | undefined) => TResult;\n onErrors?: (errors: GraphQLError[]) => TResult | undefined;\n }): Promise => {\n const resolvedApiUrl = resolveApiUrl(\n apiUrl || (config.env.apiUrl as string | undefined),\n );\n const response = await postGraphQL(resolvedApiUrl, token, {\n operationName,\n query,\n variables,\n });\n if (response.errors?.length) {\n const fallback = onErrors?.(response.errors);\n if (fallback !== undefined) {\n return fallback;\n }\n const errorMessage = response.errors\n .map((error) => error.message)\n .join(', ');\n throw new Error(`${operationName} failed: ${errorMessage}`);\n }\n return extract(response.data);\n };\n\n const isNotFoundError = (errors: GraphQLError[]): boolean => {\n return errors.some((error) => {\n const extensions = error.extensions ?? {};\n const code =\n typeof extensions.code === 'string' ? extensions.code : undefined;\n const classification =\n typeof extensions.classification === 'string'\n ? extensions.classification\n : undefined;\n const indicator =\n `${code ?? ''} ${classification ?? ''}`.toUpperCase();\n if (\n indicator.includes('NOT_FOUND') ||\n indicator.includes('NOT_EXISTS')\n ) {\n return true;\n }\n return /not found|does not exist|no such/i.test(error.message);\n });\n };\n // Custom task to log messages and read files\n on('task', {\n log(message: string) {\n console.log(message);\n return null;\n },\n readFileMaybe(filename: string) {\n return fs.existsSync(filename)\n ? fs.readFileSync(filename, 'utf8')\n : null;\n },\n async gqlSignIn({\n apiUrl,\n email,\n password,\n }: {\n apiUrl?: string;\n email: string;\n password: string;\n }) {\n return runGraphQLTask<\n {\n signIn?: {\n authenticationToken?: string;\n user?: { id?: string };\n };\n },\n { token: string; userId: string }\n >({\n apiUrl,\n operationName: 'SignIn',\n query: SIGN_IN_QUERY,\n variables: { email, password },\n extract: (data) => {\n const token = data?.signIn?.authenticationToken;\n const userId = data?.signIn?.user?.id;\n if (!token) {\n throw new Error(\n 'SignIn response missing authentication token.',\n );\n }\n if (!userId) {\n throw new Error('SignIn response missing userId.');\n }\n return { token, userId };\n },\n });\n },\n async createTestOrganization({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createOrganization?: { id?: string } },\n { orgId: string }\n >({\n apiUrl,\n token,\n operationName: 'CreateOrganization',\n query: CREATE_ORGANIZATION_MUTATION,\n variables: { input },\n extract: (data) => {\n const orgId = data?.createOrganization?.id;\n if (!orgId) {\n throw new Error('CreateOrganization response missing org id.');\n }\n return { orgId };\n },\n });\n },\n async createOrganizationMembership({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createOrganizationMembership?: { id?: string } },\n { ok: boolean }\n >({\n apiUrl,\n token,\n operationName: 'CreateOrganizationMembership',\n query: CREATE_ORGANIZATION_MEMBERSHIP_MUTATION,\n variables: { input },\n extract: (data) => ({\n ok: Boolean(data?.createOrganizationMembership?.id),\n }),\n onErrors: (responseErrors) => {\n const errorMessage = responseErrors\n .map((error) => error.message)\n .join(', ');\n if (/already|exists/i.test(errorMessage)) {\n return { ok: true };\n }\n return undefined;\n },\n });\n },\n async createTestEvent({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createEvent?: { id?: string } },\n { eventId: string }\n >({\n apiUrl,\n token,\n operationName: 'CreateEvent',\n query: CREATE_EVENT_MUTATION,\n variables: { input },\n extract: (data) => {\n const eventId = data?.createEvent?.id;\n if (!eventId) {\n throw new Error('CreateEvent response missing event id.');\n }\n return { eventId };\n },\n });\n },\n async createTestUser({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n {\n createUser?: {\n authenticationToken?: string;\n user?: { id?: string };\n };\n },\n { userId: string; authenticationToken?: string }\n >({\n apiUrl,\n token,\n operationName: 'CreateUser',\n query: CREATE_USER_MUTATION,\n variables: { input },\n extract: (data) => {\n const userId = data?.createUser?.user?.id;\n if (!userId) {\n throw new Error('CreateUser response missing user id.');\n }\n return {\n userId,\n authenticationToken: data?.createUser?.authenticationToken,\n };\n },\n });\n },\n async createTestVolunteer({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createEventVolunteer?: { id?: string } },\n { volunteerId: string }\n >({\n apiUrl,\n token,\n operationName: 'CreateEventVolunteer',\n query: CREATE_VOLUNTEER_MUTATION,\n // CREATE_VOLUNTEER_MUTATION uses $data for CreateEventVolunteer, not $input.\n variables: { data: input },\n extract: (data) => {\n const volunteerId = data?.createEventVolunteer?.id;\n if (!volunteerId) {\n throw new Error('CreateEventVolunteer response missing id.');\n }\n return { volunteerId };\n },\n });\n },\n async createTestPost({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createPost?: { id?: string } },\n { postId: string }\n >({\n apiUrl,\n token,\n operationName: 'CreatePost',\n query: CREATE_POST_MUTATION,\n variables: { input },\n extract: (data) => {\n const postId = data?.createPost?.id;\n if (!postId) {\n throw new Error('CreatePost response missing id.');\n }\n return { postId };\n },\n });\n },\n async createTestPlugin({\n apiUrl,\n token,\n pluginId,\n }: {\n apiUrl?: string;\n token: string;\n pluginId: string;\n }) {\n return runGraphQLTask<\n { createPlugin?: { id?: string } },\n { ok: boolean }\n >({\n apiUrl,\n token,\n operationName: 'CreatePlugin',\n query: CREATE_PLUGIN_MUTATION,\n variables: { input: { pluginId } },\n extract: (data) => ({ ok: Boolean(data?.createPlugin?.id) }),\n onErrors: (responseErrors) => {\n const errorMessage = responseErrors\n .map((error) => error.message)\n .join(', ');\n if (/already|exists|duplicate/i.test(errorMessage)) {\n return { ok: true };\n }\n if (isForbiddenWithExistingResource(responseErrors)) {\n return { ok: true };\n }\n return undefined;\n },\n });\n },\n async installTestPlugin({\n apiUrl,\n token,\n pluginId,\n }: {\n apiUrl?: string;\n token: string;\n pluginId: string;\n }) {\n return runGraphQLTask<\n { installPlugin?: { id?: string } },\n { ok: boolean }\n >({\n apiUrl,\n token,\n operationName: 'InstallPlugin',\n query: INSTALL_PLUGIN_MUTATION,\n variables: { input: { pluginId } },\n extract: (data) => ({ ok: Boolean(data?.installPlugin?.id) }),\n onErrors: (responseErrors) => {\n const errorMessage = responseErrors\n .map((error) => error.message)\n .join(', ');\n if (\n /already.*installed|is installed|exists/i.test(errorMessage)\n ) {\n return { ok: true };\n }\n if (isForbiddenWithExistingResource(responseErrors)) {\n return { ok: true };\n }\n return undefined;\n },\n });\n },\n async createTestActionItemCategory({\n apiUrl,\n token,\n input,\n }: {\n apiUrl?: string;\n token: string;\n input: Record;\n }) {\n return runGraphQLTask<\n { createActionItemCategory?: { id?: string; name?: string } },\n { categoryId: string; name?: string }\n >({\n apiUrl,\n token,\n operationName: 'CreateActionItemCategory',\n query: CREATE_ACTION_ITEM_CATEGORY_MUTATION,\n variables: { input },\n extract: (data) => {\n const categoryId = data?.createActionItemCategory?.id;\n if (!categoryId) {\n throw new Error(\n 'CreateActionItemCategory response missing category id.',\n );\n }\n return {\n categoryId,\n name: data?.createActionItemCategory?.name,\n };\n },\n });\n },\n async deleteTestOrganization({\n apiUrl,\n token,\n orgId,\n allowNotFound,\n }: {\n apiUrl?: string;\n token: string;\n orgId: string;\n allowNotFound?: boolean;\n }) {\n return runGraphQLTask<\n { deleteOrganization?: { id?: string } },\n { ok: boolean }\n >({\n apiUrl,\n token,\n operationName: 'DeleteOrganization',\n query: DELETE_ORGANIZATION_MUTATION,\n variables: { input: { id: orgId } },\n extract: (data) => {\n const deletedId = data?.deleteOrganization?.id;\n return { ok: Boolean(deletedId) };\n },\n onErrors: (responseErrors) => {\n const errorMessage = responseErrors\n .map((error) => error.message)\n .join(', ');\n if (allowNotFound && isNotFoundError(responseErrors)) {\n return { ok: true };\n }\n if (allowNotFound) {\n console.warn(\n `DeleteOrganization failed for ${orgId} with allowNotFound=true: ${errorMessage}`,\n );\n }\n return undefined;\n },\n });\n },\n async deleteTestUser({\n apiUrl,\n token,\n userId,\n allowNotFound,\n }: {\n apiUrl?: string;\n token: string;\n userId: string;\n allowNotFound?: boolean;\n }) {\n return runGraphQLTask<\n { deleteUser?: { id?: string } },\n { ok: boolean }\n >({\n apiUrl,\n token,\n operationName: 'DeleteUser',\n query: DELETE_USER_MUTATION,\n variables: { input: { id: userId } },\n extract: (data) => ({ ok: Boolean(data?.deleteUser?.id) }),\n onErrors: (responseErrors) => {\n const errorMessage = responseErrors\n .map((error) => error.message)\n .join(', ');\n if (allowNotFound && isNotFoundError(responseErrors)) {\n return { ok: true };\n }\n if (allowNotFound) {\n console.warn(\n `DeleteUser failed for ${userId} with allowNotFound=true: ${errorMessage}`,\n );\n }\n return undefined;\n },\n });\n },\n });\n\n // Browser launch options for both Chrome and Firefox\n on('before:browser:launch', (browser, launchOptions) => {\n // Chrome specific configurations\n if (browser.name === 'chrome') {\n if (browser.isHeadless) {\n launchOptions.args.push('--max_old_space_size=4096');\n }\n\n // Chrome performance optimizations\n launchOptions.args.push('--disable-dev-shm-usage');\n launchOptions.args.push('--no-sandbox');\n }\n\n // Firefox specific configurations\n if (browser.name === 'firefox') {\n // Firefox preferences\n launchOptions.preferences = {\n ...launchOptions.preferences,\n 'signon.rememberSignons': false,\n 'browser.safebrowsing.enabled': false,\n 'browser.safebrowsing.malware.enabled': false,\n 'app.update.enabled': false,\n 'browser.download.folderList': 2,\n 'browser.download.manager.showWhenStarting': false,\n 'browser.helperApps.neverAsk.saveToDisk':\n 'application/pdf,text/csv,application/csv',\n };\n launchOptions.args = launchOptions.args || [];\n }\n\n return launchOptions;\n });\n\n // Custom plugins can be registered here\n // Example: require('@cypress/code-coverage/task')(on, config);\n\n return config;\n },\n },\n\n includeShadowDom: true,\n experimentalStudio: true,\n\n downloadsFolder: 'cypress/downloads',\n fixturesFolder: 'cypress/fixtures',\n});\n" }, { "path": "docker/Dockerfile.deploy", "content": "###############################################################################\n#\n# DO NOT EDIT!!!\n#\n# This file is used to deploy the https://test.talawa.io site\n#\n###############################################################################\nFROM node:24-slim AS build\n\nARG PORT=4321\nARG PNPM_VERSION=10.4.1\nENV PORT=${PORT}\n\nWORKDIR /usr/src/app\nRUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate\nCOPY package.json pnpm-lock.yaml ./\nRUN pnpm install --frozen-lockfile\nCOPY . .\nRUN pnpm run build\nENV NODE_ENV=production\nEXPOSE ${PORT}\nCMD [\"pnpm\", \"run\", \"serve\"]\n" }, { "path": "docker/Dockerfile.dev", "content": "FROM node:24-slim AS build\n\nARG PORT=4321\nARG PNPM_VERSION=10.4.1\nENV PORT=${PORT}\n\nWORKDIR /usr/src/app\n\nRUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate\nCOPY package.json pnpm-lock.yaml ./\nRUN pnpm install --frozen-lockfile\n\nCOPY . .\n\nRUN pnpm run build\nEXPOSE ${PORT}\n\nCMD [\"pnpm\", \"run\", \"serve\"]\n" }, { "path": "docker/Dockerfile.prod", "content": "# Step 1: Build Stage\nFROM node:24-slim AS builder\nWORKDIR /talawa-admin\n\nARG PNPM_VERSION=10.4.1\nRUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate\nCOPY package.json pnpm-lock.yaml ./\nRUN pnpm install --frozen-lockfile\n\nCOPY . .\n\nENV NODE_ENV=production\n\nRUN pnpm run build\n\n# Step 2: Production\nFROM nginx:1.27.3-alpine AS production\n\nENV NODE_ENV=production\n\nCOPY config/docker/setup/nginx.conf /etc/nginx/conf.d/default.conf\nCOPY --from=builder /talawa-admin/build /usr/share/nginx/html\nEXPOSE 80\nCMD [\"nginx\", \"-g\", \"daemon off;\"]\n" }, { "path": "docker/Dockerfile.rootless.dev", "content": "FROM node:24-slim\nSHELL [\"/bin/bash\", \"-o\", \"pipefail\", \"-c\"]\n\nARG PORT=4321\nARG PNPM_VERSION=10.4.1\nARG WGET_VERSION=1.21.3-1+deb12u1\nARG CA_CERTIFICATES_VERSION=20230311+deb12u1\nENV PORT=${PORT}\n\n# Build args are populated from host UID/GID by compose.\nARG USER_UID=1000\nARG USER_GID=1000\n\nRUN set -eux; \\\n current_uid=\"$(id -u node)\"; \\\n current_gid=\"$(id -g node)\"; \\\n if [ \"${USER_GID}\" != \"${current_gid}\" ]; then \\\n if getent group \"${USER_GID}\" >/dev/null 2>&1; then \\\n target_group=\"$(getent group \"${USER_GID}\" | cut -d: -f1)\"; \\\n usermod -g \"${target_group}\" node; \\\n else \\\n groupmod -g \"${USER_GID}\" node; \\\n fi; \\\n fi; \\\n if [ \"${USER_UID}\" != \"${current_uid}\" ]; then \\\n usermod -u \"${USER_UID}\" node; \\\n fi\n\nWORKDIR /usr/src/app\n\nRUN apt-get update \\\n && apt-get install -y --no-install-recommends \\\n wget=${WGET_VERSION} \\\n ca-certificates=${CA_CERTIFICATES_VERSION} \\\n && rm -rf /var/lib/apt/lists/*\n\nRUN chown -R node:node /usr/src/app /home/node\n\nRUN corepack enable\n\nUSER node\nENV HOME=/home/node\nENV XDG_CACHE_HOME=/home/node/.cache\nENV COREPACK_HOME=/home/node/.cache/corepack\n\nRUN corepack prepare pnpm@${PNPM_VERSION} --activate\n\nCOPY --chown=node:node package.json pnpm-lock.yaml ./\nRUN pnpm install --frozen-lockfile\n\nCOPY --chown=node:node . .\n\nEXPOSE ${PORT}\n\nCMD [\"pnpm\", \"run\", \"serve\"]\n" }, { "path": "docker/Dockerfile.rootless.prod", "content": "# Step 1: Build Stage\nFROM node:24-slim AS builder\nWORKDIR /talawa-admin\n\nARG PNPM_VERSION=10.4.1\nRUN corepack enable && corepack prepare pnpm@${PNPM_VERSION} --activate\nCOPY package.json pnpm-lock.yaml ./\nRUN pnpm install --frozen-lockfile\n\nCOPY . .\n\nENV NODE_ENV=production\n\nRUN pnpm run build\n\n# Step 2: Production\nFROM nginx:1.27.3-alpine AS production\n\nENV NODE_ENV=production\nENV NGINX_PORT=8080\n\nCOPY config/docker/setup/nginx.rootless.conf.template /etc/nginx/templates/default.conf.template\nCOPY --from=builder /talawa-admin/build /usr/share/nginx/html\n\nRUN set -eux; \\\n apk add --no-cache gettext=~0.22; \\\n envsubst '${NGINX_PORT}' < /etc/nginx/templates/default.conf.template > /etc/nginx/conf.d/default.conf; \\\n rm -rf /etc/nginx/templates; \\\n mkdir -p /var/cache/nginx /var/run /var/log/nginx; \\\n touch /var/run/nginx.pid; \\\n chown -R nginx:nginx /var/cache/nginx /var/run /var/log/nginx /usr/share/nginx/html /etc/nginx/conf.d\n\nUSER nginx\nEXPOSE 8080\nHEALTHCHECK --interval=30s --timeout=5s --start-period=15s --retries=3 \\\n CMD wget -q -O /dev/null http://127.0.0.1:8080 || exit 1\nCMD [\"nginx\", \"-g\", \"daemon off;\"]\n" }, { "path": "docker/docker-compose.deploy.yaml", "content": "###############################################################################\n#\n# DO NOT EDIT!!!\n#\n# This file is used to deploy the https://test.talawa.io site\n#\n###############################################################################\n\nservices:\n app:\n build:\n context: ..\n dockerfile: docker/Dockerfile.deploy\n args:\n PNPM_VERSION: '${PNPM_VERSION:-10.4.1}'\n ports:\n - '${PORT:-4321}:${PORT:-4321}'\n env_file:\n - ../.env\n healthcheck:\n test: ['CMD', 'curl', '-f', 'http://localhost:${PORT:-4321}']\n interval: 30s\n timeout: 10s\n retries: 3\n restart: unless-stopped\n" }, { "path": "docker/docker-compose.dev.yaml", "content": "services:\n app:\n build:\n context: ..\n dockerfile: docker/Dockerfile.dev\n args:\n PNPM_VERSION: '${PNPM_VERSION:-10.4.1}'\n ports:\n - '${PORT:-4321}:${PORT:-4321}'\n env_file:\n - ../.env\n #environment:\n # - REACT_APP_TALAWA_URL=${REACT_APP_TALAWA_URL}\n # - PORT=${PORT}\n # - REACT_APP_USE_RECAPTCHA=${REACT_APP_USE_RECAPTCHA}\n # - REACT_APP_RECAPTCHA_SITE_KEY=${REACT_APP_RECAPTCHA_SITE_KEY}\n volumes:\n - ..:/usr/src/app\n - /usr/src/app/node_modules\n healthcheck:\n test: ['CMD', 'wget', '--spider', '-q', 'http://localhost:${PORT:-4321}']\n interval: 30s\n timeout: 10s\n retries: 3\n restart: unless-stopped\n" }, { "path": "docker/docker-compose.prod.yaml", "content": "services:\n app:\n build:\n context: ..\n dockerfile: docker/Dockerfile.prod\n args:\n PNPM_VERSION: '${PNPM_VERSION:-10.4.1}'\n ports:\n - '${PORT:-4321}:80'\n env_file:\n - ../.env\n #environment:\n # - REACT_APP_TALAWA_URL=${REACT_APP_TALAWA_URL}\n # - PORT=${PORT}\n # - REACT_APP_USE_RECAPTCHA=${REACT_APP_USE_RECAPTCHA}\n # - REACT_APP_RECAPTCHA_SITE_KEY=${REACT_APP_RECAPTCHA_SITE_KEY}\n healthcheck:\n test: ['CMD', 'curl', '-f', 'http://localhost:80']\n interval: 30s\n timeout: 10s\n retries: 3\n restart: unless-stopped\n" }, { "path": "docker/docker-compose.rootless.dev.yaml", "content": "# Rootless compose requires UID/GID exported for USER_UID/USER_GID mapping.\n# Local setup example:\n# export UID=\"$(id -u)\"\n# export GID=\"$(id -g)\"\n# CI already exports these values.\nservices:\n app:\n build:\n context: ..\n dockerfile: docker/Dockerfile.rootless.dev\n args:\n PNPM_VERSION: '${PNPM_VERSION:-10.4.1}'\n USER_UID: '${UID:-1000}'\n USER_GID: '${GID:-1000}'\n ports:\n - '${PORT:-4321}:${PORT:-4321}'\n env_file:\n - ../.env\n user: '${UID:-1000}:${GID:-1000}'\n volumes:\n - ..:/usr/src/app\n - /usr/src/app/node_modules\n healthcheck:\n test: ['CMD', 'wget', '--spider', '-q', 'http://localhost:${PORT:-4321}']\n interval: 30s\n timeout: 10s\n retries: 3\n restart: unless-stopped\n" }, { "path": "docker/docker-compose.rootless.prod.yaml", "content": "services:\n app:\n build:\n context: ..\n dockerfile: docker/Dockerfile.rootless.prod\n args:\n PNPM_VERSION: '${PNPM_VERSION:-10.4.1}'\n ports:\n - '${PORT:-4321}:8080'\n env_file:\n - ../.env\n healthcheck:\n test:\n ['CMD-SHELL', 'wget -q -O /dev/null http://localhost:8080 || exit 1']\n interval: 30s\n timeout: 10s\n retries: 3\n restart: unless-stopped\n" }, { "path": "docs/.gitignore", "content": "# Dependencies\n/node_modules\n\n# Production\n/build\n\n# Generated files\n.docusaurus\n.cache-loader\n.package-lock.json\npackage-lock.json\nyarn.lock\n\n# Misc\n.DS_Store\n.env.local\n.env.development.local\n.env.test.local\n.env.production.local\n\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n" }, { "path": "docs/CNAME", "content": "docs-admin.talawa.io\n" }, { "path": "docs/README.md", "content": "# Talawa Admin Documentation Website\n\n[![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/talawa-admin)\n\n## Installation\n\nThis document provides instructions on how to set up and start a running instance of the [talawa-admin documentation website](https://docs-admin.talawa.io/) on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections.\n\n## Table of Contents\n\n\n\n- [Talawa Admin Documentation Website](#talawa-admin-documentation-website)\n - [Installation](#installation)\n - [Table of Contents](#table-of-contents)\n - [Prerequisites for Developers](#prerequisites-for-developers)\n - [Install the Required PNPM Package Manager](#install-the-required-npm-package-manager)\n - [Install the Required Packages](#install-the-required-packages)\n - [Running the Development Server](#running-the-development-server)\n - [Building Static HTML Pages](#building-static-html-pages)\n\n\n\n## Prerequisites for Developers\n\nThe contents of the `talawa-admin` repo is used to automatically create [the talawa-admin Documentation website](https://docs-admin.talawa.io/). The automation uses [Docusaurus](https://docusaurus.io/docs/), a modern static website generator.\n\nWe recommend that you follow these steps before beginning development work in this repository.\n\n### Install the Required PNPM Package Manager\n\nFor the package installation use `pnpm`. The steps are simple:\n\n1. Validate the `pnpm` installation on your local device by running the following command. You should get the `pnpm` version.\n\n```terminal\n$ pnpm -version\n```\n\n1. If you get an error, then you'll need to install `pnpm`. A simple way to do this use [fnm](https://github.com/Schniz/fnm).\n\n### Install the Required Packages\n\nFrom the `talawa-admin/docs` directory, run the following command.\n\n```console\n$ pnpm install\n```\n\n## Running the Development Server\n\nTo preview your changes as you edit the files, you can run a local development server that will serve your website and it will reflect the latest changes.\n\nThe command to run the server is:\n\n```console\n$ pnpm run start\nOR\n$ pnpm start\n```\n\nBy default, a browser window will open at http://localhost:3000.\n\nThis command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.\n\n## Building Static HTML Pages\n\n**In most cases is unnecessary**. Running the `development server` will be sufficient.\n\nIf you need to generate static HTML pages (unlikely), then follow these steps.\n\n```console\n$ pnpm run build\n```\n\nThis command generates static content into the `/build` directory and can be served using any static contents hosting service.\n" }, { "path": "docs/docs/auto-docs/App/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `ReactElement`\n\nDefined in: [src/App.tsx:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/App.tsx#L138)\n\nThis is the main function for our application. It sets up all the routes and components,\ndefining how the user can navigate through the app. The function uses React Router's `Routes`\nand `Route` components to map different URL paths to corresponding screens and components.\n\n## Important Details\n- **UseEffect Hook**: This hook checks user authentication status using the `CHECK_AUTH` GraphQL query.\n- **Routes**:\n - The root route (\"/\") takes the user to the `LoginPage`.\n - Protected routes are wrapped with the `SecuredRoute` component to ensure they are only accessible to authenticated users.\n - Admin and Super Admin routes allow access to organization and user management screens.\n - User portal routes allow end-users to interact with organizations, settings, chat, events, etc.\n - Plugin routes are dynamically added based on loaded plugins and user permissions.\n\n## Returns\n\n`ReactElement`\n\nThe rendered routes and components of the application.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/FILE_NAME_TEMPLATE_BACKUP_ENV.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: FILE\\_NAME\\_TEMPLATE\\_BACKUP\\_ENV()\n\n> **FILE\\_NAME\\_TEMPLATE\\_BACKUP\\_ENV**(`timestamp`): `string`\n\nDefined in: [src/Constant/common.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L91)\n\nGenerates the backup environment filename.\n\n## Parameters\n\n### timestamp\n\n`string`\n\nThe timestamp.\n\n## Returns\n\n`string`\n\nThe formatted filename.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/ROUTE_USER.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: ROUTE\\_USER()\n\n> **ROUTE\\_USER**(`compId`): `string`\n\nDefined in: [src/Constant/common.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L62)\n\nGenerates the route for a user component.\n\n## Parameters\n\n### compId\n\n`string`\n\nThe component ID.\n\n## Returns\n\n`string`\n\nThe formatted route.\n\n## Throws\n\nError If compId is missing or empty.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/ROUTE_USER_ORG.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: ROUTE\\_USER\\_ORG()\n\n> **ROUTE\\_USER\\_ORG**(`compId`, `orgId`): `string`\n\nDefined in: [src/Constant/common.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L76)\n\nGenerates the route for a user component within an organization.\n\n## Parameters\n\n### compId\n\n`string`\n\nThe component ID.\n\n### orgId\n\n`string`\n\nThe organization ID.\n\n## Returns\n\n`string`\n\nThe formatted route.\n\n## Throws\n\nError If compId is missing or empty.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_DELETE_EVENT_MODAL.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_DELETE\\_EVENT\\_MODAL()\n\n> **TEST\\_ID\\_DELETE\\_EVENT\\_MODAL**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L40)\n\nGenerates the data-testid for the delete event modal.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the event.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_CARD.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_CARD()\n\n> **TEST\\_ID\\_PEOPLE\\_CARD**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L26)\n\nGenerates the data-testid for the people card.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_EMAIL.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_EMAIL()\n\n> **TEST\\_ID\\_PEOPLE\\_EMAIL**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L124)\n\nGenerates the data-testid for the people email.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_IMAGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_IMAGE()\n\n> **TEST\\_ID\\_PEOPLE\\_IMAGE**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L109)\n\nGenerates the data-testid for the people image.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_NAME.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_NAME()\n\n> **TEST\\_ID\\_PEOPLE\\_NAME**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L117)\n\nGenerates the data-testid for the people name.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_ROLE.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_ROLE()\n\n> **TEST\\_ID\\_PEOPLE\\_ROLE**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L132)\n\nGenerates the data-testid for the people role.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_PEOPLE_SNO.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_PEOPLE\\_SNO()\n\n> **TEST\\_ID\\_PEOPLE\\_SNO**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L33)\n\nGenerates the data-testid for the people sno badge.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the person.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/functions/TEST_ID_UPDATE_EVENT_MODAL.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TEST\\_ID\\_UPDATE\\_EVENT\\_MODAL()\n\n> **TEST\\_ID\\_UPDATE\\_EVENT\\_MODAL**(`id`): `string`\n\nDefined in: [src/Constant/common.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L48)\n\nGenerates the data-testid for the update event modal.\n\n## Parameters\n\n### id\n\n`string`\n\nThe ID of the event.\n\n## Returns\n\n`string`\n\nThe formatted data-testid.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/DATE_FORMAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DATE\\_FORMAT\n\n> `const` **DATE\\_FORMAT**: `\"YYYY-MM-DDTHH:mm:ssZ\"` = `'YYYY-MM-DDTHH:mm:ssZ'`\n\nDefined in: [src/Constant/common.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L9)\n\nDate format for ISO date time strings.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/DATE_FORMAT_ISO_DATE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DATE\\_FORMAT\\_ISO\\_DATE\n\n> `const` **DATE\\_FORMAT\\_ISO\\_DATE**: `\"YYYY-MM-DD\"` = `'YYYY-MM-DD'`\n\nDefined in: [src/Constant/common.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L54)\n\nDate format for ISO date string (YYYY-MM-DD).\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/DATE_TIME_SEPARATOR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DATE\\_TIME\\_SEPARATOR\n\n> `const` **DATE\\_TIME\\_SEPARATOR**: `\"T\"` = `'T'`\n\nDefined in: [src/Constant/common.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L14)\n\nSeparator for ISO date time strings.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/DUMMY_DATE_TIME_PREFIX.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DUMMY\\_DATE\\_TIME\\_PREFIX\n\n> `const` **DUMMY\\_DATE\\_TIME\\_PREFIX**: `\"2015-03-04T\"` = `'2015-03-04T'`\n\nDefined in: [src/Constant/common.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L19)\n\nPrefix for dummy date time for dayjs parsing.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/IDENTIFIER_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: IDENTIFIER\\_ID\n\n> `const` **IDENTIFIER\\_ID**: `\"id\"` = `'id'`\n\nDefined in: [src/Constant/common.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L102)\n\nIdentifier constant for ID.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/IDENTIFIER_USER_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: IDENTIFIER\\_USER\\_ID\n\n> `const` **IDENTIFIER\\_USER\\_ID**: `\"userId\"` = `'userId'`\n\nDefined in: [src/Constant/common.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L97)\n\nIdentifier constant for user ID.\n" }, { "path": "docs/docs/auto-docs/Constant/common/variables/MAX_NAME_LENGTH.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MAX\\_NAME\\_LENGTH\n\n> `const` **MAX\\_NAME\\_LENGTH**: `20` = `20`\n\nDefined in: [src/Constant/common.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/common.ts#L137)\n\nMaximum length for the displayed user name before truncation.\n" }, { "path": "docs/docs/auto-docs/Constant/constant/functions/deriveBackendWebsocketUrl.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: deriveBackendWebsocketUrl()\n\n> **deriveBackendWebsocketUrl**(`httpUrl`): `string`\n\nDefined in: [src/Constant/constant.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L5)\n\n## Parameters\n\n### httpUrl\n\n`string`\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/Constant/constant/variables/AUTH_TOKEN.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AUTH\\_TOKEN\n\n> `const` **AUTH\\_TOKEN**: `\"\"` = `''`\n\nDefined in: [src/Constant/constant.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L1)\n" }, { "path": "docs/docs/auto-docs/Constant/constant/variables/BACKEND_URL.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: BACKEND\\_URL\n\n> `const` **BACKEND\\_URL**: `string` = `process.env.REACT_APP_TALAWA_URL`\n\nDefined in: [src/Constant/constant.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L2)\n" }, { "path": "docs/docs/auto-docs/Constant/constant/variables/BACKEND_WEBSOCKET_URL.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: BACKEND\\_WEBSOCKET\\_URL\n\n> `const` **BACKEND\\_WEBSOCKET\\_URL**: `string`\n\nDefined in: [src/Constant/constant.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L25)\n" }, { "path": "docs/docs/auto-docs/Constant/constant/variables/REACT_APP_USE_RECAPTCHA.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REACT\\_APP\\_USE\\_RECAPTCHA\n\n> `const` **REACT\\_APP\\_USE\\_RECAPTCHA**: `string` = `process.env.REACT_APP_USE_RECAPTCHA`\n\nDefined in: [src/Constant/constant.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L4)\n" }, { "path": "docs/docs/auto-docs/Constant/constant/variables/RECAPTCHA_SITE_KEY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RECAPTCHA\\_SITE\\_KEY\n\n> `const` **RECAPTCHA\\_SITE\\_KEY**: `string` = `process.env.REACT_APP_RECAPTCHA_SITE_KEY`\n\nDefined in: [src/Constant/constant.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/constant.ts#L3)\n" }, { "path": "docs/docs/auto-docs/Constant/fileUpload/variables/AGENDA_ITEM_ALLOWED_MIME_TYPES.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AGENDA\\_ITEM\\_ALLOWED\\_MIME\\_TYPES\n\n> `const` **AGENDA\\_ITEM\\_ALLOWED\\_MIME\\_TYPES**: `string`[]\n\nDefined in: [src/Constant/fileUpload.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L30)\n\nList of MIME types allowed for agenda item attachments.\nUsed for file input validation.\n" }, { "path": "docs/docs/auto-docs/Constant/fileUpload/variables/AGENDA_ITEM_MIME_TYPE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AGENDA\\_ITEM\\_MIME\\_TYPE\n\n> `const` **AGENDA\\_ITEM\\_MIME\\_TYPE**: `Record`\\<`string`, `string`\\>\n\nDefined in: [src/Constant/fileUpload.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L17)\n\nMaps browser MIME types to internal attachment type identifiers\nused by the agenda item attachment system.\n" }, { "path": "docs/docs/auto-docs/Constant/fileUpload/variables/FILE_UPLOAD_ALLOWED_TYPES.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FILE\\_UPLOAD\\_ALLOWED\\_TYPES\n\n> `const` **FILE\\_UPLOAD\\_ALLOWED\\_TYPES**: `string`[]\n\nDefined in: [src/Constant/fileUpload.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L7)\n" }, { "path": "docs/docs/auto-docs/Constant/fileUpload/variables/FILE_UPLOAD_MAX_SIZE_MB.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FILE\\_UPLOAD\\_MAX\\_SIZE\\_MB\n\n> `const` **FILE\\_UPLOAD\\_MAX\\_SIZE\\_MB**: `number`\n\nDefined in: [src/Constant/fileUpload.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/Constant/fileUpload.ts#L4)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/CREATE_ACTION_ITEM_CATEGORY_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION\n\n> `const` **CREATE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L11)\n\nGraphQL mutation to create an action item category.\n\n## Param\n\nMutationCreateActionItemCategoryInput containing:\n - name: String! - Name of the action item category\n - isDisabled: Boolean - Whether the category is disabled (optional, defaults to false)\n - organizationId: ID! - ID of the organization this category belongs to\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/DELETE_ACTION_ITEM_CATEGORY_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION\n\n> `const` **DELETE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L65)\n\nGraphQL mutation to delete an action item category.\nUpdated to match new backend schema using input object\n\n## Param\n\nMutationDeleteActionItemCategoryInput containing:\n - id: ID! - ID of the action item category to delete\n\n This mutation will permanently delete the category.\n Ensure the category is not associated with any action items before deletion.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemCategoryMutations/variables/UPDATE_ACTION_ITEM_CATEGORY_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION\n\n> `const` **UPDATE\\_ACTION\\_ITEM\\_CATEGORY\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemCategoryMutations.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemCategoryMutations.ts#L41)\n\nGraphQL mutation to update an action item category.\n\n## Param\n\nMutationUpdateActionItemCategoryInput containing:\n - id: ID! - ID of the action item category to update\n - name: String - New name of the action item category (optional)\n - isDisabled: Boolean - Whether the category should be disabled (optional)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/COMPLETE_ACTION_ITEM_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: COMPLETE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE\n\n> `const` **COMPLETE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L149)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/CREATE_ACTION_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_ACTION\\_ITEM\\_MUTATION\n\n> `const` **CREATE\\_ACTION\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L7)\n\nGraphQL mutation to create an action item.\nUpdated to match new volunteer-based schema structure.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE\n\n> `const` **DELETE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L177)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/DELETE_ACTION_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ACTION\\_ITEM\\_MUTATION\n\n> `const` **DELETE\\_ACTION\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L129)\n\nGraphQL mutation to delete an action item.\nUpdated to match new schema structure.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/MARK_ACTION_ITEM_AS_PENDING_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MARK\\_ACTION\\_ITEM\\_AS\\_PENDING\\_FOR\\_INSTANCE\n\n> `const` **MARK\\_ACTION\\_ITEM\\_AS\\_PENDING\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L158)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/MARK_ACTION_ITEM_AS_PENDING_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MARK\\_ACTION\\_ITEM\\_AS\\_PENDING\\_MUTATION\n\n> `const` **MARK\\_ACTION\\_ITEM\\_AS\\_PENDING\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L141)\n\nGraphQL mutation to mark action item as pending.\nNew mutation for status updates.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE\n\n> `const` **UPDATE\\_ACTION\\_ITEM\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L167)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/ActionItemMutations/variables/UPDATE_ACTION_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ACTION\\_ITEM\\_MUTATION\n\n> `const` **UPDATE\\_ACTION\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/ActionItemMutations.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/ActionItemMutations.ts#L68)\n\nGraphQL mutation to update an action item.\nUpdated to match new volunteer-based schema structure.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/ADD_ADVERTISEMENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ADD\\_ADVERTISEMENT\\_MUTATION\n\n> `const` **ADD\\_ADVERTISEMENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L14)\n\nGraphQL mutation to create an advertisement.\n\n## Param\n\nGlobal identifier of the associated organization.\n\n## Param\n\nName of the advertisement.\n\n## Param\n\nType of the advertisement.\n\n## Param\n\nDate time at which the advertised event starts.\n\n## Param\n\nDate time at which the advertised event ends.\n\n## Param\n\nCustom information about the advertisement.\n\n## Param\n\nAttachments of the advertisement (FileMetadataInput from MinIO presigned upload).\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/DELETE_ADVERTISEMENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ADVERTISEMENT\\_MUTATION\n\n> `const` **DELETE\\_ADVERTISEMENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L80)\n\nGraphQL mutation to delete an advertisement.\n\n## Param\n\nGlobal identifier of the advertisement.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AdvertisementMutations/variables/UPDATE_ADVERTISEMENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ADVERTISEMENT\\_MUTATION\n\n> `const` **UPDATE\\_ADVERTISEMENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AdvertisementMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AdvertisementMutations.ts#L50)\n\nGraphQL mutation to update an advertisement.\n\n## Param\n\nGlobal identifier of the advertisement.\n\n## Param\n\nOptional updated name of the advertisement\n\n## Param\n\nOptional updated description of the advertisement\n\n## Param\n\nOptional updated type of the advertisement\n\n## Param\n\nOptional updated starting date of the advertisement\n\n## Param\n\nOptional updated ending date of the advertisement\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/CREATE_AGENDA_FOLDER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_AGENDA\\_FOLDER\\_MUTATION\n\n> `const` **CREATE\\_AGENDA\\_FOLDER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L9)\n\nGraphQL mutation to create a new agenda folder.\n\n## Param\n\nMutationCreateAgendaFolderInput containing folder details\n\n## Returns\n\nThe created agenda folder with id, name, description, sequence, event, and creator\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/DELETE_AGENDA_FOLDER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_AGENDA\\_FOLDER\\_MUTATION\n\n> `const` **DELETE\\_AGENDA\\_FOLDER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L50)\n\nGraphQL mutation to delete an agenda folder.\n\n## Param\n\nMutationDeleteAgendaFolderInput containing the folder id to delete\n\n## Returns\n\nThe deleted folder's id\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaFolderMutations/variables/UPDATE_AGENDA_FOLDER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_AGENDA\\_FOLDER\\_MUTATION\n\n> `const` **UPDATE\\_AGENDA\\_FOLDER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaFolderMutations.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaFolderMutations.ts#L34)\n\nGraphQL mutation to update an existing agenda folder.\n\n## Param\n\nMutationUpdateAgendaFolderInput containing folder id and fields to update\n\n## Returns\n\nThe updated agenda folder with id, name, and description\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/CREATE_AGENDA_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_AGENDA\\_ITEM\\_MUTATION\n\n> `const` **CREATE\\_AGENDA\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L9)\n\nGraphQL mutation to create a new agenda item.\n\n## Param\n\nThe agenda item creation input containing title, description, duration, etc.\n\n## Returns\n\nThe created agenda item with its details.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/DELETE_AGENDA_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_AGENDA\\_ITEM\\_MUTATION\n\n> `const` **DELETE\\_AGENDA\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L44)\n\nGraphQL mutation to delete an agenda item.\n\n## Param\n\nThe deletion input containing the agenda item ID.\n\n## Returns\n\nThe ID of the deleted agenda item.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_AGENDA\\_ITEM\\_MUTATION\n\n> `const` **UPDATE\\_AGENDA\\_ITEM\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L75)\n\nGraphQL mutation to update an agenda item's details.\n\n## Param\n\nThe update input containing item ID and fields to update.\n\n## Returns\n\nThe updated agenda item with its details.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/AgendaItemMutations/variables/UPDATE_AGENDA_ITEM_SEQUENCE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_AGENDA\\_ITEM\\_SEQUENCE\\_MUTATION\n\n> `const` **UPDATE\\_AGENDA\\_ITEM\\_SEQUENCE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/AgendaItemMutations.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/AgendaItemMutations.ts#L58)\n\nGraphQL mutation to update the sequence/order of an agenda item.\n\n## Param\n\nThe sequence update input containing item ID and new sequence.\n\n## Returns\n\nThe updated agenda item with its new sequence.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/CREATE_CAMPAIGN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_CAMPAIGN\\_MUTATION\n\n> `const` **CREATE\\_CAMPAIGN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CampaignMutation.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CampaignMutation.ts#L15)\n\nGraphQL mutation to create a new fund Campaign.\n\n## Param\n\nThe name of the fund.\n\n## Param\n\nThe fund ID the campaign is associated with.\n\n## Param\n\nThe funding goal of the campaign.\n\n## Param\n\nThe start date of the campaign.\n\n## Param\n\nThe end date of the campaign.\n\n## Param\n\nThe currency of the campaign.\n\n## Returns\n\nThe ID of the created campaign.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CampaignMutation/variables/UPDATE_CAMPAIGN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_CAMPAIGN\\_MUTATION\n\n> `const` **UPDATE\\_CAMPAIGN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CampaignMutation.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CampaignMutation.ts#L51)\n\nGraphQL mutation to update a fund Campaign.\n\n## Param\n\nThe ID of the campaign being updated.\n\n## Param\n\nThe name of the campaign.\n\n## Param\n\nThe funding goal of the campaign.\n\n## Param\n\nThe start date of the campaign.\n\n## Param\n\nThe end date of the campaign.\n\n## Param\n\nThe currency of the campaign.\n\n## Returns\n\nThe ID of the updated campaign.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/CREATE_COMMENT_POST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_COMMENT\\_POST\n\n> `const` **CREATE\\_COMMENT\\_POST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CommentMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L11)\n\nGraphQL mutation to create a new comment on a post.\n\n## Param\n\nThe text content of the comment.\n\n## Param\n\nThe ID of the post to which the comment is being added.\n\n## Returns\n\nThe created comment object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/DELETE_COMMENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_COMMENT\n\n> `const` **DELETE\\_COMMENT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CommentMutations.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L61)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/LIKE_COMMENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LIKE\\_COMMENT\n\n> `const` **LIKE\\_COMMENT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CommentMutations.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L39)\n\nGraphQL mutation to like a comment.\n\n## Param\n\nThe ID of the comment to be liked.\n\n## Returns\n\nThe liked comment object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UNLIKE_COMMENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UNLIKE\\_COMMENT\n\n> `const` **UNLIKE\\_COMMENT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CommentMutations.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L54)\n\nGraphQL mutation to unlike a comment.\n\n## Param\n\nThe ID of the comment to be unliked.\n\n## Returns\n\nThe unliked comment object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/CommentMutations/variables/UPDATE_COMMENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_COMMENT\n\n> `const` **UPDATE\\_COMMENT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/CommentMutations.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/CommentMutations.ts#L69)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/ADD_EVENT_ATTENDEE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ADD\\_EVENT\\_ATTENDEE\n\n> `const` **ADD\\_EVENT\\_ATTENDEE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L11)\n\nGraphQL mutation to add an attendee to an event.\n\n## Param\n\nThe ID of the user being added as an attendee.\n\n## Param\n\nThe ID of the event to which the user is being added as an attendee.\n\n## Returns\n\nThe updated event object with the added attendee.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/MARK_CHECKIN.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MARK\\_CHECKIN\n\n> `const` **MARK\\_CHECKIN**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L108)\n\nGraphQL mutation to mark a user's check-in at an event.\n\n## Param\n\nThe ID of the user checking in.\n\n## Param\n\nThe ID of the event at which the user is checking in.\n\n## Returns\n\nThe updated event object with the user's check-in information.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventAttendeeMutations/variables/REMOVE_EVENT_ATTENDEE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_EVENT\\_ATTENDEE\n\n> `const` **REMOVE\\_EVENT\\_ATTENDEE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventAttendeeMutations.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventAttendeeMutations.ts#L39)\n\nGraphQL mutation to remove an attendee from an event.\n\n## Param\n\nThe ID of the user being removed as an attendee.\n\n## Param\n\nThe ID of the event from which the user is being removed as an attendee.\n\n## Returns\n\nThe updated event object without the removed attendee.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/CREATE_EVENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_EVENT\\_MUTATION\n\n> `const` **CREATE\\_EVENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L5)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ENTIRE\\_RECURRING\\_EVENT\\_SERIES\\_MUTATION\n\n> `const` **DELETE\\_ENTIRE\\_RECURRING\\_EVENT\\_SERIES\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L83)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_SINGLE_EVENT_INSTANCE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_SINGLE\\_EVENT\\_INSTANCE\\_MUTATION\n\n> `const` **DELETE\\_SINGLE\\_EVENT\\_INSTANCE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L94)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_STANDALONE_EVENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_STANDALONE\\_EVENT\\_MUTATION\n\n> `const` **DELETE\\_STANDALONE\\_EVENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L75)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/DELETE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_THIS\\_AND\\_FOLLOWING\\_EVENTS\\_MUTATION\n\n> `const` **DELETE\\_THIS\\_AND\\_FOLLOWING\\_EVENTS\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L105)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/REGISTER_EVENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REGISTER\\_EVENT\n\n> `const` **REGISTER\\_EVENT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L172)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_ENTIRE_RECURRING_EVENT_SERIES_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ENTIRE\\_RECURRING\\_EVENT\\_SERIES\\_MUTATION\n\n> `const` **UPDATE\\_ENTIRE\\_RECURRING\\_EVENT\\_SERIES\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L160)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_EVENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_EVENT\\_MUTATION\n\n> `const` **UPDATE\\_EVENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L50)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_SINGLE_RECURRING_EVENT_INSTANCE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_SINGLE\\_RECURRING\\_EVENT\\_INSTANCE\\_MUTATION\n\n> `const` **UPDATE\\_SINGLE\\_RECURRING\\_EVENT\\_INSTANCE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L116)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventMutations/variables/UPDATE_THIS_AND_FOLLOWING_EVENTS_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_THIS\\_AND\\_FOLLOWING\\_EVENTS\\_MUTATION\n\n> `const` **UPDATE\\_THIS\\_AND\\_FOLLOWING\\_EVENTS\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventMutations.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventMutations.ts#L138)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/ADD_VOLUNTEER.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ADD\\_VOLUNTEER\n\n> `const` **ADD\\_VOLUNTEER**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L11)\n\nGraphQL mutation to create an event volunteer.\n\n## Param\n\nThe data required to create an event volunteer.\n\n## Returns\n\nThe created event volunteer with full details.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/CREATE_VOLUNTEER_GROUP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_VOLUNTEER\\_GROUP\n\n> `const` **CREATE\\_VOLUNTEER\\_GROUP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L69)\n\nGraphQL mutation to create an event volunteer group.\n\n## Param\n\nThe data required to create an event volunteer group.\n - data contains following fileds:\n - eventId: string\n - leaderId: string\n - name: string\n - description?: string\n - volunteers: [string]\n - volunteersRequired?: number\n\n## Returns\n\nThe ID of the created event volunteer group.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_VOLUNTEER\n\n> `const` **DELETE\\_VOLUNTEER**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L39)\n\nGraphQL mutation to delete an event volunteer.\n\n## Param\n\nThe ID of the event volunteer being deleted.\n\n## Returns\n\nThe deleted event volunteer.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_VOLUNTEER\\_FOR\\_INSTANCE\n\n> `const` **DELETE\\_VOLUNTEER\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L117)\n\nGraphQL mutation to delete a volunteer from a specific recurring event instance.\n\n## Param\n\nThe input containing volunteerId and recurringEventInstanceId.\n\n## Returns\n\nThe deleted volunteer information.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_VOLUNTEER\\_GROUP\n\n> `const` **DELETE\\_VOLUNTEER\\_GROUP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L103)\n\nGraphQL mutation to delete an event volunteer group.\n\n## Param\n\nThe ID of the event volunteer group being deleted.\n\n## Returns\n\nThe ID of the deleted event volunteer group.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/DELETE_VOLUNTEER_GROUP_FOR_INSTANCE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_VOLUNTEER\\_GROUP\\_FOR\\_INSTANCE\n\n> `const` **DELETE\\_VOLUNTEER\\_GROUP\\_FOR\\_INSTANCE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L141)\n\nGraphQL mutation to delete a volunteer group from a specific recurring event instance.\n\n## Param\n\nThe input containing volunteerGroupId and recurringEventInstanceId.\n\n## Returns\n\nThe deleted volunteer group information.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_GROUP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_VOLUNTEER\\_GROUP\n\n> `const` **UPDATE\\_VOLUNTEER\\_GROUP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L85)\n\nGraphQL mutation to update an event volunteer group.\n\n## Param\n\nThe ID of the event volunteer group being updated.\n\n## Param\n\nThe data required to update an event volunteer group.\n\n## Returns\n\nThe ID of the updated event volunteer group.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/EventVolunteerMutation/variables/UPDATE_VOLUNTEER_MEMBERSHIP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_VOLUNTEER\\_MEMBERSHIP\n\n> `const` **UPDATE\\_VOLUNTEER\\_MEMBERSHIP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/EventVolunteerMutation.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/EventVolunteerMutation.ts#L172)\n\nGraphQL mutation to update an event volunteer group.\n\n## Param\n\nThe ID of the event volunteer group being updated.\n\n## Param\n\nThe data required to update an event volunteer group.\n\n## Returns\n\nThe ID of the updated event volunteer group.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/CREATE_FUND_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_FUND\\_MUTATION\n\n> `const` **CREATE\\_FUND\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/FundMutation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/FundMutation.ts#L11)\n\nGraphQL mutation to create a new fund.\n\n## Param\n\nThe name of the fund.\n\n## Param\n\nThe organization ID the fund is associated with.\n\n## Param\n\nWhether the fund is tax deductible.\n\n## Returns\n\nThe ID of the created fund.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/FundMutation/variables/UPDATE_FUND_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_FUND\\_MUTATION\n\n> `const` **UPDATE\\_FUND\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/FundMutation.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/FundMutation.ts#L37)\n\nGraphQL mutation to update a fund.\n\n## Param\n\nThe ID of the fund being updated.\n\n## Param\n\nThe name of the fund.\n\n## Param\n\nWhether the fund is tax deductible.\n\n## Returns\n\nThe ID of the updated fund.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CANCEL_MEMBERSHIP_REQUEST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CANCEL\\_MEMBERSHIP\\_REQUEST\n\n> `const` **CANCEL\\_MEMBERSHIP\\_REQUEST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L266)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_CHAT\n\n> `const` **CREATE\\_CHAT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L69)\n\nGraphQL mutation to create a chat between users in an organization.\n\n## Param\n\nAn array of user IDs participating in the direct chat.\n\n## Param\n\nThe ID of the organization where the direct chat is created.\n\n## Returns\n\nThe created direct chat object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_CHAT_MEMBERSHIP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_CHAT\\_MEMBERSHIP\n\n> `const` **CREATE\\_CHAT\\_MEMBERSHIP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L83)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/CREATE_SAMPLE_ORGANIZATION_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_SAMPLE\\_ORGANIZATION\\_MUTATION\n\n> `const` **CREATE\\_SAMPLE\\_ORGANIZATION\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L43)\n\nGraphQL mutation to create a sample organization.\n\n## Returns\n\nThe created sample organization object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_CHAT\n\n> `const` **DELETE\\_CHAT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:284](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L284)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT_MEMBERSHIP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_CHAT\\_MEMBERSHIP\n\n> `const` **DELETE\\_CHAT\\_MEMBERSHIP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L315)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/DELETE_CHAT_MESSAGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_CHAT\\_MESSAGE\n\n> `const` **DELETE\\_CHAT\\_MESSAGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L28)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/EDIT_CHAT_MESSAGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EDIT\\_CHAT\\_MESSAGE\n\n> `const` **EDIT\\_CHAT\\_MESSAGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L123)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/JOIN_PUBLIC_ORGANIZATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: JOIN\\_PUBLIC\\_ORGANIZATION\n\n> `const` **JOIN\\_PUBLIC\\_ORGANIZATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:256](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L256)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MARK_CHAT_MESSAGES_AS_READ.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MARK\\_CHAT\\_MESSAGES\\_AS\\_READ\n\n> `const` **MARK\\_CHAT\\_MESSAGES\\_AS\\_READ**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L204)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/MESSAGE_SENT_TO_CHAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MESSAGE\\_SENT\\_TO\\_CHAT\n\n> `const` **MESSAGE\\_SENT\\_TO\\_CHAT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L175)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/REMOVE_SAMPLE_ORGANIZATION_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_SAMPLE\\_ORGANIZATION\\_MUTATION\n\n> `const` **REMOVE\\_SAMPLE\\_ORGANIZATION\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L55)\n\nGraphQL mutation to remove a sample organization.\n\n## Returns\n\nThe removed sample organization object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MEMBERSHIP_REQUEST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SEND\\_MEMBERSHIP\\_REQUEST\n\n> `const` **SEND\\_MEMBERSHIP\\_REQUEST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L241)\n\nGraphQL mutation to remove a custom field from an organization.\n\n## Param\n\nThe ID of the organization from which the custom field is being removed.\n\n## Param\n\nThe ID of the custom field to be removed.\n\n## Returns\n\nThe removed organization custom field object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/SEND_MESSAGE_TO_CHAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SEND\\_MESSAGE\\_TO\\_CHAT\n\n> `const` **SEND\\_MESSAGE\\_TO\\_CHAT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L149)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/TOGGLE_PINNED_POST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: TOGGLE\\_PINNED\\_POST\n\n> `const` **TOGGLE\\_PINNED\\_POST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L217)\n\nGraphQL mutation to toggle the pinned status of a post.\n\n## Param\n\nThe ID of the post to be toggled.\n\n## Returns\n\nThe updated post object with the new pinned status.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_CHAT\n\n> `const` **UPDATE\\_CHAT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L110)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_CHAT_MEMBERSHIP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_CHAT\\_MEMBERSHIP\n\n> `const` **UPDATE\\_CHAT\\_MEMBERSHIP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L274)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/OrganizationMutations/variables/UPDATE_USER_ROLE_IN_ORG_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_USER\\_ROLE\\_IN\\_ORG\\_MUTATION\n\n> `const` **UPDATE\\_USER\\_ROLE\\_IN\\_ORG\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/OrganizationMutations.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/OrganizationMutations.ts#L12)\n\nGraphQL mutation to update the role of a user in an organization.\n\n## Param\n\nThe ID of the organization in which the user's role is being updated.\n\n## Param\n\nThe ID of the user whose role is being updated.\n\n## Param\n\nThe new role to be assigned to the user in the organization.\n\n## Returns\n\nThe updated user object with the new role in the organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/CREATE_PLEDGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_PLEDGE\n\n> `const` **CREATE\\_PLEDGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PledgeMutation.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L12)\n\nGraphQL mutation to create a pledge.\n\n## Param\n\nThe ID of the campaign the pledge is associated with.\n\n## Param\n\nThe amount of the pledge.\n\n## Param\n\nThe ID of the pledger associated with the pledge.\n\n## Param\n\nA note associated with the pledge.\n\n## Returns\n\nThe details of the created pledge.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/DELETE_PLEDGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_PLEDGE\n\n> `const` **DELETE\\_PLEDGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PledgeMutation.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L77)\n\nGraphQL mutation to delete a pledge.\n\n## Param\n\nThe ID of the pledge being deleted.\n\n## Returns\n\nWhether the pledge was successfully deleted.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PledgeMutation/variables/UPDATE_PLEDGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_PLEDGE\n\n> `const` **UPDATE\\_PLEDGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PledgeMutation.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PledgeMutation.ts#L51)\n\nGraphQL mutation to update a pledge.\n\n## Param\n\nThe ID of the pledge being updated.\n\n## Param\n\nThe amount of the pledge.\n\n## Returns\n\nThe details of the updated pledge.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/CREATE_PLUGIN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_PLUGIN\\_MUTATION\n\n> `const` **CREATE\\_PLUGIN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PluginMutations.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L9)\n\nGraphQL mutation to create a new plugin.\n\n## Param\n\nThe ID of the plugin to create.\n\n## Returns\n\nThe created plugin object with id, pluginId, isActivated, isInstalled, and backup status.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/DELETE_PLUGIN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_PLUGIN\\_MUTATION\n\n> `const` **DELETE\\_PLUGIN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PluginMutations.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L72)\n\nGraphQL mutation to delete a plugin.\n\n## Param\n\nThe ID of the plugin to delete.\n\n## Returns\n\nThe deleted plugin object with id and pluginId.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/INSTALL_PLUGIN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: INSTALL\\_PLUGIN\\_MUTATION\n\n> `const` **INSTALL\\_PLUGIN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PluginMutations.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L29)\n\nGraphQL mutation to install a plugin.\n\n## Param\n\nThe ID of the plugin to install.\n\n## Returns\n\nThe installed plugin object with id, pluginId, isActivated, isInstalled, and backup status.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/UPDATE_PLUGIN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_PLUGIN\\_MUTATION\n\n> `const` **UPDATE\\_PLUGIN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PluginMutations.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L52)\n\nGraphQL mutation to update a plugin.\n\n## Param\n\nThe ID of the plugin to update.\n\n## Param\n\nWhether the plugin is activated.\n\n## Param\n\nWhether the plugin is installed.\n\n## Param\n\nWhether the plugin is backed up.\n\n## Returns\n\nThe updated plugin object.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/PluginMutations/variables/UPLOAD_PLUGIN_ZIP_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPLOAD\\_PLUGIN\\_ZIP\\_MUTATION\n\n> `const` **UPLOAD\\_PLUGIN\\_ZIP\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/PluginMutations.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/PluginMutations.ts#L81)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ADD_PEOPLE_TO_TAG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ADD\\_PEOPLE\\_TO\\_TAG\n\n> `const` **ADD\\_PEOPLE\\_TO\\_TAG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L76)\n\nGraphQL mutation to add people to tag.\n\n## Param\n\nId of the tag to be assigned.\n\n## Param\n\nIds of the users to assign to.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/ASSIGN_TO_TAGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ASSIGN\\_TO\\_TAGS\n\n> `const` **ASSIGN\\_TO\\_TAGS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L91)\n\nGraphQL mutation to assign people to multiple tags.\n\n## Param\n\nId of the current tag.\n\n## Param\n\nIds of the selected tags to be assined.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/CREATE_USER_TAG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_USER\\_TAG\n\n> `const` **CREATE\\_USER\\_TAG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L11)\n\nGraphQL mutation to create a user tag.\n\n## Param\n\nName of the tag.\n\n## Param\n\nId of the folder/parent tag to organize tags.\n\n## Param\n\nOrganization to which the tag belongs.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_FROM_TAGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_FROM\\_TAGS\n\n> `const` **REMOVE\\_FROM\\_TAGS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L108)\n\nGraphQL mutation to remove people from multiple tags.\n\n## Param\n\nId of the current tag.\n\n## Param\n\nIds of the selected tags to be removed from.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/REMOVE_USER_TAG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_USER\\_TAG\n\n> `const` **REMOVE\\_USER\\_TAG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L61)\n\nGraphQL mutation to remove a user tag.\n\n## Param\n\nId of the tag to be removed .\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UNASSIGN_USER_TAG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UNASSIGN\\_USER\\_TAG\n\n> `const` **UNASSIGN\\_USER\\_TAG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L32)\n\nGraphQL mutation to unsssign a user tag from a user.\n\n## Param\n\nId the tag.\n\n## Param\n\nId of the user to be unassigned.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/TagMutations/variables/UPDATE_USER_TAG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_USER\\_TAG\n\n> `const` **UPDATE\\_USER\\_TAG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/TagMutations.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/TagMutations.ts#L47)\n\nGraphQL mutation to update a user tag.\n\n## Param\n\nId the tag.\n\n## Param\n\nUpdated name of the tag.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/CREATE_VENUE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_VENUE\\_MUTATION\n\n> `const` **CREATE\\_VENUE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/VenueMutations.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L13)\n\nGraphQL mutation to create a venue.\n\n## Param\n\nName of the venue.\n\n## Param\n\nIneteger representing capacity of venue.\n\n## Param\n\nDescription of the venue.\n\n## Param\n\nImage file for the venue.\n\n## Param\n\nOrganization to which the ActionItemCategory belongs.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/DELETE_VENUE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_VENUE\\_MUTATION\n\n> `const` **DELETE\\_VENUE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/VenueMutations.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L74)\n\nGraphQL mutation to delete a venue.\n\n## Param\n\nThe id of the Venue to be deleted.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/VenueMutations/variables/UPDATE_VENUE_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_VENUE\\_MUTATION\n\n> `const` **UPDATE\\_VENUE\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/VenueMutations.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/VenueMutations.ts#L44)\n\nGraphQL mutation to update a venue.\n\n## Param\n\nThe id of the Venue to be updated.\n\n## Param\n\nDescription of the venue.\n\n## Param\n\nName of the venue.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_EVENT_INVITATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ACCEPT\\_EVENT\\_INVITATION\n\n> `const` **ACCEPT\\_EVENT\\_INVITATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L196)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/ACCEPT_ORGANIZATION_REQUEST_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ACCEPT\\_ORGANIZATION\\_REQUEST\\_MUTATION\n\n> `const` **ACCEPT\\_ORGANIZATION\\_REQUEST\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L32)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/BLOCK_USER_MUTATION_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: BLOCK\\_USER\\_MUTATION\\_PG\n\n> `const` **BLOCK\\_USER\\_MUTATION\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L5)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_MEMBER_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_MEMBER\\_PG\n\n> `const` **CREATE\\_MEMBER\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L218)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MEMBERSHIP_MUTATION_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_ORGANIZATION\\_MEMBERSHIP\\_MUTATION\\_PG\n\n> `const` **CREATE\\_ORGANIZATION\\_MEMBERSHIP\\_MUTATION\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L374)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_ORGANIZATION\\_MUTATION\n\n> `const` **CREATE\\_ORGANIZATION\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L318)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_ORGANIZATION_MUTATION_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_ORGANIZATION\\_MUTATION\\_PG\n\n> `const` **CREATE\\_ORGANIZATION\\_MUTATION\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:342](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L342)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/CREATE_POST_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CREATE\\_POST\\_MUTATION\n\n> `const` **CREATE\\_POST\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L425)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_ORGANIZATION_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_ORGANIZATION\\_MUTATION\n\n> `const` **DELETE\\_ORGANIZATION\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:394](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L394)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DELETE_POST_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DELETE\\_POST\\_MUTATION\n\n> `const` **DELETE\\_POST\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L437)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/DONATE_TO_ORGANIZATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DONATE\\_TO\\_ORGANIZATION\n\n> `const` **DONATE\\_TO\\_ORGANIZATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:602](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L602)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/FORGOT_PASSWORD_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FORGOT\\_PASSWORD\\_MUTATION\n\n> `const` **FORGOT\\_PASSWORD\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:453](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L453)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GENERATE_OTP_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GENERATE\\_OTP\\_MUTATION\n\n> `const` **GENERATE\\_OTP\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:445](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L445)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/GET_FILE_PRESIGNEDURL.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_FILE\\_PRESIGNEDURL\n\n> `const` **GET\\_FILE\\_PRESIGNEDURL**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:708](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L708)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LINK_OAUTH_ACCOUNT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LINK\\_OAUTH\\_ACCOUNT\n\n> `const` **LINK\\_OAUTH\\_ACCOUNT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:717](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L717)\n\nLinks an OAuth provider account to the currently authenticated user.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/LOGOUT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LOGOUT\\_MUTATION\n\n> `const` **LOGOUT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:298](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L298)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/PRESIGNED_URL.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PRESIGNED\\_URL\n\n> `const` **PRESIGNED\\_URL**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:698](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L698)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REFRESH_TOKEN_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REFRESH\\_TOKEN\\_MUTATION\n\n> `const` **REFRESH\\_TOKEN\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L286)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REJECT_ORGANIZATION_REQUEST_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REJECT\\_ORGANIZATION\\_REQUEST\\_MUTATION\n\n> `const` **REJECT\\_ORGANIZATION\\_REQUEST\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L19)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_MEMBER\\_MUTATION\n\n> `const` **REMOVE\\_MEMBER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:404](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L404)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REMOVE_MEMBER_MUTATION_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_MEMBER\\_MUTATION\\_PG\n\n> `const` **REMOVE\\_MEMBER\\_MUTATION\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:415](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L415)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESEND_VERIFICATION_EMAIL_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RESEND\\_VERIFICATION\\_EMAIL\\_MUTATION\n\n> `const` **RESEND\\_VERIFICATION\\_EMAIL\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L272)\n\nResends the email verification link to the currently authenticated user.\n\n## Remarks\n\nThe user must be logged in for this mutation to work.\nNo parameters are required as it uses the authenticated user's session.\n\n## Returns\n\nAn object containing:\n - success: boolean indicating if the email was sent successfully\n - message: A descriptive message about the result\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/RESET_COMMUNITY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RESET\\_COMMUNITY\n\n> `const` **RESET\\_COMMUNITY**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:596](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L596)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/REVOKE_REFRESH_TOKEN.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REVOKE\\_REFRESH\\_TOKEN\n\n> `const` **REVOKE\\_REFRESH\\_TOKEN**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:310](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L310)\n\nto revoke a refresh token (legacy - use LOGOUT_MUTATION for cookie-based auth)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SEND_EVENT_INVITATIONS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SEND\\_EVENT\\_INVITATIONS\n\n> `const` **SEND\\_EVENT\\_INVITATIONS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L158)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGNUP_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SIGNUP\\_MUTATION\n\n> `const` **SIGNUP\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L131)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/SIGN_IN_WITH_OAUTH.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SIGN\\_IN\\_WITH\\_OAUTH\n\n> `const` **SIGN\\_IN\\_WITH\\_OAUTH**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:752](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L752)\n\nAuthenticates a user using an OAuth provider and returns authentication tokens.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNBLOCK_USER_MUTATION_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UNBLOCK\\_USER\\_MUTATION\\_PG\n\n> `const` **UNBLOCK\\_USER\\_MUTATION\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L11)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UNLINK_OAUTH_ACCOUNT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UNLINK\\_OAUTH\\_ACCOUNT\n\n> `const` **UNLINK\\_OAUTH\\_ACCOUNT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:736](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L736)\n\nUnlinks an OAuth provider account from the currently authenticated user.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_COMMUNITY_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_COMMUNITY\\_PG\n\n> `const` **UPDATE\\_COMMUNITY\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:548](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L548)\n\nGraphQL mutation to update community profile settings including logo upload.\n\n## Param\n\nOptional logo file (Upload scalar) - sent as multipart request via apollo-upload-client\n\n## Param\n\nCommunity name\n\n## Param\n\nCommunity website URL\n\n## Param\n\nFacebook profile URL\n\n## Param\n\nInstagram profile URL\n\n## Param\n\nX (Twitter) profile URL\n\n## Param\n\nGitHub organization URL\n\n## Param\n\nYouTube channel URL\n\n## Param\n\nLinkedIn profile URL\n\n## Param\n\nReddit community URL\n\n## Param\n\nSlack workspace URL\n\n## Param\n\nSession timeout in minutes\n\n## Returns\n\nUpdated community with id, logoURL (computed MinIO URL) and logoMimeType\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_CURRENT_USER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_CURRENT\\_USER\\_MUTATION\n\n> `const` **UPDATE\\_CURRENT\\_USER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L66)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_EVENT_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_EVENT\\_MUTATION\n\n> `const` **UPDATE\\_EVENT\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L485)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_ORGANIZATION_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_ORGANIZATION\\_MUTATION\n\n> `const` **UPDATE\\_ORGANIZATION\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L45)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_POST\\_MUTATION\n\n> `const` **UPDATE\\_POST\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L469)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_POST_VOTE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_POST\\_VOTE\n\n> `const` **UPDATE\\_POST\\_VOTE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:515](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L515)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_SESSION_TIMEOUT_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_SESSION\\_TIMEOUT\\_PG\n\n> `const` **UPDATE\\_SESSION\\_TIMEOUT\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:586](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L586)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/UPDATE_USER_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UPDATE\\_USER\\_MUTATION\n\n> `const` **UPDATE\\_USER\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L98)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/VERIFY_EMAIL_MUTATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: VERIFY\\_EMAIL\\_MUTATION\n\n> `const` **VERIFY\\_EMAIL\\_MUTATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L252)\n\nVerifies a user's email address using a token sent via email.\n\n## Param\n\nThe verification token received via email\n\n## Returns\n\nAn object containing:\n - success: boolean indicating if the verification succeeded\n - message: A descriptive message about the result\n" }, { "path": "docs/docs/auto-docs/GraphQl/Mutations/mutations/variables/VERIFY_EVENT_INVITATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: VERIFY\\_EVENT\\_INVITATION\n\n> `const` **VERIFY\\_EVENT\\_INVITATION**: `DocumentNode`\n\nDefined in: [src/GraphQl/Mutations/mutations.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Mutations/mutations.ts#L180)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/ACTION_ITEM_CATEGORY_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ACTION\\_ITEM\\_CATEGORY\\_LIST\n\n> `const` **ACTION\\_ITEM\\_CATEGORY\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/ActionItemCategoryQueries.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemCategoryQueries.ts#L7)\n\nGraphQL query to retrieve action item categories by organization.\n*\n\n## Returns\n\nThe list of action item categories associated with the organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/ActionItemCategoryQueries/variables/GET_ACTION_ITEM_CATEGORY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ACTION\\_ITEM\\_CATEGORY\n\n> `const` **GET\\_ACTION\\_ITEM\\_CATEGORY**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/ActionItemCategoryQueries.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemCategoryQueries.ts#L29)\n\nQuery to fetch a single action item category\nUsing direct id parameter\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/ACTION_ITEM_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ACTION\\_ITEM\\_LIST\n\n> `const` **ACTION\\_ITEM\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/ActionItemQueries.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemQueries.ts#L14)\n\nGraphQL query to retrieve action item categories by organization.\n\n## Param\n\nThe ID of the organization for which action item categories are being retrieved.\n\n## Param\n\nSort action items Latest/Earliest first.\n\n## Param\n\nFilter action items belonging to an action item category.\n\n## Param\n\nFilter action items belonging to an event.\n\n## Param\n\nFilter all the completed action items.\n\n## Returns\n\nThe list of action item categories associated with the organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/ActionItemQueries/variables/GET_EVENT_ACTION_ITEMS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_EVENT\\_ACTION\\_ITEMS\n\n> `const` **GET\\_EVENT\\_ACTION\\_ITEMS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/ActionItemQueries.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/ActionItemQueries.ts#L85)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/AdvertisementQueries/variables/ORGANIZATION_ADVERTISEMENT_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_ADVERTISEMENT\\_LIST\n\n> `const` **ORGANIZATION\\_ADVERTISEMENT\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/AdvertisementQueries.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AdvertisementQueries.ts#L15)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/AgendaCategoryQueries/variables/AGENDA_ITEM_CATEGORY_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AGENDA\\_ITEM\\_CATEGORY\\_LIST\n\n> `const` **AGENDA\\_ITEM\\_CATEGORY\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/AgendaCategoryQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AgendaCategoryQueries.ts#L10)\n\nGraphQL query to retrieve agenda category by id.\n\n## Param\n\nThe ID of the category which is being retrieved.\n\n## Returns\n\nAgenda category associated with the id.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/AgendaFolderQueries/variables/AGENDA_FOLDER_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AGENDA\\_FOLDER\\_LIST\n\n> `const` **AGENDA\\_FOLDER\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/AgendaFolderQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/AgendaFolderQueries.ts#L10)\n\nGraphQL query to retrieve agenda folders by event ID.\n\n## Param\n\nThe ID of the event for which folders are retrieved.\n\n## Returns\n\nList of agenda folders with their items for the specified event.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/CommentQueries/variables/GET_POST_COMMENTS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_POST\\_COMMENTS\n\n> `const` **GET\\_POST\\_COMMENTS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/CommentQueries.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/CommentQueries.ts#L14)\n\nGraphQL query to retrieve post comments with cursor-based pagination.\n\n## Param\n\nThe ID of the post to fetch comments for.\n\n## Param\n\nCursor to fetch comments after this point (for load more).\n\n## Param\n\nCursor to fetch comments before this point.\n\n## Param\n\nNumber of comments to fetch (forward pagination).\n\n## Param\n\nNumber of comments to fetch (backward pagination).\n\n## Returns\n\nPost with paginated comments using cursor-based pagination.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/EVENT_VOLUNTEER_GROUP_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_VOLUNTEER\\_GROUP\\_LIST\n\n> `const` **EVENT\\_VOLUNTEER\\_GROUP\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L65)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/GET_EVENT_VOLUNTEERS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_EVENT\\_VOLUNTEERS\n\n> `const` **GET\\_EVENT\\_VOLUNTEERS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L12)\n\nGraphQL query to retrieve event volunteers.\n\n## Param\n\nThe filter to apply to the query.\n\n## Param\n\nThe order in which to return the results.\n\n## Returns\n\nThe list of event volunteers.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/GET_EVENT_VOLUNTEER_GROUPS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_EVENT\\_VOLUNTEER\\_GROUPS\n\n> `const` **GET\\_EVENT\\_VOLUNTEER\\_GROUPS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L102)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_EVENTS_VOLUNTEER.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_EVENTS\\_VOLUNTEER\n\n> `const` **USER\\_EVENTS\\_VOLUNTEER**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L193)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/USER_VOLUNTEER_MEMBERSHIP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_VOLUNTEER\\_MEMBERSHIP\n\n> `const` **USER\\_VOLUNTEER\\_MEMBERSHIP**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L147)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/EventVolunteerQueries/variables/VOLUNTEER_RANKING.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: VOLUNTEER\\_RANKING\n\n> `const` **VOLUNTEER\\_RANKING**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/EventVolunteerQueries.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/EventVolunteerQueries.ts#L251)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/NotificationQueries/variables/GET_USER_NOTIFICATIONS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_USER\\_NOTIFICATIONS\n\n> `const` **GET\\_USER\\_NOTIFICATIONS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/NotificationQueries.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/NotificationQueries.ts#L3)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/NotificationQueries/variables/MARK_NOTIFICATION_AS_READ.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MARK\\_NOTIFICATION\\_AS\\_READ\n\n> `const` **MARK\\_NOTIFICATION\\_AS\\_READ**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/NotificationQueries.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/NotificationQueries.ts#L22)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_MEMBERS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_MEMBERS\n\n> `const` **ORGANIZATION\\_MEMBERS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:368](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L368)\n\nGraphQL query to fetch organization members with pagination and filtering.\nThis query uses the new connection-based schema with input objects.\n\n## Param\n\nQueryOrganizationInput containing the organization ID\n\n## Param\n\nNumber of members to fetch\n\n## Param\n\nCursor for pagination\n\n## Param\n\nMembersWhereInput for filtering (e.g., name_contains)\n\n## Returns\n\nOrganization members with connection structure\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_PINNED_POST_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_PINNED\\_POST\\_LIST\n\n> `const` **ORGANIZATION\\_PINNED\\_POST\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L16)\n\nGraphQL query to retrieve the list of organizations.\n\n## Param\n\nOptional. Number of organizations to retrieve in the first batch.\n\n## Param\n\nOptional. Number of organizations to skip before starting to collect the result set.\n\n## Param\n\nOptional. Filter organizations by a specified string.\n\n## Param\n\nOptional. The ID of a specific organization to retrieve.\n\n## Returns\n\nThe list of organizations based on the applied filters.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_BY_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_POST\\_BY\\_ID\n\n> `const` **ORGANIZATION\\_POST\\_BY\\_ID**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L122)\n\nGraphQL query to retrieve a single post by its ID.\n\n## Param\n\nThe ID of the post to retrieve.\n\n## Param\n\nThe ID of the user to check vote status against.\n\n## Returns\n\nThe post with its metadata, attachments, vote information, and creator details.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_POST_LIST_WITH_VOTES.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_POST\\_LIST\\_WITH\\_VOTES\n\n> `const` **ORGANIZATION\\_POST\\_LIST\\_WITH\\_VOTES**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L65)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_USER\\_TAGS\\_LIST\n\n> `const` **ORGANIZATION\\_USER\\_TAGS\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L194)\n\nGraphQL query to retrieve the list of user tags belonging to an organization.\n\n## Param\n\nID of the organization.\n\n## Param\n\nNumber of tags to retrieve \"after\" (if provided) a certain tag.\n\n## Param\n\nId of the last tag on the current page.\n\n## Param\n\nNumber of tags to retrieve \"before\" (if provided) a certain tag.\n\n## Param\n\nId of the first tag on the current page.\n\n## Returns\n\nThe list of organizations based on the applied filters.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/ORGANIZATION_USER_TAGS_LIST_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_USER\\_TAGS\\_LIST\\_PG\n\n> `const` **ORGANIZATION\\_USER\\_TAGS\\_LIST\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L245)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_CREATED_ORGANIZATIONS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_CREATED\\_ORGANIZATIONS\n\n> `const` **USER\\_CREATED\\_ORGANIZATIONS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L291)\n\nGraphQL query to retrieve organizations created by a user.\n\n## Param\n\nThe ID of the user for which created organizations are being retrieved.\n\n## Returns\n\nThe list of organizations created by the user.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/USER_JOINED_ORGANIZATIONS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_JOINED\\_ORGANIZATIONS\\_PG\n\n> `const` **USER\\_JOINED\\_ORGANIZATIONS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L151)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/OrganizationQueries/variables/VENUE_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: VENUE\\_LIST\n\n> `const` **VENUE\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/OrganizationQueries.ts:330](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/OrganizationQueries.ts#L330)\n\nGraphQL query to retrieve the list of venues for a specific organization.\n\n## Param\n\nThe ID of the organization for which venues are being retrieved.\n\n## Returns\n\nThe list of venues associated with the organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHATS_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CHATS\\_LIST\n\n> `const` **CHATS\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/PlugInQueries.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L240)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/CHAT_BY_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CHAT\\_BY\\_ID\n\n> `const` **CHAT\\_BY\\_ID**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/PlugInQueries.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L54)\n\nGraphQL query to retrieve a list of chats based on user ID.\n\n## Param\n\nThe ID of the user for which chats are being retrieved.\n\n## Returns\n\nThe list of chats associated with the user, including details such as ID, creator, messages, organization, and participating users.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/GET_ALL_PLUGINS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ALL\\_PLUGINS\n\n> `const` **GET\\_ALL\\_PLUGINS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/PlugInQueries.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L8)\n\nGraphQL query to retrieve all plugins.\n\n## Returns\n\nThe list of plugins with details such as id, pluginId, isActivated, isInstalled, createdAt, and updatedAt.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/IS_SAMPLE_ORGANIZATION_QUERY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: IS\\_SAMPLE\\_ORGANIZATION\\_QUERY\n\n> `const` **IS\\_SAMPLE\\_ORGANIZATION\\_QUERY**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/PlugInQueries.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L359)\n\nGraphQL query to check if an organization is a sample organization.\n\n## Param\n\nThe ID of the organization being checked.\n\n## Returns\n\nA boolean indicating whether the organization is a sample organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/PlugInQueries/variables/UNREAD_CHATS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UNREAD\\_CHATS\n\n> `const` **UNREAD\\_CHATS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/PlugInQueries.ts:297](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/PlugInQueries.ts#L297)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ALL_ORGANIZATIONS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ALL\\_ORGANIZATIONS\\_PG\n\n> `const` **ALL\\_ORGANIZATIONS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L122)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/CURRENT_USER.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CURRENT\\_USER\n\n> `const` **CURRENT\\_USER**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L4)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_ATTENDEES.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_ATTENDEES\n\n> `const` **EVENT\\_ATTENDEES**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:348](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L348)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_CHECKINS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_CHECKINS\n\n> `const` **EVENT\\_CHECKINS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L391)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_DETAILS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_DETAILS\n\n> `const` **EVENT\\_DETAILS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L294)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_FEEDBACKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_FEEDBACKS\n\n> `const` **EVENT\\_FEEDBACKS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:411](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L411)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/EVENT_REGISTRANTS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_REGISTRANTS\n\n> `const` **EVENT\\_REGISTRANTS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:368](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L368)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_DATA_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_COMMUNITY\\_DATA\\_PG\n\n> `const` **GET\\_COMMUNITY\\_DATA\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1183)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_COMMUNITY_SESSION_TIMEOUT_DATA_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_COMMUNITY\\_SESSION\\_TIMEOUT\\_DATA\\_PG\n\n> `const` **GET\\_COMMUNITY\\_SESSION\\_TIMEOUT\\_DATA\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1234)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_EVENTS_BY_ORGANIZATION_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_EVENTS\\_BY\\_ORGANIZATION\\_ID\n\n> `const` **GET\\_EVENTS\\_BY\\_ORGANIZATION\\_ID**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1296)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BASIC_DATA.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_BASIC\\_DATA\n\n> `const` **GET\\_ORGANIZATION\\_BASIC\\_DATA**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L750)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BLOCKED_USERS_COUNT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_BLOCKED\\_USERS\\_COUNT\n\n> `const` **GET\\_ORGANIZATION\\_BLOCKED\\_USERS\\_COUNT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:507](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L507)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_BLOCKED_USERS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_BLOCKED\\_USERS\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_BLOCKED\\_USERS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L485)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_DATA_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_DATA\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_DATA\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:760](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L760)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_EVENTS\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_EVENTS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:525](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L525)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_EVENTS_USER_PORTAL_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_EVENTS\\_USER\\_PORTAL\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_EVENTS\\_USER\\_PORTAL\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:612](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L612)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_MEMBERS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_MEMBERS\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_MEMBERS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:463](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L463)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_COUNT_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_POSTS\\_COUNT\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_POSTS\\_COUNT\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:427](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L427)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_POSTS_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_POSTS\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_POSTS\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:694](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L694)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_VENUES_COUNT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_VENUES\\_COUNT\n\n> `const` **GET\\_ORGANIZATION\\_VENUES\\_COUNT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:516](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L516)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_ORGANIZATION_VENUES_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_ORGANIZATION\\_VENUES\\_PG\n\n> `const` **GET\\_ORGANIZATION\\_VENUES\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1242)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_USER_BY_ID.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_USER\\_BY\\_ID\n\n> `const` **GET\\_USER\\_BY\\_ID**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:436](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L436)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/GET_USER_TAGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: GET\\_USER\\_TAGS\n\n> `const` **GET\\_USER\\_TAGS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1271)\n\nFetches tags assigned to a user, including assignees (capped), creator, and folder.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERSHIP_REQUEST_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MEMBERSHIP\\_REQUEST\\_PG\n\n> `const` **MEMBERSHIP\\_REQUEST\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1065](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1065)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MEMBERS\\_LIST\n\n> `const` **MEMBERS\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:851](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L851)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST_PG.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MEMBERS\\_LIST\\_PG\n\n> `const` **MEMBERS\\_LIST\\_PG**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:832](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L832)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/MEMBERS_LIST_WITH_DETAILS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MEMBERS\\_LIST\\_WITH\\_DETAILS\n\n> `const` **MEMBERS\\_LIST\\_WITH\\_DETAILS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:865](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L865)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATIONS\\_LIST\n\n> `const` **ORGANIZATIONS\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:801](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L801)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_LIST_BASIC.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATIONS\\_LIST\\_BASIC\n\n> `const` **ORGANIZATIONS\\_LIST\\_BASIC**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:823](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L823)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATIONS_MEMBER_CONNECTION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATIONS\\_MEMBER\\_CONNECTION\\_LIST\n\n> `const` **ORGANIZATIONS\\_MEMBER\\_CONNECTION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:882](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L882)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_DONATION_CONNECTION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_DONATION\\_CONNECTION\\_LIST\n\n> `const` **ORGANIZATION\\_DONATION\\_CONNECTION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1044](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1044)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_EVENT_CONNECTION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_EVENT\\_CONNECTION\\_LIST\n\n> `const` **ORGANIZATION\\_EVENT\\_CONNECTION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:988](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L988)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_FIELDS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_FIELDS\n\n> `const` **ORGANIZATION\\_FIELDS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:785](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L785)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_FILTER_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_FILTER\\_LIST\n\n> `const` **ORGANIZATION\\_FILTER\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L73)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_LIST\n\n> `const` **ORGANIZATION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L54)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_LIST_NO_MEMBERS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_LIST\\_NO\\_MEMBERS\n\n> `const` **ORGANIZATION\\_LIST\\_NO\\_MEMBERS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L84)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/ORGANIZATION_MEMBER_ADMIN_COUNT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ORGANIZATION\\_MEMBER\\_ADMIN\\_COUNT\n\n> `const` **ORGANIZATION\\_MEMBER\\_ADMIN\\_COUNT**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L94)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/RECURRING_EVENTS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RECURRING\\_EVENTS\n\n> `const` **RECURRING\\_EVENTS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:334](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L334)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/SIGNIN_QUERY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SIGNIN\\_QUERY\n\n> `const` **SIGNIN\\_QUERY**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1206)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USERS_CONNECTION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USERS\\_CONNECTION\\_LIST\n\n> `const` **USERS\\_CONNECTION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:1094](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L1094)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_DETAILS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_DETAILS\n\n> `const` **USER\\_DETAILS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:936](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L936)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_JOINED_ORGANIZATIONS_NO_MEMBERS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_JOINED\\_ORGANIZATIONS\\_NO\\_MEMBERS\n\n> `const` **USER\\_JOINED\\_ORGANIZATIONS\\_NO\\_MEMBERS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L104)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_LIST\n\n> `const` **USER\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L142)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_ADMIN.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_LIST\\_FOR\\_ADMIN\n\n> `const` **USER\\_LIST\\_FOR\\_ADMIN**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L217)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_LIST_FOR_TABLE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_LIST\\_FOR\\_TABLE\n\n> `const` **USER\\_LIST\\_FOR\\_TABLE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L182)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/Queries/variables/USER_ORGANIZATION_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_ORGANIZATION\\_LIST\n\n> `const` **USER\\_ORGANIZATION\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/Queries.ts:922](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/Queries.ts#L922)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FUND\\_CAMPAIGN\n\n> `const` **FUND\\_CAMPAIGN**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/fundQueries.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L51)\n\nQuery to fetch a specific fund by its ID, along with its associated campaigns.\n\n## Param\n\nThe ID of the fund campaign to be fetched.\n\n## Param\n\nThe name of the fund campaign to be fetched.\n\n## Param\n\nThe start date of the fund campaign to be fetched.\n\n## Param\n\nThe end date of the fund campaign to be fetched.\n\n## Param\n\nThe currency code of the fund campaign to be fetched.\n\n## Param\n\nThe goal amount of the fund campaign to be fetched.\n\n## Returns\n\nThe fund campaign with the specified ID.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_CAMPAIGN_PLEDGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FUND\\_CAMPAIGN\\_PLEDGE\n\n> `const` **FUND\\_CAMPAIGN\\_PLEDGE**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/fundQueries.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L72)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/FUND_LIST.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FUND\\_LIST\n\n> `const` **FUND\\_LIST**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/fundQueries.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L13)\n\nGraphQL query to retrieve the list of members for a specific organization.\n\n## Param\n\nThe ID of the organization for which members are being retrieved.\n\n## Param\n\nThe name of the organization for which members are being retrieved.\n\n## Param\n\nThe ID of the creator of the organization.\n\n## Param\n\nThe ID of the user who last updated the organization.\n\n## Param\n\nA boolean value indicating whether the organization is tax deductible.\n\n## Returns\n\nThe list of members associated with the organization.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_FUND_CAMPAIGNS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_FUND\\_CAMPAIGNS\n\n> `const` **USER\\_FUND\\_CAMPAIGNS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/fundQueries.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L108)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/fundQueries/variables/USER_PLEDGES.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_PLEDGES\n\n> `const` **USER\\_PLEDGES**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/fundQueries.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/fundQueries.ts#L133)\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_ASSIGNED_MEMBERS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_TAGS\\_ASSIGNED\\_MEMBERS\n\n> `const` **USER\\_TAGS\\_ASSIGNED\\_MEMBERS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/userTagQueries.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L10)\n\nGraphQL query to retrieve organization members assigned a certain tag.\n\n## Param\n\nThe ID of the tag that is assigned.\n\n## Returns\n\nThe list of organization members.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAGS_MEMBERS_TO_ASSIGN_TO.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_TAGS\\_MEMBERS\\_TO\\_ASSIGN\\_TO\n\n> `const` **USER\\_TAGS\\_MEMBERS\\_TO\\_ASSIGN\\_TO**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/userTagQueries.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L119)\n\nGraphQL query to retrieve organization members that aren't assigned a certain tag.\n\n## Param\n\nThe ID of the tag.\n\n## Returns\n\nThe list of organization members.\n" }, { "path": "docs/docs/auto-docs/GraphQl/Queries/userTagQueries/variables/USER_TAG_SUB_TAGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: USER\\_TAG\\_SUB\\_TAGS\n\n> `const` **USER\\_TAG\\_SUB\\_TAGS**: `DocumentNode`\n\nDefined in: [src/GraphQl/Queries/userTagQueries.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/GraphQl/Queries/userTagQueries.ts#L60)\n\nGraphQL query to retrieve the sub tags of a certain tag.\n\n## Param\n\nThe ID of the parent tag.\n\n## Returns\n\nThe list of sub tags.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTag/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAddPeopleToTagProps`](../../../../../types/AdminPortal/Tag/interface/interfaces/InterfaceAddPeopleToTagProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTag.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTag.tsx#L76)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first`: `number`; `id`: `string`; `tagId?`: `undefined`; `userIds?`: `undefined`; `where`: \\{ `firstName`: \\{ `starts_with`: `string`; \\}; `lastName`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `addPeopleToUserTag?`: `undefined`; `getUsersToAssignTo`: \\{ `name`: `string`; `usersToAssignTo`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \\}; `totalCount`: `number`; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `string`; `first`: `number`; `id`: `string`; `tagId?`: `undefined`; `userIds?`: `undefined`; `where`: \\{ `firstName`: \\{ `starts_with`: `string`; \\}; `lastName`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `addPeopleToUserTag?`: `undefined`; `getUsersToAssignTo`: \\{ `name`: `string`; `usersToAssignTo`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \\}; `totalCount`: `number`; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `id?`: `undefined`; `tagId`: `string`; `userIds`: `string`[]; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `addPeopleToUserTag`: \\{ `_id`: `string`; \\}; `getUsersToAssignTo?`: `undefined`; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L5)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCKS_ERROR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_ERROR\n\n> `const` **MOCKS\\_ERROR**: `object`[]\n\nDefined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L277)\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `USER_TAGS_MEMBERS_TO_ASSIGN_TO`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.first\n\n> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE`\n\n#### request.variables.id\n\n> **id**: `string` = `'1'`\n\n#### request.variables.where\n\n> **where**: `object`\n\n#### request.variables.where.firstName\n\n> **firstName**: `object`\n\n#### request.variables.where.firstName.starts\\_with\n\n> **starts\\_with**: `string` = `''`\n\n#### request.variables.where.lastName\n\n> **lastName**: `object`\n\n#### request.variables.where.lastName.starts\\_with\n\n> **starts\\_with**: `string` = `''`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_EMPTY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCK\\_EMPTY\n\n> `const` **MOCK\\_EMPTY**: `object`[]\n\nDefined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L294)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `USER_TAGS_MEMBERS_TO_ASSIGN_TO`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.first\n\n> **first**: `number` = `TAGS_QUERY_DATA_CHUNK_SIZE`\n\n#### request.variables.id\n\n> **id**: `string` = `'1'`\n\n#### request.variables.where\n\n> **where**: `object`\n\n#### request.variables.where.firstName\n\n> **firstName**: `object`\n\n#### request.variables.where.firstName.starts\\_with\n\n> **starts\\_with**: `string` = `''`\n\n#### request.variables.where.lastName\n\n> **lastName**: `object`\n\n#### request.variables.where.lastName.starts\\_with\n\n> **starts\\_with**: `string` = `''`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.getUsersToAssignTo\n\n> **getUsersToAssignTo**: `object`\n\n#### result.data.getUsersToAssignTo.usersToAssignTo\n\n> **usersToAssignTo**: `object`\n\n#### result.data.getUsersToAssignTo.usersToAssignTo.edges\n\n> **edges**: `any`[] = `[]`\n\n#### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo\n\n> **pageInfo**: `object`\n\n#### result.data.getUsersToAssignTo.usersToAssignTo.pageInfo.hasNextPage\n\n> **hasNextPage**: `boolean` = `false`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks/variables/MOCK_NON_ERROR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCK\\_NON\\_ERROR\n\n> `const` **MOCK\\_NON\\_ERROR**: (\\{ `error?`: `undefined`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `first`: `number`; `id`: `string`; `tagId?`: `undefined`; `userIds?`: `undefined`; `where`: \\{ `firstName`: \\{ `starts_with`: `string`; \\}; `lastName`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `getUsersToAssignTo`: \\{ `usersToAssignTo`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `string`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `first?`: `undefined`; `id?`: `undefined`; `tagId`: `string`; `userIds`: `string`[]; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\})[]\n\nDefined in: [src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AddPeopleToTag/AddPeopleToTagsMocks.ts#L322)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/Advertisements/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/Advertisements/Advertisements.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/Advertisements.tsx#L51)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/functions/wait.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: wait()\n\n> **wait**(`ms`): `Promise`\\<`void`\\>\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L199)\n\n## Parameters\n\n### ms\n\n`number` = `100`\n\n## Returns\n\n`Promise`\\<`void`\\>\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/client.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: client\n\n> `const` **client**: `ApolloClient`\\<`NormalizedCacheObject`\\>\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L191)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisement.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdvertisement\n\n> `const` **createAdvertisement**: (`IAdvertisementListMock` \\| `IBaseMutationMock`\\<\\{ `endAt`: `string`; `name`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \\}\\>)[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:465](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L465)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementError.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdvertisementError\n\n> `const` **createAdvertisementError**: `IBaseMutationMock`\\<\\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \\}\\>[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:517](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L517)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementWithEndDateBeforeStart.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdvertisementWithEndDateBeforeStart\n\n> `const` **createAdvertisementWithEndDateBeforeStart**: `IBaseMutationMock`\\<\\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \\}\\>[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:504](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L504)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createAdvertisementWithoutName.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdvertisementWithoutName\n\n> `const` **createAdvertisementWithoutName**: `IBaseMutationMock`\\<\\{ `endAt`: `string`; `organizationId`: `string`; `startAt`: `string`; `type`: `string`; \\}\\>[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:491](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L491)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/createDates.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createDates\n\n> **createDates**: `object`\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L173)\n\n## Type Declaration\n\n### endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'`\n\n### endAtISO\n\n> **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'`\n\n### endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n### endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n### endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n### endISOReceived\n\n> **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'`\n\n### startAtCalledWith\n\n> **startAtCalledWith**: `string`\n\n### startAtISO\n\n> **startAtISO**: `string`\n\n### startISOReceived\n\n> **startISOReceived**: `string`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/dateConstants.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dateConstants\n\n> `const` **dateConstants**: `object`\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L138)\n\n## Type Declaration\n\n### create\n\n> **create**: `object`\n\n#### create.endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'`\n\n#### create.endAtISO\n\n> **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'`\n\n#### create.endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n#### create.endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n#### create.endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n#### create.endISOReceived\n\n> **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'`\n\n#### create.startAtCalledWith\n\n> **startAtCalledWith**: `string`\n\n#### create.startAtISO\n\n> **startAtISO**: `string`\n\n#### create.startISOReceived\n\n> **startISOReceived**: `string`\n\n### update\n\n> **update**: `object`\n\n#### update.endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'`\n\n#### update.endAtISO\n\n> **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'`\n\n#### update.endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n#### update.endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n#### update.endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n#### update.endISOReceived\n\n> **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'`\n\n#### update.startAtCalledWith\n\n> **startAtCalledWith**: `string`\n\n#### update.startAtISO\n\n> **startAtISO**: `string`\n\n#### update.startISOReceived\n\n> **startISOReceived**: `string`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/deleteAdvertisementMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: deleteAdvertisementMocks\n\n> `const` **deleteAdvertisementMocks**: (`IAdvertisementListMock` \\| `IBaseMutationMock`\\<\\{ `id`: `string`; \\}\\>)[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:357](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L357)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/emptyMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyMocks\n\n> `const` **emptyMocks**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L318)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/fetchErrorMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: fetchErrorMocks\n\n> `const` **fetchErrorMocks**: `IBaseMutationMock`\\<\\{ `after`: `any`; `first`: `number`; `id`: `string`; `where`: \\{ `isCompleted`: `boolean`; \\}; \\}\\>[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L568)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/filterActiveAdvertisementData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: filterActiveAdvertisementData\n\n> `const` **filterActiveAdvertisementData**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L437)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/filterCompletedAdvertisementData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: filterCompletedAdvertisementData\n\n> `const` **filterCompletedAdvertisementData**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:451](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L451)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/getActiveAdvertisementMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: getActiveAdvertisementMocks\n\n> `const` **getActiveAdvertisementMocks**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:352](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L352)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/getCompletedAdvertisementMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: getCompletedAdvertisementMocks\n\n> `const` **getCompletedAdvertisementMocks**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:347](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L347)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/initialActiveData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: initialActiveData\n\n> `const` **initialActiveData**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:404](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L404)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/initialArchivedData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: initialArchivedData\n\n> `const` **initialArchivedData**: `IAdvertisementListMock`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L371)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/link.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: link\n\n> `const` **link**: `ApolloLink`\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L189)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/updateAdMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: updateAdMocks\n\n> `const` **updateAdMocks**: (`IAdvertisementListMock` \\| `IBaseMutationMock`\\<\\{ `description`: `string`; `endAt`: `string`; `id`: `string`; `startAt`: `string`; \\}\\>)[]\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:531](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L531)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/AdvertisementsMocks/variables/updateDates.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: updateDates\n\n> **updateDates**: `object`\n\nDefined in: [src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/AdvertisementsMocks.ts#L173)\n\n## Type Declaration\n\n### endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'`\n\n### endAtISO\n\n> **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'`\n\n### endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n### endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n### endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n### endISOReceived\n\n> **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'`\n\n### startAtCalledWith\n\n> **startAtCalledWith**: `string`\n\n### startAtISO\n\n> **startAtISO**: `string`\n\n### startISOReceived\n\n> **startISOReceived**: `string`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementEntry/AdvertisementEntry/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementEntry/AdvertisementEntry.tsx#L55)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n#### advertisement\n\n[`Advertisement`](../../../../../../../types/AdminPortal/Advertisement/type/type-aliases/Advertisement.md)\n\n#### setAfterActive\n\n`Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\n#### setAfterCompleted\n\n`Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegister/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegister.tsx#L74)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceAddOnRegisterProps`](../../../../../../../types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnRegisterProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/createAdFailMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdFailMock\n\n> `const` **createAdFailMock**: `MockedResponse`\\<`Record`\\<`string`, `any`\\>, `Record`\\<`string`, `any`\\>\\>\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L163)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/createAdvertisement.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: createAdvertisement\n\n> `const` **createAdvertisement**: `MockedResponse`\\<`Record`\\<`string`, `any`\\>, `Record`\\<`string`, `any`\\>\\>[]\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L191)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/dateConstants.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dateConstants\n\n> `const` **dateConstants**: `object`\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L27)\n\n## Type Declaration\n\n### create\n\n> **create**: `object`\n\n#### create.endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2030-02-01T00:00:00.000Z'`\n\n#### create.endAtISO\n\n> **endAtISO**: `string` = `'2030-02-01T18:30:00.000Z'`\n\n#### create.endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n#### create.endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n#### create.endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n#### create.endISOReceived\n\n> **endISOReceived**: `string` = `'2030-01-31T18:30:00.000Z'`\n\n#### create.startAtCalledWith\n\n> **startAtCalledWith**: `string`\n\n#### create.startAtISO\n\n> **startAtISO**: `string`\n\n#### create.startISOReceived\n\n> **startISOReceived**: `string`\n\n### update\n\n> **update**: `object`\n\n#### update.endAtCalledWith\n\n> **endAtCalledWith**: `string` = `'2040-02-01T00:00:00.000Z'`\n\n#### update.endAtISO\n\n> **endAtISO**: `string` = `'2040-02-01T18:30:00.000Z'`\n\n#### update.endBeforeStartCalledWith\n\n> **endBeforeStartCalledWith**: `string` = `'2010-02-01T00:00:00.000Z'`\n\n#### update.endBeforeStartISO\n\n> **endBeforeStartISO**: `string` = `'2010-02-01T18:30:00.000Z'`\n\n#### update.endBeforeStartISOReceived\n\n> **endBeforeStartISOReceived**: `string` = `'2010-01-31T18:30:00.000Z'`\n\n#### update.endISOReceived\n\n> **endISOReceived**: `string` = `'2040-01-31T18:30:00.000Z'`\n\n#### update.startAtCalledWith\n\n> **startAtCalledWith**: `string` = `'2020-12-31T00:00:00.000Z'`\n\n#### update.startAtISO\n\n> **startAtISO**: `string` = `'2020-12-31T18:30:00.000Z'`\n\n#### update.startISOReceived\n\n> **startISOReceived**: `string`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/mockBigFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockBigFile\n\n> `const` **mockBigFile**: `File`\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L19)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/mockFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockFile\n\n> `const` **mockFile**: `File`\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L15)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks/variables/updateAdFailMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: updateAdFailMock\n\n> `const` **updateAdFailMock**: `MockedResponse`\\<`Record`\\<`string`, `any`\\>, `Record`\\<`string`, `any`\\>\\>\n\nDefined in: [src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/core/AdvertisementRegister/AdvertisementRegisterMocks.ts#L177)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Advertisements/skeleton/AdvertisementSkeleton/functions/AdvertisementSkeleton.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: AdvertisementSkeleton()\n\n> **AdvertisementSkeleton**(): `Element`[]\n\nDefined in: [src/components/AdminPortal/Advertisements/skeleton/AdvertisementSkeleton.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Advertisements/skeleton/AdvertisementSkeleton.tsx#L23)\n\nAdvertisementSkeleton Component\n\nThis component renders a skeleton loader for advertisements, typically used\nas a placeholder while the actual advertisement data is being fetched or loaded.\nIt creates a list of 6 skeleton items, each styled to resemble the layout of an\nadvertisement card.\n\nEach skeleton item includes:\n- A shimmering image container to represent the advertisement image.\n- A shimmering title placeholder to represent the advertisement name.\n- A shimmering button placeholder.\n\nThe skeleton items are styled using CSS classes provided by the `styles` object,\nand each item is uniquely identified with a `data-testid` attribute for testing purposes.\n\n## Returns\n\n`Element`[]\n\nAn array of JSX elements representing the skeleton loaders.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaFolder/AgendaFolderContainer/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/AgendaFolder/AgendaFolderContainer.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/AgendaFolderContainer.tsx#L49)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n#### agendaFolderConnection\n\n`\"Event\"`\n\n#### agendaFolderData\n\n[`InterfaceAgendaFolderInfo`](../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderInfo.md)[]\n\n#### agendaItemCategories\n\n[`InterfaceAgendaItemCategoryInfo`](../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryInfo.md)[]\n\n#### refetchAgendaFolder\n\n() => `void`\n\n#### t\n\n(`key`) => `string`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Create/AgendaFolderCreateModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaFolderCreateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaFolder/Create/AgendaFolderCreateModal.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/Create/AgendaFolderCreateModal.tsx#L33)\n\nAgendaFolderCreateModal\n\nModal component for creating a new agenda folder within an event.\nCalculates the next folder sequence based on existing folders and\nsubmits the creation request via GraphQL.\n\nDisplays validation and mutation feedback using NotificationToast\nand refreshes agenda folder data on successful creation.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nID of the event the folder belongs to\n\n## Param\n\nExisting agenda folder data for sequence calculation\n\n## Param\n\ni18n translation function\n\n## Param\n\nRefetches agenda folder data after creation\n\n## Returns\n\nJSX.Element | null\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Delete/AgendaFolderDeleteModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaFolderDeleteModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderDeleteModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaFolder/Delete/AgendaFolderDeleteModal.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/Delete/AgendaFolderDeleteModal.tsx#L26)\n\nAgendaFolderDeleteModal\n\nConfirmation modal for deleting an agenda folder.\nUses `DeleteModal` to provide consistent delete confirmation UI.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nID of the agenda folder to delete\n\n## Param\n\nRefetches agenda folder data after deletion\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaFolder/DragAndDrop/AgendaDragAndDrop/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`folders`): `Element`\n\nDefined in: [src/components/AdminPortal/AgendaFolder/DragAndDrop/AgendaDragAndDrop.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/DragAndDrop/AgendaDragAndDrop.tsx#L42)\n\nAgendaDragAndDrop\n\nRenders draggable agenda folders and items with support for reordering.\nHandles folder-level and item-level drag-and-drop with optimistic UI updates\nand backend sequence synchronization.\n\n## Parameters\n\n### folders\n\n[`InterfaceAgendaDragAndDropProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaDragAndDropProps.md)\n\nList of agenda folders with their items\n\n## Returns\n\n`Element`\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaFolder/Update/AgendaFolderUpdateModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaFolderUpdateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaFolder/Update/AgendaFolderUpdateModal.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaFolder/Update/AgendaFolderUpdateModal.tsx#L30)\n\nAgendaFolderUpdateModal\n\nEdit modal for updating an existing agenda folder.\nUses the shared `EditModal` for consistent update behavior.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nCurrent agenda folder form state\n\n## Param\n\nSetter for agenda folder form state\n\n## Param\n\nID of the agenda folder being updated\n\n## Param\n\nRefetches agenda folder data after update\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaItems/Create/AgendaItemsCreateModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaItemsCreateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsCreateModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaItems/Create/AgendaItemsCreateModal.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaItems/Create/AgendaItemsCreateModal.tsx#L49)\n\nAgendaItemsCreateModal\n\nCreate modal for adding a new agenda item.\nBuilt on `CreateModal` for consistent create UX and loading handling.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nID of the event\n\n## Param\n\nAvailable agenda item categories\n\n## Param\n\nAvailable agenda folders\n\n## Param\n\nRefetches agenda folder data after creation\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaItems/Delete/AgendaItemsDeleteModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaItemsDeleteModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsDeleteModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaItems/Delete/AgendaItemsDeleteModal.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaItems/Delete/AgendaItemsDeleteModal.tsx#L26)\n\nAgendaItemsDeleteModal\n\nConfirmation modal for deleting an agenda item.\nUses the shared `DeleteModal` for standardized delete behavior.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nID of the agenda item to delete\n\n## Param\n\nRefetches agenda folder data after deletion\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaItems/Preview/AgendaItemsPreviewModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaItemsPreviewModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsPreviewModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaItems/Preview/AgendaItemsPreviewModal.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaItems/Preview/AgendaItemsPreviewModal.tsx#L19)\n\nAgendaItemsPreviewModal\nRead-only preview modal for agenda item details rendered in `ViewModal`.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the preview modal\n\n## Param\n\nAgenda item data to display\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AgendaItems/Update/AgendaItemsUpdateModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAgendaItemsUpdateModalProps`](../../../../../../types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsUpdateModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AgendaItems/Update/AgendaItemsUpdateModal.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AgendaItems/Update/AgendaItemsUpdateModal.tsx#L51)\n\nAgendaItemsUpdateModal\n\nEdit modal for updating an existing agenda item.\nUses `EditModal` to handle submission, loading, and keyboard actions.\n\n## Param\n\nControls modal visibility\n\n## Param\n\nCallback to close the modal\n\n## Param\n\nID of the agenda item being updated\n\n## Param\n\nCurrent agenda item form state\n\n## Param\n\nSetter for agenda item form state\n\n## Param\n\nAvailable agenda item categories\n\n## Param\n\nAvailable agenda folders\n\n## Param\n\nRefetches agenda folder data after update\n\n## Param\n\ni18n translation function\n\n## Returns\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/ApplyToSelector/ApplyToSelector/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceApplyToSelectorProps`](../../../../../types/AdminPortal/ApplyToSelector/interface/interfaces/InterfaceApplyToSelectorProps.md)\\>\n\nDefined in: [src/components/AdminPortal/ApplyToSelector/ApplyToSelector.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/ApplyToSelector/ApplyToSelector.tsx#L18)\n\nA radio group selector for choosing action item scope.\nAllows users to apply an action item to an entire series or a single instance.\n\n## Param\n\nComponent props from InterfaceApplyToSelectorProps\n\n## Returns\n\nRadio group component for scope selection\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAssignmentTypeSelectorProps`](../../../../../types/AdminPortal/AssignmentTypeSelector/interface/interfaces/InterfaceAssignmentTypeSelectorProps.md)\\>\n\nDefined in: [src/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/AssignmentTypeSelector/AssignmentTypeSelector.tsx#L17)\n\nChip-based toggle selector for choosing assignment type (volunteer or volunteer group).\n\n## Param\n\nComponent props from InterfaceAssignmentTypeSelectorProps\n\n## Returns\n\nChip toggle component for assignment type selection\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/ContriStats/ContriStats/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/ContriStats/ContriStats.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/ContriStats/ContriStats.tsx#L32)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceContriStatsProps`](../../../../../types/AdminPortal/Contribution/interface/interfaces/InterfaceContriStatsProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.tsx#L44)\n\n## Parameters\n\n### props\n\n#### eventId\n\n`string`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_EMPTY_DATE_STRINGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_EMPTY\\_DATE\\_STRINGS\n\n> `const` **MOCKS\\_EMPTY\\_DATE\\_STRINGS**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L231)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'Test Description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string` = `''`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'India'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string` = `''`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_INVALID_DATETIME.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_INVALID\\_DATETIME\n\n> `const` **MOCKS\\_INVALID\\_DATETIME**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L165)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'Test Description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'India'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_MISSING_DATA.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_MISSING\\_DATA\n\n> `const` **MOCKS\\_MISSING\\_DATA**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L114)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `any` = `null`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_NO_EVENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_NO\\_EVENT\n\n> `const` **MOCKS\\_NO\\_EVENT**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L100)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `any` = `null`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_NO_LOCATION.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_NO\\_LOCATION\n\n> `const` **MOCKS\\_NO\\_LOCATION**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L126)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `''`\n\n#### result.data.event.endAt\n\n> **endAt**: `string`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `any` = `null`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_UNDEFINED_INVITE_ONLY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_UNDEFINED\\_INVITE\\_ONLY\n\n> `const` **MOCKS\\_UNDEFINED\\_INVITE\\_ONLY**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L204)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'Test Description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `any` = `undefined`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'India'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITHOUT_TIME.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_WITHOUT\\_TIME\n\n> `const` **MOCKS\\_WITHOUT\\_TIME**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L73)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `true`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'Test Description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'India'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks/variables/MOCKS_WITH_TIME.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_WITH\\_TIME\n\n> `const` **MOCKS\\_WITH\\_TIME**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/Dashboard/EventDashboard.mocks.ts#L34)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.baseEvent\n\n> **baseEvent**: `any` = `null`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2023-01-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'john.doe@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator1'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'John Doe'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'Test Description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean` = `false`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'India'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org1'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `any` = `null`\n\n#### result.data.event.startAt\n\n> **startAt**: `string`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2023-01-02T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater1'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Person'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventActionItems/EventActionItems/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<`InterfaceEventActionItemsProps`\\>\n\nDefined in: [src/components/AdminPortal/EventManagement/EventActionItems/EventActionItems.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventActionItems/EventActionItems.tsx#L76)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAgenda/EventAgenda/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAgenda/EventAgenda.tsx:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAgenda/EventAgenda.tsx#L55)\n\n## Parameters\n\n### props\n\n#### eventId\n\n`string`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/Attendance/EventAttendance/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/Attendance/EventAttendance.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/Attendance/EventAttendance.tsx#L53)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/AttendanceList/AttendedEventList/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<`Partial`\\<[`InterfaceEvent`](../../../../../../../types/Event/interface/type-aliases/InterfaceEvent.md)\\>\\>\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/AttendanceList/AttendedEventList.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/AttendanceList/AttendedEventList.tsx#L42)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKDETAIL.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKDETAIL\n\n> `const` **MOCKDETAIL**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts#L34)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_DETAILS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object` = `MOCKEVENT`\n\n#### result.data.event.allDay\n\n> **allDay**: `boolean` = `false`\n\n#### result.data.event.createdAt\n\n> **createdAt**: `string` = `'2030-04-01T00:00:00.000Z'`\n\n#### result.data.event.creator\n\n> **creator**: `object`\n\n#### result.data.event.creator.emailAddress\n\n> **emailAddress**: `string` = `'creator@example.com'`\n\n#### result.data.event.creator.id\n\n> **id**: `string` = `'creator123'`\n\n#### result.data.event.creator.name\n\n> **name**: `string` = `'Creator Name'`\n\n#### result.data.event.description\n\n> **description**: `string` = `'This is a test event description'`\n\n#### result.data.event.endAt\n\n> **endAt**: `string` = `'2030-05-02T17:00:00.000Z'`\n\n#### result.data.event.id\n\n> **id**: `string` = `'event123'`\n\n#### result.data.event.isPublic\n\n> **isPublic**: `boolean` = `true`\n\n#### result.data.event.isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n#### result.data.event.location\n\n> **location**: `string` = `'Test Location'`\n\n#### result.data.event.name\n\n> **name**: `string` = `'Test Event'`\n\n#### result.data.event.organization\n\n> **organization**: `object`\n\n#### result.data.event.organization.id\n\n> **id**: `string` = `'org456'`\n\n#### result.data.event.organization.name\n\n> **name**: `string` = `'Test Organization'`\n\n#### result.data.event.recurrenceRule\n\n> **recurrenceRule**: `object`\n\n#### result.data.event.recurrenceRule.id\n\n> **id**: `string` = `'recurringEvent123'`\n\n#### result.data.event.startAt\n\n> **startAt**: `string` = `'2030-05-01T09:00:00.000Z'`\n\n#### result.data.event.updatedAt\n\n> **updatedAt**: `string` = `'2030-04-01T00:00:00.000Z'`\n\n#### result.data.event.updater\n\n> **updater**: `object`\n\n#### result.data.event.updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### result.data.event.updater.id\n\n> **id**: `string` = `'updater123'`\n\n#### result.data.event.updater.name\n\n> **name**: `string` = `'Updater Name'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKEVENT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKEVENT\n\n> `const` **MOCKEVENT**: `object`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts#L3)\n\n## Type Declaration\n\n### allDay\n\n> **allDay**: `boolean` = `false`\n\n### createdAt\n\n> **createdAt**: `string` = `'2030-04-01T00:00:00.000Z'`\n\n### creator\n\n> **creator**: `object`\n\n#### creator.emailAddress\n\n> **emailAddress**: `string` = `'creator@example.com'`\n\n#### creator.id\n\n> **id**: `string` = `'creator123'`\n\n#### creator.name\n\n> **name**: `string` = `'Creator Name'`\n\n### description\n\n> **description**: `string` = `'This is a test event description'`\n\n### endAt\n\n> **endAt**: `string` = `'2030-05-02T17:00:00.000Z'`\n\n### id\n\n> **id**: `string` = `'event123'`\n\n### isPublic\n\n> **isPublic**: `boolean` = `true`\n\n### isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n### location\n\n> **location**: `string` = `'Test Location'`\n\n### name\n\n> **name**: `string` = `'Test Event'`\n\n### organization\n\n> **organization**: `object`\n\n#### organization.id\n\n> **id**: `string` = `'org456'`\n\n#### organization.name\n\n> **name**: `string` = `'Test Organization'`\n\n### recurrenceRule\n\n> **recurrenceRule**: `object`\n\n#### recurrenceRule.id\n\n> **id**: `string` = `'recurringEvent123'`\n\n### startAt\n\n> **startAt**: `string` = `'2030-05-01T09:00:00.000Z'`\n\n### updatedAt\n\n> **updatedAt**: `string` = `'2030-04-01T00:00:00.000Z'`\n\n### updater\n\n> **updater**: `object`\n\n#### updater.emailAddress\n\n> **emailAddress**: `string` = `'updater@example.com'`\n\n#### updater.id\n\n> **id**: `string` = `'updater123'`\n\n#### updater.name\n\n> **name**: `string` = `'Updater Name'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: `object`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/EventAttendanceMocks.ts#L48)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_ATTENDEES`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.attendees\n\n> **attendees**: (\\{ `avatarURL`: `any`; `birthDate`: `any`; `createdAt`: `string`; `emailAddress`: `string`; `eventsAttended`: `object`[]; `id`: `string`; `name`: `string`; `natalSex`: `any`; `role`: `string`; `tagsAssignedWith?`: `undefined`; \\} \\| \\{ `avatarURL`: `any`; `birthDate`: `any`; `createdAt`: `string`; `emailAddress`: `string`; `eventsAttended`: `any`; `id`: `string`; `name`: `string`; `natalSex`: `any`; `role`: `string`; `tagsAssignedWith`: \\{ `edges`: `object`[]; \\}; \\})[]\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventAttendance/Statistics/EventStatistics/variables/AttendanceStatisticsModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: AttendanceStatisticsModal\n\n> `const` **AttendanceStatisticsModal**: `React.FC`\\<[`InterfaceAttendanceStatisticsModalProps`](../../../../../../../types/Event/interface/type-aliases/InterfaceAttendanceStatisticsModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/EventManagement/EventAttendance/Statistics/EventStatistics.tsx:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventAttendance/Statistics/EventStatistics.tsx#L102)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/EventRegistrants/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/EventRegistrants.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/EventRegistrants.tsx#L56)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/COMBINED_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: COMBINED\\_MOCKS\n\n> `const` **COMBINED\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L234)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_EVENT_CHECKINS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EMPTY\\_EVENT\\_CHECKINS\\_MOCK\n\n> `const` **EMPTY\\_EVENT\\_CHECKINS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L69)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_REGISTRANTS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EMPTY\\_REGISTRANTS\\_MOCK\n\n> `const` **EMPTY\\_REGISTRANTS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L117)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EMPTY_STATE_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EMPTY\\_STATE\\_MOCKS\n\n> `const` **EMPTY\\_STATE\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L242)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/ERROR_DELETION_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ERROR\\_DELETION\\_MOCKS\n\n> `const` **ERROR\\_DELETION\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L266)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EVENT_CHECKINS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_CHECKINS\\_MOCK\n\n> `const` **EVENT\\_CHECKINS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L46)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/EVENT_DETAILS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EVENT\\_DETAILS\\_MOCK\n\n> `const` **EVENT\\_DETAILS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L13)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/MISSING_DATE_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MISSING\\_DATE\\_MOCKS\n\n> `const` **MISSING\\_DATE\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:254](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L254)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/MISSING_NAME_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MISSING\\_NAME\\_MOCKS\n\n> `const` **MISSING\\_NAME\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:260](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L260)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_DETAILS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RECURRING\\_EVENT\\_DETAILS\\_MOCK\n\n> `const` **RECURRING\\_EVENT\\_DETAILS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L29)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RECURRING\\_EVENT\\_MOCKS\n\n> `const` **RECURRING\\_EVENT\\_MOCKS**: `MockedResponse`[]\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L248)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/RECURRING_EVENT_REGISTRANTS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RECURRING\\_EVENT\\_REGISTRANTS\\_MOCK\n\n> `const` **RECURRING\\_EVENT\\_REGISTRANTS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L129)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_ERROR_USER_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REGISTRANTS\\_ERROR\\_USER\\_MOCK\n\n> `const` **REGISTRANTS\\_ERROR\\_USER\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L187)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MISSING_DATE_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REGISTRANTS\\_MISSING\\_DATE\\_MOCK\n\n> `const` **REGISTRANTS\\_MISSING\\_DATE\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L141)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MISSING_NAME_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REGISTRANTS\\_MISSING\\_NAME\\_MOCK\n\n> `const` **REGISTRANTS\\_MISSING\\_NAME\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L164)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REGISTRANTS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REGISTRANTS\\_MOCK\n\n> `const` **REGISTRANTS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L84)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REMOVE_ATTENDEE_ERROR_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_ATTENDEE\\_ERROR\\_MOCK\n\n> `const` **REMOVE\\_ATTENDEE\\_ERROR\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L225)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks/variables/REMOVE_ATTENDEE_SUCCESS_MOCK.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: REMOVE\\_ATTENDEE\\_SUCCESS\\_MOCK\n\n> `const` **REMOVE\\_ATTENDEE\\_SUCCESS\\_MOCK**: `MockedResponse`\n\nDefined in: [src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts:211](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventManagement/EventRegistrant/Registrations.mocks.ts#L211)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper/functions/EventRegistrantsWrapper.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: EventRegistrantsWrapper()\n\n> **EventRegistrantsWrapper**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper.tsx:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventRegistrantsModal/EventRegistrantsWrapper.tsx#L37)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceEventRegistrantsWrapperProps`](../../../../../types/AdminPortal/EventRegistrantsWrapper/interface/interfaces/InterfaceEventRegistrantsWrapperProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/AddOnSpot/AddOnSpotAttendee/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceAddOnSpotAttendeeProps`](../../../../../../../types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceAddOnSpotAttendeeProps.md)\\>\n\nDefined in: [src/components/AdminPortal/EventRegistrantsModal/Modal/AddOnSpot/AddOnSpotAttendee.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventRegistrantsModal/Modal/AddOnSpot/AddOnSpotAttendee.tsx#L53)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/EventRegistrantsModal/functions/EventRegistrantsModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: EventRegistrantsModal()\n\n> **EventRegistrantsModal**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/EventRegistrantsModal/Modal/EventRegistrantsModal.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventRegistrantsModal/Modal/EventRegistrantsModal.tsx#L63)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceEventRegistrantsModalProps`](../../../../../../types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceEventRegistrantsModalProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/EventRegistrantsModal/Modal/InviteByEmail/InviteByEmailModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceInviteByEmailModalProps`](../../../../../../../types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface/interfaces/InterfaceInviteByEmailModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/EventRegistrantsModal/Modal/InviteByEmail/InviteByEmailModal.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/EventRegistrantsModal/Modal/InviteByEmail/InviteByEmailModal.tsx#L42)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/LeftDrawer/LeftDrawer/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `ReactElement`\n\nDefined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L36)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`ILeftDrawerProps`](../interfaces/ILeftDrawerProps.md)\n\n## Returns\n\n`ReactElement`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/LeftDrawer/LeftDrawer/interfaces/ILeftDrawerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ILeftDrawerProps\n\nDefined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L31)\n\n## Properties\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L32)\n\n***\n\n### setHideDrawer\n\n> **setHideDrawer**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/LeftDrawer/LeftDrawer.tsx#L33)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgContriCards/OrgContriCards/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/OrgContriCards/OrgContriCards.tsx:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgContriCards/OrgContriCards.tsx#L37)\n\n## Parameters\n\n### props\n\n[`InterfaceOrgContriCardsProps`](../../../../../types/AdminPortal/Contribution/interface/interfaces/InterfaceOrgContriCardsProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgPeopleListCard/OrgPeopleListCard.tsx#L45)\n\n## Parameters\n\n### props\n\n[`InterfaceOrgPeopleListCardProps`](../../../../../types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPeopleListCardProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal/interfaces/IActionItemCategoryModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IActionItemCategoryModal\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L18)\n\n## Properties\n\n### category\n\n> **category**: [`IActionItemCategoryInfo`](../../../../../../../types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md)\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L23)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L20)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L19)\n\n***\n\n### mode\n\n> **mode**: `\"create\"` \\| `\"edit\"`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L24)\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L22)\n\n***\n\n### refetchCategories()\n\n> **refetchCategories**: () => `void`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L21)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `FC`\\<[`IActionItemCategoryModal`](../interfaces/IActionItemCategoryModal.md)\\>\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryModal.tsx#L27)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal/interfaces/ICategoryViewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICategoryViewModalProps\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx#L16)\n\n## Properties\n\n### category\n\n> **category**: [`IActionItemCategoryInfo`](../../../../../../../types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md)\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx#L19)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx#L18)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx#L17)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `FC`\\<[`ICategoryViewModalProps`](../interfaces/ICategoryViewModalProps.md)\\>\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/Modal/ActionItemCategoryViewModal.tsx#L22)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategories/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `FC`\\<`IActionItemCategoryProps`\\>\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategories.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategories.tsx#L74)\n\nRepresents the component for managing organization action item categories.\nThis component allows creating, updating, enabling, and disabling action item categories.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id?`: `undefined`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization`: `object`[]; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id?`: `undefined`; `isDisabled`: `boolean`; `name`: `string`; `organizationId`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory`: \\{ `__typename`: `string`; `createdAt`: `string`; `creator`: \\{ `__typename`: `string`; `id`: `string`; \\}; `description`: `string`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `organization`: \\{ `__typename`: `string`; `id`: `string`; `name`: `string`; \\}; \\}; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled?`: `undefined`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id`: `string`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `any`; `id`: `string`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description`: `any`; `id`: `string`; `isDisabled?`: `undefined`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id`: `string`; `isDisabled?`: `undefined`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id`: `string`; `isDisabled`: `boolean`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory?`: `undefined`; `updateActionItemCategory`: \\{ `__typename`: `string`; `description?`: `undefined`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `actionCategoriesByOrganization?`: `undefined`; `createActionItemCategory?`: `undefined`; `deleteActionItemCategory`: \\{ `__typename`: `string`; `id`: `string`; `name`: `string`; \\}; `updateActionItemCategory?`: `undefined`; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L14)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_EMPTY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_EMPTY\n\n> `const` **MOCKS\\_EMPTY**: `object`[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L359)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `ACTION_ITEM_CATEGORY_LIST`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.input\n\n> **input**: `object`\n\n#### request.variables.input.organizationId\n\n> **organizationId**: `string` = `'orgId'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.actionCategoriesByOrganization\n\n> **actionCategoriesByOrganization**: `any`[] = `[]`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks/variables/MOCKS_ERROR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_ERROR\n\n> `const` **MOCKS\\_ERROR**: (\\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id?`: `undefined`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId`: `string`; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id?`: `undefined`; `isDisabled`: `boolean`; `name`: `string`; `organizationId`: `string`; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled?`: `undefined`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description`: `string`; `id`: `string`; `isDisabled`: `boolean`; `name`: `string`; `organizationId?`: `undefined`; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `input`: \\{ `description?`: `undefined`; `id`: `string`; `isDisabled?`: `undefined`; `name?`: `undefined`; `organizationId?`: `undefined`; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts:377](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/ActionItemCategories/OrgActionItemCategoryMocks.ts#L377)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/DeleteOrg/DeleteOrg/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/DeleteOrg/DeleteOrg.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/DeleteOrg/DeleteOrg.tsx#L25)\n\nA component for deleting an organization.\n\nIt displays a card with a delete button. When the delete button is clicked,\na modal appears asking for confirmation. Depending on the type of organization\n(sample or regular), it performs the delete operation and shows appropriate\nsuccess or error messages.\n\n## Returns\n\n`Element`\n\nJSX.Element - The rendered component with delete functionality.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/GeneralSettings/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `FC`\\<`InterfaceGeneralSettingsProps`\\>\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/GeneralSettings.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/GeneralSettings.tsx#L23)\n\nA component for displaying general settings for an organization.\n\n## Param\n\nThe properties passed to the component.\n\n## Returns\n\nThe `GeneralSettings` component.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdate/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdate.tsx:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdate.tsx#L37)\n\nComponent for updating organization details.\n\nThis component allows users to update the organization's name, description, address,\nvisibility settings, and upload an image. It uses GraphQL mutations and queries to\nfetch and update data.\n\n## Parameters\n\n### props\n\n[`InterfaceOrgUpdateProps`](../../../../../../../types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrgUpdateProps.md)\n\nComponent props containing the organization ID.\n\n## Returns\n\n`Element`\n\nThe rendered component.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/FIXED_UTC_TIMESTAMP.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FIXED\\_UTC\\_TIMESTAMP\n\n> `const` **FIXED\\_UTC\\_TIMESTAMP**: `\"2025-01-01T10:00:00.000Z\"` = `'2025-01-01T10:00:00.000Z'`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L5)\n\nFixed UTC timestamp for deterministic tests.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id`: `string`; `input?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `organization`: \\{ `__typename`: `string`; `addressLine1`: `string`; `addressLine2`: `string`; `avatarURL`: `any`; `city`: `string`; `countryCode`: `string`; `createdAt`: `string`; `description`: `string`; `id`: `string`; `isUserRegistrationRequired`: `boolean`; `name`: `string`; `postalCode`: `string`; `state`: `string`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id?`: `undefined`; `input`: \\{ `addressLine1`: `string`; `addressLine2`: `string`; `city`: `string`; `countryCode`: `string`; `description`: `string`; `id`: `string`; `isUserRegistrationRequired`: `boolean`; `name`: `string`; `postalCode`: `string`; `state`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `updateOrganization`: \\{ `__typename`: `\"Organization\"`; `addressLine1`: `string`; `addressLine2`: `string`; `avatarMimeType`: `any`; `avatarURL`: `any`; `city`: `string`; `countryCode`: `string`; `createdAt`: `string`; `description`: `string`; `id`: `string`; `isUserRegistrationRequired`: `boolean`; `name`: `string`; `postalCode`: `string`; `state`: `string`; `updatedAt`: `string`; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L66)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_QUERY_ERROR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_QUERY\\_ERROR\n\n> `const` **MOCKS\\_QUERY\\_ERROR**: `object`[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L95)\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `GET_ORGANIZATION_BASIC_DATA`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.id\n\n> **id**: `string` = `'1'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_QUERY_ERROR_FETCH.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_QUERY\\_ERROR\\_FETCH\n\n> `const` **MOCKS\\_QUERY\\_ERROR\\_FETCH**: `object`[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L106)\n\nQuery error with alternate message for \"displays error message when query fails\" test.\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `GET_ORGANIZATION_BASIC_DATA`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.id\n\n> **id**: `string` = `'1'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/MOCKS_UPDATE_ERROR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_UPDATE\\_ERROR\n\n> `const` **MOCKS\\_UPDATE\\_ERROR**: (\\{ `error?`: `undefined`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id`: `string`; `input?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `organization`: \\{ `__typename`: `string`; `addressLine1`: `string`; `addressLine2`: `string`; `avatarURL`: `any`; `city`: `string`; `countryCode`: `string`; `createdAt`: `string`; `description`: `string`; `id`: `string`; `isUserRegistrationRequired`: `boolean`; `name`: `string`; `postalCode`: `string`; `state`: `string`; \\}; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id?`: `undefined`; `input`: \\{ `addressLine1`: `string`; `addressLine2`: `string`; `city`: `string`; `countryCode`: `string`; `description`: `string`; `id`: `string`; `isUserRegistrationRequired`: `boolean`; `name`: `string`; `postalCode`: `string`; `state`: `string`; \\}; \\}; \\}; `result?`: `undefined`; \\})[]\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L116)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockOrgData\n\n> `const` **mockOrgData**: `object`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L7)\n\n## Type Declaration\n\n### organization\n\n> **organization**: `object`\n\n#### organization.\\_\\_typename\n\n> **\\_\\_typename**: `string` = `'Organization'`\n\n#### organization.addressLine1\n\n> **addressLine1**: `string` = `'123 Test St'`\n\n#### organization.addressLine2\n\n> **addressLine2**: `string` = `'Suite 100'`\n\n#### organization.avatarURL\n\n> **avatarURL**: `any` = `null`\n\n#### organization.city\n\n> **city**: `string` = `'Test City'`\n\n#### organization.countryCode\n\n> **countryCode**: `string` = `'US'`\n\n#### organization.createdAt\n\n> **createdAt**: `string` = `FIXED_UTC_TIMESTAMP`\n\n#### organization.description\n\n> **description**: `string` = `'Test Description'`\n\n#### organization.id\n\n> **id**: `string` = `'1'`\n\n#### organization.isUserRegistrationRequired\n\n> **isUserRegistrationRequired**: `boolean` = `false`\n\n#### organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### organization.postalCode\n\n> **postalCode**: `string` = `'12345'`\n\n#### organization.state\n\n> **state**: `string` = `'Test State'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgDataWithEmptyFields.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockOrgDataWithEmptyFields\n\n> `const` **mockOrgDataWithEmptyFields**: `object`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L26)\n\nVariant with empty address fields for mutation payload tests.\n\n## Type Declaration\n\n### organization\n\n> **organization**: `object`\n\n#### organization.\\_\\_typename\n\n> **\\_\\_typename**: `string` = `'Organization'`\n\n#### organization.addressLine1\n\n> **addressLine1**: `string` = `'123 Test St'`\n\n#### organization.addressLine2\n\n> **addressLine2**: `string` = `''`\n\n#### organization.avatarURL\n\n> **avatarURL**: `any` = `null`\n\n#### organization.city\n\n> **city**: `string` = `''`\n\n#### organization.countryCode\n\n> **countryCode**: `string` = `'US'`\n\n#### organization.createdAt\n\n> **createdAt**: `string` = `FIXED_UTC_TIMESTAMP`\n\n#### organization.description\n\n> **description**: `string` = `'Test Description'`\n\n#### organization.id\n\n> **id**: `string` = `'1'`\n\n#### organization.isUserRegistrationRequired\n\n> **isUserRegistrationRequired**: `boolean` = `false`\n\n#### organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### organization.postalCode\n\n> **postalCode**: `string` = `''`\n\n#### organization.state\n\n> **state**: `string` = `'Test State'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockOrgDataWithNullUserReg.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockOrgDataWithNullUserReg\n\n> `const` **mockOrgDataWithNullUserReg**: `object`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L36)\n\nVariant with null isUserRegistrationRequired for switch default tests.\n\n## Type Declaration\n\n### organization\n\n> **organization**: `object`\n\n#### organization.\\_\\_typename\n\n> **\\_\\_typename**: `string` = `'Organization'`\n\n#### organization.addressLine1\n\n> **addressLine1**: `string` = `'123 Test St'`\n\n#### organization.addressLine2\n\n> **addressLine2**: `string` = `'Suite 100'`\n\n#### organization.avatarURL\n\n> **avatarURL**: `any` = `null`\n\n#### organization.city\n\n> **city**: `string` = `'Test City'`\n\n#### organization.countryCode\n\n> **countryCode**: `string` = `'US'`\n\n#### organization.createdAt\n\n> **createdAt**: `string` = `FIXED_UTC_TIMESTAMP`\n\n#### organization.description\n\n> **description**: `string` = `'Test Description'`\n\n#### organization.id\n\n> **id**: `string` = `'1'`\n\n#### organization.isUserRegistrationRequired\n\n> **isUserRegistrationRequired**: `any` = `null`\n\n#### organization.name\n\n> **name**: `string` = `'Test Org'`\n\n#### organization.postalCode\n\n> **postalCode**: `string` = `'12345'`\n\n#### organization.state\n\n> **state**: `string` = `'Test State'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks/variables/mockUpdateOrgResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockUpdateOrgResponse\n\n> `const` **mockUpdateOrgResponse**: `object`\n\nDefined in: [src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrgSettings/General/OrgUpdate/OrgUpdateMocks.ts#L44)\n\nShared updateOrganization mutation response for test mocks; derives from mockOrgData.organization with mutation-specific fields.\n\n## Type Declaration\n\n### \\_\\_typename\n\n> **\\_\\_typename**: `\"Organization\"`\n\n### addressLine1\n\n> **addressLine1**: `string` = `'123 Test St'`\n\n### addressLine2\n\n> **addressLine2**: `string` = `'Suite 100'`\n\n### avatarMimeType\n\n> **avatarMimeType**: `any` = `null`\n\n### avatarURL\n\n> **avatarURL**: `any` = `null`\n\n### city\n\n> **city**: `string` = `'Test City'`\n\n### countryCode\n\n> **countryCode**: `string` = `'US'`\n\n### createdAt\n\n> **createdAt**: `string` = `FIXED_UTC_TIMESTAMP`\n\n### description\n\n> **description**: `string` = `'Test Description'`\n\n### id\n\n> **id**: `string` = `'1'`\n\n### isUserRegistrationRequired\n\n> **isUserRegistrationRequired**: `boolean` = `false`\n\n### name\n\n> **name**: `string` = `'Test Org'`\n\n### postalCode\n\n> **postalCode**: `string` = `'12345'`\n\n### state\n\n> **state**: `string` = `'Test State'`\n\n### updatedAt\n\n> **updatedAt**: `string` = `FIXED_UTC_TIMESTAMP`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/CardItem/CardItem/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/OrganizationDashCards/CardItem/CardItem.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationDashCards/CardItem/CardItem.tsx#L34)\n\n## Parameters\n\n### props\n\n[`InterfaceCardItem`](../../../../../../types/AdminPortal/OrganizationDashCards/CardItem/interface/interfaces/InterfaceCardItem.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/CardItem/Loader/CardItemLoading/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/OrganizationDashCards/CardItem/Loader/CardItemLoading.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationDashCards/CardItem/Loader/CardItemLoading.tsx#L33)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/DashboardCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/AdminPortal/OrganizationDashCards/DashboardCard.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationDashCards/DashboardCard.tsx#L34)\n\n## Parameters\n\n### props\n\n#### count?\n\n`number`\n\n#### icon\n\n`ReactNode`\n\n#### title\n\n`string`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationDashCards/Loader/DashboardCardLoading/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/OrganizationDashCards/Loader/DashboardCardLoading.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationDashCards/Loader/DashboardCardLoading.tsx#L40)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationScreen/OrganizationScreen/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx#L44)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/OrganizationScreen/OrganizationScreen/variables/translationKeyMap.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: translationKeyMap\n\n> `const` **translationKeyMap**: [`InterfaceMapType`](../../../../../utils/interfaces/interfaces/InterfaceMapType.md)\n\nDefined in: [src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/OrganizationScreen/OrganizationScreen.tsx#L171)\n\nMapping object to get translation keys based on route\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/SecuredRoute/SecuredRoute/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/AdminPortal/SecuredRoute/SecuredRoute.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/SecuredRoute/SecuredRoute.tsx#L40)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/SuperAdminScreen/SuperAdminScreen/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `ReactElement`\n\nDefined in: [src/components/AdminPortal/SuperAdminScreen/SuperAdminScreen.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/SuperAdminScreen/SuperAdminScreen.tsx#L31)\n\n## Returns\n\n`ReactElement`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNode/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<`InterfaceTagNodeProps`\\>\n\nDefined in: [src/components/AdminPortal/TagActions/Node/TagNode.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/Node/TagNode.tsx#L56)\n\nRenders the Tags which can be expanded to list subtags.\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNodeMocks/variables/MOCKS1.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS1\n\n> `const` **MOCKS1**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first`: `number`; `id`: `string`; \\}; \\}; `result`: \\{ `data`: \\{ `getChildTags`: \\{ `__typename`: `string`; `childTags`: \\{ `__typename`: `string`; `edges`: `object`[]; `pageInfo`: \\{ `__typename`: `string`; `endCursor`: `string`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `string`; `first`: `number`; `id`: `string`; \\}; \\}; `result`: \\{ `data`: \\{ `getChildTags`: \\{ `__typename`: `string`; `childTags`: \\{ `__typename`: `string`; `edges`: `object`[]; `pageInfo`: \\{ `__typename`: `string`; `endCursor`: `string`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/TagActions/Node/TagNodeMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/Node/TagNodeMocks.ts#L3)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/Node/TagNodeMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY1.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_ERROR\\_SUBTAGS\\_QUERY1\n\n> `const` **MOCKS\\_ERROR\\_SUBTAGS\\_QUERY1**: `object`[]\n\nDefined in: [src/components/AdminPortal/TagActions/Node/TagNodeMocks.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/Node/TagNodeMocks.ts#L64)\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `USER_TAG_SUB_TAGS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.first\n\n> **first**: `number` = `10`\n\n#### request.variables.id\n\n> **id**: `string` = `'1'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/TagActions/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceTagActionsProps`](../../../../../types/AdminPortal/TagActions/interface/interfaces/InterfaceTagActionsProps.md)\\>\n\nDefined in: [src/components/AdminPortal/TagActions/TagActions.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActions.tsx#L60)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `currentTagId?`: `undefined`; `first`: `number`; `id`: `string`; `selectedTagIds?`: `undefined`; `where`: \\{ `name`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags?`: `undefined`; `getChildTags?`: `undefined`; `organizations`: `object`[]; `removeFromUserTags?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `string`; `currentTagId?`: `undefined`; `first`: `number`; `id`: `string`; `selectedTagIds?`: `undefined`; `where`: \\{ `name`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags?`: `undefined`; `getChildTags?`: `undefined`; `organizations`: `object`[]; `removeFromUserTags?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `currentTagId?`: `undefined`; `first`: `number`; `id`: `string`; `selectedTagIds?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags?`: `undefined`; `getChildTags`: \\{ `ancestorTags`: `any`[]; `childTags`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \\}; `totalCount`: `number`; \\}; `name`: `string`; \\}; `organizations?`: `undefined`; `removeFromUserTags?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `string`; `currentTagId?`: `undefined`; `first`: `number`; `id`: `string`; `selectedTagIds?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags?`: `undefined`; `getChildTags`: \\{ `ancestorTags`: `any`[]; `childTags`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `string`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string`; \\}; `totalCount`: `number`; \\}; `name`: `string`; \\}; `organizations?`: `undefined`; `removeFromUserTags?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `currentTagId`: `string`; `first?`: `undefined`; `id?`: `undefined`; `selectedTagIds`: `string`[]; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags`: \\{ `_id`: `string`; \\}; `getChildTags?`: `undefined`; `organizations?`: `undefined`; `removeFromUserTags?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `currentTagId`: `string`; `first?`: `undefined`; `id?`: `undefined`; `selectedTagIds`: `string`[]; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `assignToUserTags?`: `undefined`; `getChildTags?`: `undefined`; `organizations?`: `undefined`; `removeFromUserTags`: \\{ `_id`: `string`; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L116)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS_ERROR_ASSIGN_OR_REMOVAL_TAGS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_ERROR\\_ASSIGN\\_OR\\_REMOVAL\\_TAGS\n\n> `const` **MOCKS\\_ERROR\\_ASSIGN\\_OR\\_REMOVAL\\_TAGS**: (\\{ `error?`: `undefined`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `currentTagId?`: `undefined`; `first`: `number`; `id`: `string`; `selectedTagIds?`: `undefined`; `where`: \\{ `name`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `organizations`: `object`[]; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `currentTagId`: `string`; `first?`: `undefined`; `id?`: `undefined`; `selectedTagIds`: `string`[]; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\})[]\n\nDefined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:406](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L406)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/TagActions/TagActionsMocks/variables/MOCKS_ERROR_SUBTAGS_QUERY.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\\_ERROR\\_SUBTAGS\\_QUERY\n\n> `const` **MOCKS\\_ERROR\\_SUBTAGS\\_QUERY**: (\\{ `error?`: `undefined`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `id`: `string`; `where`: \\{ `name`: \\{ `starts_with`: `string`; \\}; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `organizations`: `object`[]; \\}; \\}; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first`: `number`; `id`: `string`; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\})[]\n\nDefined in: [src/components/AdminPortal/TagActions/TagActionsMocks.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/TagActions/TagActionsMocks.ts#L359)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/UpdateSession/UpdateSession/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceUpdateSessionProps`](../../../../../types/AdminPortal/UpdateSession/interface/interfaces/InterfaceUpdateSessionProps.md)\\>\n\nDefined in: [src/components/AdminPortal/UpdateSession/UpdateSession.tsx:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/UpdateSession/UpdateSession.tsx#L48)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/UserTableRow/UserTableRow/variables/UserTableRow.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UserTableRow\n\n> `const` **UserTableRow**: `React.FC`\\<[`InterfaceUserTableRowProps`](../../../../../types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserTableRowProps.md)\\>\n\nDefined in: [src/components/AdminPortal/UserTableRow/UserTableRow.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/UserTableRow/UserTableRow.tsx#L50)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/Modal/VenueModal/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L66)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceVenueModalProps`](../interfaces/InterfaceVenueModalProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/Modal/VenueModal/interfaces/InterfaceVenueModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVenueModalProps\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L50)\n\n## Properties\n\n### edit\n\n> **edit**: `boolean`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L56)\n\n***\n\n### onHide()\n\n> **onHide**: () => `void`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L52)\n\n#### Returns\n\n`void`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L54)\n\n***\n\n### refetchVenues()\n\n> **refetchVenues**: () => `void`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L53)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L51)\n\n***\n\n### venueData?\n\n> `optional` **venueData**: [`InterfaceQueryVenueListItem`](../../../../../../utils/interfaces/interfaces/InterfaceQueryVenueListItem.md)\n\nDefined in: [src/components/AdminPortal/Venues/Modal/VenueModal.tsx:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/Modal/VenueModal.tsx#L55)\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/VenueCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/AdminPortal/Venues/VenueCard.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCard.tsx#L46)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`InterfaceVenueCardProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCK\\_VENUE\\_ITEM\n\n> `const` **MOCK\\_VENUE\\_ITEM**: `object`\n\nDefined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L1)\n\n## Type Declaration\n\n### node\n\n> **node**: `object`\n\n#### node.capacity\n\n> **capacity**: `number` = `500`\n\n#### node.description\n\n> **description**: `string` = `'A spacious venue for large events.'`\n\n#### node.id\n\n> **id**: `string` = `'1'`\n\n#### node.image\n\n> **image**: `any` = `null`\n\n#### node.name\n\n> **name**: `string` = `'Grand Hall'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM_LONG_TEXT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCK\\_VENUE\\_ITEM\\_LONG\\_TEXT\n\n> `const` **MOCK\\_VENUE\\_ITEM\\_LONG\\_TEXT**: `object`\n\nDefined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L26)\n\n## Type Declaration\n\n### node\n\n> **node**: `object`\n\n#### node.capacity\n\n> **capacity**: `number` = `300`\n\n#### node.description\n\n> **description**: `string` = `'This is a very long description that should be truncated. It contains more than seventy five characters to ensure we can test the truncation logic properly. This text will be cut off.'`\n\n#### node.id\n\n> **id**: `string` = `'4'`\n\n#### node.image\n\n> **image**: `any` = `null`\n\n#### node.name\n\n> **name**: `string` = `'This is a very long venue name that should definitely be truncated in the display'`\n" }, { "path": "docs/docs/auto-docs/components/AdminPortal/Venues/VenueCardMocks/variables/MOCK_VENUE_ITEM_WITH_IMAGE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCK\\_VENUE\\_ITEM\\_WITH\\_IMAGE\n\n> `const` **MOCK\\_VENUE\\_ITEM\\_WITH\\_IMAGE**: `object`\n\nDefined in: [src/components/AdminPortal/Venues/VenueCardMocks.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/AdminPortal/Venues/VenueCardMocks.ts#L11)\n\n## Type Declaration\n\n### node\n\n> **node**: `object`\n\n#### node.attachments\n\n> **attachments**: `object`[]\n\n#### node.capacity\n\n> **capacity**: `number` = `200`\n\n#### node.description\n\n> **description**: `string` = `'A modern conference room with all amenities.'`\n\n#### node.id\n\n> **id**: `string` = `'2'`\n\n#### node.name\n\n> **name**: `string` = `'Conference Room'`\n" }, { "path": "docs/docs/auto-docs/components/Auth/LoginForm/LoginForm/variables/LoginForm.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LoginForm\n\n> `const` **LoginForm**: `React.FC`\\<[`InterfaceLoginFormProps`](../../../../../types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormProps.md)\\>\n\nDefined in: [src/components/Auth/LoginForm/LoginForm.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/LoginForm/LoginForm.tsx#L40)\n\nReusable login form component that composes EmailField and PasswordField.\n\n## Remarks\n\nThis component handles the login form UI and submission logic, delegating\nauthentication to the SIGNIN_QUERY GraphQL query. It supports both admin\nand user login modes via the isAdmin prop.\n\n## Param\n\nWhether the login form is rendered for an admin user\n\n## Param\n\nCallback invoked with the full sign-in result (user + tokens)\n\n## Param\n\nCallback invoked when the login request fails\n\n## Param\n\nOptional test ID used for querying the component in tests\n\n## Returns\n\nA JSX element rendering the login form\n\n## Example\n\n```tsx\n console.log('Logged in:', token)}\n onError={(error) => console.error('Login failed:', error)}\n/>\n```\n" }, { "path": "docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/type-aliases/OAuthMode.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OAuthMode\n\n> **OAuthMode** = `\"login\"` \\| `\"register\"` \\| `\"link\"`\n\nDefined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L10)\n\nDefines the authentication mode for OAuth operations.\n" }, { "path": "docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/type-aliases/OAuthSize.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OAuthSize\n\n> **OAuthSize** = `\"sm\"` \\| `\"md\"` \\| `\"lg\"`\n\nDefined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L15)\n\nDefines the size variants for the OAuth button.\n" }, { "path": "docs/docs/auto-docs/components/Auth/OAuthButton/OAuthButton/variables/OAuthButton.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: OAuthButton\n\n> `const` **OAuthButton**: `React.FC`\\<`Props`\\>\n\nDefined in: [src/components/Auth/OAuthButton/OAuthButton.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OAuthButton/OAuthButton.tsx#L51)\n\nA customizable OAuth authentication button component that supports multiple providers.\n\n## Param\n\nThe component props\n\n## Returns\n\nA styled OAuth button with provider-specific branding\n\n## Example\n\n```tsx\n\n```\n" }, { "path": "docs/docs/auto-docs/components/Auth/OrgSelector/OrgSelector/variables/OrgSelector.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: OrgSelector\n\n> `const` **OrgSelector**: `React.FC`\\<[`InterfaceOrgSelectorProps`](../../../../../types/Auth/OrgSelector/interface/interfaces/InterfaceOrgSelectorProps.md)\\>\n\nDefined in: [src/components/Auth/OrgSelector/OrgSelector.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/OrgSelector/OrgSelector.tsx#L26)\n\nReusable organization selector component with search/autocomplete and accessibility support.\n\n## Remarks\n\nThis component provides a searchable dropdown for selecting an organization from a list.\nIt supports search/autocomplete, error display, required field indication, and proper\nARIA attributes for accessibility.\n\n## Example\n\n```tsx\n\n```\n" }, { "path": "docs/docs/auto-docs/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator/variables/PasswordStrengthIndicator.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PasswordStrengthIndicator\n\n> `const` **PasswordStrengthIndicator**: `React.FC`\\<[`InterfacePasswordStrengthIndicatorProps`](../../../../../types/Auth/PasswordStrengthIndicator/interface/interfaces/InterfacePasswordStrengthIndicatorProps.md)\\>\n\nDefined in: [src/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/PasswordStrengthIndicator/PasswordStrengthIndicator.tsx#L17)\n\nPasswordStrengthIndicator displays a visual checklist of password requirements.\n\n## Remarks\n\nShows real-time feedback for password complexity requirements including\nminimum length, lowercase, uppercase, numeric, and special characters.\n\n## Param\n\nComponent props\n\n## Returns\n\nPassword strength indicator or null if not visible\n" }, { "path": "docs/docs/auto-docs/components/Auth/PasswordStrengthIndicator/RequirementRow/variables/RequirementRow.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RequirementRow\n\n> `const` **RequirementRow**: `React.FC`\\<`InterfaceRequirementRowProps`\\>\n\nDefined in: [src/components/Auth/PasswordStrengthIndicator/RequirementRow.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/PasswordStrengthIndicator/RequirementRow.tsx#L19)\n\nRow component to display a single password requirement with status indicator.\n\n## Param\n\nComponent props\n\n## Returns\n\nA div with colored text and checkmark/X indicator\n" }, { "path": "docs/docs/auto-docs/components/Auth/RegistrationForm/RegistrationForm/functions/RegistrationForm.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: RegistrationForm()\n\n> **RegistrationForm**(`__namedParameters`): `Element`\n\nDefined in: [src/components/Auth/RegistrationForm/RegistrationForm.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/RegistrationForm/RegistrationForm.tsx#L27)\n\nRegistrationForm component for user registration with validation and reCAPTCHA support\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IRegistrationFormProps`](../../../../../types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/Auth/theme/oauthBrand/functions/brandForProvider.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: brandForProvider()\n\n> **brandForProvider**(`provider`): `InterfaceProviderBrand`\n\nDefined in: [src/components/Auth/theme/oauthBrand.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Auth/theme/oauthBrand.tsx#L49)\n\nRetrieves the branding configuration for a specific OAuth provider.\n\n## Parameters\n\n### provider\n\n[`OAuthProviderKey`](../../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md)\n\nThe provider key (e.g., 'GOOGLE', 'GITHUB')\n\n## Returns\n\n`InterfaceProviderBrand`\n\nThe branding configuration for the provider, or Google branding as fallback\n\n## Example\n\n```tsx\nconst googleBrand = brandForProvider('GOOGLE');\nconsole.log(googleBrand.displayName); // 'Google'\n```\n" }, { "path": "docs/docs/auto-docs/components/ChangeLanguageDropdown/ChangeLanguageDropDown/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ChangeLanguageDropdown/ChangeLanguageDropDown.tsx#L32)\n\n## Parameters\n\n### props\n\n[`InterfaceDropDownProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/CollapsibleDropdown/CollapsibleDropdown/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/CollapsibleDropdown/CollapsibleDropdown.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CollapsibleDropdown/CollapsibleDropdown.tsx#L50)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceCollapsibleDropdown`](../../../../types/DropDown/interface/interfaces/InterfaceCollapsibleDropdown.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/CursorPaginationManager/CursorPaginationManager/functions/CursorPaginationManager.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: CursorPaginationManager()\n\n> **CursorPaginationManager**\\<`TData`, `TNode`, `TVariables`\\>(`props`): `ReactElement`\n\nDefined in: [src/components/CursorPaginationManager/CursorPaginationManager.tsx:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/CursorPaginationManager/CursorPaginationManager.tsx#L128)\n\nCursorPaginationManager - A reusable component for cursor-based pagination\n\nManages cursor-based pagination state and integrates with Apollo Client.\nExtracts data from nested GraphQL responses and provides \"Load More\" functionality.\n\n## Type Parameters\n\n### TData\n\n`TData`\n\nThe complete GraphQL query response type\n\n### TNode\n\n`TNode`\n\nThe type of individual items\n\n### TVariables\n\n`TVariables` *extends* `Record`\\<`string`, `unknown`\\> = `Record`\\<`string`, `unknown`\\>\n\nThe GraphQL query variables type\n\n## Parameters\n\n### props\n\n[`InterfaceCursorPaginationManagerProps`](../../../../types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerProps.md)\\<`TData`, `TNode`, `TVariables`\\>\n\n## Returns\n\n`ReactElement`\n\n## Example\n\n```tsx\nimport { CursorPaginationManager } from 'components/CursorPaginationManager/CursorPaginationManager';\nimport { gql } from '@apollo/client';\n\nconst GET_USERS_QUERY = gql`\n query GetUsers($first: Int!, $after: String) {\n users(first: $first, after: $after) {\n edges {\n cursor\n node {\n id\n name\n email\n }\n }\n pageInfo {\n hasNextPage\n hasPreviousPage\n startCursor\n endCursor\n }\n }\n }\n`;\n\nfunction UsersList() {\n return (\n (\n
\n

{user.name}

\n

{user.email}

\n
\n )}\n />\n );\n}\n```\n\n## Remarks\n\n**Integration Requirements:**\n- GraphQL query MUST follow Relay cursor pagination spec (edges, node, pageInfo)\n- Query MUST accept `first: Int!` and `after: String` variables\n- pageInfo MUST include: hasNextPage, hasPreviousPage, startCursor, endCursor\n- Use `dataPath` prop to specify where connection data is in response (e.g., \"users\" or \"organization.members\")\n\n**Features:**\n- Automatic loading, empty, and error states using shared components\n- \"Load More\" button with cursor-based pagination\n- Manual refetch via `refetchTrigger` prop\n- Custom loading/empty states via props\n- Data change callbacks via `onDataChange`\n" }, { "path": "docs/docs/auto-docs/components/EventCalender/EventCalenderMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variable`: \\{ `allDay?`: `undefined`; `description?`: `undefined`; `endTime?`: `undefined`; `id`: `string`; `isPublic?`: `undefined`; `isRegisterable?`: `undefined`; `location?`: `undefined`; `name?`: `undefined`; `startTime?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `removeEvent`: \\{ `_id`: `string`; \\}; `updateEvent?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variable`: \\{ `allDay`: `boolean`; `description`: `string`; `endTime`: `string`; `id`: `string`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `name`: `string`; `startTime`: `string`; \\}; \\}; `result`: \\{ `data`: \\{ `removeEvent?`: `undefined`; `updateEvent`: \\{ `_id`: `string`; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/EventCalender/EventCalenderMocks.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/EventCalenderMocks.ts#L77)\n" }, { "path": "docs/docs/auto-docs/components/EventCalender/EventCalenderMocks/variables/eventData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: eventData\n\n> `const` **eventData**: `object`[]\n\nDefined in: [src/components/EventCalender/EventCalenderMocks.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/EventCalenderMocks.ts#L10)\n\n## Type Declaration\n\n### allDay\n\n> **allDay**: `boolean` = `false`\n\n### attendees\n\n> **attendees**: `any`[] = `[]`\n\n### creator\n\n> **creator**: `object`\n\n#### creator.id\n\n> **id**: `string` = `'1'`\n\n#### creator.name\n\n> **name**: `string` = `'Creator 1'`\n\n### description\n\n> **description**: `string` = `'This is event 1'`\n\n### endAt\n\n> **endAt**: `string`\n\n### endTime\n\n> **endTime**: `string` = `'12:00'`\n\n### id\n\n> **id**: `string` = `'1'`\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean` = `false`\n\n### isPublic\n\n> **isPublic**: `boolean` = `true`\n\n### isRegisterable\n\n> **isRegisterable**: `boolean` = `true`\n\n### location\n\n> **location**: `string` = `'New York'`\n\n### name\n\n> **name**: `string` = `'Event 1'`\n\n### startAt\n\n> **startAt**: `string`\n\n### startTime\n\n> **startTime**: `string` = `'10:00'`\n" }, { "path": "docs/docs/auto-docs/components/EventCalender/Header/EventHeader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/EventCalender/Header/EventHeader.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Header/EventHeader.tsx#L40)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IEventHeaderProps`](../../../../../types/Event/interface/interfaces/IEventHeaderProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/EventCalender/Monthly/EventCalender/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceCalendarProps`](../../../../../types/Event/interface/type-aliases/InterfaceCalendarProps.md) & `object`\\>\n\nDefined in: [src/components/EventCalender/Monthly/EventCalender.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Monthly/EventCalender.tsx#L56)\n" }, { "path": "docs/docs/auto-docs/components/EventCalender/Yearly/YearlyEventCalender/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceCalendarProps`](../../../../../types/Event/interface/type-aliases/InterfaceCalendarProps.md)\\>\n\nDefined in: [src/components/EventCalender/Yearly/YearlyEventCalender.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventCalender/Yearly/YearlyEventCalender.tsx#L49)\n" }, { "path": "docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreen/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/EventDashboardScreen/EventDashboardScreen.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventDashboardScreen/EventDashboardScreen.tsx#L43)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/EventDashboardScreen/EventDashboardScreenMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: `object`[]\n\nDefined in: [src/components/EventDashboardScreen/EventDashboardScreenMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventDashboardScreen/EventDashboardScreenMocks.ts#L3)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `ORGANIZATIONS_LIST`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.id\n\n> **id**: `string` = `'123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.organizations\n\n> **organizations**: `object`[]\n" }, { "path": "docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/diverseRatingsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: diverseRatingsProps\n\n> `const` **diverseRatingsProps**: `object`\n\nDefined in: [src/components/EventStats/EventStatsMocks.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L113)\n\n## Type Declaration\n\n### data\n\n> **data**: `object`\n\n#### data.event\n\n> **event**: `object`\n\n#### data.event.\\_id\n\n> **\\_id**: `string` = `'123'`\n\n#### data.event.averageFeedbackScore\n\n> **averageFeedbackScore**: `number` = `2.4`\n\n#### data.event.feedback\n\n> **feedback**: `object`[]\n" }, { "path": "docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/emptyProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyProps\n\n> `const` **emptyProps**: `object`\n\nDefined in: [src/components/EventStats/EventStatsMocks.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L103)\n\n## Type Declaration\n\n### data\n\n> **data**: `object`\n\n#### data.event\n\n> **event**: `object`\n\n#### data.event.\\_id\n\n> **\\_id**: `string` = `'123'`\n\n#### data.event.averageFeedbackScore\n\n> **averageFeedbackScore**: `number` = `0`\n\n#### data.event.feedback\n\n> **feedback**: `any`[] = `[]`\n" }, { "path": "docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/mockData.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockData\n\n> `const` **mockData**: `object`[]\n\nDefined in: [src/components/EventStats/EventStatsMocks.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L3)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `EVENT_FEEDBACKS`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.id\n\n> **id**: `string` = `'eventStats123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.event\n\n> **event**: `object`\n\n#### result.data.event.\\_id\n\n> **\\_id**: `string` = `'eventStats123'`\n\n#### result.data.event.averageFeedbackScore\n\n> **averageFeedbackScore**: `number` = `5`\n\n#### result.data.event.feedback\n\n> **feedback**: `object`[]\n" }, { "path": "docs/docs/auto-docs/components/EventStats/EventStatsMocks/variables/nonEmptyProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: nonEmptyProps\n\n> `const` **nonEmptyProps**: `object`\n\nDefined in: [src/components/EventStats/EventStatsMocks.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/EventStatsMocks.ts#L71)\n\n## Type Declaration\n\n### data\n\n> **data**: `object`\n\n#### data.event\n\n> **event**: `object`\n\n#### data.event.\\_id\n\n> **\\_id**: `string` = `'123'`\n\n#### data.event.averageFeedbackScore\n\n> **averageFeedbackScore**: `number` = `5`\n\n#### data.event.feedback\n\n> **feedback**: `object`[]\n" }, { "path": "docs/docs/auto-docs/components/EventStats/Statistics/AverageRating/AverageRating/functions/AverageRating.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: AverageRating()\n\n> **AverageRating**(`__namedParameters`): `Element`\n\nDefined in: [src/components/EventStats/Statistics/AverageRating/AverageRating.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/AverageRating/AverageRating.tsx#L31)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/EventStats/Statistics/EventStats/functions/EventStats.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: EventStats()\n\n> **EventStats**(`__namedParameters`): `Element`\n\nDefined in: [src/components/EventStats/Statistics/EventStats.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/EventStats.tsx#L50)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`ModalPropType`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/EventStats/Statistics/Feedback/Feedback/functions/FeedbackStats.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: FeedbackStats()\n\n> **FeedbackStats**(`__namedParameters`): `Element`\n\nDefined in: [src/components/EventStats/Statistics/Feedback/Feedback.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/Feedback/Feedback.tsx#L46)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/EventStats/Statistics/Review/Review/functions/ReviewStats.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: ReviewStats()\n\n> **ReviewStats**(`__namedParameters`): `Element`\n\nDefined in: [src/components/EventStats/Statistics/Review/Review.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/EventStats/Statistics/Review/Review.tsx#L44)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IStatsModal`](../../../../../../types/Event/interface/interfaces/IStatsModal.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/HolidayCards/HolidayCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/HolidayCards/HolidayCard.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/HolidayCards/HolidayCard.tsx#L25)\n\n## Parameters\n\n### props\n\n`InterfaceHolidayList`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/IconComponent/IconComponent/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L66)\n\n## Parameters\n\n### props\n\n[`IIconComponent`](../interfaces/IIconComponent.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/IconComponent/IconComponent/interfaces/IIconComponent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IIconComponent\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L59)\n\n## Properties\n\n### fill?\n\n> `optional` **fill**: `string`\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L61)\n\n***\n\n### height?\n\n> `optional` **height**: `string`\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L62)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L60)\n\n***\n\n### width?\n\n> `optional` **width**: `string`\n\nDefined in: [src/components/IconComponent/IconComponent.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/IconComponent/IconComponent.tsx#L63)\n" }, { "path": "docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`orgId`): `ReactElement`\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L66)\n\nLeftDrawerOrg component for displaying organization details and options.\n\n## Parameters\n\n### orgId\n\n[`ILeftDrawerProps`](../interfaces/ILeftDrawerProps.md)\n\nID of the current organization.\n\n## Returns\n\n`ReactElement`\n\nJSX element for the left navigation drawer with organization details.\n" }, { "path": "docs/docs/auto-docs/components/LeftDrawerOrg/LeftDrawerOrg/interfaces/ILeftDrawerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ILeftDrawerProps\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L50)\n\n## Properties\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L53)\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L51)\n\n***\n\n### setHideDrawer\n\n> **setHideDrawer**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L54)\n\n***\n\n### targets\n\n> **targets**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)[]\n\nDefined in: [src/components/LeftDrawerOrg/LeftDrawerOrg.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/LeftDrawerOrg/LeftDrawerOrg.tsx#L52)\n" }, { "path": "docs/docs/auto-docs/components/NotificationIcon/NotificationIcon/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/NotificationIcon/NotificationIcon.tsx:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/NotificationIcon/NotificationIcon.tsx#L36)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/Pagination/Navigator/Pagination/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/Pagination/Navigator/Pagination.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/Pagination/Navigator/Pagination.tsx#L49)\n\n## Parameters\n\n### props\n\n`InterfaceTablePaginationActionsProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/ProfileCard/ProfileCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/ProfileCard/ProfileCard.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ProfileCard/ProfileCard.tsx#L52)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceProfileCardProps`](../../../../types/shared-components/ProfileCard/interface/interfaces/InterfaceProfileCardProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/ProfileDropdown/ProfileDropdown/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/ProfileDropdown/ProfileDropdown.tsx:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/ProfileDropdown/ProfileDropdown.tsx#L50)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceProfileDropdownProps`](../../../../types/shared-components/ProfileDropdown/interface/interfaces/InterfaceProfileDropdownProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/SignOut/SignOut/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/SignOut/SignOut.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/SignOut/SignOut.tsx#L51)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`ISignOutProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserDetails/UserEvents/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`PeopleTabUserEventsProps`](../../../../types/AdminPortal/UserDetails/UserEvent/type/type-aliases/PeopleTabUserEventsProps.md)\\>\n\nDefined in: [src/components/UserDetails/UserEvents.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserEvents.tsx#L51)\n" }, { "path": "docs/docs/auto-docs/components/UserDetails/UserOrganizations/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceUserOrganizationsProps`](../../../../types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrganizationsProps.md)\\>\n\nDefined in: [src/components/UserDetails/UserOrganizations.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserOrganizations.tsx#L54)\n" }, { "path": "docs/docs/auto-docs/components/UserDetails/UserTags/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserDetails/UserTags.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserDetails/UserTags.tsx#L52)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceUserTagsProps`](../../../../types/AdminPortal/UserDetails/UserTags/type/type-aliases/InterfaceUserTagsProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatHeader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/ChatRoom/ChatHeader.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/ChatHeader.tsx#L30)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceChatHeaderProps`](../../types/interfaces/InterfaceChatHeaderProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/ChatRoom/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/components/UserPortal/ChatRoom/ChatRoom.tsx:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/ChatRoom.tsx#L55)\n\n## Parameters\n\n### props\n\n`IChatRoomProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/EmptyChatState/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/ChatRoom/EmptyChatState.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/EmptyChatState.tsx#L17)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceEmptyChatStateProps`](../../../../../types/UserPortal/EmptyChatState/interface/interfaces/InterfaceEmptyChatStateProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageImage/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `MemoExoticComponent`\\<(`__namedParameters`) => `Element`\\>\n\nDefined in: [src/components/UserPortal/ChatRoom/MessageImage.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageImage.tsx#L38)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageInput/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/ChatRoom/MessageInput.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageInput.tsx#L60)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`IMessageInputProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/MessageItem/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/ChatRoom/MessageItem.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/MessageItem.tsx#L56)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`IMessageItemProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/types/interfaces/INewChat.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: INewChat\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L26)\n\nChat Types\n\nThis file defines TypeScript interfaces for the chat room functionality.\nIt includes type definitions for chat entities, members, messages, and pagination.\n\n## Remarks\n\n- INewChat: Main interface representing a chat entity.\n- Supports both direct messages and group chats.\n- Includes pagination information for messages.\n\n## Example\n\n```ts\nconst chat: INewChat = {\n id: 'chat123',\n name: 'Group Chat',\n isGroup: true,\n createdAt: '2024-01-01T00:00:00Z',\n updatedAt: '2024-01-01T00:00:00Z',\n members: { edges: [...] },\n messages: { edges: [...], pageInfo: {...} }\n};\n```\n\n## Properties\n\n### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L30)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L31)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L33)\n\n***\n\n### creator?\n\n> `optional` **creator**: `object`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L40)\n\n#### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L29)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L27)\n\n***\n\n### isGroup\n\n> **isGroup**: `boolean`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L32)\n\n***\n\n### members\n\n> **members**: `object`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L52)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### messages\n\n> **messages**: `object`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L66)\n\n#### edges\n\n> **edges**: `object`[]\n\n#### pageInfo\n\n> **pageInfo**: `object`\n\n##### pageInfo.endCursor\n\n> **endCursor**: `string`\n\n##### pageInfo.hasNextPage\n\n> **hasNextPage**: `boolean`\n\n##### pageInfo.hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\n##### pageInfo.startCursor\n\n> **startCursor**: `string`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L28)\n\n***\n\n### organization?\n\n> `optional` **organization**: `object`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L35)\n\n#### countryCode?\n\n> `optional` **countryCode**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L34)\n\n***\n\n### updater?\n\n> `optional` **updater**: `object`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L46)\n\n#### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ChatRoom/types/interfaces/InterfaceChatHeaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceChatHeaderProps\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L100)\n\n## Properties\n\n### chatImage\n\n> **chatImage**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L101)\n\n***\n\n### chatSubtitle\n\n> **chatSubtitle**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L103)\n\n***\n\n### chatTitle\n\n> **chatTitle**: `string`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L102)\n\n***\n\n### isGroup?\n\n> `optional` **isGroup**: `boolean`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L104)\n\n***\n\n### onGroupClick()?\n\n> `optional` **onGroupClick**: () => `void`\n\nDefined in: [src/components/UserPortal/ChatRoom/types.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ChatRoom/types.ts#L105)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/CommentCard/CommentCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`id`): `Element`\n\nDefined in: [src/components/UserPortal/CommentCard/CommentCard.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CommentCard/CommentCard.tsx#L72)\n\nCommentCard Component\n\nThis component represents a card displaying a comment with the ability to like or dislike it.\nIt shows the comment creator's details, the comment text, and the like/dislike counts.\n\n## Parameters\n\n### id\n\n[`InterfaceCommentCardProps`](../../../../../types/UserPortal/CommentCard/interface/interfaces/InterfaceCommentCardProps.md)\n\nThe unique identifier of the comment.\n\n## Returns\n\n`Element`\n\nJSX element representing the comment card.\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/ContactCard/ContactCard/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceContactCardProps`](../../../../../types/UserPortal/Chat/interface/interfaces/InterfaceContactCardProps.md)\\>\n\nDefined in: [src/components/UserPortal/ContactCard/ContactCard.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/ContactCard/ContactCard.tsx#L46)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/CreateDirectChat/CreateDirectChat/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CreateDirectChat/CreateDirectChat.tsx#L137)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceCreateDirectChatProps`](../../../../../types/UserPortal/CreateDirectChat/interface/interfaces/InterfaceCreateDirectChatProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/CreateGroupChat/CreateGroupChat/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/CreateGroupChat/CreateGroupChat.tsx#L82)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`InterfaceCreateGroupChatProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/DonationCard/DonationCard/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceDonationCardProps`](../../../../../types/UserPortal/Donation/interface/interfaces/InterfaceDonationCardProps.md)\\>\n\nDefined in: [src/components/UserPortal/DonationCard/DonationCard.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/DonationCard/DonationCard.tsx#L33)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/EventCard/EventCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`id`): `Element`\n\nDefined in: [src/components/UserPortal/EventCard/EventCard.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/EventCard/EventCard.tsx#L72)\n\nEventCard Component\n\nThis component renders a card displaying details of an event, including its name, description,\nlocation, start and end times, and the creator's name. It also provides functionality for users\nto register for the event.\n\n## Parameters\n\n### id\n\n[`InterfaceEventCardProps`](../../../../../types/UserPortal/EventCard/interface/interfaces/InterfaceEventCardProps.md)\n\nEvent identifier.\n\n## Returns\n\n`Element`\n\nJSX.Element - A styled card displaying event details and a registration button.\n\nDependencies\n- `@mui/icons-material` for icons.\n- `dayjs` for date and time formatting.\n- `shared-components/Button` for button UI.\n- `@apollo/client` for GraphQL mutations.\n- `NotificationToast` for notifications.\n- `utils/useLocalstorage` for local storage handling.\n\n## Remarks\n\n- The component uses the `useTranslation` hook for internationalization.\n- It retrieves the user ID from local storage to determine if the user is already registered for the event.\n- The `useMutation` hook from Apollo Client is used to handle event registration.\n- The `NotificationToast` utility is used to display success or error messages.\n\nComponent\n\n## Example\n\n```tsx\n\n```\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetails/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetails.tsx:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetails.tsx#L85)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceGroupChatDetailsProps`](../../../../../types/UserPortal/Chat/interface/interfaces/InterfaceGroupChatDetailsProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/delayedMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: delayedMocks\n\n> `const` **delayedMocks**: (\\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `input`: \\{ `id`: `string`; \\}; `where`: \\{ `name_contains`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `organization`: \\{ `members`: \\{ `edges`: `any`[]; `pageInfo`: \\{ `endCursor`: `any`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains`: `string`; `input?`: `undefined`; `lastName_contains`: `string`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users`: `object`[]; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where`: \\{ \\}; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization`: \\{ `members`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `any`; `hasNextPage`: `boolean`; \\}; \\}; \\}; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role`: `string`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar`: \\{ `uri`: `string`; \\}; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role`: `string`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables?`: `undefined`; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables?`: `undefined`; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `delay`: `number`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\})[]\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L627)\n\nDelayed mocks to simulate network latency for loading states testing\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/failingMocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: failingMocks\n\n> `const` **failingMocks**: (\\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role`: `string`; \\}; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role?`: `undefined`; \\}; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\} \\| \\{ `error`: `Error`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `input`: \\{ `avatar`: \\{ `uri`: `string`; \\}; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `where?`: `undefined`; \\}; \\}; `result?`: `undefined`; \\} \\| \\{ `error?`: `undefined`; `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `where`: \\{ `name_contains`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `organization`: \\{ `members`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `any`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\})[]\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:534](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L534)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/filledMockChat.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: filledMockChat\n\n> `const` **filledMockChat**: [`Chat`](../../../../../types/UserPortal/Chat/interface/type-aliases/Chat.md)\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L197)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/incompleteMockChat.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: incompleteMockChat\n\n> `const` **incompleteMockChat**: [`Chat`](../../../../../types/UserPortal/Chat/interface/type-aliases/Chat.md)\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L204)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks/variables/mocks.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mocks\n\n> `const` **mocks**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `input`: \\{ `id`: `string`; \\}; `where`: \\{ `name_contains`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `organization`: \\{ `members`: \\{ `edges`: `any`[]; `pageInfo`: \\{ `endCursor`: `any`; `hasNextPage`: `boolean`; \\}; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains`: `string`; `input?`: `undefined`; `lastName_contains`: `string`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users`: `object`[]; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after`: `any`; `first`: `number`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where`: \\{ \\}; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization`: \\{ `members`: \\{ `edges`: `object`[]; `pageInfo`: \\{ `endCursor`: `any`; `hasNextPage`: `boolean`; \\}; \\}; \\}; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role`: `string`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar`: \\{ `uri`: `string`; \\}; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role`: `string`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables?`: `undefined`; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId`: `string`; `id?`: `undefined`; `memberId`: `string`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership`: \\{ `id`: `string`; `success`: `boolean`; \\}; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name`: `string`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables?`: `undefined`; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat?`: `undefined`; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `after?`: `undefined`; `first?`: `undefined`; `firstName_contains?`: `undefined`; `input`: \\{ `avatar?`: `undefined`; `chatId?`: `undefined`; `id`: `string`; `memberId?`: `undefined`; `name?`: `undefined`; `role?`: `undefined`; \\}; `lastName_contains?`: `undefined`; `where?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `createChatMembership?`: `undefined`; `deleteChat`: \\{ `id`: `string`; `success`: `boolean`; \\}; `deleteChatMembership?`: `undefined`; `organization?`: `undefined`; `updateChat?`: `undefined`; `updateChatMembership?`: `undefined`; `users?`: `undefined`; \\}; \\}; \\})[]\n\nDefined in: [src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/GroupChatDetails/GroupChatDetailsMocks.tsx#L212)\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/OrganizationSidebar/OrganizationSidebar/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/OrganizationSidebar/OrganizationSidebar.tsx#L45)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/SecuredRouteForUser/SecuredRouteForUser.tsx#L42)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/UserNavbar/UserNavbar/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/components/UserPortal/UserNavbar/UserNavbar.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/UserNavbar/UserNavbar.tsx#L63)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/components/UserPortal/UserPortalCard/UserPortalCard/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceUserPortalCardProps`](../../../../../types/UserPortal/UserPortalCard/interface/interfaces/InterfaceUserPortalCardProps.md)\\>\n\nDefined in: [src/components/UserPortal/UserPortalCard/UserPortalCard.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/components/UserPortal/UserPortalCard/UserPortalCard.tsx#L34)\n\nUserPortalCard\n\nReusable 3-section layout wrapper for User Portal cards.\n\nStructure:\n[ imageSlot ] [ content (children) ] [ actionsSlot ]\n\nResponsibilities:\n- Centralizes spacing and alignment logic\n- Supports density variants (compact / standard / expanded)\n- Remains content-agnostic and styling-agnostic\n\nAccessibility:\n- role=\"group\"\n- aria-label provided by consumer (i18n required)\n\n## Example\n\n```tsx\n}\n actionsSlot={\n \n \n }\n>\n \n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/BasicUsage.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: BasicUsage\n\n> `const` **BasicUsage**: `Story`\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L93)\n\nBasic usage of ViewModal displaying entity details\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/LoadingState.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LoadingState\n\n> `const` **LoadingState**: `Story`\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L127)\n\nViewModal in loading state while fetching data\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/OrganizationDetails.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: OrganizationDetails\n\n> `const` **OrganizationDetails**: `Story`\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L236)\n\nViewModal displaying organization details\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/UserProfile.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: UserProfile\n\n> `const` **UserProfile**: `Story`\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L194)\n\nViewModal displaying user profile information\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/WithCustomActions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithCustomActions\n\n> `const` **WithCustomActions**: `Story`\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L146)\n\nViewModal with custom action buttons\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/ViewModal.stories/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `Meta`\\<*typeof* [`ViewModal`](../../ViewModal/variables/ViewModal.md)\\>\n\nDefined in: [src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/ViewModal.stories.tsx#L49)\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useFormModal/functions/useFormModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useFormModal()\n\n> **useFormModal**\\<`T`\\>(`initialData`): [`InterfaceUseFormModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md)\\<`T`\\>\n\nDefined in: [src/shared-components/CRUDModalTemplate/hooks/useFormModal.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/hooks/useFormModal.ts#L50)\n\nCustom hook combining modal state with form data handling.\n\nExtends useModalState with form data management, useful for\nedit modals where you need to open the modal with pre-populated data.\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### initialData\n\n`T` = `null`\n\nInitial form data (defaults to null)\n\n## Returns\n\n[`InterfaceUseFormModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md)\\<`T`\\>\n\nObject containing modal state, form data, and control functions\n\n## Example\n\n```tsx\nconst {\n isOpen,\n close,\n formData,\n openWithData,\n reset,\n isSubmitting,\n setIsSubmitting\n} = useFormModal();\n\nconst handleEdit = (campaign: Campaign) => {\n openWithData(campaign);\n};\n\nconst handleSubmit = async (e: FormEvent) => {\n e.preventDefault();\n setIsSubmitting(true);\n await updateCampaign(formData);\n setIsSubmitting(false);\n reset();\n};\n\nreturn (\n \n \n \n);\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useModalState/functions/useModalState.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useModalState()\n\n> **useModalState**(`initialState`): [`InterfaceUseModalStateReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md)\n\nDefined in: [src/shared-components/CRUDModalTemplate/hooks/useModalState.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/hooks/useModalState.ts#L27)\n\nCustom hook for managing modal open/close state.\n\nProvides a simple API for controlling modal visibility with\nopen, close, and toggle functions.\n\n## Parameters\n\n### initialState\n\n`boolean` = `false`\n\nInitial open state (defaults to false)\n\n## Returns\n\n[`InterfaceUseModalStateReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md)\n\nObject containing isOpen state and control functions\n\n## Example\n\n```tsx\nconst { isOpen, open, close } = useModalState();\n\nreturn (\n <>\n \n \n \n \n \n);\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/CRUDModalTemplate/hooks/useMutationModal/functions/useMutationModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useMutationModal()\n\n> **useMutationModal**\\<`TData`, `TResult`\\>(`mutationFn`, `options?`): [`InterfaceUseMutationModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md)\\<`TData`, `TResult`\\>\n\nDefined in: [src/shared-components/CRUDModalTemplate/hooks/useMutationModal.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CRUDModalTemplate/hooks/useMutationModal.ts#L57)\n\nCustom hook for modals that execute mutations (GraphQL or API calls).\n\nExtends useFormModal with mutation execution, error handling,\nand automatic state management during async operations.\n\n## Type Parameters\n\n### TData\n\n`TData`\n\n### TResult\n\n`TResult` = `unknown`\n\n## Parameters\n\n### mutationFn\n\n(`data`) => `Promise`\\<`TResult`\\>\n\nAsync function to execute (e.g., GraphQL mutation)\n\n### options?\n\nOptional callbacks for success and error handling\n\n#### allowEmptyData?\n\n`boolean`\n\n#### onError?\n\n(`error`) => `void`\n\n#### onSuccess?\n\n(`result`) => `void`\n\n## Returns\n\n[`InterfaceUseMutationModalReturn`](../../../../../types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md)\\<`TData`, `TResult`\\>\n\nObject containing modal state, form data, mutation execution, and error state\n\n## Example\n\n```tsx\nconst [updateCampaign] = useMutation(UPDATE_CAMPAIGN);\n\nconst {\n isOpen,\n formData,\n openWithData,\n reset,\n execute,\n isSubmitting,\n error,\n clearError\n} = useMutationModal(\n async (data) => {\n const result = await updateCampaign({ variables: { input: data } });\n return result.data;\n },\n {\n onSuccess: () => {\n toast.success('Campaign updated!');\n reset();\n },\n onError: (err) => {\n toast.error(err.message);\n }\n }\n);\n\nreturn (\n { e.preventDefault(); execute(); }}\n loading={isSubmitting}\n error={error?.message}\n title=\"Edit Campaign\"\n >\n \n \n);\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationSuccess.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: checkInMutationSuccess\n\n> `const` **checkInMutationSuccess**: `object`[]\n\nDefined in: [src/shared-components/CheckIn/CheckInMocks.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L64)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `MARK_CHECKIN`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n#### request.variables.userId\n\n> **userId**: `string` = `'user123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.checkIn\n\n> **checkIn**: `object`\n\n#### result.data.checkIn.checkinTime\n\n> **checkinTime**: `string`\n\n#### result.data.checkIn.checkoutTime\n\n> **checkoutTime**: `any` = `null`\n\n#### result.data.checkIn.feedbackSubmitted\n\n> **feedbackSubmitted**: `boolean` = `false`\n\n#### result.data.checkIn.id\n\n> **id**: `string` = `'123'`\n\n#### result.data.checkIn.isCheckedIn\n\n> **isCheckedIn**: `boolean` = `true`\n\n#### result.data.checkIn.isCheckedOut\n\n> **isCheckedOut**: `boolean` = `false`\n\n#### result.data.checkIn.user\n\n> **user**: `object`\n\n#### result.data.checkIn.user.id\n\n> **id**: `string` = `'user123'`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationSuccessRecurring.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: checkInMutationSuccessRecurring\n\n> `const` **checkInMutationSuccessRecurring**: `object`[]\n\nDefined in: [src/shared-components/CheckIn/CheckInMocks.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L104)\n\n## Type Declaration\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `MARK_CHECKIN`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.recurringEventInstanceId\n\n> **recurringEventInstanceId**: `string` = `'recurring123'`\n\n#### request.variables.userId\n\n> **userId**: `string` = `'user123'`\n\n### result\n\n> **result**: `object`\n\n#### result.data\n\n> **data**: `object`\n\n#### result.data.checkIn\n\n> **checkIn**: `object`\n\n#### result.data.checkIn.checkinTime\n\n> **checkinTime**: `string`\n\n#### result.data.checkIn.checkoutTime\n\n> **checkoutTime**: `any` = `null`\n\n#### result.data.checkIn.feedbackSubmitted\n\n> **feedbackSubmitted**: `boolean` = `false`\n\n#### result.data.checkIn.id\n\n> **id**: `string` = `'123'`\n\n#### result.data.checkIn.isCheckedIn\n\n> **isCheckedIn**: `boolean` = `true`\n\n#### result.data.checkIn.isCheckedOut\n\n> **isCheckedOut**: `boolean` = `false`\n\n#### result.data.checkIn.user\n\n> **user**: `object`\n\n#### result.data.checkIn.user.id\n\n> **id**: `string` = `'user123'`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInMutationUnsuccess.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: checkInMutationUnsuccess\n\n> `const` **checkInMutationUnsuccess**: `object`[]\n\nDefined in: [src/shared-components/CheckIn/CheckInMocks.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L91)\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `MARK_CHECKIN`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.eventId\n\n> **eventId**: `string` = `'event123'`\n\n#### request.variables.userId\n\n> **userId**: `string` = `'user123'`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/CheckInMocks/variables/checkInQueryMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: checkInQueryMock\n\n> `const` **checkInQueryMock**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `eventId`: `string`; \\}; \\}; `result`: \\{ `data`: \\{ `event`: \\{ `id`: `string`; `recurrenceRule`: `any`; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `eventId`: `string`; \\}; \\}; `result`: \\{ `data`: [`InterfaceAttendeeQueryResponse`](../../../../types/shared-components/CheckIn/interface/interfaces/InterfaceAttendeeQueryResponse.md); \\}; \\})[]\n\nDefined in: [src/shared-components/CheckIn/CheckInMocks.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInMocks.ts#L38)\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/CheckInWrapper/functions/CheckInWrapper.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: CheckInWrapper()\n\n> **CheckInWrapper**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/CheckIn/CheckInWrapper.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/CheckInWrapper.tsx#L32)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceCheckInWrapperProps`](../../../../types/shared-components/CheckInWrapper/interface/interfaces/InterfaceCheckInWrapperProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/Modal/CheckInModal/functions/CheckInModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: CheckInModal()\n\n> **CheckInModal**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/CheckIn/Modal/CheckInModal.tsx:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/Modal/CheckInModal.tsx#L36)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceModalProp`](../../../../../types/shared-components/CheckIn/interface/interfaces/InterfaceModalProp.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/Modal/Row/TableRow/functions/TableRow.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TableRow()\n\n> **TableRow**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/CheckIn/Modal/Row/TableRow.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/Modal/Row/TableRow.tsx#L41)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n#### data\n\n[`InterfaceTableCheckIn`](../../../../../../types/shared-components/CheckIn/interface/interfaces/InterfaceTableCheckIn.md)\n\n#### onCheckInUpdate?\n\n() => `void`\n\n#### refetch\n\n() => `void`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/CheckIn/tagTemplate/variables/tagTemplate.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: tagTemplate\n\n> `const` **tagTemplate**: `Template`\n\nDefined in: [src/shared-components/CheckIn/tagTemplate.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/CheckIn/tagTemplate.ts#L4)\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridErrorOverlay/functions/DataGridErrorOverlay.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataGridErrorOverlay()\n\n> **DataGridErrorOverlay**(`props`): `Element`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridErrorOverlay.tsx:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridErrorOverlay.tsx#L27)\n\nError overlay component for DataGrid\n\n## Parameters\n\n### props\n\n`InterfaceDataGridErrorOverlayProps`\n\nComponent props\n\n## Returns\n\n`Element`\n\nA centered error message overlay with an error icon\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridLoadingOverlay/functions/DataGridLoadingOverlay.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataGridLoadingOverlay()\n\n> **DataGridLoadingOverlay**(): `Element`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridLoadingOverlay.tsx:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridLoadingOverlay.tsx#L17)\n\nWrapper component to bridge GridLoadingOverlayProps and LoadingState.\nThis is used as the loadingOverlay slot in DataGrid to display a loading indicator.\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper/functions/DataGridWrapper.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataGridWrapper()\n\n> **DataGridWrapper**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.tsx:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.tsx#L121)\n\nA generic wrapper around MUI DataGrid with built-in search, sorting, and pagination.\n\n## Type Parameters\n\n### T\n\n`T` *extends* `object`\n\n## Parameters\n\n### props\n\n[`InterfaceDataGridWrapperProps`](../../../../types/DataGridWrapper/interface/interfaces/InterfaceDataGridWrapperProps.md)\\<`T`\\>\n\nComponent props defined by InterfaceDataGridWrapperProps\n\n## Returns\n\n`Element`\n\nA data grid with optional toolbar controls (search, sort) and enhanced features\n\n## Example\n\n```tsx\n// Basic usage with search and pagination\n\n\n// With custom empty state\n\n\n// Backward compatible with legacy emptyStateMessage\n\n```\n\n## Remarks\n\n- The `emptyStateProps` prop provides full customization of the empty state (icon, description, action button).\n- If both `emptyStateProps` and `emptyStateMessage` are provided, `emptyStateProps` takes precedence.\n- Error states always take precedence over empty states.\n- Accessibility: The component preserves a11y attributes (role=\"status\", aria-live, aria-label) when using either `emptyStateProps` or `emptyStateMessage`.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper/functions/convertTokenColumns.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: convertTokenColumns()\n\n> **convertTokenColumns**(`columns`): `GridColDef`[]\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.tsx#L46)\n\nConverts token-aware column definitions to MUI-compatible GridColDef.\nTransforms spacing token names (e.g., 'space-15') to pixel values (e.g., 150).\n\nUse this function when passing columns to raw DataGrid instead of DataGridWrapper.\n\n## Parameters\n\n### columns\n\n[`TokenAwareGridColDef`](../../../../types/DataGridWrapper/interface/type-aliases/TokenAwareGridColDef.md)[]\n\nArray of TokenAwareGridColDef with token names for width properties\n\n## Returns\n\n`GridColDef`[]\n\nArray of GridColDef with numeric pixel values\n\n## Example\n\n```tsx\nconst columns: TokenAwareGridColDef[] = [\n { field: 'name', minWidth: 'space-15' },\n];\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/BasicUsage.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: BasicUsage\n\n> `const` **BasicUsage**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L136)\n\nBasic usage of DataGridWrapper with minimal configuration.\nJust provide rows and columns to display a simple data table.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/CompleteExample.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: CompleteExample\n\n> `const` **CompleteExample**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:331](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L331)\n\nComplete example with all features enabled.\nDemonstrates search, sorting, pagination, and action column together.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/EmptyState.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EmptyState\n\n> `const` **EmptyState**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L291)\n\nDataGridWrapper with empty state.\nDisplays a message when no data is available.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/ErrorState.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ErrorState\n\n> `const` **ErrorState**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L311)\n\nDataGridWrapper with error state.\nShows an error message when data fetching fails.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/LoadingState.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: LoadingState\n\n> `const` **LoadingState**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L271)\n\nDataGridWrapper in loading state.\nDisplays a loading overlay while data is being fetched.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/SearchWithNoResults.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SearchWithNoResults\n\n> `const` **SearchWithNoResults**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L390)\n\nDataGridWrapper with custom empty state and search.\nShows how empty state interacts with search functionality.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithActionColumn.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithActionColumn\n\n> `const` **WithActionColumn**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L233)\n\nDataGridWrapper with custom action column.\nAdd interactive buttons for each row.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithPagination.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithPagination\n\n> `const` **WithPagination**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L209)\n\nDataGridWrapper with pagination enabled.\nUseful for displaying large datasets with configurable page sizes.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithRowClick.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithRowClick\n\n> `const` **WithRowClick**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:415](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L415)\n\nDataGridWrapper with row click handler.\nResponds to row clicks for navigation or modal opening.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithSearch.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithSearch\n\n> `const` **WithSearch**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L154)\n\nDataGridWrapper with integrated search functionality.\nSearch across multiple fields with a built-in search bar.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/WithSorting.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: WithSorting\n\n> `const` **WithSorting**: `Story`\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L178)\n\nDataGridWrapper with sorting dropdown.\nPre-configured sorting options for common use cases.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataGridWrapper/DataGridWrapper.stories/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `Meta`\\<*typeof* [`DataGridWrapper`](../../DataGridWrapper/functions/DataGridWrapper.md)\\>\n\nDefined in: [src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataGridWrapper/DataGridWrapper.stories.tsx#L114)\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/BulkActionsBar/functions/BulkActionsBar.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: BulkActionsBar()\n\n> **BulkActionsBar**(`count`): `Element`\n\nDefined in: [src/shared-components/DataTable/BulkActionsBar.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/BulkActionsBar.tsx#L18)\n\nBulkActionsBar displays a toolbar when rows are selected.\nShows the selected count, action buttons, and a clear button.\n\n## Parameters\n\n### count\n\n[`InterfaceBulkActionsBarProps`](../../../../types/shared-components/BulkActionsBar/interface/interfaces/InterfaceBulkActionsBarProps.md)\n\nThe number of selected rows.\n\n## Returns\n\n`Element`\n\nThe rendered toolbar or null if no rows are selected.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/DataTable/functions/DataTable.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataTable()\n\n> **DataTable**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/DataTable.tsx:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTable.tsx#L75)\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### props\n\n[`InterfaceDataTableProps`](../../../../types/shared-components/DataTable/props/type-aliases/InterfaceDataTableProps.md)\\<`T`\\>\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/DataTable/functions/defaultCompare.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: defaultCompare()\n\n> **defaultCompare**(`a`, `b`): `number`\n\nDefined in: [src/shared-components/DataTable/DataTable.tsx:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTable.tsx#L52)\n\n**`Internal`**\n\nCompare values with nulls last, numbers/dates/booleans handled explicitly.\n Exported for testing purposes.\n\n## Parameters\n\n### a\n\n`unknown`\n\n### b\n\n`unknown`\n\n## Returns\n\n`number`\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/DataTableSkeleton/functions/DataTableSkeleton.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataTableSkeleton()\n\n> **DataTableSkeleton**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/DataTableSkeleton.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTableSkeleton.tsx#L32)\n\nDataTableSkeleton component that displays a loading skeleton matching the table layout.\n\nRenders a responsive table structure with skeleton cells for each column and row,\nincluding optional selection checkbox and actions columns. The skeleton respects\nthe column definitions to ensure consistent layout during data loading.\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### props\n\n[`InterfaceDataTableSkeletonProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceDataTableSkeletonProps.md)\\<`T`\\>\n\nThe component props (`InterfaceDataTableSkeletonProps`):\n - ariaLabel: Optional accessible label\n - columns: Column definitions determining structure\n - effectiveSelectable: Whether to show selection checkbox\n - hasRowActions: Whether to show actions column\n - skeletonRows: Number of skeleton rows to display\n - tableClassNames: CSS class names for the table\n\n## Returns\n\n`Element`\n\nThe rendered skeleton table component\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/DataTableTable/functions/DataTableTable.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: DataTableTable()\n\n> **DataTableTable**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/DataTableTable.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/DataTableTable.tsx#L60)\n\nDataTableTable component for rendering the core table structure.\n\nRenders the HTML table with headers, rows, selection checkboxes, sorting indicators,\nand action cells. Handles user interactions for sorting, row selection, and displays\nloading states during pagination. Includes sorting UI, selection controls, and action cells.\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### props\n\n[`InterfaceDataTableTableProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceDataTableTableProps.md)\\<`T`\\>\n\nThe component props (`InterfaceDataTableTableProps`):\n Table structure (columns, sortedRows, ariaLabel, tableClassNames)\n Sorting (activeSortBy, activeSortDir, handleHeaderClick)\n Selection (effectiveSelectable, currentSelection, toggleRowSelection, headerCheckboxRef, selectAllOnPage, someSelectedOnPage, allSelectedOnPage)\n Rendering (renderRow, getKey, startIndex)\n Actions (hasRowActions, effectiveRowActions)\n Loading (loadingMore, skeletonRows, ariaBusy)\n Utilities (tCommon)\n\n## Returns\n\n`Element`\n\nThe rendered table JSX element with headers, rows, and optional loading indicators\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/LoadingMoreRows/functions/LoadingMoreRows.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: LoadingMoreRows()\n\n> **LoadingMoreRows**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/LoadingMoreRows.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/LoadingMoreRows.tsx#L29)\n\nLoadingMoreRows component that displays skeleton rows appended to a table.\n\nRenders placeholder rows with skeleton cells to indicate data is being loaded,\nmatching the table structure with optional selection checkboxes and actions columns.\nUseful for infinite scroll or \"load more\" pagination patterns.\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### props\n\n[`InterfaceLoadingMoreRowsProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceLoadingMoreRowsProps.md)\\<`T`\\>\n\nThe component props (`InterfaceLoadingMoreRowsProps`):\n - columns: Column definitions determining structure\n - effectiveSelectable: Whether to show selection checkbox column\n - hasRowActions: Whether to show actions column\n - skeletonRows: Number of skeleton rows to display\n\n## Returns\n\n`Element`\n\nA fragment containing skeleton table rows\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/Pagination/functions/PaginationControls.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: PaginationControls()\n\n> **PaginationControls**(`page`): `Element`\n\nDefined in: [src/shared-components/DataTable/Pagination.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/Pagination.tsx#L24)\n\nPaginationControls component for navigating through paginated data.\n\nType Safety: IPaginationControlsProps enforces number types for pageSize and totalItems.\nTypeScript prevents string/unknown types at compile-time, so runtime Number.isFinite()\nchecks are defensive fallbacks only (should never receive strings from properly-typed callers).\n\nAUDIT RESULT: All call sites verified (DataTable.tsx only caller):\n- pageSize: defaults to 10 (numeric), derived from props with number type\n- totalItems: comes from (totalItems ?? data.length), both numeric\n- No URL/form-based string-to-number coercion needed (type safety enforced)\n\n## Parameters\n\n### page\n\n[`InterfacePaginationControlsProps`](../../../../types/shared-components/DataTable/pagination/interfaces/InterfacePaginationControlsProps.md)\n\nCurrent page number (1-indexed)\n\n## Returns\n\n`Element`\n\nPagination navigation controls\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/SearchBar/functions/SearchBar.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: SearchBar()\n\n> **SearchBar**(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/SearchBar.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/SearchBar.tsx#L12)\n\nA controlled search input with optional clear button.\n\n## Parameters\n\n### props\n\n[`InterfaceSearchBarProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceSearchBarProps.md)\n\nComponent props containing value, onChange, placeholder, and aria-label\n\n## Returns\n\n`Element`\n\nA search input element with optional clear button\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/TableLoader/variables/TableLoader.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: TableLoader()\n\n> `const` **TableLoader**: \\<`T`\\>(`props`) => `ReactElement`\n\nDefined in: [src/shared-components/DataTable/TableLoader.tsx:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/TableLoader.tsx#L69)\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### props\n\n[`InterfaceTableLoaderProps`](../../../../types/shared-components/DataTable/props/interfaces/InterfaceTableLoaderProps.md)\\<`T`\\>\n\n## Returns\n\n`ReactElement`\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/cells/ActionsCell/functions/ActionsCell.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: ActionsCell()\n\n> **ActionsCell**\\<`T`\\>(`props`): `Element`\n\nDefined in: [src/shared-components/DataTable/cells/ActionsCell.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/cells/ActionsCell.tsx#L13)\n\nActionsCell renders a row of action buttons for a single table row.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of the row data\n\n## Parameters\n\n### props\n\n[`InterfaceActionsCellProps`](../../../../../types/shared-components/ActionsCell/interface/interfaces/InterfaceActionsCellProps.md)\\<`T`\\>\n\nProps containing row data and action definitions\n\n## Returns\n\n`Element`\n\nThe rendered actions cell element\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useDataTableFiltering/functions/useDataTableFiltering.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useDataTableFiltering()\n\n> **useDataTableFiltering**\\<`T`\\>(`options`): `object`\n\nDefined in: [src/shared-components/DataTable/hooks/useDataTableFiltering.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useDataTableFiltering.ts#L42)\n\nHook to manage DataTable filtering and search logic.\n\nProvides controlled and uncontrolled modes for both global search and\nper-column filtering. Handles client-side filtering when server flags\nare not set.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe row data type used in the DataTable\n\n## Parameters\n\n### options\n\n[`IUseDataTableFilteringOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseDataTableFilteringOptions.md)\\<`T`\\>\n\nConfiguration options for filtering behavior including:\n - `data` - Array of row data to filter\n - `columns` - Column definitions with filter/search metadata\n - `initialGlobalSearch` - Initial search value for uncontrolled mode\n - `globalSearch` - Controlled global search value\n - `onGlobalSearchChange` - Callback for controlled search updates\n - `columnFilters` - Column filter values by column ID\n - `onColumnFiltersChange` - Callback when column filters change\n - `serverSearch` - If true, skip client-side global search filtering\n - `serverFilter` - If true, skip client-side column filtering\n - `paginationMode` - Pagination mode affecting page reset behavior\n - `onPageReset` - Callback to reset page when filters change\n\n## Returns\n\n`object`\n\nObject containing:\n - `query` - Current global search string\n - `updateGlobalSearch` - Function to update the search query\n - `filteredRows` - Array of rows after applying filters\n - `filters` - Current column filter values\n\n### filteredRows\n\n> **filteredRows**: `T`[]\n\n### filters\n\n> **filters**: `Record`\\<`string`, `unknown`\\>\n\n### query\n\n> **query**: `string`\n\n### updateGlobalSearch()\n\n> **updateGlobalSearch**: (`next`) => `void`\n\n#### Parameters\n\n##### next\n\n`string`\n\n#### Returns\n\n`void`\n\n## Example\n\n```tsx\nconst { query, updateGlobalSearch, filteredRows } = useDataTableFiltering({\n data: users,\n columns: userColumns,\n initialGlobalSearch: '',\n});\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useDataTableSelection/functions/useDataTableSelection.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useDataTableSelection()\n\n> **useDataTableSelection**\\<`T`\\>(`options`): `object`\n\nDefined in: [src/shared-components/DataTable/hooks/useDataTableSelection.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useDataTableSelection.ts#L17)\n\nHook to manage DataTable selection and bulk action logic.\nSupports controlled and uncontrolled modes for row selection.\nNormalizes selection to current page keys on page changes.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe row data type\n\n## Parameters\n\n### options\n\n[`IUseDataTableSelectionOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseDataTableSelectionOptions.md)\\<`T`\\>\n\nConfiguration options for selection behavior\n\n## Returns\n\n`object`\n\nObject containing selection state and mutation helpers\n\n### allSelectedOnPage\n\n> **allSelectedOnPage**: `boolean`\n\n### clearSelection()\n\n> **clearSelection**: () => `void`\n\n#### Returns\n\n`void`\n\n### currentSelection\n\n> **currentSelection**: `Set`\\<[`Key`](../../../../../types/shared-components/DataTable/types/type-aliases/Key.md)\\>\n\n### runBulkAction()\n\n> **runBulkAction**: (`action`) => `void`\n\n#### Parameters\n\n##### action\n\n[`IBulkAction`](../../../../../types/shared-components/DataTable/hooks/interfaces/IBulkAction.md)\\<`T`\\>\n\n#### Returns\n\n`void`\n\n### selectAllOnPage()\n\n> **selectAllOnPage**: (`checked`) => `void`\n\n#### Parameters\n\n##### checked\n\n`boolean`\n\n#### Returns\n\n`void`\n\n### selectedCountOnPage\n\n> **selectedCountOnPage**: `number`\n\n### someSelectedOnPage\n\n> **someSelectedOnPage**: `boolean`\n\n### toggleRowSelection()\n\n> **toggleRowSelection**: (`key`) => `void`\n\n#### Parameters\n\n##### key\n\n[`Key`](../../../../../types/shared-components/DataTable/types/type-aliases/Key.md)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/functions/useSimpleTableData.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useSimpleTableData()\n\n> **useSimpleTableData**\\<`TRow`, `TData`\\>(`result`, `options`): [`IUseSimpleTableDataResult`](../interfaces/IUseSimpleTableDataResult.md)\\<`TRow`, `TData`\\>\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L67)\n\nHook for integrating simple array-based GraphQL queries with DataTable.\nUse this for queries that return arrays directly, not connection format.\n\nFor connection-based queries (with edges/pageInfo), use useTableData instead.\n\n## Type Parameters\n\n### TRow\n\n`TRow` = `unknown`\n\n### TData\n\n`TData` = `unknown`\n\n## Parameters\n\n### result\n\n`QueryResult`\\<`TData`\\>\n\n### options\n\n[`IUseSimpleTableDataOptions`](../interfaces/IUseSimpleTableDataOptions.md)\\<`TRow`, `TData`\\>\n\n## Returns\n\n[`IUseSimpleTableDataResult`](../interfaces/IUseSimpleTableDataResult.md)\\<`TRow`, `TData`\\>\n\n## Example\n\n```tsx\nconst queryResult = useQuery(MEMBERSHIP_REQUEST_PG, {\n variables: { input: { id: orgId }, first: 10 }\n});\n\n// Path function MUST be memoized with useCallback\nconst extractRequests = useCallback(\n (data: InterfaceMembershipRequestsQueryData) =>\n data?.organization?.membershipRequests ?? [],\n []\n);\n\nconst { rows, loading, error, refetch } = useSimpleTableData<\n InterfaceRequestsListItem,\n InterfaceMembershipRequestsQueryData\n>(queryResult, {\n path: extractRequests\n});\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/interfaces/IUseSimpleTableDataOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseSimpleTableDataOptions\\\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L7)\n\nOptions for useSimpleTableData hook\n\n## Type Parameters\n\n### TRow\n\n`TRow`\n\n### TData\n\n`TData`\n\n## Properties\n\n### path()\n\n> **path**: (`data`) => `TRow`[]\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L12)\n\nPath function to extract array data from GraphQL response.\nIMPORTANT: Must be memoized with useCallback for stable reference.\n\n#### Parameters\n\n##### data\n\n`TData`\n\n#### Returns\n\n`TRow`[]\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useSimpleTableData/interfaces/IUseSimpleTableDataResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseSimpleTableDataResult\\\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L18)\n\nResult returned by useSimpleTableData hook\n\n## Type Parameters\n\n### TRow\n\n`TRow`\n\n### TData\n\n`TData`\n\n## Properties\n\n### error\n\n> **error**: `ApolloError`\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L31)\n\nError from the query, if any.\nPreserves ApolloError properties (graphQLErrors, networkError, etc.)\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L26)\n\nLoading state from the query\n\n***\n\n### refetch()\n\n> **refetch**: (`variables?`) => `Promise`\\<`ApolloQueryResult`\\<`TData`\\>\\>\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L37)\n\nFunction to refetch the query.\nReturns a Promise that resolves with Apollo query result.\nMatches Apollo's refetch signature: can accept variables and returns Promise.\n\n#### Parameters\n\n##### variables?\n\n`Partial`\\<`TVariables`\\>\n\n#### Returns\n\n`Promise`\\<`ApolloQueryResult`\\<`TData`\\>\\>\n\n***\n\n### rows\n\n> **rows**: `TRow`[]\n\nDefined in: [src/shared-components/DataTable/hooks/useSimpleTableData.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useSimpleTableData.ts#L22)\n\nExtracted rows from the query data\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/hooks/useTableData/functions/useTableData.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useTableData()\n\n> **useTableData**\\<`TNode`, `TRow`, `TData`\\>(`result`, `options`): [`IUseTableDataResult`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md)\\<`TRow`, `TData`\\>\n\nDefined in: [src/shared-components/DataTable/hooks/useTableData.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/hooks/useTableData.ts#L12)\n\nExtract GraphQL connection data into table rows with optional node transform; filters null nodes.\n\n## Type Parameters\n\n### TNode\n\n`TNode` = `unknown`\n\n### TRow\n\n`TRow` = `TNode`\n\n### TData\n\n`TData` = `unknown`\n\n## Parameters\n\n### result\n\n`QueryResult`\\<`TData`\\>\n\n### options\n\n[`IUseTableDataOptions`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataOptions.md)\\<`TNode`, `TRow`, `TData`\\>\n\n## Returns\n\n[`IUseTableDataResult`](../../../../../types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md)\\<`TRow`, `TData`\\>\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/utils/functions/getCellValue.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getCellValue()\n\n> **getCellValue**\\<`T`, `TValue`\\>(`row`, `accessor`): `TValue`\n\nDefined in: [src/shared-components/DataTable/utils.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L41)\n\nHelper to get raw cell value from a row using the accessor.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe row data type\n\n### TValue\n\n`TValue` = `unknown`\n\nThe expected return value type\n\n## Parameters\n\n### row\n\n`T`\n\nThe row data object\n\n### accessor\n\n[`Accessor`](../../../../types/shared-components/DataTable/types/type-aliases/Accessor.md)\\<`T`, `TValue`\\>\n\nColumn accessor (property key or function)\n\n## Returns\n\n`TValue`\n\nThe cell value\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/utils/functions/renderCellValue.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: renderCellValue()\n\n> **renderCellValue**(`value`): `string` \\| `number`\n\nDefined in: [src/shared-components/DataTable/utils.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L22)\n\nRenders a cell value for display.\n\n## Parameters\n\n### value\n\n`unknown`\n\nRaw cell value.\n\n## Returns\n\n`string` \\| `number`\n\nDisplay-safe string or primitive.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/utils/functions/renderHeader.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: renderHeader()\n\n> **renderHeader**(`header`): `ReactNode`\n\nDefined in: [src/shared-components/DataTable/utils.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L12)\n\nRenders the header of a column.\n\n## Parameters\n\n### header\n\n[`HeaderRender`](../../../../types/shared-components/DataTable/types/type-aliases/HeaderRender.md)\n\nHeader value or render function.\n\n## Returns\n\n`ReactNode`\n\nThe rendered header content.\n" }, { "path": "docs/docs/auto-docs/shared-components/DataTable/utils/functions/toSearchableString.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: toSearchableString()\n\n> **toSearchableString**(`v`): `string`\n\nDefined in: [src/shared-components/DataTable/utils.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DataTable/utils.ts#L56)\n\nHelper for text search interactions.\n\n## Parameters\n\n### v\n\n`unknown`\n\nValue to stringify for search.\n\n## Returns\n\n`string`\n\nSearchable string.\n" }, { "path": "docs/docs/auto-docs/shared-components/DatePicker/DatePicker/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceDatePickerProps`](../../../../types/shared-components/DatePicker/interface/interfaces/InterfaceDatePickerProps.md)\\>\n\nDefined in: [src/shared-components/DatePicker/DatePicker.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DatePicker/DatePicker.tsx#L25)\n" }, { "path": "docs/docs/auto-docs/shared-components/DateRangePicker/DateRangePicker/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/DateRangePicker/DateRangePicker.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DateRangePicker/DateRangePicker.tsx#L74)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceDateRangePickerProps`](../../../../types/shared-components/DateRangePicker/interface/interfaces/InterfaceDateRangePickerProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/baseProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: baseProps\n\n> `const` **baseProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L30)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/basicOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: basicOptions\n\n> `const` **basicOptions**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[]\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L16)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/customLabelProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: customLabelProps\n\n> `const` **customLabelProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L51)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/disabledDropdownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: disabledDropdownProps\n\n> `const` **disabledDropdownProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L46)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/disabledOptionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: disabledOptionProps\n\n> `const` **disabledOptionProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L67)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/dropUpProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dropUpProps\n\n> `const` **dropUpProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L85)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/mockOnSelect.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: mockOnSelect\n\n> `const` **mockOnSelect**: `Mock`\\<`Procedure`\\>\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L28)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/noSelectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: noSelectionProps\n\n> `const` **noSelectionProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L40)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/noTestIdProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: noTestIdProps\n\n> `const` **noTestIdProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L77)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/optionsWithDisabled.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: optionsWithDisabled\n\n> `const` **optionsWithDisabled**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[]\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L22)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/optionsWithNonStringLabel.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: optionsWithNonStringLabel\n\n> `const` **optionsWithNonStringLabel**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[]\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L109)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/searchableMinimalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: searchableMinimalProps\n\n> `const` **searchableMinimalProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L95)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/searchableOptionsForCoverage.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: searchableOptionsForCoverage\n\n> `const` **searchableOptionsForCoverage**: [`InterfaceDropDownOption`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md)[]\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L90)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/styledProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: styledProps\n\n> `const` **styledProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L61)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/variantProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: variantProps\n\n> `const` **variantProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L72)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withIconProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: withIconProps\n\n> `const` **withIconProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L56)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withIconSearchProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: withIconSearchProps\n\n> `const` **withIconSearchProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L104)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/DropDownButton.mocks/variables/withNonStringLabelProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: withNonStringLabelProps\n\n> `const` **withNonStringLabelProps**: [`InterfaceDropDownButtonProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.mocks.tsx:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.mocks.tsx#L114)\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/SearchToggle/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `ForwardRefExoticComponent`\\<[`InterfaceSearchToggleProps`](../../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceSearchToggleProps.md) & `RefAttributes`\\<`HTMLDivElement`\\>\\>\n\nDefined in: [src/shared-components/DropDownButton/SearchToggle.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/SearchToggle.tsx#L12)\n\nCustom Toggle for Search functionality.\nRenders an input field that acts as a dropdown toggle.\n\n## Param\n\nThe props for the SearchToggle component.\n\n## Param\n\nThe ref forwarded to the div element.\n" }, { "path": "docs/docs/auto-docs/shared-components/DropDownButton/variables/DropDownButton.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DropDownButton\n\n> `const` **DropDownButton**: `React.FC`\\<[`InterfaceDropDownButtonProps`](../../../types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md)\\>\n\nDefined in: [src/shared-components/DropDownButton/DropDownButton.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/DropDownButton/DropDownButton.tsx#L56)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyState/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\\>\n\nDefined in: [src/shared-components/EmptyState/EmptyState.tsx:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyState.tsx#L73)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateBaseForActionMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateBaseForActionMock\n\n> `const` **emptyStateBaseForActionMock**: `Omit`\\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md), `\"action\"`\\>\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L23)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateBaseMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateBaseMock\n\n> `const` **emptyStateBaseMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L4)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithAllPropsMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithAllPropsMock\n\n> `const` **emptyStateWithAllPropsMock**: `Omit`\\<[`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md), `\"action\"`\\>\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L30)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomCSSMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithCustomCSSMock\n\n> `const` **emptyStateWithCustomCSSMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L41)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomDataTestIdMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithCustomDataTestIdMock\n\n> `const` **emptyStateWithCustomDataTestIdMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L46)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithCustomIconMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithCustomIconMock\n\n> `const` **emptyStateWithCustomIconMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L18)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithDescriptionMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithDescriptionMock\n\n> `const` **emptyStateWithDescriptionMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L8)\n" }, { "path": "docs/docs/auto-docs/shared-components/EmptyState/EmptyStateMocks/variables/emptyStateWithIconMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: emptyStateWithIconMock\n\n> `const` **emptyStateWithIconMock**: [`InterfaceEmptyStateProps`](../../../../types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/shared-components/EmptyState/EmptyStateMocks.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EmptyState/EmptyStateMocks.ts#L13)\n" }, { "path": "docs/docs/auto-docs/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper/classes/ErrorBoundaryWrapper.md", "content": "[Admin Docs](/)\n\n***\n\n# Class: ErrorBoundaryWrapper\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L58)\n\n## Extends\n\n- `Component`\\<[`InterfaceErrorBoundaryWrapperProps`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md), [`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\\>\n\n## Constructors\n\n### Constructor\n\n> **new ErrorBoundaryWrapper**(`props`): `ErrorBoundaryWrapper`\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L63)\n\n#### Parameters\n\n##### props\n\n[`InterfaceErrorBoundaryWrapperProps`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md)\n\n#### Returns\n\n`ErrorBoundaryWrapper`\n\n#### Overrides\n\n`React.Component< InterfaceErrorBoundaryWrapperProps, InterfaceErrorBoundaryWrapperState >.constructor`\n\n## Methods\n\n### componentDidCatch()\n\n> **componentDidCatch**(`error`, `errorInfo`): `void`\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L90)\n\nLog error details after an error has been caught\nThis lifecycle method is called during the commit phase (to log/ report)\n\n#### Parameters\n\n##### error\n\n`Error`\n\n##### errorInfo\n\n`ErrorInfo`\n\n#### Returns\n\n`void`\n\n#### Overrides\n\n`React.Component.componentDidCatch`\n\n***\n\n### handleReset()\n\n> **handleReset**(): `void`\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L117)\n\nReset error boundary state to recover from error\n\n#### Returns\n\n`void`\n\n***\n\n### render()\n\n> **render**(): `ReactNode`\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L136)\n\n#### Returns\n\n`ReactNode`\n\n#### Overrides\n\n`React.Component.render`\n\n***\n\n### getDerivedStateFromError()\n\n> `static` **getDerivedStateFromError**(`error`): `Partial`\\<[`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\\>\n\nDefined in: [src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorBoundaryWrapper/ErrorBoundaryWrapper.tsx#L76)\n\nUpdate state when an error is caught\nThis lifecycle method is called during the render phase (to change UI)\n\n#### Parameters\n\n##### error\n\n`Error`\n\n#### Returns\n\n`Partial`\\<[`InterfaceErrorBoundaryWrapperState`](../../../../types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md)\\>\n" }, { "path": "docs/docs/auto-docs/shared-components/ErrorPanel/ErrorPanel/interfaces/InterfaceErrorPanelProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceErrorPanelProps\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L53)\n\n## Properties\n\n### ariaLive?\n\n> `optional` **ariaLive**: `\"off\"` \\| `\"polite\"` \\| `\"assertive\"`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L87)\n\nARIA live region setting (only used when role is not 'alert', defaults to 'assertive')\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L77)\n\nAdditional CSS class name for the container\n\n***\n\n### error\n\n> **error**: `Error`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L62)\n\nThe error object containing additional error details\n\n***\n\n### message\n\n> **message**: `ReactNode`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L57)\n\nThe main error message to display (can be a string or React node)\n\n***\n\n### onRetry()\n\n> **onRetry**: () => `void`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L67)\n\nCallback function to retry the failed operation\n\n#### Returns\n\n`void`\n\n***\n\n### retryAriaLabel?\n\n> `optional` **retryAriaLabel**: `string`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L92)\n\nARIA label for the retry button (only set if different from button text)\n\n***\n\n### role?\n\n> `optional` **role**: `\"status\"` \\| `\"alert\"` \\| `\"log\"` \\| `\"marquee\"` \\| `\"timer\"`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L82)\n\nARIA role for accessibility (role=\"alert\" implies aria-live=\"assertive\", defaults to 'alert')\n\n***\n\n### showErrorDetails?\n\n> `optional` **showErrorDetails**: `boolean`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L98)\n\nWhether to show raw error details (for development/debugging)\nWhen false, displays a sanitized/truncated message instead (defaults to false)\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L72)\n\nTest ID for the error message container (defaults to 'errorMsg')\n" }, { "path": "docs/docs/auto-docs/shared-components/ErrorPanel/ErrorPanel/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceErrorPanelProps`](../interfaces/InterfaceErrorPanelProps.md)\\>\n\nDefined in: [src/shared-components/ErrorPanel/ErrorPanel.tsx:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ErrorPanel/ErrorPanel.tsx#L105)\n\nErrorPanel component that displays error information with a retry button.\nSanitizes sensitive information from error messages and logs full errors to console.\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/EventForm/functions/formatRecurrenceForPayload.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: formatRecurrenceForPayload()\n\n> **formatRecurrenceForPayload**(`recurrenceRule`, `startDate`): `Omit`\\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `\"endDate\"`\\> & `object`\n\nDefined in: [src/shared-components/EventForm/EventForm.tsx:556](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/EventForm.tsx#L556)\n\nFormats a recurrence rule for API submission.\n\n## Parameters\n\n### recurrenceRule\n\n[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nThe recurrence rule to format\n\n### startDate\n\n`Date`\n\nThe event start date\n\n## Returns\n\n`Omit`\\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `\"endDate\"`\\> & `object`\n\nThe formatted recurrence string or null\n\n## Throws\n\nError if the recurrence rule is invalid\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/EventForm/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`IEventFormProps`](../../../../types/EventForm/interface/interfaces/IEventFormProps.md)\\>\n\nDefined in: [src/shared-components/EventForm/EventForm.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/EventForm.tsx#L41)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/RecurrenceDropdown/RecurrenceDropdown/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceRecurrenceDropdownProps`](../../../../../types/shared-components/RecurrenceDropdown/interface/interfaces/InterfaceRecurrenceDropdownProps.md)\\>\n\nDefined in: [src/shared-components/EventForm/RecurrenceDropdown/RecurrenceDropdown.tsx:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/RecurrenceDropdown/RecurrenceDropdown.tsx#L16)\n\nRenders a dropdown for selecting recurrence patterns.\n\n## Param\n\nComponent props from InterfaceRecurrenceDropdownProps\n\n## Returns\n\nJSX.Element - The recurrence dropdown component\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/VisibilitySelector/VisibilitySelector/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceVisibilitySelectorProps`](../../../../../types/shared-components/VisibilitySelector/interface/interfaces/InterfaceVisibilitySelectorProps.md)\\>\n\nDefined in: [src/shared-components/EventForm/VisibilitySelector/VisibilitySelector.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/VisibilitySelector/VisibilitySelector.tsx#L13)\n\nRenders a radio button group for selecting event visibility.\n\n## Param\n\nComponent props\n\n## Returns\n\nThe visibility selector JSX\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/utils/recurrenceOptions/functions/buildRecurrenceOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: buildRecurrenceOptions()\n\n> **buildRecurrenceOptions**(`startDate`, `t`): [`InterfaceRecurrenceOption`](../interfaces/InterfaceRecurrenceOption.md)[]\n\nDefined in: [src/shared-components/EventForm/utils/recurrenceOptions.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/recurrenceOptions.ts#L26)\n\nBuilds an array of recurrence options based on the event start date.\n\n## Parameters\n\n### startDate\n\n`Date`\n\nThe event start date\n\n### t\n\n(`key`, `options?`) => `string`\n\nTranslation function for option labels\n\n## Returns\n\n[`InterfaceRecurrenceOption`](../interfaces/InterfaceRecurrenceOption.md)[]\n\nArray of recurrence options for the dropdown\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceOption\n\nDefined in: [src/shared-components/EventForm/utils/recurrenceOptions.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/recurrenceOptions.ts#L15)\n\nRepresents a recurrence option in the dropdown.\n\n## Properties\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/shared-components/EventForm/utils/recurrenceOptions.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/recurrenceOptions.ts#L16)\n\n***\n\n### value\n\n> **value**: `\"custom\"` \\| [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/shared-components/EventForm/utils/recurrenceOptions.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/recurrenceOptions.ts#L17)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/utils/timeUtils/functions/timeToDayJs.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: timeToDayJs()\n\n> **timeToDayJs**(`time`): `Dayjs`\n\nDefined in: [src/shared-components/EventForm/utils/timeUtils.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/timeUtils.ts#L13)\n\nConverts a time string (HH:mm:ss) to a dayjs object.\n\n## Parameters\n\n### time\n\n`string`\n\nTime string in HH:mm:ss format\n\n## Returns\n\n`Dayjs`\n\nA dayjs object with the specified time set on today's date\n\n## Example\n\n```ts\ntimeToDayJs('14:30:00') // Returns dayjs object for 2:30 PM today\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/utils/visibilityUtils/functions/getVisibilityType.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getVisibilityType()\n\n> **getVisibilityType**(`isPublic?`, `isInviteOnly?`): [`EventVisibility`](../type-aliases/EventVisibility.md)\n\nDefined in: [src/shared-components/EventForm/utils/visibilityUtils.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/visibilityUtils.ts#L19)\n\nDetermines the visibility type based on boolean flags.\n\n## Parameters\n\n### isPublic?\n\n`boolean`\n\nWhether the event is public\n\n### isInviteOnly?\n\n`boolean`\n\nWhether the event is invite-only\n\n## Returns\n\n[`EventVisibility`](../type-aliases/EventVisibility.md)\n\nThe corresponding EventVisibility value\n" }, { "path": "docs/docs/auto-docs/shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventVisibility\n\n> **EventVisibility** = `\"PUBLIC\"` \\| `\"ORGANIZATION\"` \\| `\"INVITE_ONLY\"`\n\nDefined in: [src/shared-components/EventForm/utils/visibilityUtils.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventForm/utils/visibilityUtils.ts#L11)\n\nRepresents the visibility level of an event.\n- PUBLIC: Visible to everyone\n- ORGANIZATION: Visible to organization members only\n- INVITE_ONLY: Visible only to invited attendees\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/EventListCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/shared-components/EventListCard/EventListCard.tsx:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/EventListCard.tsx#L40)\n\nProps for the EventListCard component.\n\n## Parameters\n\n### props\n\n[`IEventListCard`](../../../../types/Event/interface/interfaces/IEventListCard.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/EventListCardProps.mock/variables/props.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: props\n\n> `const` **props**: `IEventListCardProps`[]\n\nDefined in: [src/shared-components/EventListCard/EventListCardProps.mock.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/EventListCardProps.mock.ts#L8)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/Delete/EventListCardDeleteModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceDeleteEventModalProps`](../../../../../../types/Event/interface/type-aliases/InterfaceDeleteEventModalProps.md)\\>\n\nDefined in: [src/shared-components/EventListCard/Modal/Delete/EventListCardDeleteModal.tsx:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/Delete/EventListCardDeleteModal.tsx#L44)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardMocks/variables/ERROR_MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ERROR\\_MOCKS\n\n> `const` **ERROR\\_MOCKS**: `object`[]\n\nDefined in: [src/shared-components/EventListCard/Modal/EventListCardMocks.ts:295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/EventListCardMocks.ts#L295)\n\n## Type Declaration\n\n### error\n\n> **error**: `Error`\n\n### request\n\n> **request**: `object`\n\n#### request.query\n\n> **query**: `DocumentNode` = `DELETE_STANDALONE_EVENT_MUTATION`\n\n#### request.variables\n\n> **variables**: `object`\n\n#### request.variables.input\n\n> **input**: `object`\n\n#### request.variables.input.id\n\n> **id**: `string` = `'1'`\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardMocks/variables/MOCKS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: MOCKS\n\n> `const` **MOCKS**: (\\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id?`: `undefined`; `input`: \\{ `allDay?`: `undefined`; `description?`: `undefined`; `endAt?`: `undefined`; `id`: `string`; `isPublic?`: `undefined`; `isRegisterable?`: `undefined`; `location?`: `undefined`; `name?`: `undefined`; `startAt?`: `undefined`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `deleteStandaloneEvent`: \\{ `id`: `string`; \\}; `registerForEvent?`: `undefined`; `updateStandaloneEvent?`: `undefined`; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id?`: `undefined`; `input`: \\{ `allDay`: `boolean`; `description`: `string`; `endAt`: `string`; `id`: `string`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `name`: `string`; `startAt`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `deleteStandaloneEvent?`: `undefined`; `registerForEvent?`: `undefined`; `updateStandaloneEvent`: \\{ `allDay`: `boolean`; `createdAt`: `string`; `creator`: \\{ `id`: `string`; `name`: `string`; \\}; `description`: `string`; `endAt`: `string`; `id`: `string`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `name`: `string`; `organization`: \\{ `id`: `string`; `name`: `string`; \\}; `startAt`: `string`; `updatedAt`: `string`; `updater`: \\{ `id`: `string`; `name`: `string`; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id?`: `undefined`; `input`: \\{ `allDay?`: `undefined`; `description`: `string`; `endAt`: `string`; `id`: `string`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `name`: `string`; `startAt`: `string`; \\}; \\}; \\}; `result`: \\{ `data`: \\{ `deleteStandaloneEvent?`: `undefined`; `registerForEvent?`: `undefined`; `updateStandaloneEvent`: \\{ `allDay`: `boolean`; `createdAt`: `string`; `creator`: \\{ `id`: `string`; `name`: `string`; \\}; `description`: `string`; `endAt`: `string`; `id`: `string`; `isPublic`: `boolean`; `isRegisterable`: `boolean`; `location`: `string`; `name`: `string`; `organization`: \\{ `id`: `string`; `name`: `string`; \\}; `startAt`: `string`; `updatedAt`: `string`; `updater`: \\{ `id`: `string`; `name`: `string`; \\}; \\}; \\}; \\}; \\} \\| \\{ `request`: \\{ `query`: `DocumentNode`; `variables`: \\{ `id`: `string`; `input?`: `undefined`; \\}; \\}; `result`: \\{ `data`: \\{ `deleteStandaloneEvent?`: `undefined`; `registerForEvent`: `object`[]; `updateStandaloneEvent?`: `undefined`; \\}; \\}; \\})[]\n\nDefined in: [src/shared-components/EventListCard/Modal/EventListCardMocks.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/EventListCardMocks.ts#L8)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/EventListCardModals/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/EventListCard/Modal/EventListCardModals.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/EventListCardModals.tsx#L54)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceEventListCardModalsProps`](../../../../../types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCardModalsProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/Preview/EventListCardPreviewModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePreviewEventModalProps`](../../../../../../types/Event/interface/type-aliases/InterfacePreviewEventModalProps.md)\\>\n\nDefined in: [src/shared-components/EventListCard/Modal/Preview/EventListCardPreviewModal.tsx:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/Preview/EventListCardPreviewModal.tsx#L59)\n" }, { "path": "docs/docs/auto-docs/shared-components/EventListCard/Modal/updateLogic/functions/useUpdateEventHandler.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useUpdateEventHandler()\n\n> **useUpdateEventHandler**(): `object`\n\nDefined in: [src/shared-components/EventListCard/Modal/updateLogic.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/EventListCard/Modal/updateLogic.ts#L28)\n\nCreates the update handler for EventListCard modal edits, managing mutations for standalone and recurring events.\n\n## Returns\n\n`object`\n\nAn object containing the update logic:\n- updateEventHandler: `(args: IUpdateEventHandlerProps) => Promise` - Asynchronous function that handles the event update process, including validation and mutation execution.\n\n### updateEventHandler()\n\n> **updateEventHandler**: (`__namedParameters`) => `Promise`\\<`void`\\>\n\n#### Parameters\n\n##### \\_\\_namedParameters\n\n[`InterfaceUpdateEventHandlerProps`](../../../../../types/shared-components/EventListCard/interface/interfaces/InterfaceUpdateEventHandlerProps.md)\n\n#### Returns\n\n`Promise`\\<`void`\\>\n" }, { "path": "docs/docs/auto-docs/shared-components/FormFieldGroup/FormCheckField/variables/FormCheckField.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FormCheckField\n\n> `const` **FormCheckField**: `React.FC`\\<[`InterfaceFormCheckFieldProps`](../../../../types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md)\\>\n\nDefined in: [src/shared-components/FormFieldGroup/FormCheckField.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormCheckField.tsx#L13)\n\nRenders a checkbox, radio, or switch input field within a FormFieldGroup for consistent styling and validation.\nUse this component to wrap Form.Check and Form.Switch elements.\n\n## Param\n\nThe properties for the FormCheckField component.\n\n## Returns\n\nA form check React element.\n" }, { "path": "docs/docs/auto-docs/shared-components/FormFieldGroup/FormFieldGroup/variables/FormFieldGroup.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FormFieldGroup\n\n> `const` **FormFieldGroup**: `React.FC`\\<[`InterfaceFormFieldGroupProps`](../../../../types/FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md) & `object`\\>\n\nDefined in: [src/shared-components/FormFieldGroup/FormFieldGroup.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormFieldGroup.tsx#L12)\n\nRenders a grouped form field with label, help text, error, and children elements.\n\n## Param\n\nThe properties for the FormFieldGroup component.\n\n## Returns\n\nA form group React element.\n" }, { "path": "docs/docs/auto-docs/shared-components/FormFieldGroup/FormSelectField/variables/FormSelectField.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FormSelectField\n\n> `const` **FormSelectField**: `React.FC`\\<[`InterfaceFormSelectFieldProps`](../../../../types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md)\\>\n\nDefined in: [src/shared-components/FormFieldGroup/FormSelectField.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormSelectField.tsx#L20)\n\nRenders a select input field within a FormFieldGroup for consistent styling and validation.\n\n`@param` name - Field name/id.\n`@param` label - Field label text.\n`@param` required - Whether the field is required.\n`@param` helpText - Helper text below the field.\n`@param` error - Validation error message.\n`@param` touched - Whether the field has been touched.\n`@param` value - Current selected value.\n`@param` onChange - Value change handler.\n`@param` children - Option elements.\n\n## Returns\n\nA select field React element.\n" }, { "path": "docs/docs/auto-docs/shared-components/FormFieldGroup/FormTextField/variables/FormTextField.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FormTextField\n\n> `const` **FormTextField**: `React.FC`\\<[`IFormTextFieldProps`](../../../../types/FormFieldGroup/interface/interfaces/IFormTextFieldProps.md)\\>\n\nDefined in: [src/shared-components/FormFieldGroup/FormTextField.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/FormFieldGroup/FormTextField.tsx#L12)\n\nRenders a text input field within a FormFieldGroup for consistent styling and validation.\n\n## Param\n\nThe properties for the FormTextField component.\n\n## Returns\n\nA text field React element.\n" }, { "path": "docs/docs/auto-docs/shared-components/InfiniteScrollLoader/InfiniteScrollLoader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/shared-components/InfiniteScrollLoader/InfiniteScrollLoader.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/InfiniteScrollLoader/InfiniteScrollLoader.tsx#L29)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/LoadingState/LoadingState/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/LoadingState/LoadingState.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/LoadingState/LoadingState.tsx#L38)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceLoadingStateProps`](../../../../types/shared-components/LoadingState/interface/type-aliases/InterfaceLoadingStateProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/Navbar/Navbar/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/Navbar/Navbar.tsx:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Navbar/Navbar.tsx#L56)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfacePageHeaderProps`](../../../../types/shared-components/Navbar/interface/interfaces/InterfacePageHeaderProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/NotificationToast/NotificationToast/functions/NotificationToastContainer.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: NotificationToastContainer()\n\n> **NotificationToastContainer**(`props`): `ReactElement`\n\nDefined in: [src/shared-components/NotificationToast/NotificationToast.tsx:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/NotificationToast/NotificationToast.tsx#L148)\n\nNotificationToastContainer\n\nWrapper for `ToastContainer` with project defaults. Consumers can override\nany prop via `props`.\n\n## Parameters\n\n### props\n\n`ToastContainerProps` = `{}`\n\nOptional ToastContainerProps to override DEFAULT_CONTAINER_PROPS\n\n## Returns\n\n`ReactElement`\n\nReact.ReactElement rendering ToastContainer with merged props\n" }, { "path": "docs/docs/auto-docs/shared-components/NotificationToast/NotificationToast/variables/NotificationToast.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: NotificationToast\n\n> `const` **NotificationToast**: [`InterfaceNotificationToastHelpers`](../../../../types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastHelpers.md)\n\nDefined in: [src/shared-components/NotificationToast/NotificationToast.tsx:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/NotificationToast/NotificationToast.tsx#L126)\n\nNotificationToast\n\nA small wrapper around `react-toastify` that standardizes toast defaults and\nsupports translating messages with an explicit i18n namespace.\n\n## Examples\n\n```ts\nNotificationToast.success('Saved');\n```\n\n```ts\nNotificationToast.error({ key: 'unknownError', namespace: 'errors' });\n```\n\n```ts\nNotificationToast.dismiss(); // Dismiss all active toasts\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/OrganizationCard/OrganizationCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L64)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceOrganizationCardPropsPG`](../interfaces/InterfaceOrganizationCardPropsPG.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/OrganizationCard/OrganizationCard/interfaces/InterfaceOrganizationCardPropsPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationCardPropsPG\n\nDefined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L60)\n\n## Properties\n\n### data\n\n> **data**: [`InterfaceOrganizationCardProps`](../../../../types/OrganizationCard/interface/interfaces/InterfaceOrganizationCardProps.md)\n\nDefined in: [src/shared-components/OrganizationCard/OrganizationCard.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/OrganizationCard/OrganizationCard.tsx#L61)\n" }, { "path": "docs/docs/auto-docs/shared-components/PaginationList/PaginationList/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/PaginationList/PaginationList.tsx:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PaginationList/PaginationList.tsx#L39)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfacePaginationListProps`](../../../../types/shared-components/PaginationList/interface/interfaces/InterfacePaginationListProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/PeopleTabNavbar/PeopleTabNavbar/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/PeopleTabNavbar/PeopleTabNavbar.tsx:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabNavbar/PeopleTabNavbar.tsx#L53)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfacePeopleTabNavbarProps`](../../../../types/shared-components/PeopleTabNavbar/interface/interfaces/InterfacePeopleTabNavbarProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePeopleTabNavbar`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbar.md)\\>\n\nDefined in: [src/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton.tsx:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabNavbarButton/PeopleTabNavbarButton.tsx#L35)\n" }, { "path": "docs/docs/auto-docs/shared-components/PeopleTabUserEvents/PeopleTabUserEvents/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePeopletabUserEventsProps`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopletabUserEventsProps.md)\\>\n\nDefined in: [src/shared-components/PeopleTabUserEvents/PeopleTabUserEvents.tsx:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabUserEvents/PeopleTabUserEvents.tsx#L46)\n" }, { "path": "docs/docs/auto-docs/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePeopleTabUserOrganizationProps`](../../../../types/PeopleTab/interface/interfaces/InterfacePeopleTabUserOrganizationProps.md)\\>\n\nDefined in: [src/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PeopleTabUserOrganization/PeopleTabUserOrganizations.tsx#L43)\n" }, { "path": "docs/docs/auto-docs/shared-components/PostViewModal/PostViewModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePostViewModalProps`](../../../../types/shared-components/PostViewModal/interface/interfaces/InterfacePostViewModalProps.md)\\>\n\nDefined in: [src/shared-components/PostViewModal/PostViewModal.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/PostViewModal/PostViewModal.tsx#L51)\n" }, { "path": "docs/docs/auto-docs/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay/functions/ProfileAvatarDisplay.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: ProfileAvatarDisplay()\n\n> **ProfileAvatarDisplay**(`imageUrl`): `Element`\n\nDefined in: [src/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ProfileAvatarDisplay/ProfileAvatarDisplay.tsx#L41)\n\nProfileAvatarDisplay component renders a profile avatar based on the provided properties.\nIt handles image loading errors and falls back to an initial-based avatar.\n\n## Parameters\n\n### imageUrl\n\n[`InterfaceProfileAvatarDisplayProps`](../../../../types/shared-components/ProfileAvatarDisplay/interface/interfaces/InterfaceProfileAvatarDisplayProps.md)\n\nThe URL of the avatar image.\n\n## Returns\n\n`Element`\n\nJSX.Element - The ProfileAvatarDisplay component.\n\n## Example\n\n```\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/CustomRecurrenceModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceCustomRecurrenceModalProps`](../../../../types/Recurrence/interface/interfaces/InterfaceCustomRecurrenceModalProps.md)\\>\n\nDefined in: [src/shared-components/Recurrence/CustomRecurrenceModal.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/CustomRecurrenceModal.tsx#L30)\n\nCustomRecurrenceModal Component\n\nA shared modal component for configuring custom recurrence rules for events.\r\nThis component is used by both Admin and User portals via the shared EventForm.\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/RecurrenceEndOptionsSection/variables/RecurrenceEndOptionsSection.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RecurrenceEndOptionsSection\n\n> `const` **RecurrenceEndOptionsSection**: `React.FC`\\<[`InterfaceRecurrenceEndOptionsSectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceEndOptionsSectionProps.md)\\>\n\nDefined in: [src/shared-components/Recurrence/RecurrenceEndOptionsSection.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceEndOptionsSection.tsx#L21)\n\nRecurrence end options section (never, on date, after count)\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/RecurrenceFrequencySection/variables/RecurrenceFrequencySection.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RecurrenceFrequencySection\n\n> `const` **RecurrenceFrequencySection**: `React.FC`\\<[`InterfaceRecurrenceFrequencySectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceFrequencySectionProps.md)\\>\n\nDefined in: [src/shared-components/Recurrence/RecurrenceFrequencySection.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceFrequencySection.tsx#L11)\n\nFrequency and interval selection section\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/RecurrenceMonthlySection/variables/RecurrenceMonthlySection.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RecurrenceMonthlySection\n\n> `const` **RecurrenceMonthlySection**: `React.FC`\\<[`InterfaceRecurrenceMonthlySectionProps`](../../../../types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceMonthlySectionProps.md)\\>\n\nDefined in: [src/shared-components/Recurrence/RecurrenceMonthlySection.tsx:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceMonthlySection.tsx#L10)\n\nMonthly recurrence options section\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/RecurrenceWeeklySection/variables/RecurrenceWeeklySection.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RecurrenceWeeklySection\n\n> `const` **RecurrenceWeeklySection**: `React.FC`\\<`InterfaceRecurrenceWeeklySectionProps`\\>\n\nDefined in: [src/shared-components/Recurrence/RecurrenceWeeklySection.tsx:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceWeeklySection.tsx#L24)\n\nWeekly recurrence day selection section\n" }, { "path": "docs/docs/auto-docs/shared-components/Recurrence/RecurrenceYearlySection/variables/RecurrenceYearlySection.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: RecurrenceYearlySection\n\n> `const` **RecurrenceYearlySection**: `React.FC`\\<`InterfaceRecurrenceYearlySectionProps`\\>\n\nDefined in: [src/shared-components/Recurrence/RecurrenceYearlySection.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/Recurrence/RecurrenceYearlySection.tsx#L13)\n\nYearly recurrence options section\n" }, { "path": "docs/docs/auto-docs/shared-components/ReportingTable/ReportingTable/functions/adjustColumnsForCompactMode.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: adjustColumnsForCompactMode()\n\n> **adjustColumnsForCompactMode**(`columns`, `compactMode`): [`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[]\n\nDefined in: [src/shared-components/ReportingTable/ReportingTable.tsx:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ReportingTable/ReportingTable.tsx#L23)\n\nAdjusts column widths for compact display mode.\nIn compact mode:\n- First column gets flex: 0.5 and minWidth: space-10 (typically for row numbers)\n- Second column gets flex capped at 1.5 (typically for names)\n- Remaining columns are unchanged\n\n## Parameters\n\n### columns\n\n[`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[]\n\nOriginal column definitions\n\n### compactMode\n\n`boolean`\n\nWhether to apply compact adjustments\n\n## Returns\n\n[`ReportingTableColumn`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableColumn.md)[]\n\nAdjusted column definitions\n" }, { "path": "docs/docs/auto-docs/shared-components/ReportingTable/ReportingTable/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`ReportingTableProps`](../../../../types/ReportingTable/interface/type-aliases/ReportingTableProps.md)\\>\n\nDefined in: [src/shared-components/ReportingTable/ReportingTable.tsx:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/ReportingTable/ReportingTable.tsx#L87)\n\nA flexible reporting table component that wraps MUI DataGrid with optional infinite scroll.\n\n## Remarks\n\nThis component provides a consistent table interface across the application with support for:\n- Standard DataGrid rendering for static data\n- Infinite scroll wrapper for paginated/lazy-loaded data\n- Customizable grid and scroll container properties\n- Compact column mode for tables with many columns (7+)\n\n## Param\n\nArray of data rows to display in the table\n\n## Param\n\nColumn definitions following ReportingTableColumn structure\n\n## Param\n\nOptional additional props passed directly to MUI DataGrid\n\n## Param\n\nWhen provided, enables infinite scroll with dataLength, next, and hasMore\n\n## Param\n\nOptional styling and behavior props for the InfiniteScroll container\n\n## Returns\n\nA DataGrid wrapped in InfiniteScroll if infiniteProps is provided, otherwise a standalone DataGrid\n\n## Example\n\n```tsx\n// Basic usage without infinite scroll\n\n\n// With infinite scroll\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/SearchBar/SearchBar/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `ForwardRefExoticComponent`\\<[`InterfaceSearchBarProps`](../../../../types/SearchBar/interface/interfaces/InterfaceSearchBarProps.md) & `RefAttributes`\\<[`InterfaceSearchBarRef`](../../../../types/SearchBar/interface/interfaces/InterfaceSearchBarRef.md)\\>\\>\n\nDefined in: [src/shared-components/SearchBar/SearchBar.tsx:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SearchBar/SearchBar.tsx#L31)\n\nShared SearchBar component that centralizes all search UI across the app.\n\n## Remarks\n\n- Supports both controlled and uncontrolled usage.\n- Emits change, search, and clear callbacks for flexible data handling.\n- Offers multiple visual variants and sizes to match the Figma design tokens.\n" }, { "path": "docs/docs/auto-docs/shared-components/SearchFilterBar/SearchFilterBar/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceSearchFilterBarProps`](../../../../types/shared-components/SearchFilterBar/interface/type-aliases/InterfaceSearchFilterBarProps.md)\\>\n\nDefined in: [src/shared-components/SearchFilterBar/SearchFilterBar.tsx:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SearchFilterBar/SearchFilterBar.tsx#L20)\n\nSearchFilterBar component provides a unified search and filter interface.\nSupports search functionality with optional sorting and filtering dropdowns.\nManages internal state for instant visual feedback while debouncing parent updates.\nIncludes internal i18n support for accessibility and customizable translations.\n\n## Param\n\nComponent props based on discriminated union (simple or advanced variant)\n\n## Returns\n\nThe rendered SearchFilterBar component\n" }, { "path": "docs/docs/auto-docs/shared-components/SidebarBase/SidebarBase/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `ReactElement`\n\nDefined in: [src/shared-components/SidebarBase/SidebarBase.tsx:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarBase/SidebarBase.tsx#L19)\n\nSidebarBase Component\n\nThis is the foundational component for all sidebars in both Admin and User portals.\nIt provides common functionality including toggle behavior, branding, and layout structure.\n\n## Parameters\n\n### props\n\n[`ISidebarBaseProps`](../../../../types/SidebarBase/interface/interfaces/ISidebarBaseProps.md)\n\nThe props for the component\n\n## Returns\n\n`ReactElement`\n\nThe rendered SidebarBase component\n" }, { "path": "docs/docs/auto-docs/shared-components/SidebarNavItem/SidebarNavItem/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `ReactElement`\n\nDefined in: [src/shared-components/SidebarNavItem/SidebarNavItem.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarNavItem/SidebarNavItem.tsx#L43)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`ISidebarNavItemProps`](../../../../types/SidebarNavItem/interface/interfaces/ISidebarNavItemProps.md)\n\n## Returns\n\n`ReactElement`\n" }, { "path": "docs/docs/auto-docs/shared-components/SidebarOrgSection/SidebarOrgSection/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `ReactElement`\\<`unknown`, `string` \\| `JSXElementConstructor`\\<`any`\\>\\>\n\nDefined in: [src/shared-components/SidebarOrgSection/SidebarOrgSection.tsx:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarOrgSection/SidebarOrgSection.tsx#L38)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`ISidebarOrgSectionProps`](../../../../types/shared-components/SidebarOrgSection/interface/interfaces/ISidebarOrgSectionProps.md)\n\n## Returns\n\n`ReactElement`\\<`unknown`, `string` \\| `JSXElementConstructor`\\<`any`\\>\\>\n" }, { "path": "docs/docs/auto-docs/shared-components/SidebarPluginSection/SidebarPluginSection/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `ReactElement`\\<`unknown`, `string` \\| `JSXElementConstructor`\\<`any`\\>\\>\n\nDefined in: [src/shared-components/SidebarPluginSection/SidebarPluginSection.tsx:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SidebarPluginSection/SidebarPluginSection.tsx#L29)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`ISidebarPluginSectionProps`](../../../../types/SidebarPluginSection/interface/interfaces/ISidebarPluginSectionProps.md)\n\n## Returns\n\n`ReactElement`\\<`unknown`, `string` \\| `JSXElementConstructor`\\<`any`\\>\\>\n" }, { "path": "docs/docs/auto-docs/shared-components/SortingButton/SortingButton/namespaces/default/variables/propTypes.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: propTypes\n\n> **propTypes**: `any`\n\nDefined in: [src/shared-components/SortingButton/SortingButton.tsx:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SortingButton/SortingButton.tsx#L76)\n" }, { "path": "docs/docs/auto-docs/shared-components/SortingButton/SortingButton/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceSortingButtonProps`](../../../../types/shared-components/SortingButton/interface/interfaces/InterfaceSortingButtonProps.md)\\>\n\nDefined in: [src/shared-components/SortingButton/SortingButton.tsx:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/SortingButton/SortingButton.tsx#L18)\n\nSortingButton component renders a Dropdown with sorting options.\nIt allows users to select a sorting option and triggers a callback on selection.\nIncludes accessibility support for screen readers.\n\n## Param\n\nThe properties for the SortingButton component.\n\n## Returns\n\nThe rendered SortingButton component.\n" }, { "path": "docs/docs/auto-docs/shared-components/StatusBadge/StatusBadge/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceStatusBadgeProps`](../../../../types/shared-components/StatusBadge/interface/interfaces/InterfaceStatusBadgeProps.md)\\>\n\nDefined in: [src/shared-components/StatusBadge/StatusBadge.tsx:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/StatusBadge/StatusBadge.tsx#L69)\n\nStatusBadge component for displaying status information with consistent styling.\n\nThis component wraps MUI Chip and provides:\n- Domain-to-semantic variant mapping (e.g., 'completed' implies 'success')\n- Three size variants: sm (20px), md (24px), lg (32px)\n- Internationalization support with fallback keys (statusBadge.variant)\n- Accessibility features (role=\"status\", aria-label)\n- Optional icon and label customization\n\n## Param\n\nComponent properties\n\n## Returns\n\nA styled badge component with semantic coloring\n\n## Example\n\n```tsx\n// Basic usage\n\n\n// With size and icon\n} />\n\n// With custom label\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/TableLoader/TableLoader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`props`): `Element`\n\nDefined in: [src/shared-components/TableLoader/TableLoader.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TableLoader/TableLoader.tsx#L30)\n\n## Parameters\n\n### props\n\n[`InterfaceTableLoaderProps`](../../../../types/shared-components/TableLoader/interface/interfaces/InterfaceTableLoaderProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/TimePicker/TimePicker/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceTimePickerProps`](../../../../types/shared-components/TimePicker/interface/interfaces/InterfaceTimePickerProps.md)\\>\n\nDefined in: [src/shared-components/TimePicker/TimePicker.tsx:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TimePicker/TimePicker.tsx#L30)\n\nTimePicker wrapper component that integrates MUI TimePicker with react-bootstrap styling.\n\nThis component provides a standardized time picker interface that maintains consistency\nacross the application by using react-bootstrap Form.Control for styling.\n\n## Param\n\nThe component props.\n\n## Example\n\n```tsx\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/TruncatedText/TruncatedText/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceTruncatedTextProps`](../../../../types/shared-components/TruncatedText/interface/interfaces/InterfaceTruncatedTextProps.md)\\>\n\nDefined in: [src/shared-components/TruncatedText/TruncatedText.tsx:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/TruncatedText/TruncatedText.tsx#L25)\n" }, { "path": "docs/docs/auto-docs/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfaceVolunteerGroupViewModalProps`](../../../../types/shared-components/VolunteerGroupViewModal/interface/interfaces/InterfaceVolunteerGroupViewModalProps.md)\\>\n\nDefined in: [src/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal.tsx:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/VolunteerGroupViewModal/VolunteerGroupViewModal.tsx#L54)\n" }, { "path": "docs/docs/auto-docs/shared-components/pinnedPosts/pinnedPostCard/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePinnedPostCardProps`](../../../../types/Post/interface/interfaces/InterfacePinnedPostCardProps.md)\\>\n\nDefined in: [src/shared-components/pinnedPosts/pinnedPostCard.tsx:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/pinnedPosts/pinnedPostCard.tsx#L66)\n" }, { "path": "docs/docs/auto-docs/shared-components/pinnedPosts/pinnedPostsLayout/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`InterfacePinnedPostsLayoutProps`](../../../../types/Post/interface/interfaces/InterfacePinnedPostsLayoutProps.md)\\>\n\nDefined in: [src/shared-components/pinnedPosts/pinnedPostsLayout.tsx:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/pinnedPosts/pinnedPostsLayout.tsx#L41)\n" }, { "path": "docs/docs/auto-docs/shared-components/postCard/PostCard/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/postCard/PostCard.tsx:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/postCard/PostCard.tsx#L61)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/posts/createPostModal/createPostModal/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/shared-components/posts/createPostModal/createPostModal.tsx:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/posts/createPostModal/createPostModal.tsx#L33)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`ICreatePostModalProps`](../../../../../types/Post/interface/interfaces/ICreatePostModalProps.md)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/posts/helperFunctions/functions/formatPostForCard.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: formatPostForCard()\n\n> **formatPostForCard**(`post`, `t`, `refetch`): `Omit`\\<[`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md), `\"image\"` \\| `\"video\"`\\>\n\nDefined in: [src/shared-components/posts/helperFunctions.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/posts/helperFunctions.ts#L25)\n\nFormats a post object to match the PostCard component's expected interface.\n\nThis function transforms a raw post object from the GraphQL API into the format\nrequired by the PostCard component, handling missing values with appropriate fallbacks\nand formatting dates safely.\n\n## Parameters\n\n### post\n\n[`InterfacePost`](../../../../types/Post/interface/interfaces/InterfacePost.md)\n\nThe raw post object from the API\n\n### t\n\n(`key`) => `string`\n\nTranslation function for internationalized text\n\n### refetch\n\n() => `Promise`\\<`unknown`\\>\n\nFunction to refetch posts data, typically from Apollo Client\n\n## Returns\n\n`Omit`\\<[`InterfacePostCard`](../../../../utils/interfaces/interfaces/InterfacePostCard.md), `\"image\"` \\| `\"video\"`\\>\n\nAn object formatted to match the InterfacePostCard interface\n\n## Example\n\n```tsx\nconst formattedPost = formatPostForCard(rawPost, t, refetch);\n\n```\n" }, { "path": "docs/docs/auto-docs/shared-components/posts/posts/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/shared-components/posts/posts.tsx:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/posts/posts.tsx#L74)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/shared-components/useDebounce/useDebounce/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**\\<`T`\\>(`callback`, `delay`): `object`\n\nDefined in: [src/shared-components/useDebounce/useDebounce.tsx:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/shared-components/useDebounce/useDebounce.tsx#L21)\n\n## Type Parameters\n\n### T\n\n`T` *extends* (...`args`) => `void`\n\n## Parameters\n\n### callback\n\n`T`\n\n### delay\n\n`number`\n\n## Returns\n\n`object`\n\n### cancel()\n\n> **cancel**: () => `void`\n\n#### Returns\n\n`void`\n\n### debouncedCallback()\n\n> **debouncedCallback**: (...`args`) => `void`\n\n#### Parameters\n\n##### args\n\n...`Parameters`\\<`T`\\>\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/state/action-creators/functions/updateTargets.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: updateTargets()\n\n> **updateTargets**(`orgId`): (`dispatch`) => `void`\n\nDefined in: [src/state/action-creators/index.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/action-creators/index.ts#L3)\n\n## Parameters\n\n### orgId\n\n`string`\n\n## Returns\n\n> (`dispatch`): `void`\n\n### Parameters\n\n#### dispatch\n\n`Dispatch`\n\n### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/state/helpers/Action/interfaces/InterfaceAction.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAction\\\n\nDefined in: [src/state/helpers/Action.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L1)\n\n## Type Parameters\n\n### T\n\n`T` = `unknown`\n\n## Properties\n\n### payload\n\n> **payload**: `T`\n\nDefined in: [src/state/helpers/Action.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L3)\n\n***\n\n### type\n\n> **type**: `string`\n\nDefined in: [src/state/helpers/Action.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/helpers/Action.ts#L2)\n" }, { "path": "docs/docs/auto-docs/state/hooks/variables/useAppDispatch.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: useAppDispatch\n\n> `const` **useAppDispatch**: `UseDispatch`\\<`ThunkDispatch`\\<\\{ `appRoutes`: \\{ `components`: [`ComponentType`](../../reducers/routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/routesReducer/type-aliases/TargetsType.md)[]; \\}; `userRoutes`: \\{ `components`: [`ComponentType`](../../reducers/userRoutesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/userRoutesReducer/type-aliases/TargetsType.md)[]; \\}; \\}, `undefined`, `UnknownAction`\\> & `Dispatch`\\<[`InterfaceAction`](../../helpers/Action/interfaces/InterfaceAction.md)\\<`unknown`\\>\\>\\>\n\nDefined in: [src/state/hooks.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/hooks.ts#L5)\n" }, { "path": "docs/docs/auto-docs/state/reducers/routesReducer/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`state`, `action`): `object`\n\nDefined in: [src/state/reducers/routesReducer.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L16)\n\n## Parameters\n\n### state\n\n#### components\n\n[`ComponentType`](../type-aliases/ComponentType.md)[]\n\n#### targets\n\n[`TargetsType`](../type-aliases/TargetsType.md)[] = `...`\n\n### action\n\n[`InterfaceAction`](../../../helpers/Action/interfaces/InterfaceAction.md)\n\n## Returns\n\n`object`\n\n### components\n\n> **components**: [`ComponentType`](../type-aliases/ComponentType.md)[]\n\n### targets\n\n> **targets**: [`TargetsType`](../type-aliases/TargetsType.md)[]\n" }, { "path": "docs/docs/auto-docs/state/reducers/routesReducer/functions/generateRoutes.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: generateRoutes()\n\n> **generateRoutes**(`comps`, `currentOrg?`): [`TargetsType`](../type-aliases/TargetsType.md)[]\n\nDefined in: [src/state/reducers/routesReducer.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L69)\n\n## Parameters\n\n### comps\n\n[`ComponentType`](../type-aliases/ComponentType.md)[]\n\n### currentOrg?\n\n`string`\n\n## Returns\n\n[`TargetsType`](../type-aliases/TargetsType.md)[]\n" }, { "path": "docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/ComponentType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ComponentType\n\n> **ComponentType** = `object`\n\nDefined in: [src/state/reducers/routesReducer.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L34)\n\n## Properties\n\n### comp\\_id\n\n> **comp\\_id**: `string` \\| `null`\n\nDefined in: [src/state/reducers/routesReducer.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L36)\n\n***\n\n### component\n\n> **component**: `string` \\| `null`\n\nDefined in: [src/state/reducers/routesReducer.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L37)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L35)\n\n***\n\n### subTargets?\n\n> `optional` **subTargets**: `object`[]\n\nDefined in: [src/state/reducers/routesReducer.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L38)\n\n#### comp\\_id\n\n> **comp\\_id**: `string`\n\n#### component\n\n> **component**: `string`\n\n#### icon?\n\n> `optional` **icon**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/SubTargetType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SubTargetType\n\n> **SubTargetType** = `object`\n\nDefined in: [src/state/reducers/routesReducer.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L9)\n\n## Properties\n\n### comp\\_id?\n\n> `optional` **comp\\_id**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L13)\n\n***\n\n### icon?\n\n> `optional` **icon**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L12)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L10)\n\n***\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L11)\n" }, { "path": "docs/docs/auto-docs/state/reducers/routesReducer/type-aliases/TargetsType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: TargetsType\n\n> **TargetsType** = `object`\n\nDefined in: [src/state/reducers/routesReducer.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L3)\n\n## Properties\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L4)\n\n***\n\n### subTargets?\n\n> `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[]\n\nDefined in: [src/state/reducers/routesReducer.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L6)\n\n***\n\n### url?\n\n> `optional` **url**: `string`\n\nDefined in: [src/state/reducers/routesReducer.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/routesReducer.ts#L5)\n" }, { "path": "docs/docs/auto-docs/state/reducers/type-aliases/RootState.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: RootState\n\n> **RootState** = `ReturnType`\\<*typeof* [`reducers`](../variables/reducers.md)\\>\n\nDefined in: [src/state/reducers/index.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/index.ts#L10)\n" }, { "path": "docs/docs/auto-docs/state/reducers/userRoutesReducer/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`state`, `action`): `object`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L17)\n\n## Parameters\n\n### state\n\n#### components\n\n[`ComponentType`](../type-aliases/ComponentType.md)[]\n\n#### targets\n\n[`TargetsType`](../type-aliases/TargetsType.md)[] = `...`\n\n### action\n\n[`InterfaceAction`](../../../helpers/Action/interfaces/InterfaceAction.md)\n\n## Returns\n\n`object`\n\n### components\n\n> **components**: [`ComponentType`](../type-aliases/ComponentType.md)[]\n\n### targets\n\n> **targets**: [`TargetsType`](../type-aliases/TargetsType.md)[]\n" }, { "path": "docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/ComponentType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ComponentType\n\n> **ComponentType** = `object`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L33)\n\n## Properties\n\n### comp\\_id\n\n> **comp\\_id**: `string` \\| `null`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L35)\n\n***\n\n### component\n\n> **component**: `string` \\| `null`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L36)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L34)\n\n***\n\n### subTargets?\n\n> `optional` **subTargets**: `object`[]\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L37)\n\n#### comp\\_id\n\n> **comp\\_id**: `string`\n\n#### component\n\n> **component**: `string`\n\n#### icon?\n\n> `optional` **icon**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/SubTargetType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SubTargetType\n\n> **SubTargetType** = `object`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L10)\n\n## Properties\n\n### comp\\_id?\n\n> `optional` **comp\\_id**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L14)\n\n***\n\n### icon?\n\n> `optional` **icon**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L13)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L11)\n\n***\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L12)\n" }, { "path": "docs/docs/auto-docs/state/reducers/userRoutesReducer/type-aliases/TargetsType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: TargetsType\n\n> **TargetsType** = `object`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L4)\n\n## Properties\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L5)\n\n***\n\n### subTargets?\n\n> `optional` **subTargets**: [`SubTargetType`](SubTargetType.md)[]\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L7)\n\n***\n\n### url?\n\n> `optional` **url**: `string`\n\nDefined in: [src/state/reducers/userRoutesReducer.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/userRoutesReducer.ts#L6)\n" }, { "path": "docs/docs/auto-docs/state/reducers/variables/reducers.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: reducers\n\n> `const` **reducers**: `Reducer`\\<\\{ `appRoutes`: \\{ `components`: [`ComponentType`](../routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../routesReducer/type-aliases/TargetsType.md)[]; \\}; `userRoutes`: \\{ `components`: [`ComponentType`](../userRoutesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../userRoutesReducer/type-aliases/TargetsType.md)[]; \\}; \\}, [`InterfaceAction`](../../helpers/Action/interfaces/InterfaceAction.md)\\<`unknown`\\>, `Partial`\\<\\{ `appRoutes`: `never`; `userRoutes`: `never`; \\}\\>\\>\n\nDefined in: [src/state/reducers/index.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/reducers/index.ts#L5)\n" }, { "path": "docs/docs/auto-docs/state/store/type-aliases/AppDispatch.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AppDispatch\n\n> **AppDispatch** = *typeof* `store.dispatch`\n\nDefined in: [src/state/store.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/store.ts#L8)\n" }, { "path": "docs/docs/auto-docs/state/store/variables/store.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: store\n\n> `const` **store**: `EnhancedStore`\\<\\{ `appRoutes`: \\{ `components`: [`ComponentType`](../../reducers/routesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/routesReducer/type-aliases/TargetsType.md)[]; \\}; `userRoutes`: \\{ `components`: [`ComponentType`](../../reducers/userRoutesReducer/type-aliases/ComponentType.md)[]; `targets`: [`TargetsType`](../../reducers/userRoutesReducer/type-aliases/TargetsType.md)[]; \\}; \\}, [`InterfaceAction`](../../helpers/Action/interfaces/InterfaceAction.md)\\<`unknown`\\>, `Tuple`\\<\\[`StoreEnhancer`\\<\\{ \\}\\>, `StoreEnhancer`\\]\\>\\>\n\nDefined in: [src/state/store.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/state/store.ts#L4)\n" }, { "path": "docs/docs/auto-docs/test-utils/AsyncComponent/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/test-utils/AsyncComponent.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/AsyncComponent.tsx#L12)\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/test-utils/ComplexLoader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/test-utils/ComplexLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/ComplexLoader.tsx#L11)\n\nComplexLoader test utility component.\n\nSimulates a skeleton style loader with multiple shimmer\nelements to verify layout and rendering behavior.\n\n## Returns\n\n`Element`\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/test-utils/CustomDashboardLoader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/test-utils/CustomDashboardLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/CustomDashboardLoader.tsx#L11)\n\nCustomDashboardLoader test utility component.\n\nRenders multiple placeholder items to emulate a dashboard\nloading state for testing LoadingState custom loaders.\n\n## Returns\n\n`Element`\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/test-utils/CustomLoader/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `Element`\n\nDefined in: [src/test-utils/CustomLoader.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/CustomLoader.tsx#L11)\n\nCustomLoader test utility component.\n\nProvides a minimal loader element used for testing\nthe LoadingState custom variant rendering behavior.\n\n## Returns\n\n`Element`\n\nJSX.Element\n" }, { "path": "docs/docs/auto-docs/test-utils/I18nextProviderMock/functions/I18nextProvider.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: I18nextProvider()\n\n> **I18nextProvider**(`__namedParameters`): `Element`\n\nDefined in: [src/test-utils/I18nextProviderMock.tsx:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/I18nextProviderMock.tsx#L14)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n#### children\n\n`ReactNode`\n\n#### i18n\n\n`i18n`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/test-utils/MockBrowserRouter/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(`__namedParameters`): `Element`\n\nDefined in: [src/test-utils/MockBrowserRouter.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/MockBrowserRouter.tsx#L12)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n#### children\n\n`ReactNode`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/test-utils/TestErrorBoundary/classes/TestErrorBoundary.md", "content": "[Admin Docs](/)\n\n***\n\n# Class: TestErrorBoundary\n\nDefined in: [src/test-utils/TestErrorBoundary.tsx:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L22)\n\n## Extends\n\n- `Component`\\<`TestInterfaceErrorBoundaryProps`, `TestInterfaceErrorBoundaryState`\\>\n\n## Constructors\n\n### Constructor\n\n> **new TestErrorBoundary**(`props`): `TestErrorBoundary`\n\nDefined in: [src/test-utils/TestErrorBoundary.tsx:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L26)\n\n#### Parameters\n\n##### props\n\n`TestInterfaceErrorBoundaryProps`\n\n#### Returns\n\n`TestErrorBoundary`\n\n#### Overrides\n\n`React.Component< TestInterfaceErrorBoundaryProps, TestInterfaceErrorBoundaryState >.constructor`\n\n## Methods\n\n### render()\n\n> **render**(): `ReactNode`\n\nDefined in: [src/test-utils/TestErrorBoundary.tsx:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L43)\n\n#### Returns\n\n`ReactNode`\n\n#### Overrides\n\n`React.Component.render`\n\n***\n\n### getDerivedStateFromError()\n\n> `static` **getDerivedStateFromError**(`error`): `TestInterfaceErrorBoundaryState`\n\nDefined in: [src/test-utils/TestErrorBoundary.tsx:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestErrorBoundary.tsx#L34)\n\n#### Parameters\n\n##### error\n\n`Error`\n\n#### Returns\n\n`TestInterfaceErrorBoundaryState`\n" }, { "path": "docs/docs/auto-docs/test-utils/TestWrapper/functions/TestWrapper.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: TestWrapper()\n\n> **TestWrapper**(`__namedParameters`): `Element`\n\nDefined in: [src/test-utils/TestWrapper.tsx:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/TestWrapper.tsx#L51)\n\n## Parameters\n\n### \\_\\_namedParameters\n\n`InterfaceTestWrapperProps`\n\n## Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/cleanupTempDirs.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: cleanupTempDirs()\n\n> **cleanupTempDirs**(): `void`\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L94)\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/makeTempDir.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: makeTempDir()\n\n> **makeTempDir**(): `string`\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L81)\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/runScript.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: runScript()\n\n> **runScript**(`targets`, `options`): `SpawnSyncReturns`\\<`string`\\>\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L37)\n\n## Parameters\n\n### targets\n\n`any`\n\n### options\n\n## Returns\n\n`SpawnSyncReturns`\\<`string`\\>\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/functions/writeTempFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: writeTempFile()\n\n> **writeTempFile**(`dir`, `relPath`, `content`): `string`\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L87)\n\n## Parameters\n\n### dir\n\n`any`\n\n### relPath\n\n`any`\n\n### content\n\n`any`\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/variables/fixturesDir.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: fixturesDir\n\n> `const` **fixturesDir**: `string`\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L18)\n" }, { "path": "docs/docs/auto-docs/test-utils/check-i18n/check-i18n.test-utils/variables/scriptPath.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: scriptPath\n\n> `const` **scriptPath**: `string`\n\nDefined in: [src/test-utils/check-i18n/check-i18n.test-utils.js:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/check-i18n/check-i18n.test-utils.js#L10)\n" }, { "path": "docs/docs/auto-docs/test-utils/localStorageMock/functions/createLocalStorageMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: createLocalStorageMock()\n\n> **createLocalStorageMock**(): `Storage`\n\nDefined in: [src/test-utils/localStorageMock.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/localStorageMock.ts#L12)\n\nCreates an in-memory localStorage mock for test isolation\nPrevents tests from interfering with each other or real browser storage\n\n## Returns\n\n`Storage`\n\nStorage - Mock implementation of the Storage interface\n\n## Example\n\n```ts\nconst mockStorage = createLocalStorageMock();\nmockStorage.setItem('key', 'value');\nexpect(mockStorage.getItem('key')).toBe('value');\nmockStorage.clear();\n```\n" }, { "path": "docs/docs/auto-docs/test-utils/localStorageMock/functions/setupLocalStorageMock.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: setupLocalStorageMock()\n\n> **setupLocalStorageMock**(): `Storage`\n\nDefined in: [src/test-utils/localStorageMock.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/localStorageMock.ts#L54)\n\nSetup localStorage mock for tests\nConfigures window.localStorage with a mock implementation for test isolation\n\n## Returns\n\n`Storage`\n\nStorage - The configured localStorage mock instance\n\n## Example\n\n```ts\n// In your test file's setup:\nconst localStorageMock = setupLocalStorageMock();\n\nafterEach(() => {\n localStorageMock.clear();\n});\n\n// Then in your tests:\nwindow.localStorage.setItem('token', 'abc123');\nexpect(window.localStorage.getItem('token')).toBe('abc123');\n```\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/Dropdown/variables/Dropdown.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: Dropdown\n\n> `const` **Dropdown**: [`InterfaceDropdown`](../../types/interfaces/InterfaceDropdown.md)\n\nDefined in: [src/test-utils/mocks/react-bootstrap/Dropdown.tsx:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/Dropdown.tsx#L13)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownBase/type-aliases/DivProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DivProps\n\n> **DivProps** = `React.PropsWithChildren`\\<`React.HTMLAttributes`\\<`HTMLDivElement`\\>\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownBase.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownBase.tsx#L8)\n\nBase container for the mocked Dropdown. Acts as the root wrapper and simply\nrenders its children inside a div. Kept minimal because it's only used in\ntests.\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownBase/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`DivProps`](../type-aliases/DivProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownBase.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownBase.tsx#L12)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownItem/type-aliases/BtnProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: BtnProps\n\n> **BtnProps** = `React.PropsWithChildren`\\<`React.ButtonHTMLAttributes`\\<`HTMLButtonElement`\\> & `object`\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownItem.tsx:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownItem.tsx#L7)\n\nMock Dropdown.Item - renders a button representing an item inside a\nDropdown.Menu. For tests we simply forward onClick and any provided props.\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownItem/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`BtnProps`](../type-aliases/BtnProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownItem.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownItem.tsx#L11)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownMenu/type-aliases/DivProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DivProps\n\n> **DivProps** = `React.PropsWithChildren`\\<`React.HTMLAttributes`\\<`HTMLDivElement`\\>\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownMenu.tsx:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownMenu.tsx#L7)\n\nMock Dropdown.Menu - simple container used to wrap dropdown items within\ntests. Keeps behavior minimal and predictable.\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownMenu/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`DivProps`](../type-aliases/DivProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownMenu.tsx:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownMenu.tsx#L11)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownToggle/type-aliases/BtnProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: BtnProps\n\n> **BtnProps** = `React.PropsWithChildren`\\<`React.ButtonHTMLAttributes`\\<`HTMLButtonElement`\\> & `object`\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownToggle.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownToggle.tsx#L8)\n\nMock Dropdown.Toggle - renders a button and forwards onClick and any props.\nProvides a `data-testid` default of `dropdown` unless overridden. Used by\ntests that expect a clickable toggle element.\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/components/DropdownToggle/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `React.FC`\\<[`BtnProps`](../type-aliases/BtnProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/components/DropdownToggle.tsx:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/components/DropdownToggle.tsx#L12)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/interfaces/InterfaceDropdown.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropdown()\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L10)\n\n## Extends\n\n- `FC`\\<[`DivProps`](../type-aliases/DivProps.md)\\>\n\n> **InterfaceDropdown**(`props`): `ReactNode` \\| `Promise`\\<`ReactNode`\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L10)\n\n## Parameters\n\n### props\n\n[`DivProps`](../type-aliases/DivProps.md)\n\n## Returns\n\n`ReactNode` \\| `Promise`\\<`ReactNode`\\>\n\n## Properties\n\n### Item\n\n> **Item**: `FC`\\<[`BtnProps`](../type-aliases/BtnProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L13)\n\n***\n\n### Menu\n\n> **Menu**: `FC`\\<[`DivProps`](../type-aliases/DivProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L12)\n\n***\n\n### Toggle\n\n> **Toggle**: `FC`\\<[`BtnProps`](../type-aliases/BtnProps.md)\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L11)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/type-aliases/BtnProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: BtnProps\n\n> **BtnProps** = `React.PropsWithChildren`\\<`React.ButtonHTMLAttributes`\\<`HTMLButtonElement`\\> & `object`\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L6)\n" }, { "path": "docs/docs/auto-docs/test-utils/mocks/react-bootstrap/types/type-aliases/DivProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DivProps\n\n> **DivProps** = `React.PropsWithChildren`\\<`React.HTMLAttributes`\\<`HTMLDivElement`\\>\\>\n\nDefined in: [src/test-utils/mocks/react-bootstrap/types.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/test-utils/mocks/react-bootstrap/types.ts#L3)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnEntryProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddOnEntryProps\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L32)\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: [`AdvertisementAttachment`](../../type/type-aliases/AdvertisementAttachment.md)[]\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L40)\n\n***\n\n### endAt?\n\n> `optional` **endAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L39)\n\n***\n\n### existingAttachments?\n\n> `optional` **existingAttachments**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L35)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L33)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L34)\n\n***\n\n### organizationId?\n\n> `optional` **organizationId**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L37)\n\n***\n\n### setAfter\n\n> **setAfter**: `Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L41)\n\n***\n\n### startAt?\n\n> `optional` **startAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L38)\n\n***\n\n### type?\n\n> `optional` **type**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L36)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceAddOnRegisterProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddOnRegisterProps\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L3)\n\n## Properties\n\n### createdBy?\n\n> `optional` **createdBy**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L10)\n\n***\n\n### descriptionEdit?\n\n> `optional` **descriptionEdit**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L8)\n\n***\n\n### endAtEdit?\n\n> `optional` **endAtEdit**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L11)\n\n***\n\n### formStatus?\n\n> `optional` **formStatus**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L4)\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L9)\n\n***\n\n### idEdit?\n\n> `optional` **idEdit**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L5)\n\n***\n\n### nameEdit?\n\n> `optional` **nameEdit**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L6)\n\n***\n\n### setAfterActive\n\n> **setAfterActive**: `Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L13)\n\n***\n\n### setAfterCompleted\n\n> **setAfterCompleted**: `Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L16)\n\n***\n\n### startAtEdit?\n\n> `optional` **startAtEdit**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L12)\n\n***\n\n### typeEdit?\n\n> `optional` **typeEdit**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/interface/interfaces/InterfaceFormStateTypes.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormStateTypes\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L21)\n\n## Properties\n\n### attachments\n\n> **attachments**: `File`[]\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L28)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L25)\n\n***\n\n### endAt\n\n> **endAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L26)\n\n***\n\n### existingAttachments?\n\n> `optional` **existingAttachments**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L29)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L22)\n\n***\n\n### organizationId?\n\n> `optional` **organizationId**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L27)\n\n***\n\n### startAt\n\n> **startAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L24)\n\n***\n\n### type\n\n> **type**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/interface.ts#L23)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/enumerations/AdvertisementType.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: AdvertisementType\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L5)\n\n## Enumeration Members\n\n### Banner\n\n> **Banner**: `\"banner\"`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L6)\n\n***\n\n### Menu\n\n> **Menu**: `\"menu\"`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L7)\n\n***\n\n### Popup\n\n> **Popup**: `\"pop_up\"`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/Advertisement.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Advertisement\n\n> **Advertisement** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L12)\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: [`AdvertisementAttachment`](AdvertisementAttachment.md)[]\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L26)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L14)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L16)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L15)\n\n***\n\n### endAt\n\n> **endAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L20)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L13)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L21)\n\n***\n\n### organization\n\n> **organization**: `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L17)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L22)\n\n***\n\n### startAt\n\n> **startAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L23)\n\n***\n\n### type\n\n> **type**: [`AdvertisementType`](../enumerations/AdvertisementType.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L24)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L25)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementAttachment.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AdvertisementAttachment\n\n> **AdvertisementAttachment** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L30)\n\n## Properties\n\n### mimeType\n\n> **mimeType**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L32)\n\n***\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L31)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AdvertisementEdge\n\n> **AdvertisementEdge** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L35)\n\n## Properties\n\n### cursor?\n\n> `optional` **cursor**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L36)\n\n***\n\n### node?\n\n> `optional` **node**: [`Advertisement`](Advertisement.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L37)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/AdvertisementsConnection.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AdvertisementsConnection\n\n> **AdvertisementsConnection** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L40)\n\n## Properties\n\n### edges?\n\n> `optional` **edges**: [`AdvertisementEdge`](AdvertisementEdge.md)[]\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L41)\n\n***\n\n### pageInfo?\n\n> `optional` **pageInfo**: [`DefaultConnectionPageInfo`](../../../pagination/type-aliases/DefaultConnectionPageInfo.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L42)\n\n***\n\n### totalCount?\n\n> `optional` **totalCount**: `number`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L43)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/CreateAdvertisementInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateAdvertisementInput\n\n> **CreateAdvertisementInput** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L46)\n\n## Properties\n\n### attachments\n\n> **attachments**: `File`[]\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L53)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L48)\n\n***\n\n### endAt\n\n> **endAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L52)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L47)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L50)\n\n***\n\n### startAt\n\n> **startAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L51)\n\n***\n\n### type\n\n> **type**: [`AdvertisementType`](../enumerations/AdvertisementType.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L49)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Advertisement/type/type-aliases/CreateAdvertisementPayload.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateAdvertisementPayload\n\n> **CreateAdvertisementPayload** = `object`\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L56)\n\n## Properties\n\n### advertisement?\n\n> `optional` **advertisement**: [`Advertisement`](Advertisement.md)\n\nDefined in: [src/types/AdminPortal/Advertisement/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Advertisement/type.ts#L57)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaDragAndDropProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaDragAndDropProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:304](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L304)\n\nProps for the AgendaDragAndDrop component.\n\nDefines the data and callback handlers required to render\nagenda folders and agenda items with drag-and-drop support,\nalong with edit, preview, and delete actions.\n\n## Properties\n\n### agendaFolderConnection\n\n> **agendaFolderConnection**: `\"Organization\"` \\| `\"Event\"`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:307](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L307)\n\n***\n\n### folders\n\n> **folders**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L305)\n\n***\n\n### onDeleteFolder()\n\n> **onDeleteFolder**: (`folder`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L311)\n\n#### Parameters\n\n##### folder\n\n[`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### onDeleteItem()\n\n> **onDeleteItem**: (`item`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L315)\n\n#### Parameters\n\n##### item\n\n[`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### onEditFolder()\n\n> **onEditFolder**: (`folder`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:310](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L310)\n\n#### Parameters\n\n##### folder\n\n[`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### onEditItem()\n\n> **onEditItem**: (`item`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:314](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L314)\n\n#### Parameters\n\n##### item\n\n[`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### onPreviewItem()\n\n> **onPreviewItem**: (`item`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:313](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L313)\n\n#### Parameters\n\n##### item\n\n[`InterfaceAgendaItemInfo`](InterfaceAgendaItemInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L316)\n\n#### Returns\n\n`void`\n\n***\n\n### setFolders\n\n> **setFolders**: `Dispatch`\\<`SetStateAction`\\<[`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\\>\\>\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:306](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L306)\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:308](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L308)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderCreateFormStateType\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L222)\n\n## Properties\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:226](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L226)\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L225)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L223)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:224](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L224)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderCreateModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderCreateModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L231)\n\n## Properties\n\n### agendaFolderData\n\n> **agendaFolderData**: [`InterfaceAgendaFolderList`](InterfaceAgendaFolderList.md)\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:235](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L235)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L234)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L233)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L232)\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L237)\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L236)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderDeleteModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderDeleteModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:213](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L213)\n\nProps for the AgendaFolderDeleteModal component.\n\n## Properties\n\n### agendaFolderId\n\n> **agendaFolderId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L216)\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L214)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L215)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L217)\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L218)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:219](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L219)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderInfo\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L68)\n\nDefines the structure for agenda folder information.\nRepresents a folder/section containing grouped agenda items for an event.\n\n## Properties\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L71)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L69)\n\n***\n\n### isDefaultFolder?\n\n> `optional` **isDefaultFolder**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L74)\n\n***\n\n### items\n\n> **items**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L75)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### key?\n\n> `optional` **key**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L73)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L70)\n\n***\n\n### sequence\n\n> **sequence**: `number`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L72)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderList\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L120)\n\nDefines the structure for a list of agenda folders by event.\n\n## Properties\n\n### agendaFoldersByEventId\n\n> **agendaFoldersByEventId**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L121)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderUpdateFormStateType\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L240)\n\n## Properties\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L244)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L243)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L241)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L242)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaFolderUpdateModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaFolderUpdateModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:250](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L250)\n\n## Properties\n\n### agendaFolderId\n\n> **agendaFolderId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L253)\n\n***\n\n### folderFormState\n\n> **folderFormState**: [`InterfaceAgendaFolderUpdateFormStateType`](InterfaceAgendaFolderUpdateFormStateType.md)\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:254](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L254)\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L251)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L252)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:258](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L258)\n\n#### Returns\n\n`void`\n\n***\n\n### setFolderFormState()\n\n> **setFolderFormState**: (`state`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:255](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L255)\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<[`InterfaceAgendaFolderUpdateFormStateType`](InterfaceAgendaFolderUpdateFormStateType.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L259)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemCategoryInfo\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L6)\n\nDefines the structure for agenda item category information.\n\n## Properties\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L10)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L9)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L7)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemCategoryList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemCategoryList\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L19)\n\nDefines the structure for a list of agenda item categories by organization.\n\n## Properties\n\n### agendaCategoriesByEventId\n\n> **agendaCategoriesByEventId**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L20)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemInfo\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L26)\n\nDefines the structure for agenda item information.\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: `object`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L39)\n\n#### fileHash\n\n> **fileHash**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### mimeType\n\n> **mimeType**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### objectName\n\n> **objectName**: `string`\n\n***\n\n### category\n\n> **category**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L34)\n\n#### description\n\n> **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L46)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L29)\n\n***\n\n### duration\n\n> **duration**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L30)\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L58)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### folder\n\n> **folder**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L54)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L27)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L28)\n\n***\n\n### notes\n\n> **notes**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L32)\n\n***\n\n### sequence\n\n> **sequence**: `number`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L31)\n\n***\n\n### type?\n\n> `optional` **type**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L33)\n\n***\n\n### url\n\n> **url**: `object`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L50)\n\n#### id\n\n> **id**: `string`\n\n#### url\n\n> **url**: `string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsCreateModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemsCreateModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L171)\n\nProps for the AgendaItemsCreateModal component.\n\n## Properties\n\n### agendaFolderData\n\n> **agendaFolderData**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L177)\n\n***\n\n### agendaItemCategories\n\n> **agendaItemCategories**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L176)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L174)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L173)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L172)\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L178)\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L175)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsDeleteModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemsDeleteModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L201)\n\nProps for the AgendaItemsDeleteModal component.\n\n## Properties\n\n### agendaItemId\n\n> **agendaItemId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L204)\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L202)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L203)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L207)\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L205)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L206)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsPreviewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemsPreviewModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L290)\n\nProps for the AgendaItemsPreviewModal component.\n\nDefines the data and callback functions required to display\nagenda item details in a preview modal and perform related actions\nsuch as updating or deleting an agenda item.\n\n## Properties\n\n### formState\n\n> **formState**: [`InterfaceItemFormStateType`](InterfaceItemFormStateType.md)\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L293)\n\n***\n\n### hidePreviewModal()\n\n> **hidePreviewModal**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L292)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L291)\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L294)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAgendaItemsUpdateModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAgendaItemsUpdateModalProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L184)\n\nProps for the AgendaItemsUpdateModal component.\n\n## Properties\n\n### agendaFolderData\n\n> **agendaFolderData**: [`InterfaceAgendaFolderInfo`](InterfaceAgendaFolderInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L194)\n\n***\n\n### agendaItemCategories\n\n> **agendaItemCategories**: [`InterfaceAgendaItemCategoryInfo`](InterfaceAgendaItemCategoryInfo.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L193)\n\n***\n\n### agendaItemId\n\n> **agendaItemId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L187)\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L185)\n\n***\n\n### itemFormState\n\n> **itemFormState**: [`InterfaceFormStateType`](InterfaceFormStateType.md)\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L188)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L186)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L195)\n\n#### Returns\n\n`void`\n\n***\n\n### setItemFormState()\n\n> **setItemFormState**: (`state`) => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L189)\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<[`InterfaceFormStateType`](InterfaceFormStateType.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L192)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceAttachment.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAttachment\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L127)\n\nDefines the structure for file attachments in agenda items.\n\n## Properties\n\n### fileHash\n\n> **fileHash**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L130)\n\n***\n\n### mimeType\n\n> **mimeType**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L129)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L128)\n\n***\n\n### objectName\n\n> **objectName**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L131)\n\n***\n\n### previewUrl?\n\n> `optional` **previewUrl**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L132)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceCreateFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateFormStateType\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L138)\n\nDefines the form state structure for creating a new agenda item.\n\n## Properties\n\n### attachments\n\n> **attachments**: [`InterfaceAttachment`](InterfaceAttachment.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L144)\n\n***\n\n### categoryId\n\n> **categoryId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L149)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L146)\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L142)\n\n***\n\n### duration\n\n> **duration**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L143)\n\n***\n\n### folderId\n\n> **folderId**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L140)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L139)\n\n***\n\n### notes\n\n> **notes**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L150)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L141)\n\n***\n\n### urls\n\n> **urls**: `string`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L145)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormStateType\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L156)\n\nDefines the form state structure for viewing/updating an agenda item.\n\n## Properties\n\n### attachments\n\n> **attachments**: [`InterfaceAttachment`](InterfaceAttachment.md)[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L163)\n\n***\n\n### category\n\n> **category**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L161)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L159)\n\n***\n\n### duration\n\n> **duration**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L160)\n\n***\n\n### folder?\n\n> `optional` **folder**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L165)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L157)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L158)\n\n***\n\n### notes\n\n> **notes**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L162)\n\n***\n\n### url\n\n> **url**: `string`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L164)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceItemFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceItemFormStateType\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:262](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L262)\n\n## Properties\n\n### attachment?\n\n> `optional` **attachment**: `object`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L268)\n\n#### mimeType\n\n> **mimeType**: `string`\n\n#### previewUrl\n\n> **previewUrl**: `string`\n\n***\n\n### category\n\n> **category**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:276](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L276)\n\n#### description\n\n> **description**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L272)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:265](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L265)\n\n***\n\n### duration\n\n> **duration**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L266)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L263)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:264](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L264)\n\n***\n\n### notes\n\n> **notes**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L267)\n\n***\n\n### url\n\n> **url**: `string`[]\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:280](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L280)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/interface/interfaces/InterfaceUseAgendaMutationsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUseAgendaMutationsProps\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L322)\n\nProps for the useAgendaMutations hook.\n\n## Properties\n\n### refetchAgendaFolder()\n\n> **refetchAgendaFolder**: () => `void`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:323](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L323)\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/AdminPortal/Agenda/interface.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/interface.ts#L324)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Agenda/type/type-aliases/AgendaCategory.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AgendaCategory\n\n> **AgendaCategory** = `object`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L4)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L5)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L6)\n\n***\n\n### createdBy\n\n> **createdBy**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L7)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L8)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L9)\n\n***\n\n### organization\n\n> **organization**: [`Organization`](../../../Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L10)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L11)\n\n***\n\n### updatedBy?\n\n> `optional` **updatedBy**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/Agenda/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Agenda/type.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/ApplyToSelector/interface/interfaces/InterfaceApplyToSelectorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceApplyToSelectorProps\n\nDefined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L11)\n\nProps for ApplyToSelector component.\n\n## Properties\n\n### applyTo\n\n> **applyTo**: [`ApplyToType`](../type-aliases/ApplyToType.md)\n\nDefined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L13)\n\nCurrent selection value ('series' or 'instance')\n\n***\n\n### onChange()\n\n> **onChange**: (`value`) => `void`\n\nDefined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L15)\n\nCallback fired when user changes the selection\n\n#### Parameters\n\n##### value\n\n[`ApplyToType`](../type-aliases/ApplyToType.md)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/ApplyToSelector/interface/type-aliases/ApplyToType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ApplyToType\n\n> **ApplyToType** = `\"series\"` \\| `\"instance\"`\n\nDefined in: [src/types/AdminPortal/ApplyToSelector/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/ApplyToSelector/interface.ts#L6)\n\nType representing the scope of action item application.\n- 'series': Apply to entire recurring series\n- 'instance': Apply to single event instance only\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/AssignmentTypeSelector/interface/interfaces/InterfaceAssignmentTypeSelectorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAssignmentTypeSelectorProps\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L9)\n\nProps interface for the AssignmentTypeSelector component.\n\n## Properties\n\n### assignmentType\n\n> **assignmentType**: [`AssignmentType`](../type-aliases/AssignmentType.md)\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L11)\n\nCurrent assignment type selection\n\n***\n\n### isVolunteerDisabled\n\n> **isVolunteerDisabled**: `boolean`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L15)\n\nWhether the volunteer chip is disabled\n\n***\n\n### isVolunteerGroupDisabled\n\n> **isVolunteerGroupDisabled**: `boolean`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L17)\n\nWhether the volunteer group chip is disabled\n\n***\n\n### onClearVolunteer()\n\n> **onClearVolunteer**: () => `void`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L19)\n\nCallback to clear volunteer selection when switching to volunteer group\n\n#### Returns\n\n`void`\n\n***\n\n### onClearVolunteerGroup()\n\n> **onClearVolunteerGroup**: () => `void`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L21)\n\nCallback to clear volunteer group selection when switching to volunteer\n\n#### Returns\n\n`void`\n\n***\n\n### onTypeChange()\n\n> **onTypeChange**: (`type`) => `void`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L13)\n\nCallback fired when assignment type changes\n\n#### Parameters\n\n##### type\n\n[`AssignmentType`](../type-aliases/AssignmentType.md)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/AssignmentTypeSelector/interface/type-aliases/AssignmentType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AssignmentType\n\n> **AssignmentType** = `\"volunteer\"` \\| `\"volunteerGroup\"`\n\nDefined in: [src/types/AdminPortal/AssignmentTypeSelector/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/AssignmentTypeSelector/interface.ts#L4)\n\nType for assignment selection - either volunteer or volunteer group.\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Contribution/interface/interfaces/InterfaceContriStatsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceContriStatsProps\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L1)\n\n## Properties\n\n### highestAmount\n\n> **highestAmount**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L4)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L2)\n\n***\n\n### recentAmount\n\n> **recentAmount**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L3)\n\n***\n\n### totalAmount\n\n> **totalAmount**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Contribution/interface/interfaces/InterfaceOrgContriCardsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgContriCardsProps\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L8)\n\n## Properties\n\n### contriAmount\n\n> **contriAmount**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L13)\n\n***\n\n### contriDate\n\n> **contriDate**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L12)\n\n***\n\n### contriTransactionId\n\n> **contriTransactionId**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L14)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L10)\n\n***\n\n### key\n\n> **key**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L9)\n\n***\n\n### userEmail\n\n> **userEmail**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L15)\n\n***\n\n### userName\n\n> **userName**: `string`\n\nDefined in: [src/types/AdminPortal/Contribution/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Contribution/interface.ts#L11)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceAddOnSpotAttendeeProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddOnSpotAttendeeProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L4)\n\nDefines the props for the AddOnSpotAttendee component.\n\n## Properties\n\n### handleClose()\n\n> **handleClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L6)\n\n#### Returns\n\n`void`\n\n***\n\n### reloadMembers()\n\n> **reloadMembers**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L7)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/AddOnSpot/interfaces/InterfaceFormData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormData\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L13)\n\nDefines the structure for form data.\n\n## Properties\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L16)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L14)\n\n***\n\n### gender\n\n> **gender**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L18)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L15)\n\n***\n\n### phoneNo\n\n> **phoneNo**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/AddOnSpot.ts#L17)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface/interfaces/InterfaceInviteByEmailModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceInviteByEmailModalProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L4)\n\nProps for InviteByEmailModal component.\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L7)\n\n***\n\n### handleClose()\n\n> **handleClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L6)\n\n#### Returns\n\n`void`\n\n***\n\n### isRecurring?\n\n> `optional` **isRecurring**: `boolean`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L8)\n\n***\n\n### onInvitesSent()?\n\n> `optional` **onInvitesSent**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L9)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/InviteByEmail/interface.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceAutocompleteMockProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAutocompleteMockProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L27)\n\nProps for Autocomplete mock component used in tests.\n\n## Properties\n\n### getOptionLabel()?\n\n> `optional` **getOptionLabel**: (`option`) => `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L48)\n\n#### Parameters\n\n##### option\n\n###### id\n\n`string`\n\n###### name?\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### inputValue?\n\n> `optional` **inputValue**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L39)\n\n***\n\n### noOptionsText?\n\n> `optional` **noOptionsText**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L40)\n\n***\n\n### onChange()?\n\n> `optional` **onChange**: (`event`, `value`) => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L30)\n\n#### Parameters\n\n##### event\n\n`SyntheticEvent`\n\n##### value\n\n###### id\n\n`string`\n\n###### name?\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### onInputChange()?\n\n> `optional` **onInputChange**: (`event`, `value`, `reason`) => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L34)\n\n#### Parameters\n\n##### event\n\n`SyntheticEvent`\n\n##### value\n\n`string`\n\n##### reason\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### options?\n\n> `optional` **options**: `object`[]\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L29)\n\n#### id\n\n> **id**: `string`\n\n#### name?\n\n> `optional` **name**: `string`\n\n***\n\n### renderInput()\n\n> **renderInput**: (`params`) => `Element`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L28)\n\n#### Parameters\n\n##### params\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`Element`\n\n***\n\n### renderOption()?\n\n> `optional` **renderOption**: (`props`, `option`, `state`) => `Element`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L41)\n\n#### Parameters\n\n##### props\n\n`Record`\\<`string`, `unknown`\\>\n\n##### option\n\n###### id\n\n`string`\n\n###### name?\n\n`string`\n\n##### state\n\n###### selected\n\n`boolean`\n\n#### Returns\n\n`Element`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceBaseModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBaseModalProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L15)\n\nProps for BaseModal mock component used in tests.\n\n## Properties\n\n### children?\n\n> `optional` **children**: `ReactNode`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L17)\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L20)\n\n***\n\n### footer?\n\n> `optional` **footer**: `ReactNode`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L18)\n\n***\n\n### onHide()?\n\n> `optional` **onHide**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L21)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L16)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L19)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsModal/interface/interfaces/InterfaceEventRegistrantsModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventRegistrantsModalProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L5)\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L7)\n\n***\n\n### handleClose()\n\n> **handleClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L9)\n\n#### Returns\n\n`void`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L8)\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsModal/interface.ts#L6)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/EventRegistrantsWrapper/interface/interfaces/InterfaceEventRegistrantsWrapperProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventRegistrantsWrapperProps\n\nDefined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L4)\n\nProps for EventRegistrantsWrapper component.\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L5)\n\n***\n\n### onUpdate()?\n\n> `optional` **onUpdate**: () => `void`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L7)\n\n#### Returns\n\n`void`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/AdminPortal/EventRegistrantsWrapper/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/EventRegistrantsWrapper/interface.ts#L6)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfaceAddressFieldConfig.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddressFieldConfig\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L26)\n\nInterface representing the configuration for an address input field.\n\n## Properties\n\n### colSize?\n\n> `optional` **colSize**: `number`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L34)\n\nOptional column size for layout/grid purposes\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L28)\n\nUnique identifier for the field\n\n***\n\n### key\n\n> **key**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L32)\n\nKey used to map the field to data in the form or state\n\n***\n\n### testId\n\n> **testId**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L30)\n\nTest ID used for automated testing selectors\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfacePhoneFieldConfig.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePhoneFieldConfig\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L15)\n\nInterface representing the configuration for a phone input field.\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L17)\n\nUnique identifier for the field\n\n***\n\n### key\n\n> **key**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L21)\n\nKey used to map the field to data in the form or state\n\n***\n\n### testId\n\n> **testId**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L19)\n\nTest ID used for automated testing selectors\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/interfaces/InterfaceResolveAvatarFileParams.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceResolveAvatarFileParams\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L4)\n\nInterface for the parameters of resolveAvatarFile function.\n\n## Properties\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L10)\n\nURL of the existing avatar if no new file is uploaded\n\n***\n\n### newAvatarUploaded\n\n> **newAvatarUploaded**: `boolean`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L6)\n\nWhether a new avatar was uploaded\n\n***\n\n### selectedAvatar\n\n> **selectedAvatar**: `File`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L8)\n\nFile object of the selected avatar if uploaded\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/MemberDetail/interface/type-aliases/InterfaceMemberDetailProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceMemberDetailProps\n\n> **InterfaceMemberDetailProps** = `object`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L37)\n\nProps for the MemberDetail screen component.\n\n## Properties\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/AdminPortal/MemberDetail/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/MemberDetail/interface.ts#L37)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceMutationUpdateOrganizationInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMutationUpdateOrganizationInput\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L40)\n\nInput type for the updateOrganization mutation.\n\n## Properties\n\n### addressLine1?\n\n> `optional` **addressLine1**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L44)\n\n***\n\n### addressLine2?\n\n> `optional` **addressLine2**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L45)\n\n***\n\n### avatar?\n\n> `optional` **avatar**: `File`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L50)\n\n***\n\n### city?\n\n> `optional` **city**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L46)\n\n***\n\n### countryCode?\n\n> `optional` **countryCode**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L49)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L43)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L41)\n\n***\n\n### isUserRegistrationRequired?\n\n> `optional` **isUserRegistrationRequired**: `boolean`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L51)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L42)\n\n***\n\n### postalCode?\n\n> `optional` **postalCode**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L48)\n\n***\n\n### state?\n\n> `optional` **state**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L47)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrgUpdateProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgUpdateProps\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L4)\n\nProps for the OrgUpdate component.\n\n## Properties\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L6)\n\nThe unique identifier of the organization to update.\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/OrgUpdate/interface/interfaces/InterfaceOrganization.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganization\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L12)\n\nRepresents an organization's basic data structure.\n\n## Properties\n\n### addressLine1\n\n> **addressLine1**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L20)\n\nPrimary address line.\n\n***\n\n### addressLine2\n\n> **addressLine2**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L22)\n\nSecondary address line.\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L32)\n\nURL of the organization's avatar image, or null if not set.\n\n***\n\n### city\n\n> **city**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L24)\n\nCity of the organization.\n\n***\n\n### countryCode\n\n> **countryCode**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L30)\n\nISO country code.\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L18)\n\nDescription of the organization.\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L14)\n\nUnique identifier of the organization.\n\n***\n\n### isUserRegistrationRequired\n\n> **isUserRegistrationRequired**: `boolean`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L34)\n\nWhether user registration requires approval, or null if not configured.\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L16)\n\nName of the organization.\n\n***\n\n### postalCode\n\n> **postalCode**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L28)\n\nPostal or ZIP code.\n\n***\n\n### state\n\n> **state**: `string`\n\nDefined in: [src/types/AdminPortal/OrgUpdate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrgUpdate/interface.ts#L26)\n\nState or province.\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPeopleListCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgPeopleListCardProps\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L1)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L2)\n\n***\n\n### toggleRemoveModal()\n\n> **toggleRemoveModal**: () => `void`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L3)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Organization/interface/interfaces/InterfaceOrgPostCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgPostCardProps\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L6)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L8)\n\n***\n\n### pinned\n\n> **pinned**: `boolean`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L14)\n\n***\n\n### postAuthor\n\n> **postAuthor**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L11)\n\n***\n\n### postID\n\n> **postID**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L7)\n\n***\n\n### postInfo\n\n> **postInfo**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L10)\n\n***\n\n### postPhoto\n\n> **postPhoto**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L12)\n\n***\n\n### postTitle\n\n> **postTitle**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L9)\n\n***\n\n### postVideo\n\n> **postVideo**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/interface.ts#L13)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/Organization.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Organization\n\n> **Organization** = `object`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L24)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L25)\n\n***\n\n### actionItemCategories?\n\n> `optional` **actionItemCategories**: [`ActionItemCategory`](../../../actionItem/type-aliases/ActionItemCategory.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L26)\n\n***\n\n### address?\n\n> `optional` **address**: [`Address`](../../../address/type-aliases/Address.md)\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L27)\n\n***\n\n### admins?\n\n> `optional` **admins**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L28)\n\n***\n\n### agendaCategories?\n\n> `optional` **agendaCategories**: [`AgendaCategory`](../../../Agenda/type/type-aliases/AgendaCategory.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L29)\n\n***\n\n### apiUrl\n\n> **apiUrl**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L30)\n\n***\n\n### blockedUsers?\n\n> `optional` **blockedUsers**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L31)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L32)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L33)\n\n***\n\n### customFields\n\n> **customFields**: [`OrganizationCustomField`](OrganizationCustomField.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L34)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L35)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L36)\n\n***\n\n### members?\n\n> `optional` **members**: [`User`](../../../../shared-components/User/type/type-aliases/User.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L37)\n\n***\n\n### membershipRequests?\n\n> `optional` **membershipRequests**: [`MembershipRequest`](../../../membership/type-aliases/MembershipRequest.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L38)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L39)\n\n***\n\n### pinnedPosts?\n\n> `optional` **pinnedPosts**: [`Post`](../../../../Post/type/type-aliases/Post.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L40)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L41)\n\n***\n\n### userRegistrationRequired\n\n> **userRegistrationRequired**: `boolean`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L42)\n\n***\n\n### venues?\n\n> `optional` **venues**: [`Venue`](../../../venue/type-aliases/Venue.md)[]\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L44)\n\n***\n\n### visibleInSearch\n\n> **visibleInSearch**: `boolean`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L43)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/OrganizationCustomField.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OrganizationCustomField\n\n> **OrganizationCustomField** = `object`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L47)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L48)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L49)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L50)\n\n***\n\n### type\n\n> **type**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L51)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Organization/type/type-aliases/OrganizationInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OrganizationInput\n\n> **OrganizationInput** = `object`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L54)\n\n## Properties\n\n### address\n\n> **address**: [`AddressInput`](../../../address/type-aliases/AddressInput.md)\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L55)\n\n***\n\n### apiUrl?\n\n> `optional` **apiUrl**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L56)\n\n***\n\n### attendees?\n\n> `optional` **attendees**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L57)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L58)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L59)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L60)\n\n***\n\n### userRegistrationRequired?\n\n> `optional` **userRegistrationRequired**: `boolean`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L61)\n\n***\n\n### visibleInSearch?\n\n> `optional` **visibleInSearch**: `boolean`\n\nDefined in: [src/types/AdminPortal/Organization/type.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Organization/type.ts#L62)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/OrganizationDashCards/CardItem/interface/interfaces/InterfaceCardItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCardItem\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L1)\n\n## Properties\n\n### creator?\n\n> `optional` **creator**: `object`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L7)\n\n#### id\n\n> **id**: `string` \\| `number`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### enddate?\n\n> `optional` **enddate**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L6)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L9)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L8)\n\n***\n\n### startdate?\n\n> `optional` **startdate**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L5)\n\n***\n\n### time?\n\n> `optional` **time**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L4)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L3)\n\n***\n\n### type\n\n> **type**: `\"Event\"` \\| `\"Post\"` \\| `\"MembershipRequest\"`\n\nDefined in: [src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationDashCards/CardItem/interface.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/OrganizationPeople/addMember/interface/interfaces/InterfaceAddMemberProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddMemberProps\n\nDefined in: [src/types/AdminPortal/OrganizationPeople/addMember/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationPeople/addMember/interface.ts#L5)\n\nProps for the AddMember component (organization people \"Add Members\" dropdown and modals).\nUsed to pass styling class names from the parent screen so styles stay decoupled from test IDs.\n\n## Properties\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationPeople/addMember/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationPeople/addMember/interface.ts#L9)\n\nOptional class for the Add Members dropdown container.\n\n***\n\n### rootClassName?\n\n> `optional` **rootClassName**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationPeople/addMember/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationPeople/addMember/interface.ts#L7)\n\nOptional class for the Add Members header wrapper (e.g. PageHeader root).\n\n***\n\n### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\nDefined in: [src/types/AdminPortal/OrganizationPeople/addMember/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/OrganizationPeople/addMember/interface.ts#L11)\n\nOptional class for the Add Members dropdown toggle button.\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface/interfaces/IUninstallConfirmationModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUninstallConfirmationModalProps\n\nDefined in: [src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts#L11)\n\nInterface for the UninstallConfirmationModal component props.\n\n## Param\n\nBoolean to control the visibility of the modal.\n\n## Param\n\nCallback function to handle the closing of the modal.\n\n## Param\n\nCallback function to handle the confirmation action.\n\n## Param\n\nThe plugin metadata object to be uninstalled, or null if none selected.\n\n## Properties\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts#L13)\n\n#### Returns\n\n`void`\n\n***\n\n### onConfirm()\n\n> **onConfirm**: () => `void`\n\nDefined in: [src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts#L14)\n\n#### Returns\n\n`void`\n\n***\n\n### plugin\n\n> **plugin**: [`IPluginMeta`](../../../../../../plugin/types/interfaces/IPluginMeta.md)\n\nDefined in: [src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts#L15)\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/PluginStore/UninstallConfirmationModal/interface.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceAddPeopleToTagProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddPeopleToTagProps\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L27)\n\n## Properties\n\n### addPeopleToTagModalIsOpen\n\n> **addPeopleToTagModalIsOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L28)\n\n***\n\n### hideAddPeopleToTagModal()\n\n> **hideAddPeopleToTagModal**: () => `void`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L29)\n\n#### Returns\n\n`void`\n\n***\n\n### refetchAssignedMembersData()\n\n> **refetchAssignedMembersData**: () => `void`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L30)\n\n#### Returns\n\n`void`\n\n***\n\n### t\n\n> **t**: `TFunction`\\<`\"translation\"`, `\"manageTag\"`\\>\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L31)\n\n***\n\n### tCommon\n\n> **tCommon**: `TFunction`\\<`\"common\"`, `undefined`\\>\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L32)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceBaseFetchMoreOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBaseFetchMoreOptions\\\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L45)\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Properties\n\n### updateQuery()?\n\n> `optional` **updateQuery**: (`prev`, `options`) => `T`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L47)\n\n#### Parameters\n\n##### prev\n\n`T`\n\n##### options\n\n###### fetchMoreResult\n\n`T`\n\n#### Returns\n\n`T`\n\n***\n\n### variables\n\n> **variables**: [`InterfacePaginationVariables`](InterfacePaginationVariables.md)\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L46)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceBaseQueryResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBaseQueryResult\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L39)\n\n## Extended by\n\n- [`InterfaceTagUsersToAssignToQuery`](InterfaceTagUsersToAssignToQuery.md)\n\n## Properties\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L41)\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L40)\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L42)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceMemberData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMemberData\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L4)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L5)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L6)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfacePaginationVariables.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePaginationVariables\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L35)\n\n## Properties\n\n### after?\n\n> `optional` **after**: `string`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L36)\n\n***\n\n### first?\n\n> `optional` **first**: `number`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L37)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserTagsMembersToAssignTo\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L50)\n\n## Properties\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L51)\n\n***\n\n### usersToAssignTo\n\n> **usersToAssignTo**: [`InterfaceTagMembersData`](InterfaceTagMembersData.md)\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L52)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceTagMembersData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagMembersData\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L10)\n\n## Properties\n\n### edges\n\n> **edges**: `object`[]\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L11)\n\n#### node\n\n> **node**: `object`\n\n##### node.\\_id\n\n> **\\_id**: `string`\n\n##### node.firstName\n\n> **firstName**: `string`\n\n##### node.lastName\n\n> **lastName**: `string`\n\n***\n\n### pageInfo\n\n> **pageInfo**: `object`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L18)\n\n#### endCursor\n\n> **endCursor**: `string`\n\n#### hasNextPage\n\n> **hasNextPage**: `boolean`\n\n#### hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\n#### startCursor\n\n> **startCursor**: `string`\n\n***\n\n### totalCount\n\n> **totalCount**: `number`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L24)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/interface/interfaces/InterfaceTagUsersToAssignToQuery.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagUsersToAssignToQuery\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L55)\n\n## Extends\n\n- [`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md)\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L56)\n\n#### getUsersToAssignTo\n\n> **getUsersToAssignTo**: [`InterfaceQueryUserTagsMembersToAssignTo`](InterfaceQueryUserTagsMembersToAssignTo.md)\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L41)\n\n#### Inherited from\n\n[`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`error`](InterfaceBaseQueryResult.md#error)\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L59)\n\n#### Parameters\n\n##### options\n\n[`InterfaceBaseFetchMoreOptions`](InterfaceBaseFetchMoreOptions.md)\\<\\{ `getUsersToAssignTo`: [`InterfaceQueryUserTagsMembersToAssignTo`](InterfaceQueryUserTagsMembersToAssignTo.md); \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L40)\n\n#### Inherited from\n\n[`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`loading`](InterfaceBaseQueryResult.md#loading)\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/types/AdminPortal/Tag/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/interface.ts#L42)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceBaseQueryResult`](InterfaceBaseQueryResult.md).[`refetch`](InterfaceBaseQueryResult.md#refetch)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/utils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: TAGS\\_QUERY\\_DATA\\_CHUNK\\_SIZE\n\n> `const` **TAGS\\_QUERY\\_DATA\\_CHUNK\\_SIZE**: `10` = `10`\n\nDefined in: [src/types/AdminPortal/Tag/utils.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/utils.ts#L1)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/Tag/utils/variables/dataGridStyle.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dataGridStyle\n\n> `const` **dataGridStyle**: `object`\n\nDefined in: [src/types/AdminPortal/Tag/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/Tag/utils.ts#L3)\n\n## Type Declaration\n\n#### & .MuiDataGrid-cell:focus\n\n> **& .MuiDataGrid-cell:focus**: `object`\n\n#### & .MuiDataGrid-cell:focus.outline\n\n> **outline**: `string` = `'2px solid #000'`\n\n#### & .MuiDataGrid-cell:focus.outlineOffset\n\n> **outlineOffset**: `string` = `'-2px'`\n\n#### & .MuiDataGrid-main\n\n> **& .MuiDataGrid-main**: `object`\n\n#### & .MuiDataGrid-main.borderRadius\n\n> **borderRadius**: `string` = `'0.1rem'`\n\n#### & .MuiDataGrid-root\n\n> **& .MuiDataGrid-root**: `object`\n\n#### & .MuiDataGrid-root.borderRadius\n\n> **borderRadius**: `string` = `'0.1rem'`\n\n#### & .MuiDataGrid-row:hover\n\n> **& .MuiDataGrid-row:hover**: `object`\n\n#### & .MuiDataGrid-row:hover.backgroundColor\n\n> **backgroundColor**: `string` = `'transparent'`\n\n#### & .MuiDataGrid-row:hover.boxShadow\n\n> **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'`\n\n#### & .MuiDataGrid-row.Mui-hovered\n\n> **& .MuiDataGrid-row.Mui-hovered**: `object`\n\n#### & .MuiDataGrid-row.Mui-hovered.backgroundColor\n\n> **backgroundColor**: `string` = `'transparent'`\n\n#### & .MuiDataGrid-row.Mui-hovered.boxShadow\n\n> **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'`\n\n#### & .MuiDataGrid-topContainer\n\n> **& .MuiDataGrid-topContainer**: `object`\n\n#### & .MuiDataGrid-topContainer.position\n\n> **position**: `string` = `'fixed'`\n\n#### & .MuiDataGrid-topContainer.top\n\n> **top**: `number` = `290`\n\n#### & .MuiDataGrid-topContainer.zIndex\n\n> **zIndex**: `number` = `1`\n\n#### & .MuiDataGrid-virtualScrollerContent\n\n> **& .MuiDataGrid-virtualScrollerContent**: `object`\n\n#### & .MuiDataGrid-virtualScrollerContent.marginTop\n\n> **marginTop**: `number` = `6.5`\n\n#### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within\n\n> **&.MuiDataGrid-root .MuiDataGrid-cell:focus-within**: `object`\n\n#### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within.outline\n\n> **outline**: `string` = `'none !important'`\n\n#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within\n\n> **&.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within**: `object`\n\n#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within.outline\n\n> **outline**: `string` = `'none'`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/TagActions/interface/interfaces/InterfaceTagActionsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagActionsProps\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L4)\n\n## Properties\n\n### hideTagActionsModal()\n\n> **hideTagActionsModal**: () => `void`\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L6)\n\n#### Returns\n\n`void`\n\n***\n\n### t\n\n> **t**: `TFunction`\\<`\"translation\"`, `\"manageTag\"`\\>\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L8)\n\n***\n\n### tagActionsModalIsOpen\n\n> **tagActionsModalIsOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L5)\n\n***\n\n### tagActionType\n\n> **tagActionType**: [`TagActionType`](../../../../../utils/organizationTagsUtils/type-aliases/TagActionType.md)\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L7)\n\n***\n\n### tCommon\n\n> **tCommon**: `TFunction`\\<`\"common\"`, `undefined`\\>\n\nDefined in: [src/types/AdminPortal/TagActions/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/TagActions/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UpdateSession/interface/interfaces/InterfaceUpdateSessionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUpdateSessionProps\n\nDefined in: [src/types/AdminPortal/UpdateSession/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UpdateSession/interface.ts#L4)\n\nProps for UpdateSession component.\n\n## Properties\n\n### onValueChange()?\n\n> `optional` **onValueChange**: (`value`) => `void`\n\nDefined in: [src/types/AdminPortal/UpdateSession/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UpdateSession/interface.ts#L8)\n\nCallback invoked when the timeout value changes.\n\n#### Parameters\n\n##### value\n\n`number`\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLEventLite.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGQLEventLite\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L27)\n\nRepresents a minimal GraphQL event reference used\nfor relational fields such as attended events.\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L28)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLOrganization.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGQLOrganization\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L34)\n\nRepresents a GraphQL organization entity associated\nwith events and user participation.\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L35)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L36)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGQLUser.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGQLUser\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L19)\n\nRepresents a lightweight GraphQL user object containing\nbasic identity details used in event relationships.\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L20)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L21)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceGetUserEventsData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGetUserEventsData\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L42)\n\nGraphQL response payload containing events fetched\nfor a specific organization.\n\n## Properties\n\n### eventsByOrganizationId\n\n> **eventsByOrganizationId**: [`InterfaceUserEventsGQL`](InterfaceUserEventsGQL.md)[]\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L43)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceUserEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserEvent\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L5)\n\nRepresents a UI-friendly event payload with formatted date/time\nand minimal fields required for rendering user events.\n\n## Properties\n\n### creatorId\n\n> **creatorId**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L13)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L8)\n\n***\n\n### endDate\n\n> **endDate**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L11)\n\n***\n\n### endTime\n\n> **endTime**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L12)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L6)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L7)\n\n***\n\n### startDate\n\n> **startDate**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L9)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/interfaces/InterfaceUserEventsGQL.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserEventsGQL\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L49)\n\nRepresents detailed event data returned by GraphQL,\nincluding metadata, attendees, creator, and organization.\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L55)\n\n***\n\n### attendees\n\n> **attendees**: [`InterfaceGQLUser`](InterfaceGQLUser.md)[]\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L63)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L60)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceGQLUser`](InterfaceGQLUser.md) & `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L65)\n\n#### Type Declaration\n\n##### eventsAttended\n\n> **eventsAttended**: [`InterfaceGQLEventLite`](InterfaceGQLEventLite.md)[]\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L52)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L54)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L50)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L57)\n\n***\n\n### isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L58)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L59)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L56)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L51)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceGQLOrganization`](InterfaceGQLOrganization.md)\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L69)\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L53)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L61)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/interface/type-aliases/ParticipationFilter.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ParticipationFilter\n\n> **ParticipationFilter** = `\"ALL\"` \\| `\"ADMIN_CREATOR\"`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/interface.ts#L72)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserEvent/type/type-aliases/PeopleTabUserEventsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PeopleTabUserEventsProps\n\n> **PeopleTabUserEventsProps** = `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/type.ts#L2)\n\nProps for the UserEvents component.\n\n## Properties\n\n### orgId?\n\n> `optional` **orgId**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/type.ts#L2)\n\n***\n\n### userId?\n\n> `optional` **userId**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserEvent/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserEvent/type.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/interface/interfaces/InterfaceJoinedOrgEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceJoinedOrgEdge\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/interface.ts#L1)\n\n## Properties\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/interface.ts#L2)\n\n#### adminsCount\n\n> **adminsCount**: `number`\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### description?\n\n> `optional` **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### membersCount\n\n> **membersCount**: `number`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/interface/interfaces/InterfaceJoinedOrganizationsData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceJoinedOrganizationsData\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/interface.ts#L12)\n\n## Properties\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/interface.ts#L13)\n\n#### organizationsWhereMember?\n\n> `optional` **organizationsWhereMember**: `object`\n\n##### organizationsWhereMember.edges?\n\n> `optional` **edges**: [`InterfaceJoinedOrgEdge`](InterfaceJoinedOrgEdge.md)[]\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceOrgRelationType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceOrgRelationType\n\n> **InterfaceOrgRelationType** = `\"CREATED\"` \\| `\"BELONG_TO\"` \\| `\"JOINED\"`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrg.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceUserOrg\n\n> **InterfaceUserOrg** = `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L4)\n\n## Properties\n\n### adminsCount\n\n> **adminsCount**: `number`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L8)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L11)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L10)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L5)\n\n***\n\n### membersCount\n\n> **membersCount**: `number`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L9)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L6)\n\n***\n\n### relation\n\n> **relation**: [`InterfaceOrgRelationType`](InterfaceOrgRelationType.md)\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserOrganization/type/type-aliases/InterfaceUserOrganizationsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceUserOrganizationsProps\n\n> **InterfaceUserOrganizationsProps** = `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L1)\n\n## Properties\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserOrganization/type.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserOrganization/type.ts#L1)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceGetUserTagsData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGetUserTagsData\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L11)\n\nShape of the GraphQL response for the GetUserTags query.\n\n## Properties\n\n### userTags\n\n> **userTags**: [`InterfaceUserTagGQL`](InterfaceUserTagGQL.md)[]\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceUserTag.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserTag\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L2)\n\nUI-mapped representation of a user tag for table display.\n\n## Properties\n\n### assignedTo\n\n> **assignedTo**: `number`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L5)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L7)\n\n***\n\n### createdBy?\n\n> `optional` **createdBy**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L8)\n\n***\n\n### createdOn\n\n> **createdOn**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L6)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L3)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L4)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/interface/interfaces/InterfaceUserTagGQL.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserTagGQL\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L15)\n\nRaw GraphQL shape for a single user tag as returned by the API.\n\n## Properties\n\n### assignees?\n\n> `optional` **assignees**: `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L22)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L18)\n\n***\n\n### creator?\n\n> `optional` **creator**: `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L29)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### folder?\n\n> `optional` **folder**: `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L19)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L16)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/interface.ts#L17)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserDetails/UserTags/type/type-aliases/InterfaceUserTagsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceUserTagsProps\n\n> **InterfaceUserTagsProps** = `object`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/type.ts#L2)\n\nProps for the UserTags component.\n\n## Properties\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserDetails/UserTags/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserDetails/UserTags/type.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceActionButton.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceActionButton\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L26)\n\nAction button configuration interface\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L33)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L32)\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactElement`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L29)\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L27)\n\n***\n\n### onClick()\n\n> **onClick**: (`user`) => `void`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L28)\n\n#### Parameters\n\n##### user\n\n[`InterfaceUserInfo`](InterfaceUserInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L31)\n\n***\n\n### variant?\n\n> `optional` **variant**: [`InterfaceActionVariant`](../type-aliases/InterfaceActionVariant.md)\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L30)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserInfo\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L6)\n\nUser information interface for UserTableRow component\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L10)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L11)\n\n***\n\n### emailAddress?\n\n> `optional` **emailAddress**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L9)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L7)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/interfaces/InterfaceUserTableRowProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserTableRowProps\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L39)\n\nProps interface for UserTableRow component\n\n## Properties\n\n### actions?\n\n> `optional` **actions**: [`InterfaceActionButton`](InterfaceActionButton.md)[]\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L43)\n\n***\n\n### compact?\n\n> `optional` **compact**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L47)\n\n***\n\n### isDataGrid?\n\n> `optional` **isDataGrid**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L46)\n\n***\n\n### linkPath?\n\n> `optional` **linkPath**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L42)\n\n***\n\n### onRowClick()?\n\n> `optional` **onRowClick**: (`user`) => `void`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L45)\n\n#### Parameters\n\n##### user\n\n[`InterfaceUserInfo`](InterfaceUserInfo.md)\n\n#### Returns\n\n`void`\n\n***\n\n### rowNumber?\n\n> `optional` **rowNumber**: `number`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L41)\n\n***\n\n### showJoinedDate?\n\n> `optional` **showJoinedDate**: `boolean`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L44)\n\n***\n\n### testIdPrefix?\n\n> `optional` **testIdPrefix**: `string`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L48)\n\n***\n\n### user\n\n> **user**: [`InterfaceUserInfo`](InterfaceUserInfo.md)\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L40)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/UserTableRow/interface/type-aliases/InterfaceActionVariant.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceActionVariant\n\n> **InterfaceActionVariant** = `\"primary\"` \\| `\"success\"` \\| `\"danger\"` \\| `\"default\"`\n\nDefined in: [src/types/AdminPortal/UserTableRow/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/UserTableRow/interface.ts#L17)\n\nAction button variant types for styling\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/VolunteerDeleteModal/interface/interfaces/InterfaceVolunteerDeleteModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerDeleteModalProps\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L6)\n\nProps for VolunteerDeleteModal component.\n\n## Properties\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L12)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L8)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L7)\n\n***\n\n### isRecurring?\n\n> `optional` **isRecurring**: `boolean`\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L11)\n\n***\n\n### refetchVolunteers()\n\n> **refetchVolunteers**: () => `void`\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L10)\n\n#### Returns\n\n`void`\n\n***\n\n### volunteer\n\n> **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md)\n\nDefined in: [src/types/AdminPortal/VolunteerDeleteModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerDeleteModal/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/VolunteerViewModal/interface/interfaces/InterfaceVolunteerViewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerViewModalProps\n\nDefined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L6)\n\nProps for VolunteerViewModal component.\n\n## Properties\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L8)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L7)\n\n***\n\n### volunteer\n\n> **volunteer**: [`InterfaceEventVolunteerInfo`](../../../../../utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md)\n\nDefined in: [src/types/AdminPortal/VolunteerViewModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/VolunteerViewModal/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/ActionItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ActionItem\n\n> **ActionItem** = `object`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L5)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L6)\n\n***\n\n### actionItemCategory?\n\n> `optional` **actionItemCategory**: [`ActionItemCategory`](ActionItemCategory.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L7)\n\n***\n\n### assignee?\n\n> `optional` **assignee**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L8)\n\n***\n\n### assigner?\n\n> `optional` **assigner**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L9)\n\n***\n\n### assignmentDate\n\n> **assignmentDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L10)\n\n***\n\n### completionDate\n\n> **completionDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L11)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L12)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L13)\n\n***\n\n### dueDate\n\n> **dueDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L14)\n\n***\n\n### event?\n\n> `optional` **event**: `Event`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L15)\n\n***\n\n### isCompleted\n\n> **isCompleted**: `boolean`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L16)\n\n***\n\n### postCompletionNotes?\n\n> `optional` **postCompletionNotes**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L17)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L18)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L19)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/ActionItemCategory.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ActionItemCategory\n\n> **ActionItemCategory** = `object`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L22)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L23)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L24)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L25)\n\n***\n\n### isDisabled\n\n> **isDisabled**: `boolean`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L26)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L27)\n\n***\n\n### organization?\n\n> `optional` **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/AdminPortal/actionItem.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L28)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L29)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/CreateActionItemInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateActionItemInput\n\n> **CreateActionItemInput** = `object`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L32)\n\n## Properties\n\n### assigneeId\n\n> **assigneeId**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L33)\n\n***\n\n### dueDate?\n\n> `optional` **dueDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L34)\n\n***\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L35)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L36)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/actionItem/type-aliases/UpdateActionItemInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UpdateActionItemInput\n\n> **UpdateActionItemInput** = `object`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L39)\n\n## Properties\n\n### assigneeId?\n\n> `optional` **assigneeId**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L40)\n\n***\n\n### completionDate?\n\n> `optional` **completionDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L41)\n\n***\n\n### dueDate?\n\n> `optional` **dueDate**: `Date`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L42)\n\n***\n\n### isCompleted?\n\n> `optional` **isCompleted**: `boolean`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L43)\n\n***\n\n### postCompletionNotes?\n\n> `optional` **postCompletionNotes**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L44)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/AdminPortal/actionItem.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/actionItem.ts#L45)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/address/type-aliases/Address.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Address\n\n> **Address** = `object`\n\nDefined in: [src/types/AdminPortal/address.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L1)\n\n## Properties\n\n### city?\n\n> `optional` **city**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L2)\n\n***\n\n### countryCode?\n\n> `optional` **countryCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L3)\n\n***\n\n### dependentLocality?\n\n> `optional` **dependentLocality**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L4)\n\n***\n\n### line1?\n\n> `optional` **line1**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L5)\n\n***\n\n### line2?\n\n> `optional` **line2**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L6)\n\n***\n\n### postalCode?\n\n> `optional` **postalCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L7)\n\n***\n\n### sortingCode?\n\n> `optional` **sortingCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L8)\n\n***\n\n### state?\n\n> `optional` **state**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/address/type-aliases/AddressInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AddressInput\n\n> **AddressInput** = `object`\n\nDefined in: [src/types/AdminPortal/address.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L12)\n\n## Properties\n\n### city?\n\n> `optional` **city**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L13)\n\n***\n\n### countryCode?\n\n> `optional` **countryCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L14)\n\n***\n\n### dependentLocality?\n\n> `optional` **dependentLocality**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L15)\n\n***\n\n### line1?\n\n> `optional` **line1**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L16)\n\n***\n\n### line2?\n\n> `optional` **line2**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L17)\n\n***\n\n### postalCode?\n\n> `optional` **postalCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L18)\n\n***\n\n### sortingCode?\n\n> `optional` **sortingCode**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L19)\n\n***\n\n### state?\n\n> `optional` **state**: `string`\n\nDefined in: [src/types/AdminPortal/address.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/address.ts#L20)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/membership/type-aliases/MembershipRequest.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: MembershipRequest\n\n> **MembershipRequest** = `object`\n\nDefined in: [src/types/AdminPortal/membership.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L4)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/membership.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L5)\n\n***\n\n### organization\n\n> **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/AdminPortal/membership.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L6)\n\n***\n\n### user\n\n> **user**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/AdminPortal/membership.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/membership.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/pagination/type-aliases/DefaultConnectionPageInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DefaultConnectionPageInfo\n\n> **DefaultConnectionPageInfo** = `object`\n\nDefined in: [src/types/AdminPortal/pagination.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L1)\n\n## Properties\n\n### endCursor?\n\n> `optional` **endCursor**: `string`\n\nDefined in: [src/types/AdminPortal/pagination.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L5)\n\n***\n\n### hasNextPage\n\n> **hasNextPage**: `boolean`\n\nDefined in: [src/types/AdminPortal/pagination.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L2)\n\n***\n\n### hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\nDefined in: [src/types/AdminPortal/pagination.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L3)\n\n***\n\n### startCursor?\n\n> `optional` **startCursor**: `string`\n\nDefined in: [src/types/AdminPortal/pagination.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/pagination.ts#L4)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/EditVenueInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EditVenueInput\n\n> **EditVenueInput** = `object`\n\nDefined in: [src/types/AdminPortal/venue.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L20)\n\n## Properties\n\n### capacity?\n\n> `optional` **capacity**: `number`\n\nDefined in: [src/types/AdminPortal/venue.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L21)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L22)\n\n***\n\n### file?\n\n> `optional` **file**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L23)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L24)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L25)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/Venue.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Venue\n\n> **Venue** = `object`\n\nDefined in: [src/types/AdminPortal/venue.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L3)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L4)\n\n***\n\n### capacity\n\n> **capacity**: `number`\n\nDefined in: [src/types/AdminPortal/venue.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L5)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L6)\n\n***\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L7)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L8)\n\n***\n\n### organization\n\n> **organization**: [`Organization`](../../Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/AdminPortal/venue.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/AdminPortal/venue/type-aliases/VenueInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: VenueInput\n\n> **VenueInput** = `object`\n\nDefined in: [src/types/AdminPortal/venue.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L12)\n\n## Properties\n\n### capacity\n\n> **capacity**: `number`\n\nDefined in: [src/types/AdminPortal/venue.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L13)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L14)\n\n***\n\n### file?\n\n> `optional` **file**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L15)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L16)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/AdminPortal/venue.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/AdminPortal/venue.ts#L17)\n" }, { "path": "docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceLoginFormData\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L4)\n\nForm data structure for login form state.\n\n## Properties\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L6)\n\nUser email address\n\n***\n\n### password\n\n> **password**: `string`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L8)\n\nUser password\n" }, { "path": "docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceLoginFormProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceLoginFormProps\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L36)\n\nProps for the LoginForm component.\n\n## Remarks\n\nLoginForm composes EmailField and PasswordField to create a reusable\nlogin form with callback support for success/error handling.\n\n## Properties\n\n### enableRecaptcha?\n\n> `optional` **enableRecaptcha**: `boolean`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L46)\n\nWhen true, render ReCAPTCHA and send token with sign-in request\n\n***\n\n### isAdmin?\n\n> `optional` **isAdmin**: `boolean`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L38)\n\nWhether this is an admin login form (affects heading text)\n\n***\n\n### onError()?\n\n> `optional` **onError**: (`error`) => `void`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L42)\n\nCallback fired when login fails with error details\n\n#### Parameters\n\n##### error\n\n`Error`\n\n#### Returns\n\n`void`\n\n***\n\n### onSuccess()?\n\n> `optional` **onSuccess**: (`signInResult`) => `void`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L40)\n\nCallback fired on successful login with full signIn result (user + tokens)\n\n#### Parameters\n\n##### signInResult\n\n[`InterfaceSignInResult`](InterfaceSignInResult.md)\n\n#### Returns\n\n`void`\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L44)\n\nTest ID for testing purposes\n" }, { "path": "docs/docs/auto-docs/types/Auth/LoginForm/interface/interfaces/InterfaceSignInResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSignInResult\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L15)\n\nShape of the signIn result from SIGNIN_QUERY, passed to onSuccess so the\nparent can handle session, redirect, and invitation logic.\n\n## Properties\n\n### authenticationToken\n\n> **authenticationToken**: `string`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L25)\n\n***\n\n### refreshToken?\n\n> `optional` **refreshToken**: `string`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L26)\n\n***\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/types/Auth/LoginForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/LoginForm/interface.ts#L16)\n\n#### avatarURL\n\n> **avatarURL**: `string`\n\n#### countryCode\n\n> **countryCode**: `string`\n\n#### emailAddress\n\n> **emailAddress**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### isEmailAddressVerified\n\n> **isEmailAddressVerified**: `boolean`\n\n#### name\n\n> **name**: `string`\n\n#### role\n\n> **role**: `string`\n" }, { "path": "docs/docs/auto-docs/types/Auth/OrgSelector/interface/interfaces/InterfaceOrgOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgOption\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L4)\n\nRepresents an organization option in the selector.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L6)\n\nUnique identifier for the organization\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L9)\n\nDisplay name of the organization\n" }, { "path": "docs/docs/auto-docs/types/Auth/OrgSelector/interface/interfaces/InterfaceOrgSelectorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgSelectorProps\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L19)\n\nProps for the OrgSelector component.\n\n## Remarks\n\nThis component is designed for Phase 2 UI implementation.\nIntegration with validators will be handled in Phase 2b.\n\n## Properties\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L36)\n\nWhether the selector is disabled\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L30)\n\nError message to display - null or undefined means no error\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L42)\n\nOptional custom label text - defaults to \"Organization\"\n\n***\n\n### onChange()\n\n> **onChange**: (`orgId`) => `void`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L27)\n\nCallback invoked when the selected organization changes\n\n#### Parameters\n\n##### orgId\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### options\n\n> **options**: [`InterfaceOrgOption`](InterfaceOrgOption.md)[]\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L21)\n\nArray of available organizations to select from\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L39)\n\nWhether the field is required - shows asterisk if true\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L33)\n\nTest ID for testing purposes\n\n***\n\n### value?\n\n> `optional` **value**: `string`\n\nDefined in: [src/types/Auth/OrgSelector/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/OrgSelector/interface.ts#L24)\n\nCurrently selected organization ID\n" }, { "path": "docs/docs/auto-docs/types/Auth/PasswordStrengthIndicator/interface/interfaces/InterfacePasswordStrengthIndicatorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePasswordStrengthIndicatorProps\n\nDefined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L7)\n\nProps for the PasswordStrengthIndicator component.\n\n## Remarks\n\nDisplays a checklist of password requirements with real-time feedback.\n\n## Properties\n\n### isVisible?\n\n> `optional` **isVisible**: `boolean`\n\nDefined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L12)\n\nControls component visibility - defaults to true\n\n***\n\n### password\n\n> **password**: `string`\n\nDefined in: [src/types/Auth/PasswordStrengthIndicator/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/PasswordStrengthIndicator/interface.ts#L9)\n\nPassword string to validate against requirements\n" }, { "path": "docs/docs/auto-docs/types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IRegistrationFormData\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L7)\n\nForm data structure for user registration\n\n## Properties\n\n### confirmPassword\n\n> **confirmPassword**: `string`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L11)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L9)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L8)\n\n***\n\n### orgId?\n\n> `optional` **orgId**: `string`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L12)\n\n***\n\n### password\n\n> **password**: `string`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/Auth/RegistrationForm/interface/interfaces/IRegistrationFormProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IRegistrationFormProps\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L18)\n\nProps for the RegistrationForm component\n\n## Properties\n\n### enableRecaptcha?\n\n> `optional` **enableRecaptcha**: `boolean`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L23)\n\n***\n\n### onError()?\n\n> `optional` **onError**: (`e`) => `void`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L22)\n\n#### Parameters\n\n##### e\n\n`Error`\n\n#### Returns\n\n`void`\n\n***\n\n### onSuccess()?\n\n> `optional` **onSuccess**: (`result`) => `void`\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L21)\n\nCalled on successful signup with result so parent can handle session/redirect\n\n#### Parameters\n\n##### result\n\n[`IRegistrationSuccessResult`](../../../../../hooks/auth/useRegistration/interfaces/IRegistrationSuccessResult.md)\n\n#### Returns\n\n`void`\n\n***\n\n### organizations\n\n> **organizations**: [`InterfaceOrgOption`](../../../OrgSelector/interface/interfaces/InterfaceOrgOption.md)[]\n\nDefined in: [src/types/Auth/RegistrationForm/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/RegistrationForm/interface.ts#L19)\n" }, { "path": "docs/docs/auto-docs/types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePasswordRequirements\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L14)\n\nPassword complexity requirements status.\n\n## Properties\n\n### lowercase\n\n> **lowercase**: `boolean`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L16)\n\nHas lowercase letter\n\n***\n\n### numeric\n\n> **numeric**: `boolean`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L20)\n\nHas numeric digit\n\n***\n\n### specialChar\n\n> **specialChar**: `boolean`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L22)\n\nHas special character\n\n***\n\n### uppercase\n\n> **uppercase**: `boolean`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L18)\n\nHas uppercase letter\n" }, { "path": "docs/docs/auto-docs/types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceValidationResult\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L4)\n\nResult of a validation operation.\n\n## Properties\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L8)\n\nError message if validation failed\n\n***\n\n### isValid\n\n> **isValid**: `boolean`\n\nDefined in: [src/types/Auth/ValidationInterfaces.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/ValidationInterfaces.ts#L6)\n\nWhether the validation passed\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/interfaces/IOAuthProviderConfig.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IOAuthProviderConfig\n\nDefined in: [src/types/Auth/auth.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L77)\n\n## Properties\n\n### clientId?\n\n> `optional` **clientId**: `string`\n\nDefined in: [src/types/Auth/auth.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L81)\n\n***\n\n### displayName\n\n> **displayName**: `string`\n\nDefined in: [src/types/Auth/auth.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L79)\n\n***\n\n### enabled\n\n> **enabled**: `boolean`\n\nDefined in: [src/types/Auth/auth.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L83)\n\n***\n\n### id\n\n> **id**: [`OAuthProviderKey`](../type-aliases/OAuthProviderKey.md)\n\nDefined in: [src/types/Auth/auth.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L78)\n\n***\n\n### redirectUri?\n\n> `optional` **redirectUri**: `string`\n\nDefined in: [src/types/Auth/auth.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L82)\n\n***\n\n### scopes\n\n> **scopes**: `string`[]\n\nDefined in: [src/types/Auth/auth.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L80)\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAuthenticationPayload\n\nDefined in: [src/types/Auth/auth.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L36)\n\nPayload returned after successful authentication.\n\n## Properties\n\n### authenticationToken\n\n> **authenticationToken**: `string`\n\nDefined in: [src/types/Auth/auth.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L38)\n\nToken used for authenticating API requests\n\n***\n\n### refreshToken?\n\n> `optional` **refreshToken**: `string`\n\nDefined in: [src/types/Auth/auth.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L40)\n\nOptional token for refreshing the authentication token\n\n***\n\n### user\n\n> **user**: `InterfaceAuthUser`\n\nDefined in: [src/types/Auth/auth.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L42)\n\nAuthenticated user information\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthAccount.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOAuthAccount\n\nDefined in: [src/types/Auth/auth.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L48)\n\nRepresents a linked OAuth account.\n\n## Properties\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/Auth/auth.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L52)\n\nEmail address associated with the OAuth account\n\n***\n\n### lastUsedAt\n\n> **lastUsedAt**: `string`\n\nDefined in: [src/types/Auth/auth.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L56)\n\nDate when the account was last used for authentication\n\n***\n\n### linkedAt\n\n> **linkedAt**: `string`\n\nDefined in: [src/types/Auth/auth.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L54)\n\nDate when the account was linked\n\n***\n\n### provider\n\n> **provider**: `string`\n\nDefined in: [src/types/Auth/auth.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L50)\n\nOAuth provider name\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOAuthLinkResponse\n\nDefined in: [src/types/Auth/auth.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L62)\n\nResponse data returned from linking an OAuth account.\n\n## Properties\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/types/Auth/auth.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L68)\n\nUser's email address\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Auth/auth.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L64)\n\nUser's unique identifier\n\n***\n\n### isEmailAddressVerified\n\n> **isEmailAddressVerified**: `boolean`\n\nDefined in: [src/types/Auth/auth.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L70)\n\nWhether the user's email address has been verified\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Auth/auth.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L66)\n\nUser's full name\n\n***\n\n### oauthAccounts\n\n> **oauthAccounts**: [`InterfaceOAuthAccount`](InterfaceOAuthAccount.md)[]\n\nDefined in: [src/types/Auth/auth.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L74)\n\nList of linked OAuth accounts\n\n***\n\n### role\n\n> **role**: [`UserRole`](../../../../utils/interfaces/enumerations/UserRole.md)\n\nDefined in: [src/types/Auth/auth.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L72)\n\nUser's role in the system\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/interfaces/InterfaceOAuthLoginInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOAuthLoginInput\n\nDefined in: [src/types/Auth/auth.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L24)\n\nInput data required for OAuth login flow.\n\n## Properties\n\n### authorizationCode\n\n> **authorizationCode**: `string`\n\nDefined in: [src/types/Auth/auth.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L28)\n\nAuthorization code received from OAuth provider\n\n***\n\n### provider\n\n> **provider**: [`OAuthProviderKey`](../type-aliases/OAuthProviderKey.md)\n\nDefined in: [src/types/Auth/auth.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L26)\n\nThe OAuth provider to use for authentication\n\n***\n\n### redirectUri\n\n> **redirectUri**: `string`\n\nDefined in: [src/types/Auth/auth.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L30)\n\nRedirect URI registered with the OAuth provider\n" }, { "path": "docs/docs/auto-docs/types/Auth/auth/type-aliases/OAuthProviderKey.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OAuthProviderKey\n\n> **OAuthProviderKey** = `\"GOOGLE\"` \\| `\"GITHUB\"`\n\nDefined in: [src/types/Auth/auth.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/auth.ts#L19)\n\nSupported OAuth providers for authentication.\n" }, { "path": "docs/docs/auto-docs/types/Auth/useFieldValidation/interfaces/IUseFieldValidationReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseFieldValidationReturn\n\nDefined in: [src/types/Auth/useFieldValidation.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L8)\n\n## Properties\n\n### clearError()\n\n> **clearError**: () => `void`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L11)\n\n#### Returns\n\n`void`\n\n***\n\n### error\n\n> **error**: `string`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L9)\n\n***\n\n### validate()\n\n> **validate**: () => `boolean`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L10)\n\n#### Returns\n\n`boolean`\n" }, { "path": "docs/docs/auto-docs/types/Auth/useFieldValidation/interfaces/IValidationResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IValidationResult\n\nDefined in: [src/types/Auth/useFieldValidation.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L1)\n\n## Properties\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L3)\n\n***\n\n### isValid\n\n> **isValid**: `boolean`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/Auth/useFieldValidation/type-aliases/ValidationTrigger.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ValidationTrigger\n\n> **ValidationTrigger** = `\"onChange\"` \\| `\"onBlur\"` \\| `\"manual\"`\n\nDefined in: [src/types/Auth/useFieldValidation.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useFieldValidation.ts#L6)\n" }, { "path": "docs/docs/auto-docs/types/Auth/useLogin/interface/interfaces/ILoginCredentials.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ILoginCredentials\n\nDefined in: [src/types/Auth/useLogin/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L6)\n\nCredentials required for login.\n\n## Properties\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/Auth/useLogin/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L7)\n\n***\n\n### password\n\n> **password**: `string`\n\nDefined in: [src/types/Auth/useLogin/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L8)\n\n***\n\n### recaptchaToken?\n\n> `optional` **recaptchaToken**: `string`\n\nDefined in: [src/types/Auth/useLogin/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/Auth/useLogin/interface/interfaces/IUseLoginOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseLoginOptions\n\nDefined in: [src/types/Auth/useLogin/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L15)\n\nOptions for the useLogin hook.\n\n## Properties\n\n### onError()?\n\n> `optional` **onError**: (`error`) => `void`\n\nDefined in: [src/types/Auth/useLogin/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L17)\n\n#### Parameters\n\n##### error\n\n`Error`\n\n#### Returns\n\n`void`\n\n***\n\n### onSuccess()?\n\n> `optional` **onSuccess**: (`result`) => `void`\n\nDefined in: [src/types/Auth/useLogin/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/useLogin/interface.ts#L16)\n\n#### Parameters\n\n##### result\n\n[`InterfaceSignInResult`](../../../LoginForm/interface/interfaces/InterfaceSignInResult.md)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/Auth/usePasswordVisibility/interfaces/IUsePasswordVisibilityReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUsePasswordVisibilityReturn\n\nDefined in: [src/types/Auth/usePasswordVisibility.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L4)\n\nReturn type for the usePasswordVisibility hook.\n\n## Properties\n\n### showPassword\n\n> **showPassword**: `boolean`\n\nDefined in: [src/types/Auth/usePasswordVisibility.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L5)\n\n***\n\n### togglePassword()\n\n> **togglePassword**: () => `void`\n\nDefined in: [src/types/Auth/usePasswordVisibility.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Auth/usePasswordVisibility.ts#L6)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/Comment/type/type-aliases/Comment.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Comment\n\n> **Comment** = `object`\n\nDefined in: [src/types/Comment/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L4)\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/Comment/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L6)\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../../shared-components/User/type/type-aliases/User.md)\\>\n\nDefined in: [src/types/Comment/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L7)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Comment/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L5)\n\n***\n\n### likeCount?\n\n> `optional` **likeCount**: `number`\n\nDefined in: [src/types/Comment/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L8)\n\n***\n\n### post\n\n> **post**: [`Post`](../../../Post/type/type-aliases/Post.md)\n\nDefined in: [src/types/Comment/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L9)\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/Comment/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L10)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/Comment/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L11)\n" }, { "path": "docs/docs/auto-docs/types/Comment/type/type-aliases/CommentInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CommentInput\n\n> **CommentInput** = `object`\n\nDefined in: [src/types/Comment/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L14)\n\n## Properties\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/Comment/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Comment/type.ts#L15)\n" }, { "path": "docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceConnectionData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceConnectionData\\\n\nDefined in: [src/types/CursorPagination/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L26)\n\nRepresents the GraphQL connection structure with edges and pageInfo.\nThis follows the Relay cursor pagination specification.\n\n## Remarks\n\nWhile the Relay spec requires both edges and pageInfo, this interface\nmakes pageInfo optional to gracefully handle incomplete responses.\nWhen pageInfo is missing, items are still rendered but pagination is disabled.\n\n## Type Parameters\n\n### TNode\n\n`TNode`\n\nThe type of individual items in the connection\n\n## Properties\n\n### edges\n\n> **edges**: `object`[]\n\nDefined in: [src/types/CursorPagination/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L27)\n\n#### cursor\n\n> **cursor**: `string`\n\n#### node\n\n> **node**: `TNode`\n\n***\n\n### pageInfo?\n\n> `optional` **pageInfo**: [`DefaultConnectionPageInfo`](../../../AdminPortal/pagination/type-aliases/DefaultConnectionPageInfo.md)\n\nDefined in: [src/types/CursorPagination/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L31)\n" }, { "path": "docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCursorPaginationManagerProps\\\n\nDefined in: [src/types/CursorPagination/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L40)\n\nProps for the CursorPaginationManager component.\n\n## Type Parameters\n\n### TData\n\n`TData`\n\n### TNode\n\n`TNode`\n\nThe type of individual items extracted from edges\n\n### TVariables\n\n`TVariables` *extends* `Record`\\<`string`, `unknown`\\> = `Record`\\<`string`, `unknown`\\>\n\nThe GraphQL query variables type (defaults to `Record`)\n\n## Properties\n\n### actionRef?\n\n> `optional` **actionRef**: `Ref`\\<[`InterfaceCursorPaginationManagerRef`](InterfaceCursorPaginationManagerRef.md)\\<`TNode`\\>\\>\n\nDefined in: [src/types/CursorPagination/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L166)\n\nRef to access imperative actions\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/CursorPagination/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L171)\n\nCustom class name for the container\n\n***\n\n### dataPath\n\n> **dataPath**: `string`\n\nDefined in: [src/types/CursorPagination/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L60)\n\nDot-separated path to extract connection data from the query response\n\n#### Examples\n\n```ts\n\"users\" for data.users\n```\n\n```ts\n\"organization.members\" for data.organization.members\n```\n\n***\n\n### emptyStateComponent?\n\n> `optional` **emptyStateComponent**: `ReactNode`\n\nDefined in: [src/types/CursorPagination/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L119)\n\nCustom component to show when no items are available\n\n***\n\n### infiniteScroll?\n\n> `optional` **infiniteScroll**: `boolean`\n\nDefined in: [src/types/CursorPagination/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L176)\n\nEnable infinite scroll behavior (auto-load when reaching threshold)\n\n***\n\n### itemsPerPage?\n\n> `optional` **itemsPerPage**: `number`\n\nDefined in: [src/types/CursorPagination/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L66)\n\nNumber of items to fetch per page\ndefault 10\n\n***\n\n### keyExtractor()?\n\n> `optional` **keyExtractor**: (`item`, `index`) => `string` \\| `number`\n\nDefined in: [src/types/CursorPagination/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L109)\n\nOptional function to extract a unique key for each item\n\n#### Parameters\n\n##### item\n\n`TNode`\n\nThe current item\n\n##### index\n\n`number`\n\nThe index of the item in the array\n\n#### Returns\n\n`string` \\| `number`\n\nA unique string or number identifier for the item\n\n#### Remarks\n\nProvides a stable key for React reconciliation. When not provided,\nfalls back to using the array index as the key.\n\n#### Example\n\n```tsx\nkeyExtractor={(user) => user.id}\n```\n\n***\n\n### loadingComponent?\n\n> `optional` **loadingComponent**: `ReactNode`\n\nDefined in: [src/types/CursorPagination/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L114)\n\nCustom loading component to show during initial data fetch\n\n***\n\n### onContentScroll()?\n\n> `optional` **onContentScroll**: (`e`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L161)\n\nCallback to handle scroll events or restoration.\nIf provided, the manager might delegate some scroll logic to the parent.\n\n#### Parameters\n\n##### e\n\n`UIEvent`\\<`HTMLElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onDataChange()?\n\n> `optional` **onDataChange**: (`data`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L124)\n\nCallback invoked when the data changes (initial load or after loading more)\n\n#### Parameters\n\n##### data\n\n`TNode`[]\n\n#### Returns\n\n`void`\n\n***\n\n### onQueryResult()?\n\n> `optional` **onQueryResult**: (`data`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L155)\n\nCallback to return the full query result data.\nUseful when the parent component needs access to metadata in the response\n(e.g., chat title, member count) outside of the connection data.\n\n#### Parameters\n\n##### data\n\n`TData`\n\n#### Returns\n\n`void`\n\n***\n\n### paginationType?\n\n> `optional` **paginationType**: `\"forward\"` \\| `\"backward\"`\n\nDefined in: [src/types/CursorPagination/interface.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L137)\n\nDirection of pagination.\n'forward': Uses 'first' and 'after' (default)\n'backward': Uses 'last' and 'before' (mapped via variableKeyMap if needed)\n\n***\n\n### query\n\n> **query**: `DocumentNode`\n\nDefined in: [src/types/CursorPagination/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L48)\n\nGraphQL query document for fetching data\n\n***\n\n### queryVariables?\n\n> `optional` **queryVariables**: `Omit`\\<`TVariables`, `\"first\"` \\| `\"after\"`\\>\n\nDefined in: [src/types/CursorPagination/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L53)\n\nQuery variables (excluding pagination variables like 'first' and 'after')\n\n***\n\n### refetchTrigger?\n\n> `optional` **refetchTrigger**: `number`\n\nDefined in: [src/types/CursorPagination/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L130)\n\nTrigger value that causes a refetch when changed\nCan be a number (counter) or any value that changes\n\n***\n\n### renderItem()\n\n> **renderItem**: (`item`, `index`) => `ReactNode`\n\nDefined in: [src/types/CursorPagination/interface.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L91)\n\nFunction to render each item in the list\n\n#### Parameters\n\n##### item\n\n`TNode`\n\n##### index\n\n`number`\n\n#### Returns\n\n`ReactNode`\n\n#### Remarks\n\nWhen items have stable unique identifiers, provide a keyExtractor function\nto ensure proper React reconciliation. If keyExtractor is not provided,\nthe component falls back to using the array index as the key, which works\nfor append-only pagination but may cause issues if items are reordered.\n\n#### Example\n\n```tsx\n// With keyExtractor for stable keys:\n user.id}\n renderItem={(user) =>
{user.name}
}\n/>\n\n// Without keyExtractor (uses index):\n
{user.name}
}\n/>\n```\n\n***\n\n### scrollThreshold?\n\n> `optional` **scrollThreshold**: `number`\n\nDefined in: [src/types/CursorPagination/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L182)\n\nDistance from edge (top for backward, bottom for forward) to trigger load more.\nDefault: 50px\n\n***\n\n### variableKeyMap?\n\n> `optional` **variableKeyMap**: `object`\n\nDefined in: [src/types/CursorPagination/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L143)\n\nMap generic pagination variables (first, after, last, before) to custom query variable names.\nUseful when the query uses different variable names (e.g., 'lastMessages' instead of 'last').\n\n#### after?\n\n> `optional` **after**: `string`\n\n#### before?\n\n> `optional` **before**: `string`\n\n#### first?\n\n> `optional` **first**: `string`\n\n#### last?\n\n> `optional` **last**: `string`\n" }, { "path": "docs/docs/auto-docs/types/CursorPagination/interface/interfaces/InterfaceCursorPaginationManagerRef.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCursorPaginationManagerRef\\\n\nDefined in: [src/types/CursorPagination/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L185)\n\n## Type Parameters\n\n### TNode\n\n`TNode`\n\n## Properties\n\n### addItem()\n\n> **addItem**: (`item`, `position?`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L186)\n\n#### Parameters\n\n##### item\n\n`TNode`\n\n##### position?\n\n`\"start\"` | `\"end\"`\n\n#### Returns\n\n`void`\n\n***\n\n### getItems()\n\n> **getItems**: () => `TNode`[]\n\nDefined in: [src/types/CursorPagination/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L192)\n\n#### Returns\n\n`TNode`[]\n\n***\n\n### removeItem()\n\n> **removeItem**: (`predicate`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L187)\n\n#### Parameters\n\n##### predicate\n\n(`item`) => `boolean`\n\n#### Returns\n\n`void`\n\n***\n\n### updateItem()\n\n> **updateItem**: (`predicate`, `updater`) => `void`\n\nDefined in: [src/types/CursorPagination/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L188)\n\n#### Parameters\n\n##### predicate\n\n(`item`) => `boolean`\n\n##### updater\n\n(`item`) => `TNode`\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/CursorPagination/interface/type-aliases/PaginationVariables.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PaginationVariables\\\n\n> **PaginationVariables**\\<`T`\\> = `T` & `object`\n\nDefined in: [src/types/CursorPagination/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/CursorPagination/interface.ts#L7)\n\nHelper type to combine pagination variables with custom query variables\n\n## Type Declaration\n\n### after?\n\n> `optional` **after**: `string` \\| `null`\n\n### before?\n\n> `optional` **before**: `string` \\| `null`\n\n### first?\n\n> `optional` **first**: `number`\n\n### last?\n\n> `optional` **last**: `number`\n\n## Type Parameters\n\n### T\n\n`T` *extends* `Record`\\<`string`, `unknown`\\>\n" }, { "path": "docs/docs/auto-docs/types/DataGridWrapper/interface/interfaces/InterfaceDataGridWrapperProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDataGridWrapperProps\\\n\nDefined in: [src/types/DataGridWrapper/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L46)\n\nProps for the DataGridWrapper component.\n\nThis interface defines the configuration for the `DataGridWrapper`, a standardized wrapper around\nMUI's DataGrid that provides consistent search, sorting, pagination, and styling across the application.\n\n## Type Parameters\n\n### T\n\n`T` *extends* `GridValidRowModel` = `GridValidRowModel`\n\n## Properties\n\n### actionColumn()?\n\n> `optional` **actionColumn**: (`row`) => `ReactNode`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L168)\n\nA function to render custom content in the \"Actions\" column (appended to the right).\n\n#### Parameters\n\n##### row\n\n`T`\n\nThe data object for the row being rendered.\n\n#### Returns\n\n`ReactNode`\n\nA ReactNode (e.g., buttons, menu) to display in the actions cell.\n\n***\n\n### columns?\n\n> `optional` **columns**: [`TokenAwareGridColDef`](../type-aliases/TokenAwareGridColDef.md)\\<`GridValidRowModel`, `unknown`, `unknown`\\>[]\n\nDefined in: [src/types/DataGridWrapper/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L70)\n\nConfiguration for the grid columns.\nDefines headers, widths, and cell rendering logic.\n\nSupports design tokens for width properties (width, minWidth, maxWidth).\nToken names like 'space-15' are automatically converted to pixel values.\n\n#### Example\n\n```tsx\ncolumns={[\n { field: 'name', headerName: 'Name', minWidth: 'space-15' }, // 150px\n { field: 'email', headerName: 'Email', minWidth: 200 }, // raw pixel value still works\n]}\n```\n\n***\n\n### emptyStateMessage?\n\n> `optional` **emptyStateMessage**: `string`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L198)\n\nCustom message to display when there are no rows and `loading` is false.\nUse `emptyStateProps` instead for full customization.\nIf `emptyStateProps` is provided, this prop is ignored.\nThis property is maintained for backward compatibility.\n\n***\n\n### emptyStateProps?\n\n> `optional` **emptyStateProps**: [`InterfaceEmptyStateProps`](../../../shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md)\n\nDefined in: [src/types/DataGridWrapper/interface.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L190)\n\nFull EmptyState component props for flexible empty state rendering.\nTakes precedence over `emptyStateMessage`.\nAllows customization of icon, description, action buttons, and more.\n\n#### Example\n\n```tsx\nemptyStateProps={{\n icon: \"users\",\n message: \"noUsers\",\n description: \"inviteFirstUser\",\n action: {\n label: \"inviteUser\",\n onClick: handleInvite,\n variant: \"primary\"\n },\n dataTestId: \"users-empty-state\"\n}}\n```\n\n***\n\n### error?\n\n> `optional` **error**: `ReactNode`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L203)\n\nError message or component to display instead of the grid when data fetch fails.\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L75)\n\nIf `true`, displays a loading indicator (e.g., Progress Bar) overlaying the grid.\n\n***\n\n### onRowClick()?\n\n> `optional` **onRowClick**: (`row`) => `void`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L161)\n\nCallback fired when a row is clicked.\n\n#### Parameters\n\n##### row\n\n`T`\n\nThe data object of the clicked row.\n\n#### Returns\n\n`void`\n\n***\n\n### paginationConfig?\n\n> `optional` **paginationConfig**: `object`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L148)\n\nConfiguration for pagination.\n\n#### defaultPageSize?\n\n> `optional` **defaultPageSize**: `number`\n\nThe default number of rows per page.\n\n#### enabled\n\n> **enabled**: `boolean`\n\nEnables pagination controls.\n\n#### pageSizeOptions?\n\n> `optional` **pageSizeOptions**: `number`[]\n\nAvailable options for rows per page. default: [10, 25, 50, 100]\n\n***\n\n### rows?\n\n> `optional` **rows**: readonly `T`[]\n\nDefined in: [src/types/DataGridWrapper/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L53)\n\nThe array of data rows to display in the grid.\nEach row must include a unique `id` property (string or number).\n\n***\n\n### searchConfig?\n\n> `optional` **searchConfig**: `object`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L105)\n\nConfiguration for search functionality (client-side or server-side).\n\n#### debounceMs?\n\n> `optional` **debounceMs**: `number`\n\nDelay in milliseconds for search debounce.\n\n#### enabled\n\n> **enabled**: `boolean`\n\nEnables the search bar in the toolbar.\n\n#### fields?\n\n> `optional` **fields**: keyof `T` & `string`[]\n\nThe fields (keys of T) to include in the search filter. Client-side only.\n\n#### onSearchByChange()?\n\n> `optional` **onSearchByChange**: (`searchBy`) => `void`\n\nCallback when search type changes in server-side mode.\n\n##### Parameters\n\n###### searchBy\n\n`string`\n\n##### Returns\n\n`void`\n\n#### onSearchChange()?\n\n> `optional` **onSearchChange**: (`term`, `searchBy?`) => `void`\n\nCallback when search changes in server-side mode.\n\n##### Parameters\n\n###### term\n\n`string`\n\n###### searchBy?\n\n`string`\n\n##### Returns\n\n`void`\n\n#### placeholder?\n\n> `optional` **placeholder**: `string`\n\nCustom placeholder text for the search input.\n\n#### searchByOptions?\n\n> `optional` **searchByOptions**: `object`[]\n\nSearch type options dropdown for server-side mode.\n\n#### searchInputTestId?\n\n> `optional` **searchInputTestId**: `string`\n\nTest ID for search input.\n\n#### searchTerm?\n\n> `optional` **searchTerm**: `string`\n\nCurrent search term value for server-side mode.\n\n#### selectedSearchBy?\n\n> `optional` **selectedSearchBy**: `string`\n\nCurrent selected search type for server-side mode.\n\n#### serverSide?\n\n> `optional` **serverSide**: `boolean`\n\nEnable server-side search mode.\n\n#### Example\n\n```ts\n// Client-side search\nsearchConfig: {\n enabled: true,\n fields: ['name', 'email'],\n placeholder: 'Search users...',\n}\n\n// Server-side search with search-by dropdown\nsearchConfig: {\n enabled: true,\n serverSide: true,\n searchTerm: 'john',\n searchByOptions: [\n { label: 'Group', value: 'group' },\n { label: 'Leader', value: 'leader' }\n ],\n selectedSearchBy: 'group',\n onSearchChange: (term, searchBy) => refetchData(term, searchBy),\n onSearchByChange: (searchBy) => setSearchBy(searchBy),\n searchInputTestId: 'searchByInput'\n}\n```\n\n***\n\n### sortConfig?\n\n> `optional` **sortConfig**: `object`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L134)\n\nConfiguration for sorting options displayed in a dropdown.\nNote: This is separate from MUI DataGrid's native column header sorting.\n\n#### defaultSortField?\n\n> `optional` **defaultSortField**: `string`\n\n#### defaultSortOrder?\n\n> `optional` **defaultSortOrder**: `\"desc\"` \\| `\"asc\"`\n\n#### onSortChange()?\n\n> `optional` **onSortChange**: (`value`) => `void`\n\nCallback when sort changes in server-side mode.\n\n##### Parameters\n\n###### value\n\n`string` | `number`\n\n##### Returns\n\n`void`\n\n#### selectedSort?\n\n> `optional` **selectedSort**: `string` \\| `number`\n\nCurrent selected sort option for server-side mode.\n\n#### sortingOptions?\n\n> `optional` **sortingOptions**: `object`[]\n\nArray of sorting options for the SortingButton component.\n" }, { "path": "docs/docs/auto-docs/types/DataGridWrapper/interface/type-aliases/TokenAwareGridColDef.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: TokenAwareGridColDef\\\n\n> **TokenAwareGridColDef**\\<`TRow`, `TValue`, `TFormattedValue`\\> = `Omit`\\<`GridColDef`\\<`TRow`, `TValue`, `TFormattedValue`\\>, `\"width\"` \\| `\"minWidth\"` \\| `\"maxWidth\"`\\> & `object`\n\nDefined in: [src/types/DataGridWrapper/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DataGridWrapper/interface.ts#L24)\n\nExtended column definition that accepts design tokens for width properties.\n\nMUI DataGrid requires numeric values for width, minWidth, and maxWidth.\nThis type allows using spacing token names (e.g., 'space-15') which are\nconverted to pixel values by DataGridWrapper before passing to MUI.\n\n## Type Declaration\n\n### maxWidth?\n\n> `optional` **maxWidth**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nMaximum column width - accepts number (pixels) or spacing token name\n\n### minWidth?\n\n> `optional` **minWidth**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nMinimum column width - accepts number (pixels) or spacing token name\n\n### width?\n\n> `optional` **width**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nColumn width - accepts number (pixels) or spacing token name\n\n## Type Parameters\n\n### TRow\n\n`TRow` *extends* `GridValidRowModel` = `GridValidRowModel`\n\n### TValue\n\n`TValue` = `unknown`\n\n### TFormattedValue\n\n`TFormattedValue` = `TValue`\n\n## Example\n\n```tsx\nconst columns: TokenAwareGridColDef[] = [\n { field: 'name', headerName: 'Name', minWidth: 'space-15' }, // 150px\n { field: 'email', headerName: 'Email', width: 'space-17' }, // 220px\n];\n```\n" }, { "path": "docs/docs/auto-docs/types/DropDown/interface/interfaces/InterfaceCollapsibleDropdown.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCollapsibleDropdown\n\nDefined in: [src/types/DropDown/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L8)\n\n## Properties\n\n### setShowDropdown\n\n> **setShowDropdown**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/DropDown/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L11)\n\n***\n\n### showDropdown\n\n> **showDropdown**: `boolean`\n\nDefined in: [src/types/DropDown/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L9)\n\n***\n\n### target\n\n> **target**: [`TargetsType`](../../../../state/reducers/routesReducer/type-aliases/TargetsType.md)\n\nDefined in: [src/types/DropDown/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/DropDown/interface/interfaces/InterfaceDropDownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropDownProps\n\nDefined in: [src/types/DropDown/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L2)\n\n## Properties\n\n### btnStyle?\n\n> `optional` **btnStyle**: `string`\n\nDefined in: [src/types/DropDown/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L4)\n\n***\n\n### btnTextStyle?\n\n> `optional` **btnTextStyle**: `string`\n\nDefined in: [src/types/DropDown/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L5)\n\n***\n\n### parentContainerStyle?\n\n> `optional` **parentContainerStyle**: `string`\n\nDefined in: [src/types/DropDown/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/DropDown/interface.ts#L3)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/enumerations/UserRole.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserRole\n\nDefined in: [src/types/Event/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L7)\n\n## Enumeration Members\n\n### ADMINISTRATOR\n\n> **ADMINISTRATOR**: `\"ADMINISTRATOR\"`\n\nDefined in: [src/types/Event/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L8)\n\n***\n\n### REGULAR\n\n> **REGULAR**: `\"REGULAR\"`\n\nDefined in: [src/types/Event/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IAttendanceStatisticsModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IAttendanceStatisticsModalProps\n\nDefined in: [src/types/Event/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L203)\n\n## Properties\n\n### handleClose()\n\n> **handleClose**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L205)\n\n#### Returns\n\n`void`\n\n***\n\n### memberData\n\n> **memberData**: [`IMember`](IMember.md)[]\n\nDefined in: [src/types/Event/interface.ts:211](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L211)\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L204)\n\n***\n\n### statistics\n\n> **statistics**: `object`\n\nDefined in: [src/types/Event/interface.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L206)\n\n#### attendanceRate\n\n> **attendanceRate**: `number`\n\n#### membersAttended\n\n> **membersAttended**: `number`\n\n#### totalMembers\n\n> **totalMembers**: `number`\n\n***\n\n### t()\n\n> **t**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/Event/interface.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L212)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/ICalendarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICalendarProps\n\nDefined in: [src/types/Event/interface.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L111)\n\n## Properties\n\n### currentMonth?\n\n> `optional` **currentMonth**: `number`\n\nDefined in: [src/types/Event/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L119)\n\n***\n\n### currentYear?\n\n> `optional` **currentYear**: `number`\n\nDefined in: [src/types/Event/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L120)\n\n***\n\n### eventData\n\n> **eventData**: [`IEvent`](IEvent.md)[]\n\nDefined in: [src/types/Event/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L112)\n\n***\n\n### onMonthChange()?\n\n> `optional` **onMonthChange**: (`month`, `year`) => `void`\n\nDefined in: [src/types/Event/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L118)\n\n#### Parameters\n\n##### month\n\n`number`\n\n##### year\n\n`number`\n\n#### Returns\n\n`void`\n\n***\n\n### orgData?\n\n> `optional` **orgData**: [`IOrgList`](IOrgList.md)\n\nDefined in: [src/types/Event/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L114)\n\n***\n\n### refetchEvents()?\n\n> `optional` **refetchEvents**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L113)\n\n#### Returns\n\n`void`\n\n***\n\n### userId?\n\n> `optional` **userId**: `string`\n\nDefined in: [src/types/Event/interface.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L116)\n\n***\n\n### userRole?\n\n> `optional` **userRole**: `string`\n\nDefined in: [src/types/Event/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L115)\n\n***\n\n### viewType?\n\n> `optional` **viewType**: [`ViewType`](../../../../screens/AdminPortal/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md)\n\nDefined in: [src/types/Event/interface.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L117)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/ICreateEventInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreateEventInput\n\nDefined in: [src/types/Event/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L267)\n\nInput interface for creating events via CREATE_EVENT_MUTATION.\nUsed by both Admin Portal (CreateEventModal) and User Portal (Events).\n\nNote: The recurrence property type matches the return type of\nformatRecurrenceForPayload from EventForm.tsx\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L272)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/Event/interface.ts:280](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L280)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:270](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L270)\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:279](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L279)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L277)\n\nDetermines if the event is visible to the entire community.\nOften referred to as \"Community Visible\" in the UI.\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:278](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L278)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/Event/interface.ts:281](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L281)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/interface.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L268)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/Event/interface.ts:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L271)\n\n***\n\n### recurrence?\n\n> `optional` **recurrence**: `Omit`\\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `\"endDate\"`\\> & `object`\n\nDefined in: [src/types/Event/interface.ts:282](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L282)\n\n#### Type Declaration\n\n##### endDate?\n\n> `optional` **endDate**: `string`\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L269)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IDeleteEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IDeleteEventModalProps\n\nDefined in: [src/types/Event/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L139)\n\n## Properties\n\n### deleteEventHandler()\n\n> **deleteEventHandler**: (`deleteOption?`) => `Promise`\\<`void`\\>\n\nDefined in: [src/types/Event/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L145)\n\n#### Parameters\n\n##### deleteOption?\n\n`\"all\"` | `\"single\"` | `\"following\"`\n\n#### Returns\n\n`Promise`\\<`void`\\>\n\n***\n\n### eventDeleteModalIsOpen\n\n> **eventDeleteModalIsOpen**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L141)\n\n***\n\n### eventListCardProps\n\n> **eventListCardProps**: [`IEventListCard`](IEventListCard.md)\n\nDefined in: [src/types/Event/interface.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L140)\n\n***\n\n### t()\n\n> **t**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/Event/interface.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L143)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/Event/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L144)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### toggleDeleteModal()\n\n> **toggleDeleteModal**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L142)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEvent\n\nDefined in: [src/types/Event/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L40)\n\n## Extended by\n\n- [`IEventListCard`](IEventListCard.md)\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51)\n\n***\n\n### attendees\n\n> **attendees**: `Partial`\\<[`User`](../../type/type-aliases/User.md)\\>[]\n\nDefined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64)\n\n***\n\n### averageFeedbackScore?\n\n> `optional` **averageFeedbackScore**: `number`\n\nDefined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66)\n\n***\n\n### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\nDefined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../type/type-aliases/User.md)\\>\n\nDefined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48)\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50)\n\n***\n\n### feedback?\n\n> `optional` **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[]\n\nDefined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67)\n\n***\n\n### hasExceptions?\n\n> `optional` **hasExceptions**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43)\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63)\n\nDetermines if the event is restricted to invited participants only.\nWhen true, only invited users can see and access the event.\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57)\n\nDetermines if the event is visible to the entire community.\nOften referred to as \"Community Visible\" in the UI.\n\n***\n\n### isRecurringEventTemplate?\n\n> `optional` **isRecurringEventTemplate**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58)\n\n***\n\n### key?\n\n> `optional` **key**: `string`\n\nDefined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45)\n\n***\n\n### progressLabel?\n\n> `optional` **progressLabel**: `string`\n\nDefined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76)\n\n***\n\n### recurrenceDescription?\n\n> `optional` **recurrenceDescription**: `string`\n\nDefined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78)\n\n***\n\n### recurrenceRule?\n\n> `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79)\n\n***\n\n### sequenceNumber?\n\n> `optional` **sequenceNumber**: `number`\n\nDefined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73)\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47)\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49)\n\n***\n\n### totalCount?\n\n> `optional` **totalCount**: `number`\n\nDefined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74)\n\n***\n\n### userId?\n\n> `optional` **userId**: `string`\n\nDefined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52)\n\n***\n\n### userRole?\n\n> `optional` **userRole**: `string`\n\nDefined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IEventEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventEdge\n\nDefined in: [src/types/Event/interface.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L215)\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/types/Event/interface.ts:257](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L257)\n\n***\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/types/Event/interface.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L216)\n\n#### allDay\n\n> **allDay**: `boolean`\n\n#### attendees?\n\n> `optional` **attendees**: `object`[]\n\n#### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\n##### baseEvent.id\n\n> **id**: `string`\n\n##### baseEvent.name\n\n> **name**: `string`\n\n#### creator?\n\n> `optional` **creator**: `object`\n\n##### creator.id\n\n> **id**: `string`\n\n##### creator.name\n\n> **name**: `string`\n\n#### description?\n\n> `optional` **description**: `string`\n\n#### endAt\n\n> **endAt**: `string`\n\n#### hasExceptions?\n\n> `optional` **hasExceptions**: `boolean`\n\n#### id\n\n> **id**: `string`\n\n#### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDetermines if the event is restricted to invited participants only.\nWhen true, only invited users, the creator, and admins can see and access the event.\n\n#### isPublic\n\n> **isPublic**: `boolean`\n\nDetermines if the event is visible to the entire community.\nOften referred to as \"Community Visible\" in the UI.\n\n#### isRecurringEventTemplate?\n\n> `optional` **isRecurringEventTemplate**: `boolean`\n\n#### isRegisterable\n\n> **isRegisterable**: `boolean`\n\n#### location?\n\n> `optional` **location**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### progressLabel?\n\n> `optional` **progressLabel**: `string`\n\n#### recurrenceDescription?\n\n> `optional` **recurrenceDescription**: `string`\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\n#### sequenceNumber?\n\n> `optional` **sequenceNumber**: `number`\n\n#### startAt\n\n> **startAt**: `string`\n\n#### totalCount?\n\n> `optional` **totalCount**: `number`\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IEventHeaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventHeaderProps\n\nDefined in: [src/types/Event/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L123)\n\n## Properties\n\n### handleChangeView()\n\n> **handleChangeView**: (`item`) => `void`\n\nDefined in: [src/types/Event/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L125)\n\n#### Parameters\n\n##### item\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### showInviteModal()\n\n> **showInviteModal**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L126)\n\n#### Returns\n\n`void`\n\n***\n\n### viewType\n\n> **viewType**: [`ViewType`](../../../../screens/AdminPortal/OrganizationEvents/OrganizationEvents/enumerations/ViewType.md)\n\nDefined in: [src/types/Event/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L124)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IEventListCard.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventListCard\n\nDefined in: [src/types/Event/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L134)\n\nProps for EventListCard component.\n\n`@remarks` Extends IEvent and adds optional refetchEvents callback.\n\n## Extends\n\n- [`IEvent`](IEvent.md)\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`allDay`](IEvent.md#allday)\n\n***\n\n### attendees\n\n> **attendees**: `Partial`\\<[`User`](../../type/type-aliases/User.md)\\>[]\n\nDefined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`attendees`](IEvent.md#attendees)\n\n***\n\n### averageFeedbackScore?\n\n> `optional` **averageFeedbackScore**: `number`\n\nDefined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`averageFeedbackScore`](IEvent.md#averagefeedbackscore)\n\n***\n\n### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\nDefined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70)\n\n#### id\n\n> **id**: `string`\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`baseEvent`](IEvent.md#baseevent)\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../type/type-aliases/User.md)\\>\n\nDefined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`creator`](IEvent.md#creator)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`description`](IEvent.md#description)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`endAt`](IEvent.md#endat)\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`endTime`](IEvent.md#endtime)\n\n***\n\n### feedback?\n\n> `optional` **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[]\n\nDefined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`feedback`](IEvent.md#feedback)\n\n***\n\n### hasExceptions?\n\n> `optional` **hasExceptions**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`hasExceptions`](IEvent.md#hasexceptions)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`id`](IEvent.md#id)\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63)\n\nDetermines if the event is restricted to invited participants only.\nWhen true, only invited users can see and access the event.\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`isInviteOnly`](IEvent.md#isinviteonly)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57)\n\nDetermines if the event is visible to the entire community.\nOften referred to as \"Community Visible\" in the UI.\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`isPublic`](IEvent.md#ispublic)\n\n***\n\n### isRecurringEventTemplate?\n\n> `optional` **isRecurringEventTemplate**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`isRecurringEventTemplate`](IEvent.md#isrecurringeventtemplate)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`isRegisterable`](IEvent.md#isregisterable)\n\n***\n\n### key?\n\n> `optional` **key**: `string`\n\nDefined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`key`](IEvent.md#key)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`location`](IEvent.md#location)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`name`](IEvent.md#name)\n\n***\n\n### progressLabel?\n\n> `optional` **progressLabel**: `string`\n\nDefined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`progressLabel`](IEvent.md#progresslabel)\n\n***\n\n### recurrenceDescription?\n\n> `optional` **recurrenceDescription**: `string`\n\nDefined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`recurrenceDescription`](IEvent.md#recurrencedescription)\n\n***\n\n### recurrenceRule?\n\n> `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`recurrenceRule`](IEvent.md#recurrencerule)\n\n***\n\n### refetchEvents()?\n\n> `optional` **refetchEvents**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L136)\n\nOptional callback to refresh the events list after modifications.\n\n#### Returns\n\n`void`\n\n***\n\n### sequenceNumber?\n\n> `optional` **sequenceNumber**: `number`\n\nDefined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`sequenceNumber`](IEvent.md#sequencenumber)\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`startAt`](IEvent.md#startat)\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`startTime`](IEvent.md#starttime)\n\n***\n\n### totalCount?\n\n> `optional` **totalCount**: `number`\n\nDefined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`totalCount`](IEvent.md#totalcount)\n\n***\n\n### userId?\n\n> `optional` **userId**: `string`\n\nDefined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`userId`](IEvent.md#userid)\n\n***\n\n### userRole?\n\n> `optional` **userRole**: `string`\n\nDefined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41)\n\n#### Inherited from\n\n[`IEvent`](IEvent.md).[`userRole`](IEvent.md#userrole)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IMember.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IMember\n\nDefined in: [src/types/Event/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L18)\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/Event/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L22)\n\n***\n\n### birthDate\n\n> **birthDate**: `Date`\n\nDefined in: [src/types/Event/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L27)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L19)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `` `${string}@${string}.${string}` ``\n\nDefined in: [src/types/Event/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L21)\n\n***\n\n### eventsAttended?\n\n> `optional` **eventsAttended**: `object`[]\n\nDefined in: [src/types/Event/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L24)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L29)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L20)\n\n***\n\n### natalSex\n\n> **natalSex**: `string`\n\nDefined in: [src/types/Event/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L23)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/types/Event/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L28)\n\n***\n\n### tagsAssignedWith\n\n> **tagsAssignedWith**: `object`\n\nDefined in: [src/types/Event/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L30)\n\n#### edges\n\n> **edges**: `object`[]\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IOrgList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IOrgList\n\nDefined in: [src/types/Event/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L82)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L83)\n\n***\n\n### members\n\n> **members**: `object`\n\nDefined in: [src/types/Event/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L84)\n\n#### edges\n\n> **edges**: `object`[]\n\n#### pageInfo\n\n> **pageInfo**: `object`\n\n##### pageInfo.endCursor\n\n> **endCursor**: `string`\n\n##### pageInfo.hasNextPage\n\n> **hasNextPage**: `boolean`\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IPreviewEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IPreviewEventModalProps\n\nDefined in: [src/types/Event/interface.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L150)\n\n## Properties\n\n### allDayChecked\n\n> **allDayChecked**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L163)\n\n***\n\n### customRecurrenceModalIsOpen\n\n> **customRecurrenceModalIsOpen**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L190)\n\n***\n\n### eventEndDate\n\n> **eventEndDate**: `Date`\n\nDefined in: [src/types/Event/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L160)\n\n***\n\n### eventListCardProps\n\n> **eventListCardProps**: [`IEventListCard`](IEventListCard.md)\n\nDefined in: [src/types/Event/interface.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L151)\n\n***\n\n### eventModalIsOpen\n\n> **eventModalIsOpen**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L152)\n\n***\n\n### eventStartDate\n\n> **eventStartDate**: `Date`\n\nDefined in: [src/types/Event/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L159)\n\n***\n\n### formState\n\n> **formState**: `object`\n\nDefined in: [src/types/Event/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L171)\n\n#### endTime\n\n> **endTime**: `string`\n\n#### eventDescription\n\n> **eventDescription**: `string`\n\n#### location\n\n> **location**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### startTime\n\n> **startTime**: `string`\n\n***\n\n### handleEventUpdate()\n\n> **handleEventUpdate**: () => `Promise`\\<`void`\\>\n\nDefined in: [src/types/Event/interface.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L186)\n\n#### Returns\n\n`Promise`\\<`void`\\>\n\n***\n\n### hideViewModal()\n\n> **hideViewModal**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L153)\n\n#### Returns\n\n`void`\n\n***\n\n### inviteOnlyChecked\n\n> **inviteOnlyChecked**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L169)\n\n***\n\n### isRegistered?\n\n> `optional` **isRegistered**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L157)\n\n***\n\n### openEventDashboard()\n\n> **openEventDashboard**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L187)\n\n#### Returns\n\n`void`\n\n***\n\n### publicChecked\n\n> **publicChecked**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L165)\n\n***\n\n### recurrence\n\n> **recurrence**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/Event/interface.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L188)\n\n***\n\n### registerableChecked\n\n> **registerableChecked**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L167)\n\n***\n\n### registerEventHandler()\n\n> **registerEventHandler**: () => `Promise`\\<`void`\\>\n\nDefined in: [src/types/Event/interface.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L185)\n\n#### Returns\n\n`Promise`\\<`void`\\>\n\n***\n\n### setAllDayChecked\n\n> **setAllDayChecked**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L164)\n\n***\n\n### setCustomRecurrenceModalIsOpen\n\n> **setCustomRecurrenceModalIsOpen**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L191)\n\n***\n\n### setEventEndDate\n\n> **setEventEndDate**: `Dispatch`\\<`SetStateAction`\\<`Date`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L162)\n\n***\n\n### setEventStartDate\n\n> **setEventStartDate**: `Dispatch`\\<`SetStateAction`\\<`Date`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L161)\n\n***\n\n### setFormState()\n\n> **setFormState**: (`state`) => `void`\n\nDefined in: [src/types/Event/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L178)\n\n#### Parameters\n\n##### state\n\n###### endTime\n\n`string`\n\n###### eventDescription\n\n`string`\n\n###### location\n\n`string`\n\n###### name\n\n`string`\n\n###### startTime\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### setInviteOnlyChecked\n\n> **setInviteOnlyChecked**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L170)\n\n***\n\n### setPublicChecked\n\n> **setPublicChecked**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L166)\n\n***\n\n### setRecurrence\n\n> **setRecurrence**: `Dispatch`\\<`SetStateAction`\\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\\>\\>\n\nDefined in: [src/types/Event/interface.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L189)\n\n***\n\n### setRegisterableChecked\n\n> **setRegisterableChecked**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/Event/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L168)\n\n***\n\n### t()\n\n> **t**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/Event/interface.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L155)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/Event/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L156)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### toggleDeleteModal()\n\n> **toggleDeleteModal**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L154)\n\n#### Returns\n\n`void`\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/Event/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L158)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IStatsModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IStatsModal\n\nDefined in: [src/types/Event/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L101)\n\n## Properties\n\n### data\n\n> **data**: `object`\n\nDefined in: [src/types/Event/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L102)\n\n#### event\n\n> **event**: `object`\n\n##### event.\\_id\n\n> **\\_id**: `string`\n\n##### event.averageFeedbackScore\n\n> **averageFeedbackScore**: `number`\n\n##### event.feedback\n\n> **feedback**: [`Feedback`](../../type/type-aliases/Feedback.md)[]\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/interfaces/IUpdateEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUpdateEventModalProps\n\nDefined in: [src/types/Event/interface.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L194)\n\n## Properties\n\n### eventListCardProps\n\n> **eventListCardProps**: [`IEventListCard`](IEventListCard.md)\n\nDefined in: [src/types/Event/interface.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L195)\n\n***\n\n### recurringEventUpdateModalIsOpen\n\n> **recurringEventUpdateModalIsOpen**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L196)\n\n***\n\n### t()\n\n> **t**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/Event/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L198)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/Event/interface.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L199)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### toggleRecurringEventUpdateModal()\n\n> **toggleRecurringEventUpdateModal**: () => `void`\n\nDefined in: [src/types/Event/interface.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L197)\n\n#### Returns\n\n`void`\n\n***\n\n### updateEventHandler()\n\n> **updateEventHandler**: () => `Promise`\\<`void`\\>\n\nDefined in: [src/types/Event/interface.ts:200](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L200)\n\n#### Returns\n\n`Promise`\\<`void`\\>\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceAttendanceStatisticsModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceAttendanceStatisticsModalProps\n\n> **InterfaceAttendanceStatisticsModalProps** = [`IAttendanceStatisticsModalProps`](../interfaces/IAttendanceStatisticsModalProps.md)\n\nDefined in: [src/types/Event/interface.ts:300](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L300)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceCalendarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceCalendarProps\n\n> **InterfaceCalendarProps** = [`ICalendarProps`](../interfaces/ICalendarProps.md)\n\nDefined in: [src/types/Event/interface.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L294)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceDeleteEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceDeleteEventModalProps\n\n> **InterfaceDeleteEventModalProps** = [`IDeleteEventModalProps`](../interfaces/IDeleteEventModalProps.md)\n\nDefined in: [src/types/Event/interface.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L296)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceEvent\n\n> **InterfaceEvent** = [`IEvent`](../interfaces/IEvent.md)\n\nDefined in: [src/types/Event/interface.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L291)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEventEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceEventEdge\n\n> **InterfaceEventEdge** = [`IEventEdge`](../interfaces/IEventEdge.md)\n\nDefined in: [src/types/Event/interface.ts:298](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L298)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceEventHeaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceEventHeaderProps\n\n> **InterfaceEventHeaderProps** = [`IEventHeaderProps`](../interfaces/IEventHeaderProps.md)\n\nDefined in: [src/types/Event/interface.ts:295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L295)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceIOrgList.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceIOrgList\n\n> **InterfaceIOrgList** = [`IOrgList`](../interfaces/IOrgList.md)\n\nDefined in: [src/types/Event/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L292)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceMember.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceMember\n\n> **InterfaceMember** = [`IMember`](../interfaces/IMember.md)\n\nDefined in: [src/types/Event/interface.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L290)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfacePreviewEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfacePreviewEventModalProps\n\n> **InterfacePreviewEventModalProps** = [`IPreviewEventModalProps`](../interfaces/IPreviewEventModalProps.md)\n\nDefined in: [src/types/Event/interface.ts:297](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L297)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceStatsModal.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceStatsModal\n\n> **InterfaceStatsModal** = [`IStatsModal`](../interfaces/IStatsModal.md)\n\nDefined in: [src/types/Event/interface.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L293)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/type-aliases/InterfaceUpdateEventModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceUpdateEventModalProps\n\n> **InterfaceUpdateEventModalProps** = [`IUpdateEventModalProps`](../interfaces/IUpdateEventModalProps.md)\n\nDefined in: [src/types/Event/interface.ts:299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L299)\n" }, { "path": "docs/docs/auto-docs/types/Event/interface/variables/FilterPeriod.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: FilterPeriod\n\n> `const` **FilterPeriod**: `object`\n\nDefined in: [src/types/Event/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L12)\n\n## Type Declaration\n\n### All\n\n> `readonly` **All**: `\"All\"` = `'All'`\n\n### ThisMonth\n\n> `readonly` **ThisMonth**: `\"This Month\"` = `'This Month'`\n\n### ThisYear\n\n> `readonly` **ThisYear**: `\"This Year\"` = `'This Year'`\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/Event.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Event\n\n> **Event** = `object`\n\nDefined in: [src/types/Event/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L16)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/Event/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L17)\n\n***\n\n### actionItems\n\n> **actionItems**: [`ActionItem`](../../../AdminPortal/actionItem/type-aliases/ActionItem.md)[]\n\nDefined in: [src/types/Event/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L18)\n\n***\n\n### admins?\n\n> `optional` **admins**: [`User`](User.md)[]\n\nDefined in: [src/types/Event/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L19)\n\n***\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L20)\n\n***\n\n### attendees\n\n> **attendees**: [`User`](User.md)[]\n\nDefined in: [src/types/Event/type.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L21)\n\n***\n\n### attendeesCheckInStatus\n\n> **attendeesCheckInStatus**: [`CheckInStatus`](../../../shared-components/CheckIn/type/type-aliases/CheckInStatus.md)[]\n\nDefined in: [src/types/Event/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L22)\n\n***\n\n### averageFeedbackScore?\n\n> `optional` **averageFeedbackScore**: `number`\n\nDefined in: [src/types/Event/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L23)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L24)\n\n***\n\n### creator\n\n> **creator**: [`User`](User.md)\n\nDefined in: [src/types/Event/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L25)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Event/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L26)\n\n***\n\n### endDate?\n\n> `optional` **endDate**: `Date`\n\nDefined in: [src/types/Event/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L27)\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/Event/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L28)\n\n***\n\n### feedback\n\n> **feedback**: [`Feedback`](Feedback.md)[]\n\nDefined in: [src/types/Event/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L29)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L30)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L31)\n\n***\n\n### latitude?\n\n> `optional` **latitude**: `number`\n\nDefined in: [src/types/Event/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L32)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/Event/type.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L33)\n\n***\n\n### longitude?\n\n> `optional` **longitude**: `number`\n\nDefined in: [src/types/Event/type.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L34)\n\n***\n\n### organization?\n\n> `optional` **organization**: [`Organization`](../../../AdminPortal/Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/Event/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L35)\n\n***\n\n### recurrence?\n\n> `optional` **recurrence**: `string`\n\nDefined in: [src/types/Event/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L36)\n\n***\n\n### recurring\n\n> **recurring**: `boolean`\n\nDefined in: [src/types/Event/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L37)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/Event/type.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L38)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/types/Event/type.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L39)\n\n***\n\n### status\n\n> **status**: `string`\n\nDefined in: [src/types/Event/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L40)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/Event/type.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L41)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L42)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventAttendeeInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventAttendeeInput\n\n> **EventAttendeeInput** = `object`\n\nDefined in: [src/types/Event/type.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L78)\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/Event/type.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L79)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/Event/type.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L80)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventInput\n\n> **EventInput** = `object`\n\nDefined in: [src/types/Event/type.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L60)\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L61)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Event/type.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L62)\n\n***\n\n### endDate?\n\n> `optional` **endDate**: `Date`\n\nDefined in: [src/types/Event/type.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L63)\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/Event/type.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L64)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/type.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L65)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/type.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L66)\n\n***\n\n### latitude?\n\n> `optional` **latitude**: `number`\n\nDefined in: [src/types/Event/type.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L67)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/Event/type.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L68)\n\n***\n\n### longitude?\n\n> `optional` **longitude**: `number`\n\nDefined in: [src/types/Event/type.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L69)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/Event/type.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L70)\n\n***\n\n### recurrence?\n\n> `optional` **recurrence**: `string`\n\nDefined in: [src/types/Event/type.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L71)\n\n***\n\n### recurring\n\n> **recurring**: `boolean`\n\nDefined in: [src/types/Event/type.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L72)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/Event/type.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L73)\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/Event/type.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L74)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/Event/type.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L75)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventOrderByInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventOrderByInput\n\n> **EventOrderByInput** = *typeof* [`EventOrderByInputEnum`](../variables/EventOrderByInputEnum.md)\\[keyof *typeof* [`EventOrderByInputEnum`](../variables/EventOrderByInputEnum.md)\\]\n\nDefined in: [src/types/Event/type.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L138)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteer.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventVolunteer\n\n> **EventVolunteer** = `object`\n\nDefined in: [src/types/Event/type.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L83)\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L88)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](User.md)\n\nDefined in: [src/types/Event/type.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L92)\n\n***\n\n### event?\n\n> `optional` **event**: [`Event`](Event.md)\n\nDefined in: [src/types/Event/type.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L91)\n\n***\n\n### hasAccepted\n\n> **hasAccepted**: `boolean`\n\nDefined in: [src/types/Event/type.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L85)\n\n***\n\n### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\nDefined in: [src/types/Event/type.ts:86](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L86)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/type.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L84)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/type.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L87)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L89)\n\n***\n\n### updater?\n\n> `optional` **updater**: [`User`](User.md)\n\nDefined in: [src/types/Event/type.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L93)\n\n***\n\n### user\n\n> **user**: [`User`](User.md)\n\nDefined in: [src/types/Event/type.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L90)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteerInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventVolunteerInput\n\n> **EventVolunteerInput** = `object`\n\nDefined in: [src/types/Event/type.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L96)\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/Event/type.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L97)\n\n***\n\n### groupId?\n\n> `optional` **groupId**: `string`\n\nDefined in: [src/types/Event/type.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L99)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/Event/type.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L98)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventVolunteerResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventVolunteerResponse\n\n> **EventVolunteerResponse** = *typeof* [`EventVolunteerResponseEnum`](../variables/EventVolunteerResponseEnum.md)\\[keyof *typeof* [`EventVolunteerResponseEnum`](../variables/EventVolunteerResponseEnum.md)\\]\n\nDefined in: [src/types/Event/type.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L113)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/EventWhereInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: EventWhereInput\n\n> **EventWhereInput** = `object`\n\nDefined in: [src/types/Event/type.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L141)\n\n## Properties\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/Event/type.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L142)\n\n***\n\n### description\\_contains?\n\n> `optional` **description\\_contains**: `string`\n\nDefined in: [src/types/Event/type.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L143)\n\n***\n\n### description\\_in?\n\n> `optional` **description\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L144)\n\n***\n\n### description\\_not?\n\n> `optional` **description\\_not**: `string`\n\nDefined in: [src/types/Event/type.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L145)\n\n***\n\n### description\\_not\\_in?\n\n> `optional` **description\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L146)\n\n***\n\n### description\\_starts\\_with?\n\n> `optional` **description\\_starts\\_with**: `string`\n\nDefined in: [src/types/Event/type.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L147)\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/Event/type.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L149)\n\n***\n\n### id\\_contains?\n\n> `optional` **id\\_contains**: `string`\n\nDefined in: [src/types/Event/type.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L150)\n\n***\n\n### id\\_in?\n\n> `optional` **id\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L151)\n\n***\n\n### id\\_not?\n\n> `optional` **id\\_not**: `string`\n\nDefined in: [src/types/Event/type.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L152)\n\n***\n\n### id\\_not\\_in?\n\n> `optional` **id\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L153)\n\n***\n\n### id\\_starts\\_with?\n\n> `optional` **id\\_starts\\_with**: `string`\n\nDefined in: [src/types/Event/type.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L154)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/Event/type.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L156)\n\n***\n\n### location\\_contains?\n\n> `optional` **location\\_contains**: `string`\n\nDefined in: [src/types/Event/type.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L157)\n\n***\n\n### location\\_in?\n\n> `optional` **location\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L158)\n\n***\n\n### location\\_not?\n\n> `optional` **location\\_not**: `string`\n\nDefined in: [src/types/Event/type.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L159)\n\n***\n\n### location\\_not\\_in?\n\n> `optional` **location\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L160)\n\n***\n\n### location\\_starts\\_with?\n\n> `optional` **location\\_starts\\_with**: `string`\n\nDefined in: [src/types/Event/type.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L161)\n\n***\n\n### organization\\_id?\n\n> `optional` **organization\\_id**: `string`\n\nDefined in: [src/types/Event/type.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L163)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Event/type.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L165)\n\n***\n\n### title\\_contains?\n\n> `optional` **title\\_contains**: `string`\n\nDefined in: [src/types/Event/type.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L166)\n\n***\n\n### title\\_in?\n\n> `optional` **title\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L167)\n\n***\n\n### title\\_not?\n\n> `optional` **title\\_not**: `string`\n\nDefined in: [src/types/Event/type.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L168)\n\n***\n\n### title\\_not\\_in?\n\n> `optional` **title\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Event/type.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L169)\n\n***\n\n### title\\_starts\\_with?\n\n> `optional` **title\\_starts\\_with**: `string`\n\nDefined in: [src/types/Event/type.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L170)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/Feedback.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Feedback\n\n> **Feedback** = `object`\n\nDefined in: [src/types/Event/type.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L45)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/Event/type.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L46)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L47)\n\n***\n\n### event?\n\n> `optional` **event**: [`Event`](Event.md)\n\nDefined in: [src/types/Event/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L48)\n\n***\n\n### rating\n\n> **rating**: `number`\n\nDefined in: [src/types/Event/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L49)\n\n***\n\n### review\n\n> **review**: `string` \\| `null`\n\nDefined in: [src/types/Event/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L50)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L51)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/FeedbackInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: FeedbackInput\n\n> **FeedbackInput** = `object`\n\nDefined in: [src/types/Event/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L54)\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/Event/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L55)\n\n***\n\n### rating\n\n> **rating**: `number`\n\nDefined in: [src/types/Event/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L56)\n\n***\n\n### review?\n\n> `optional` **review**: `string`\n\nDefined in: [src/types/Event/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L57)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/UpdateEventVolunteerInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UpdateEventVolunteerInput\n\n> **UpdateEventVolunteerInput** = `object`\n\nDefined in: [src/types/Event/type.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L102)\n\n## Properties\n\n### assignments?\n\n> `optional` **assignments**: `string`[]\n\nDefined in: [src/types/Event/type.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L103)\n\n***\n\n### hasAccepted?\n\n> `optional` **hasAccepted**: `boolean`\n\nDefined in: [src/types/Event/type.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L104)\n\n***\n\n### isPublic?\n\n> `optional` **isPublic**: `boolean`\n\nDefined in: [src/types/Event/type.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L105)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/type-aliases/User.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: User\n\n> **User** = `object`\n\nDefined in: [src/types/Event/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L5)\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/Event/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L9)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L11)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/types/Event/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L8)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L6)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L7)\n\n***\n\n### natalSex?\n\n> `optional` **natalSex**: `string`\n\nDefined in: [src/types/Event/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L13)\n\n***\n\n### role?\n\n> `optional` **role**: `string`\n\nDefined in: [src/types/Event/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L10)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `Date`\n\nDefined in: [src/types/Event/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/Event/type/variables/EventOrderByInputEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EventOrderByInputEnum\n\n> `const` **EventOrderByInputEnum**: `object`\n\nDefined in: [src/types/Event/type.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L116)\n\n## Type Declaration\n\n### allDay\\_ASC\n\n> `readonly` **allDay\\_ASC**: `\"allDay_ASC\"` = `'allDay_ASC'`\n\n### allDay\\_DESC\n\n> `readonly` **allDay\\_DESC**: `\"allDay_DESC\"` = `'allDay_DESC'`\n\n### description\\_ASC\n\n> `readonly` **description\\_ASC**: `\"description_ASC\"` = `'description_ASC'`\n\n### description\\_DESC\n\n> `readonly` **description\\_DESC**: `\"description_DESC\"` = `'description_DESC'`\n\n### endDate\\_ASC\n\n> `readonly` **endDate\\_ASC**: `\"endDate_ASC\"` = `'endDate_ASC'`\n\n### endDate\\_DESC\n\n> `readonly` **endDate\\_DESC**: `\"endDate_DESC\"` = `'endDate_DESC'`\n\n### endTime\\_ASC\n\n> `readonly` **endTime\\_ASC**: `\"endTime_ASC\"` = `'endTime_ASC'`\n\n### endTime\\_DESC\n\n> `readonly` **endTime\\_DESC**: `\"endTime_DESC\"` = `'endTime_DESC'`\n\n### id\\_ASC\n\n> `readonly` **id\\_ASC**: `\"id_ASC\"` = `'id_ASC'`\n\n### id\\_DESC\n\n> `readonly` **id\\_DESC**: `\"id_DESC\"` = `'id_DESC'`\n\n### location\\_ASC\n\n> `readonly` **location\\_ASC**: `\"location_ASC\"` = `'location_ASC'`\n\n### location\\_DESC\n\n> `readonly` **location\\_DESC**: `\"location_DESC\"` = `'location_DESC'`\n\n### recurrence\\_ASC\n\n> `readonly` **recurrence\\_ASC**: `\"recurrence_ASC\"` = `'recurrence_ASC'`\n\n### recurrence\\_DESC\n\n> `readonly` **recurrence\\_DESC**: `\"recurrence_DESC\"` = `'recurrence_DESC'`\n\n### startDate\\_ASC\n\n> `readonly` **startDate\\_ASC**: `\"startDate_ASC\"` = `'startDate_ASC'`\n\n### startDate\\_DESC\n\n> `readonly` **startDate\\_DESC**: `\"startDate_DESC\"` = `'startDate_DESC'`\n\n### startTime\\_ASC\n\n> `readonly` **startTime\\_ASC**: `\"startTime_ASC\"` = `'startTime_ASC'`\n\n### startTime\\_DESC\n\n> `readonly` **startTime\\_DESC**: `\"startTime_DESC\"` = `'startTime_DESC'`\n\n### title\\_ASC\n\n> `readonly` **title\\_ASC**: `\"title_ASC\"` = `'title_ASC'`\n\n### title\\_DESC\n\n> `readonly` **title\\_DESC**: `\"title_DESC\"` = `'title_DESC'`\n" }, { "path": "docs/docs/auto-docs/types/Event/type/variables/EventVolunteerResponseEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: EventVolunteerResponseEnum\n\n> `const` **EventVolunteerResponseEnum**: `object`\n\nDefined in: [src/types/Event/type.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/type.ts#L108)\n\n## Type Declaration\n\n### NO\n\n> `readonly` **NO**: `\"NO\"` = `'NO'`\n\n### YES\n\n> `readonly` **YES**: `\"YES\"` = `'YES'`\n" }, { "path": "docs/docs/auto-docs/types/Event/utils/interfaces/InterfaceHoliday.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceHoliday\n\nDefined in: [src/types/Event/utils.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L1)\n\n## Properties\n\n### date\n\n> **date**: `string`\n\nDefined in: [src/types/Event/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L3)\n\n***\n\n### month\n\n> **month**: `string`\n\nDefined in: [src/types/Event/utils.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L4)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/utils.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/Event/utils/variables/holidays.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: holidays\n\n> `const` **holidays**: [`InterfaceHoliday`](../interfaces/InterfaceHoliday.md)[]\n\nDefined in: [src/types/Event/utils.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/Event/utils/variables/weekdays.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: weekdays\n\n> `const` **weekdays**: `string`[]\n\nDefined in: [src/types/Event/utils.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/utils.ts#L19)\n" }, { "path": "docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventFormProps\n\nDefined in: [src/types/EventForm/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L68)\n\nProps interface for the EventForm component.\r\nProvides a reusable form for creating and editing events across Admin and User portals.\n\n- `initialValues`: Initial form values\r\n- `onSubmit`: Callback fired when form is submitted with valid data\r\n- `onCancel`: Callback fired when form is cancelled\r\n- `submitLabel`: Label text for the submit button\r\n- `t`: Translation function for event-specific keys\r\n- `tCommon`: Translation function for common keys\r\n- `showCreateChat`: Whether to show the \"Create Chat\" toggle\r\n- `showRegisterable`: Whether to show the \"Is Registerable\" toggle\r\n- `showPublicToggle`: Whether to show the \"Is Public\" toggle\r\n- `disableRecurrence`: Whether to disable recurrence options\r\n- `submitting`: Whether the form is currently submitting\r\n- `showRecurrenceToggle`: Whether to show the recurrence toggle\r\n- `showCancelButton`: Whether to show the cancel button\n\n## Properties\n\n### disableRecurrence?\n\n> `optional` **disableRecurrence**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L79)\n\n***\n\n### initialValues\n\n> **initialValues**: [`IEventFormValues`](IEventFormValues.md)\n\nDefined in: [src/types/EventForm/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L69)\n\n***\n\n### onCancel()\n\n> **onCancel**: () => `void`\n\nDefined in: [src/types/EventForm/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L71)\n\n#### Returns\n\n`void`\n\n***\n\n### onSubmit()\n\n> **onSubmit**: (`payload`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/EventForm/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L70)\n\n#### Parameters\n\n##### payload\n\n[`IEventFormSubmitPayload`](IEventFormSubmitPayload.md)\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### showCancelButton?\n\n> `optional` **showCancelButton**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L82)\n\n***\n\n### showCreateChat?\n\n> `optional` **showCreateChat**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L75)\n\n***\n\n### showPublicToggle?\n\n> `optional` **showPublicToggle**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L77)\n\n***\n\n### showRecurrenceToggle?\n\n> `optional` **showRecurrenceToggle**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L81)\n\n***\n\n### showRegisterable?\n\n> `optional` **showRegisterable**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L76)\n\n***\n\n### submitLabel\n\n> **submitLabel**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L72)\n\n***\n\n### submitting?\n\n> `optional` **submitting**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L80)\n\n***\n\n### t()\n\n> **t**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/EventForm/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L73)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/EventForm/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L74)\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormSubmitPayload.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventFormSubmitPayload\n\nDefined in: [src/types/EventForm/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L43)\n\nPayload interface for event form submission.\r\nExtends base fields with ISO timestamp strings for API transmission.\n\n## Extends\n\n- `IEventFormBase`\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L11)\n\n#### Inherited from\n\n`IEventFormBase.allDay`\n\n***\n\n### createChat?\n\n> `optional` **createChat**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L25)\n\n#### Inherited from\n\n`IEventFormBase.createChat`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L9)\n\n#### Inherited from\n\n`IEventFormBase.description`\n\n***\n\n### endAtISO\n\n> **endAtISO**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L45)\n\n***\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/types/EventForm/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L47)\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L21)\n\nDetermines if the event is accessible only by invitation.\r\nMutually exclusive with isPublic.\n\n#### Inherited from\n\n`IEventFormBase.isInviteOnly`\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L16)\n\nDetermines if the event is visible to the entire community.\r\nOften referred to as \"Community Visible\" in the UI.\n\n#### Inherited from\n\n`IEventFormBase.isPublic`\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L22)\n\n#### Inherited from\n\n`IEventFormBase.isRegisterable`\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L10)\n\n#### Inherited from\n\n`IEventFormBase.location`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L8)\n\n#### Inherited from\n\n`IEventFormBase.name`\n\n***\n\n### recurrenceRule\n\n> **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/EventForm/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L24)\n\n#### Inherited from\n\n`IEventFormBase.recurrenceRule`\n\n***\n\n### startAtISO\n\n> **startAtISO**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L44)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/EventForm/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L46)\n" }, { "path": "docs/docs/auto-docs/types/EventForm/interface/interfaces/IEventFormValues.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventFormValues\n\nDefined in: [src/types/EventForm/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L32)\n\nForm values interface for event creation/editing.\r\nExtends base fields with Date objects and time strings for form inputs.\n\n## Extends\n\n- `IEventFormBase`\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L11)\n\n#### Inherited from\n\n`IEventFormBase.allDay`\n\n***\n\n### createChat?\n\n> `optional` **createChat**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L25)\n\n#### Inherited from\n\n`IEventFormBase.createChat`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L9)\n\n#### Inherited from\n\n`IEventFormBase.description`\n\n***\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/types/EventForm/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L34)\n\n***\n\n### endTime\n\n> **endTime**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L36)\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L21)\n\nDetermines if the event is accessible only by invitation.\r\nMutually exclusive with isPublic.\n\n#### Inherited from\n\n`IEventFormBase.isInviteOnly`\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L16)\n\nDetermines if the event is visible to the entire community.\r\nOften referred to as \"Community Visible\" in the UI.\n\n#### Inherited from\n\n`IEventFormBase.isPublic`\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/EventForm/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L22)\n\n#### Inherited from\n\n`IEventFormBase.isRegisterable`\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L10)\n\n#### Inherited from\n\n`IEventFormBase.location`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L8)\n\n#### Inherited from\n\n`IEventFormBase.name`\n\n***\n\n### recurrenceRule\n\n> **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/EventForm/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L24)\n\n#### Inherited from\n\n`IEventFormBase.recurrenceRule`\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/EventForm/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L33)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/types/EventForm/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/EventForm/interface.ts#L35)\n" }, { "path": "docs/docs/auto-docs/types/FormFieldGroup/interface/interfaces/IFormTextFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IFormTextFieldProps\n\nDefined in: [src/types/FormFieldGroup/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L22)\n\nProps for FormFieldGroup component.\n\n## Extends\n\n- [`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md)\n\n## Indexable\n\n\\[`x`: `string`\\]: `unknown`\n\nAdditional HTML input attributes passed through to the underlying control\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`className`](InterfaceFormFieldGroupProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`data-testid`](InterfaceFormFieldGroupProps.md#data-testid)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L29)\n\n#### Overrides\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`disabled`](InterfaceFormFieldGroupProps.md#disabled)\n\n***\n\n### endAdornment?\n\n> `optional` **endAdornment**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L28)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`error`](InterfaceFormFieldGroupProps.md#error)\n\n***\n\n### helpText?\n\n> `optional` **helpText**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`helpText`](InterfaceFormFieldGroupProps.md#helptext)\n\n***\n\n### hideLabel?\n\n> `optional` **hideLabel**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`hideLabel`](InterfaceFormFieldGroupProps.md#hidelabel)\n\n***\n\n### inline?\n\n> `optional` **inline**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`inline`](InterfaceFormFieldGroupProps.md#inline)\n\n***\n\n### inputId?\n\n> `optional` **inputId**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`inputId`](InterfaceFormFieldGroupProps.md#inputid)\n\n***\n\n### label\n\n> **label**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`label`](InterfaceFormFieldGroupProps.md#label)\n\n***\n\n### labelClassName?\n\n> `optional` **labelClassName**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`labelClassName`](InterfaceFormFieldGroupProps.md#labelclassname)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`name`](InterfaceFormFieldGroupProps.md#name)\n\n***\n\n### onChange()?\n\n> `optional` **onChange**: (`v`) => `void`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L26)\n\n#### Parameters\n\n##### v\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L24)\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`required`](InterfaceFormFieldGroupProps.md#required)\n\n***\n\n### startAdornment?\n\n> `optional` **startAdornment**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L27)\n\n***\n\n### touched?\n\n> `optional` **touched**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](InterfaceFormFieldGroupProps.md).[`touched`](InterfaceFormFieldGroupProps.md#touched)\n\n***\n\n### type?\n\n> `optional` **type**: `\"number\"` \\| `\"text\"` \\| `\"email\"` \\| `\"password\"` \\| `\"url\"` \\| `\"tel\"`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L23)\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L25)\n" }, { "path": "docs/docs/auto-docs/types/FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormFieldGroupProps\n\nDefined in: [src/types/FormFieldGroup/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L6)\n\nProps for FormFieldGroup component.\n\n## Extended by\n\n- [`IFormTextFieldProps`](IFormTextFieldProps.md)\n- [`InterfaceFormSelectFieldProps`](../../../shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md)\n- [`InterfaceFormCheckFieldProps`](../../../shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md)\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L18)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11)\n\n***\n\n### helpText?\n\n> `optional` **helpText**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10)\n\n***\n\n### hideLabel?\n\n> `optional` **hideLabel**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16)\n\n***\n\n### inline?\n\n> `optional` **inline**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15)\n\n***\n\n### inputId?\n\n> `optional` **inputId**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19)\n\n***\n\n### label\n\n> **label**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8)\n\n***\n\n### labelClassName?\n\n> `optional` **labelClassName**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7)\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9)\n\n***\n\n### touched?\n\n> `optional` **touched**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/OrganizationCard/interface/interfaces/InterfaceOrganizationCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationCardProps\n\nDefined in: [src/types/OrganizationCard/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L1)\n\n## Properties\n\n### addressLine1\n\n> **addressLine1**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L14)\n\n***\n\n### admins?\n\n> `optional` **admins**: `object`[]\n\nDefined in: [src/types/OrganizationCard/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L13)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### adminsCount?\n\n> `optional` **adminsCount**: `number`\n\nDefined in: [src/types/OrganizationCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L16)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L26)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L27)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L5)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L2)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L4)\n\n***\n\n### isJoined?\n\n> `optional` **isJoined**: `boolean`\n\nDefined in: [src/types/OrganizationCard/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L25)\n\n***\n\n### members?\n\n> `optional` **members**: `object`\n\nDefined in: [src/types/OrganizationCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L6)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### membersCount?\n\n> `optional` **membersCount**: `number`\n\nDefined in: [src/types/OrganizationCard/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L15)\n\n***\n\n### membershipRequests?\n\n> `optional` **membershipRequests**: `object`[]\n\nDefined in: [src/types/OrganizationCard/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L19)\n\n#### id\n\n> **id**: `string`\n\n#### user\n\n> **user**: `object`\n\n##### user.id\n\n> **id**: `string`\n\n***\n\n### membershipRequestStatus?\n\n> `optional` **membershipRequestStatus**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L17)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L3)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/types/OrganizationCard/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L28)\n\n***\n\n### userRegistrationRequired?\n\n> `optional` **userRegistrationRequired**: `boolean`\n\nDefined in: [src/types/OrganizationCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/OrganizationCard/interface.ts#L18)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePageHeaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePageHeaderProps\n\nDefined in: [src/types/PeopleTab/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L4)\n\n## Properties\n\n### actions?\n\n> `optional` **actions**: `ReactNode`\n\nDefined in: [src/types/PeopleTab/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L21)\n\n***\n\n### search?\n\n> `optional` **search**: `object`\n\nDefined in: [src/types/PeopleTab/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L6)\n\n#### buttonTestId?\n\n> `optional` **buttonTestId**: `string`\n\n#### inputTestId?\n\n> `optional` **inputTestId**: `string`\n\n#### onSearch()\n\n> **onSearch**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string`\n\n##### Returns\n\n`void`\n\n#### placeholder\n\n> **placeholder**: `string`\n\n***\n\n### sorting?\n\n> `optional` **sorting**: `object`[]\n\nDefined in: [src/types/PeopleTab/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L12)\n\n#### icon?\n\n> `optional` **icon**: `ReactNode`\n\n#### onChange()\n\n> **onChange**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string` | `number`\n\n##### Returns\n\n`void`\n\n#### options\n\n> **options**: `object`[]\n\n#### selected\n\n> **selected**: `string` \\| `number`\n\n#### testIdPrefix\n\n> **testIdPrefix**: `string`\n\n#### title\n\n> **title**: `string`\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTab.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopleTab\n\nDefined in: [src/types/PeopleTab/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L45)\n\n## Properties\n\n### action()\n\n> **action**: () => `void`\n\nDefined in: [src/types/PeopleTab/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L49)\n\n#### Returns\n\n`void`\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactElement`\\<`SVGProps`\\<`SVGSVGElement`\\>\\>\n\nDefined in: [src/types/PeopleTab/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L47)\n\n***\n\n### isActive?\n\n> `optional` **isActive**: `boolean`\n\nDefined in: [src/types/PeopleTab/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L48)\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L50)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L46)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbar.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopleTabNavbar\n\nDefined in: [src/types/PeopleTab/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L53)\n\n## Properties\n\n### action()\n\n> **action**: () => `void`\n\nDefined in: [src/types/PeopleTab/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L57)\n\n#### Returns\n\n`void`\n\n***\n\n### icon?\n\n> `optional` **icon**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L55)\n\n***\n\n### isActive?\n\n> `optional` **isActive**: `boolean`\n\nDefined in: [src/types/PeopleTab/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L56)\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L58)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L54)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabNavbarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopleTabNavbarProps\n\nDefined in: [src/types/PeopleTab/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L24)\n\n## Properties\n\n### actions?\n\n> `optional` **actions**: `ReactNode`\n\nDefined in: [src/types/PeopleTab/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L41)\n\n***\n\n### search?\n\n> `optional` **search**: `object`\n\nDefined in: [src/types/PeopleTab/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L26)\n\n#### buttonTestId?\n\n> `optional` **buttonTestId**: `string`\n\n#### inputTestId?\n\n> `optional` **inputTestId**: `string`\n\n#### onSearch()\n\n> **onSearch**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string`\n\n##### Returns\n\n`void`\n\n#### placeholder\n\n> **placeholder**: `string`\n\n***\n\n### sorting?\n\n> `optional` **sorting**: `object`[]\n\nDefined in: [src/types/PeopleTab/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L32)\n\n#### icon?\n\n> `optional` **icon**: `string`\n\n#### onChange()\n\n> **onChange**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string` | `number`\n\n##### Returns\n\n`void`\n\n#### options\n\n> **options**: `object`[]\n\n#### selected\n\n> **selected**: `string` \\| `number`\n\n#### testIdPrefix\n\n> **testIdPrefix**: `string`\n\n#### title\n\n> **title**: `string`\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L25)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopleTabUserOrganizationProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopleTabUserOrganizationProps\n\nDefined in: [src/types/PeopleTab/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L74)\n\n## Properties\n\n### actionIcon?\n\n> `optional` **actionIcon**: `ReactNode`\n\nDefined in: [src/types/PeopleTab/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L80)\n\n***\n\n### actionName?\n\n> `optional` **actionName**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L81)\n\n***\n\n### adminCount?\n\n> `optional` **adminCount**: `number`\n\nDefined in: [src/types/PeopleTab/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L78)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L77)\n\n***\n\n### img?\n\n> `optional` **img**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L75)\n\n***\n\n### membersCount?\n\n> `optional` **membersCount**: `number`\n\nDefined in: [src/types/PeopleTab/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L79)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L76)\n" }, { "path": "docs/docs/auto-docs/types/PeopleTab/interface/interfaces/InterfacePeopletabUserEventsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopletabUserEventsProps\n\nDefined in: [src/types/PeopleTab/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L62)\n\n## Properties\n\n### actionIcon?\n\n> `optional` **actionIcon**: `ReactNode`\n\nDefined in: [src/types/PeopleTab/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L69)\n\n***\n\n### actionName?\n\n> `optional` **actionName**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L70)\n\n***\n\n### endDate?\n\n> `optional` **endDate**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L66)\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L64)\n\n***\n\n### eventDescription?\n\n> `optional` **eventDescription**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L68)\n\n***\n\n### eventName?\n\n> `optional` **eventName**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L67)\n\n***\n\n### startDate?\n\n> `optional` **startDate**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L65)\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/PeopleTab/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/PeopleTab/interface.ts#L63)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/ICreatePostModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreatePostModalProps\n\nDefined in: [src/types/Post/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L118)\n\n## Properties\n\n### body?\n\n> `optional` **body**: `string`\n\nDefined in: [src/types/Post/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L122)\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L120)\n\n***\n\n### onHide()\n\n> **onHide**: () => `void`\n\nDefined in: [src/types/Post/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L123)\n\n#### Returns\n\n`void`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/Post/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L125)\n\n***\n\n### refetch()\n\n> **refetch**: () => `Promise`\\<`unknown`\\>\n\nDefined in: [src/types/Post/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L124)\n\n#### Returns\n\n`Promise`\\<`unknown`\\>\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L119)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Post/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L121)\n\n***\n\n### type\n\n> **type**: `\"create\"` \\| `\"edit\"`\n\nDefined in: [src/types/Post/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L126)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceAttachment.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAttachment\n\nDefined in: [src/types/Post/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L76)\n\n## Properties\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/types/Post/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L77)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceCreator.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreator\n\nDefined in: [src/types/Post/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L80)\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/Post/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L84)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/Post/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L83)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L81)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Post/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L82)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceMutationCreatePostInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMutationCreatePostInput\n\nDefined in: [src/types/Post/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L69)\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: `File`[]\n\nDefined in: [src/types/Post/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L73)\n\n***\n\n### caption\n\n> **caption**: `string`\n\nDefined in: [src/types/Post/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L70)\n\n***\n\n### isPinned\n\n> **isPinned**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L72)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/Post/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L71)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceOrganization.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganization\n\nDefined in: [src/types/Post/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L50)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L51)\n\n***\n\n### pinnedPosts\n\n> **pinnedPosts**: `object`\n\nDefined in: [src/types/Post/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L57)\n\n#### edges\n\n> **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[]\n\n#### pageInfo\n\n> **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md)\n\n#### totalCount\n\n> **totalCount**: `number`\n\n***\n\n### posts\n\n> **posts**: `object`\n\nDefined in: [src/types/Post/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L52)\n\n#### edges\n\n> **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[]\n\n#### pageInfo\n\n> **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md)\n\n#### totalCount\n\n> **totalCount**: `number`\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfaceOrganizationPostListData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPostListData\n\nDefined in: [src/types/Post/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L64)\n\n## Properties\n\n### organization\n\n> **organization**: [`InterfaceOrganization`](InterfaceOrganization.md)\n\nDefined in: [src/types/Post/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L65)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePageInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePageInfo\n\nDefined in: [src/types/Post/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L38)\n\n## Properties\n\n### endCursor\n\n> **endCursor**: `string`\n\nDefined in: [src/types/Post/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L40)\n\n***\n\n### hasNextPage\n\n> **hasNextPage**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L41)\n\n***\n\n### hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L42)\n\n***\n\n### startCursor\n\n> **startCursor**: `string`\n\nDefined in: [src/types/Post/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L39)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePinnedPostCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePinnedPostCardProps\n\nDefined in: [src/types/Post/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L112)\n\n## Properties\n\n### onPostUpdate()?\n\n> `optional` **onPostUpdate**: () => `void`\n\nDefined in: [src/types/Post/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L115)\n\n#### Returns\n\n`void`\n\n***\n\n### onStoryClick()\n\n> **onStoryClick**: (`post`) => `void`\n\nDefined in: [src/types/Post/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L114)\n\n#### Parameters\n\n##### post\n\n[`InterfacePost`](InterfacePost.md)\n\n#### Returns\n\n`void`\n\n***\n\n### pinnedPost\n\n> **pinnedPost**: [`InterfacePostEdge`](InterfacePostEdge.md)\n\nDefined in: [src/types/Post/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L113)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePinnedPostsLayoutProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePinnedPostsLayoutProps\n\nDefined in: [src/types/Post/interface.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L106)\n\n## Properties\n\n### onPostUpdate()?\n\n> `optional` **onPostUpdate**: () => `void`\n\nDefined in: [src/types/Post/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L109)\n\n#### Returns\n\n`void`\n\n***\n\n### onStoryClick()\n\n> **onStoryClick**: (`post`) => `void`\n\nDefined in: [src/types/Post/interface.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L108)\n\n#### Parameters\n\n##### post\n\n[`InterfacePost`](InterfacePost.md)\n\n#### Returns\n\n`void`\n\n***\n\n### pinnedPosts\n\n> **pinnedPosts**: [`InterfacePostEdge`](InterfacePostEdge.md)[]\n\nDefined in: [src/types/Post/interface.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L107)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePost.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePost\n\nDefined in: [src/types/Post/interface.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L87)\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: \\[\\{ `mimeType`: `string`; \\}\\]\n\nDefined in: [src/types/Post/interface.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L96)\n\n***\n\n### attachmentURL?\n\n> `optional` **attachmentURL**: `string`\n\nDefined in: [src/types/Post/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L95)\n\n***\n\n### body?\n\n> `optional` **body**: `string`\n\nDefined in: [src/types/Post/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L94)\n\n***\n\n### caption?\n\n> `optional` **caption**: `string`\n\nDefined in: [src/types/Post/interface.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L89)\n\n***\n\n### commentsCount?\n\n> `optional` **commentsCount**: `number`\n\nDefined in: [src/types/Post/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L103)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Post/interface.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L90)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`InterfaceCreator`](InterfaceCreator.md)\n\nDefined in: [src/types/Post/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L93)\n\n***\n\n### downVotesCount?\n\n> `optional` **downVotesCount**: `number`\n\nDefined in: [src/types/Post/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L102)\n\n***\n\n### hasUserVoted?\n\n> `optional` **hasUserVoted**: `object`\n\nDefined in: [src/types/Post/interface.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L97)\n\n#### hasVoted\n\n> **hasVoted**: `boolean`\n\n#### voteType\n\n> **voteType**: `\"up_vote\"` \\| `\"down_vote\"`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L88)\n\n***\n\n### pinned?\n\n> `optional` **pinned**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L92)\n\n***\n\n### pinnedAt?\n\n> `optional` **pinnedAt**: `string`\n\nDefined in: [src/types/Post/interface.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L91)\n\n***\n\n### upVotesCount?\n\n> `optional` **upVotesCount**: `number`\n\nDefined in: [src/types/Post/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L101)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostCard.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostCard\n\nDefined in: [src/types/Post/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L3)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/Post/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L4)\n\n***\n\n### commentCount\n\n> **commentCount**: `number`\n\nDefined in: [src/types/Post/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L12)\n\n***\n\n### comments\n\n> **comments**: [`Comment`](../../../Comment/type/type-aliases/Comment.md)[]\n\nDefined in: [src/types/Post/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L13)\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../../shared-components/User/type/type-aliases/User.md)\\>\n\nDefined in: [src/types/Post/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L5)\n\n***\n\n### fetchPosts()\n\n> **fetchPosts**: () => `void`\n\nDefined in: [src/types/Post/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L14)\n\n#### Returns\n\n`void`\n\n***\n\n### image\n\n> **image**: `string`\n\nDefined in: [src/types/Post/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L7)\n\n***\n\n### likeCount\n\n> **likeCount**: `number`\n\nDefined in: [src/types/Post/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L11)\n\n***\n\n### postedAt\n\n> **postedAt**: `string`\n\nDefined in: [src/types/Post/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L6)\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/Post/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L9)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/Post/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L10)\n\n***\n\n### video\n\n> **video**: `string`\n\nDefined in: [src/types/Post/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostConnection.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostConnection\n\nDefined in: [src/types/Post/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L45)\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfacePostEdge`](InterfacePostEdge.md)[]\n\nDefined in: [src/types/Post/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L46)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfo`](InterfacePageInfo.md)\n\nDefined in: [src/types/Post/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L47)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostCreator.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostCreator\n\nDefined in: [src/types/Post/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L17)\n\n## Properties\n\n### firstName?\n\n> `optional` **firstName**: `string`\n\nDefined in: [src/types/Post/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L19)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L18)\n\n***\n\n### lastName?\n\n> `optional` **lastName**: `string`\n\nDefined in: [src/types/Post/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L20)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostEdge\n\nDefined in: [src/types/Post/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L34)\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/types/Post/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L36)\n\n***\n\n### node\n\n> **node**: [`InterfacePost`](InterfacePost.md)\n\nDefined in: [src/types/Post/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L35)\n" }, { "path": "docs/docs/auto-docs/types/Post/interface/interfaces/InterfacePostNode.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostNode\n\nDefined in: [src/types/Post/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L23)\n\n## Properties\n\n### caption\n\n> **caption**: `string`\n\nDefined in: [src/types/Post/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L25)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Post/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L31)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`InterfacePostCreator`](InterfacePostCreator.md)\n\nDefined in: [src/types/Post/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L29)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L24)\n\n***\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/Post/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L27)\n\n***\n\n### pinned?\n\n> `optional` **pinned**: `boolean`\n\nDefined in: [src/types/Post/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L30)\n\n***\n\n### text?\n\n> `optional` **text**: `string`\n\nDefined in: [src/types/Post/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L26)\n\n***\n\n### videoUrl?\n\n> `optional` **videoUrl**: `string`\n\nDefined in: [src/types/Post/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/interface.ts#L28)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/interfaces/ICreatePostData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreatePostData\n\nDefined in: [src/types/Post/type.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L156)\n\n## Properties\n\n### createPost\n\n> **createPost**: `object`\n\nDefined in: [src/types/Post/type.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L157)\n\n#### attachments?\n\n> `optional` **attachments**: `object`[]\n\n#### caption\n\n> **caption**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### pinnedAt?\n\n> `optional` **pinnedAt**: `string`\n" }, { "path": "docs/docs/auto-docs/types/Post/type/interfaces/ICreatePostInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreatePostInput\n\nDefined in: [src/types/Post/type.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L170)\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: `File`[]\n\nDefined in: [src/types/Post/type.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L175)\n\n***\n\n### body?\n\n> `optional` **body**: `string`\n\nDefined in: [src/types/Post/type.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L172)\n\n***\n\n### caption\n\n> **caption**: `string`\n\nDefined in: [src/types/Post/type.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L171)\n\n***\n\n### isPinned\n\n> **isPinned**: `boolean`\n\nDefined in: [src/types/Post/type.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L174)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/Post/type.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L173)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/interfaces/IFileMetadataInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IFileMetadataInput\n\nDefined in: [src/types/Post/type.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L178)\n\n## Properties\n\n### fileHash\n\n> **fileHash**: `string`\n\nDefined in: [src/types/Post/type.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L179)\n\n***\n\n### mimetype\n\n> **mimetype**: `string`\n\nDefined in: [src/types/Post/type.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L180)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Post/type.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L181)\n\n***\n\n### objectName\n\n> **objectName**: `string`\n\nDefined in: [src/types/Post/type.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L182)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/Post.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Post\n\n> **Post** = `object`\n\nDefined in: [src/types/Post/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L6)\n\n## Properties\n\n### \\_id?\n\n> `optional` **\\_id**: `string`\n\nDefined in: [src/types/Post/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L7)\n\n***\n\n### commentCount?\n\n> `optional` **commentCount**: `number`\n\nDefined in: [src/types/Post/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L8)\n\n***\n\n### comments?\n\n> `optional` **comments**: [`Comment`](../../../Comment/type/type-aliases/Comment.md)[]\n\nDefined in: [src/types/Post/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L9)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/Post/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L10)\n\n***\n\n### creator?\n\n> `optional` **creator**: [`User`](../../../shared-components/User/type/type-aliases/User.md)\n\nDefined in: [src/types/Post/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L11)\n\n***\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L12)\n\n***\n\n### likeCount?\n\n> `optional` **likeCount**: `number`\n\nDefined in: [src/types/Post/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L13)\n\n***\n\n### organization\n\n> **organization**: [`Organization`](../../../AdminPortal/Organization/type/type-aliases/Organization.md)\n\nDefined in: [src/types/Post/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L14)\n\n***\n\n### pinned?\n\n> `optional` **pinned**: `boolean`\n\nDefined in: [src/types/Post/type.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L15)\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/Post/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L16)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Post/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L17)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/Post/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L18)\n\n***\n\n### videoUrl?\n\n> `optional` **videoUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L19)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostComments.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostComments\n\n> **PostComments** = `object`[]\n\nDefined in: [src/types/Post/type.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L83)\n\n## Type Declaration\n\n### creator\n\n> **creator**: `object`\n\n#### creator.email\n\n> **email**: `string`\n\n#### creator.firstName\n\n> **firstName**: `string`\n\n#### creator.id\n\n> **id**: `string`\n\n#### creator.lastName\n\n> **lastName**: `string`\n\n### id\n\n> **id**: `string`\n\n### likeCount\n\n> **likeCount**: `number`\n\n### text\n\n> **text**: `string`\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostInput\n\n> **PostInput** = `object`\n\nDefined in: [src/types/Post/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L22)\n\n## Properties\n\n### \\_id?\n\n> `optional` **\\_id**: `string`\n\nDefined in: [src/types/Post/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L23)\n\n***\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L24)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/Post/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L25)\n\n***\n\n### pinned?\n\n> `optional` **pinned**: `boolean`\n\nDefined in: [src/types/Post/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L26)\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/Post/type.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L27)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Post/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L28)\n\n***\n\n### videoUrl?\n\n> `optional` **videoUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L29)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostLikes.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostLikes\n\n> **PostLikes** = `object`[]\n\nDefined in: [src/types/Post/type.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L96)\n\n## Type Declaration\n\n### id\n\n> **id**: `string`\n\n### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostNode.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostNode\n\n> **PostNode** = `object`\n\nDefined in: [src/types/Post/type.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L101)\n\n## Properties\n\n### attachments\n\n> **attachments**: `object`[]\n\nDefined in: [src/types/Post/type.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L127)\n\n#### fileHash\n\n> **fileHash**: `string`\n\n#### mimeType\n\n> **mimeType**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### objectName\n\n> **objectName**: `string`\n\n***\n\n### caption\n\n> **caption**: `string` \\| `null`\n\nDefined in: [src/types/Post/type.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L103)\n\n***\n\n### commentCount\n\n> **commentCount**: `number`\n\nDefined in: [src/types/Post/type.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L105)\n\n***\n\n### comments?\n\n> `optional` **comments**: `object`\n\nDefined in: [src/types/Post/type.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L136)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### commentsCount\n\n> **commentsCount**: `number`\n\nDefined in: [src/types/Post/type.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L134)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Post/type.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L104)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/Post/type.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L106)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string` \\| `null`\n\n#### emailAddress\n\n> **emailAddress**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### downVoters\n\n> **downVoters**: `object`\n\nDefined in: [src/types/Post/type.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L116)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### downVotesCount\n\n> **downVotesCount**: `number`\n\nDefined in: [src/types/Post/type.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L114)\n\n***\n\n### hasUserVoted\n\n> **hasUserVoted**: [`VoteState`](../../../../utils/interfaces/type-aliases/VoteState.md)\n\nDefined in: [src/types/Post/type.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L112)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Post/type.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L102)\n\n***\n\n### pinnedAt\n\n> **pinnedAt**: `string` \\| `null`\n\nDefined in: [src/types/Post/type.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L115)\n\n***\n\n### upVotesCount\n\n> **upVotesCount**: `number`\n\nDefined in: [src/types/Post/type.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L113)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostOrderByInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostOrderByInput\n\n> **PostOrderByInput** = *typeof* [`PostOrderByInputEnum`](../variables/PostOrderByInputEnum.md)\\[keyof *typeof* [`PostOrderByInputEnum`](../variables/PostOrderByInputEnum.md)\\]\n\nDefined in: [src/types/Post/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L51)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostUpdateInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostUpdateInput\n\n> **PostUpdateInput** = `object`\n\nDefined in: [src/types/Post/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L54)\n\n## Properties\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L55)\n\n***\n\n### text?\n\n> `optional` **text**: `string`\n\nDefined in: [src/types/Post/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L56)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Post/type.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L57)\n\n***\n\n### videoUrl?\n\n> `optional` **videoUrl**: `string`\n\nDefined in: [src/types/Post/type.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L58)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/type-aliases/PostWhereInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PostWhereInput\n\n> **PostWhereInput** = `object`\n\nDefined in: [src/types/Post/type.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L61)\n\n## Properties\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/Post/type.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L63)\n\n***\n\n### id\\_contains?\n\n> `optional` **id\\_contains**: `string`\n\nDefined in: [src/types/Post/type.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L64)\n\n***\n\n### id\\_in?\n\n> `optional` **id\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L65)\n\n***\n\n### id\\_not?\n\n> `optional` **id\\_not**: `string`\n\nDefined in: [src/types/Post/type.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L66)\n\n***\n\n### id\\_not\\_in?\n\n> `optional` **id\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L67)\n\n***\n\n### id\\_starts\\_with?\n\n> `optional` **id\\_starts\\_with**: `string`\n\nDefined in: [src/types/Post/type.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L68)\n\n***\n\n### text?\n\n> `optional` **text**: `string`\n\nDefined in: [src/types/Post/type.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L69)\n\n***\n\n### text\\_contains?\n\n> `optional` **text\\_contains**: `string`\n\nDefined in: [src/types/Post/type.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L70)\n\n***\n\n### text\\_in?\n\n> `optional` **text\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L71)\n\n***\n\n### text\\_not?\n\n> `optional` **text\\_not**: `string`\n\nDefined in: [src/types/Post/type.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L72)\n\n***\n\n### text\\_not\\_in?\n\n> `optional` **text\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L73)\n\n***\n\n### text\\_starts\\_with?\n\n> `optional` **text\\_starts\\_with**: `string`\n\nDefined in: [src/types/Post/type.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L74)\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/Post/type.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L75)\n\n***\n\n### title\\_contains?\n\n> `optional` **title\\_contains**: `string`\n\nDefined in: [src/types/Post/type.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L76)\n\n***\n\n### title\\_in?\n\n> `optional` **title\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L77)\n\n***\n\n### title\\_not?\n\n> `optional` **title\\_not**: `string`\n\nDefined in: [src/types/Post/type.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L78)\n\n***\n\n### title\\_not\\_in?\n\n> `optional` **title\\_not\\_in**: `string`[]\n\nDefined in: [src/types/Post/type.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L79)\n\n***\n\n### title\\_starts\\_with?\n\n> `optional` **title\\_starts\\_with**: `string`\n\nDefined in: [src/types/Post/type.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L80)\n" }, { "path": "docs/docs/auto-docs/types/Post/type/variables/PostOrderByInputEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PostOrderByInputEnum\n\n> `const` **PostOrderByInputEnum**: `object`\n\nDefined in: [src/types/Post/type.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Post/type.ts#L32)\n\n## Type Declaration\n\n### COMMENT\\_COUNT\\_ASC\n\n> `readonly` **COMMENT\\_COUNT\\_ASC**: `\"commentCount_ASC\"` = `'commentCount_ASC'`\n\n### COMMENT\\_COUNT\\_DESC\n\n> `readonly` **COMMENT\\_COUNT\\_DESC**: `\"commentCount_DESC\"` = `'commentCount_DESC'`\n\n### CREATED\\_AT\\_ASC\n\n> `readonly` **CREATED\\_AT\\_ASC**: `\"createdAt_ASC\"` = `'createdAt_ASC'`\n\n### CREATED\\_AT\\_DESC\n\n> `readonly` **CREATED\\_AT\\_DESC**: `\"createdAt_DESC\"` = `'createdAt_DESC'`\n\n### ID\\_ASC\n\n> `readonly` **ID\\_ASC**: `\"id_ASC\"` = `'id_ASC'`\n\n### ID\\_DESC\n\n> `readonly` **ID\\_DESC**: `\"id_DESC\"` = `'id_DESC'`\n\n### IMAGE\\_URL\\_ASC\n\n> `readonly` **IMAGE\\_URL\\_ASC**: `\"imageUrl_ASC\"` = `'imageUrl_ASC'`\n\n### IMAGE\\_URL\\_DESC\n\n> `readonly` **IMAGE\\_URL\\_DESC**: `\"imageUrl_DESC\"` = `'imageUrl_DESC'`\n\n### LIKE\\_COUNT\\_ASC\n\n> `readonly` **LIKE\\_COUNT\\_ASC**: `\"likeCount_ASC\"` = `'likeCount_ASC'`\n\n### LIKE\\_COUNT\\_DESC\n\n> `readonly` **LIKE\\_COUNT\\_DESC**: `\"likeCount_DESC\"` = `'likeCount_DESC'`\n\n### TEXT\\_ASC\n\n> `readonly` **TEXT\\_ASC**: `\"text_ASC\"` = `'text_ASC'`\n\n### TEXT\\_DESC\n\n> `readonly` **TEXT\\_DESC**: `\"text_DESC\"` = `'text_DESC'`\n\n### TITLE\\_ASC\n\n> `readonly` **TITLE\\_ASC**: `\"title_ASC\"` = `'title_ASC'`\n\n### TITLE\\_DESC\n\n> `readonly` **TITLE\\_DESC**: `\"title_DESC\"` = `'title_DESC'`\n\n### VIDEO\\_URL\\_ASC\n\n> `readonly` **VIDEO\\_URL\\_ASC**: `\"videoUrl_ASC\"` = `'videoUrl_ASC'`\n\n### VIDEO\\_URL\\_DESC\n\n> `readonly` **VIDEO\\_URL\\_DESC**: `\"videoUrl_DESC\"` = `'videoUrl_DESC'`\n" }, { "path": "docs/docs/auto-docs/types/Recurrence/interface/interfaces/InterfaceCustomRecurrenceModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCustomRecurrenceModalProps\n\nDefined in: [src/types/Recurrence/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L7)\n\nProps interface for the CustomRecurrenceModal component\n\n## Properties\n\n### customRecurrenceModalIsOpen\n\n> **customRecurrenceModalIsOpen**: `boolean`\n\nDefined in: [src/types/Recurrence/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L19)\n\nWhether the custom recurrence modal is open\n\n***\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/types/Recurrence/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L15)\n\nEvent end date\n\n***\n\n### hideCustomRecurrenceModal()\n\n> **hideCustomRecurrenceModal**: () => `void`\n\nDefined in: [src/types/Recurrence/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L21)\n\nFunction to hide the custom recurrence modal\n\n#### Returns\n\n`void`\n\n***\n\n### recurrenceRuleState\n\n> **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/Recurrence/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L9)\n\nCurrent recurrence rule state\n\n***\n\n### setCustomRecurrenceModalIsOpen()\n\n> **setCustomRecurrenceModalIsOpen**: (`state`) => `void`\n\nDefined in: [src/types/Recurrence/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L23)\n\nFunction to set custom recurrence modal open state\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<`boolean`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### setEndDate()\n\n> **setEndDate**: (`state`) => `void`\n\nDefined in: [src/types/Recurrence/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L17)\n\nFunction to set event end date\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<`Date`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### setRecurrenceRuleState()\n\n> **setRecurrenceRuleState**: (`state`) => `void`\n\nDefined in: [src/types/Recurrence/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L11)\n\nFunction to update recurrence rule state\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<[`InterfaceRecurrenceRule`](../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/Recurrence/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L29)\n\nEvent start date\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/Recurrence/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Recurrence/interface.ts#L27)\n\nTranslation function\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/InfiniteScrollProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InfiniteScrollProps\n\n> **InfiniteScrollProps** = `object`\n\nDefined in: [src/types/ReportingTable/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L55)\n\nProps for the InfiniteScroll component used in ReportingTable\n\n## Properties\n\n### dataLength\n\n> **dataLength**: `number`\n\nDefined in: [src/types/ReportingTable/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L56)\n\n***\n\n### hasMore\n\n> **hasMore**: `boolean`\n\nDefined in: [src/types/ReportingTable/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L58)\n\n***\n\n### next()\n\n> **next**: () => `void`\n\nDefined in: [src/types/ReportingTable/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L57)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingRow.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ReportingRow\n\n> **ReportingRow** = `Record`\\<`string`, `unknown`\\>\n\nDefined in: [src/types/ReportingTable/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableColumn.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ReportingTableColumn\n\n> **ReportingTableColumn** = `Partial`\\<`Omit`\\<`GridColDef`, `\"width\"` \\| `\"minWidth\"` \\| `\"maxWidth\"`\\>\\> & `object`\n\nDefined in: [src/types/ReportingTable/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L16)\n\nReportingTableColumnDef\nApp-level column shape used across the app. It's a thin composition over\nMUI's `GridColDef` exposing the props we use commonly in screen files.\n\n## Type Declaration\n\n### align?\n\n> `optional` **align**: `\"left\"` \\| `\"center\"` \\| `\"right\"`\n\nAlignment for the column content\n\n### field\n\n> **field**: `string`\n\nUnique field id for the column (required)\n\n### flex?\n\n> `optional` **flex**: `number`\n\nFlex grow for the column\n\n### headerAlign?\n\n> `optional` **headerAlign**: `\"left\"` \\| `\"center\"` \\| `\"right\"`\n\nAlignment for the column header\n\n### headerClassName?\n\n> `optional` **headerClassName**: `string`\n\nAdditional class applied to the header cell\n\n### headerName?\n\n> `optional` **headerName**: `string`\n\nHeader name for the column\n\n### maxWidth?\n\n> `optional` **maxWidth**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nMaximum width for the column - accepts number (pixels) or spacing token name\n\n### minWidth?\n\n> `optional` **minWidth**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nMinimum width for the column - accepts number (pixels) or spacing token name\n\n### renderCell()?\n\n> `optional` **renderCell**: (`params`) => `ReactNode`\n\nCustom renderer for the cell\n\n#### Parameters\n\n##### params\n\n`ReportingCellParams`\n\n#### Returns\n\n`ReactNode`\n\n### sortable?\n\n> `optional` **sortable**: `boolean`\n\nWhether the column is sortable\n\n### valueGetter()?\n\n> `optional` **valueGetter**: (`value`, `row`, `column`, `apiRef`) => `unknown`\n\nCustom value getter for the cell\n\n#### Parameters\n\n##### value\n\n`unknown`\n\n##### row\n\n[`ReportingRow`](ReportingRow.md)\n\n##### column\n\n`GridColDef`\n\n##### apiRef\n\n`unknown`\n\n#### Returns\n\n`unknown`\n\n### width?\n\n> `optional` **width**: `number` \\| [`SpacingToken`](../../../../utils/tokenValues/type-aliases/SpacingToken.md)\n\nColumn width - accepts number (pixels) or spacing token name\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableGridProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ReportingTableGridProps\n\n> **ReportingTableGridProps** = `object`\n\nDefined in: [src/types/ReportingTable/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L64)\n\nProps for the ReportingTableGrid component\n\n## Indexable\n\n\\[`key`: `string`\\]: `unknown`\n\n## Properties\n\n### columns?\n\n> `optional` **columns**: [`ReportingTableColumn`](ReportingTableColumn.md)[]\n\nDefined in: [src/types/ReportingTable/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L66)\n\n***\n\n### compactColumns?\n\n> `optional` **compactColumns**: `boolean`\n\nDefined in: [src/types/ReportingTable/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L68)\n\nWhen true, applies tighter column widths for tables with many columns (7+)\n\n***\n\n### rows?\n\n> `optional` **rows**: readonly [`ReportingRow`](ReportingRow.md)[]\n\nDefined in: [src/types/ReportingTable/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L65)\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/interface/type-aliases/ReportingTableProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ReportingTableProps\n\n> **ReportingTableProps** = `object`\n\nDefined in: [src/types/ReportingTable/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L76)\n\nProps for the ReportingTable component\n\n## Properties\n\n### columns\n\n> **columns**: [`ReportingTableColumn`](ReportingTableColumn.md)[]\n\nDefined in: [src/types/ReportingTable/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L78)\n\n***\n\n### gridProps?\n\n> `optional` **gridProps**: [`ReportingTableGridProps`](ReportingTableGridProps.md)\n\nDefined in: [src/types/ReportingTable/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L79)\n\n***\n\n### infiniteProps?\n\n> `optional` **infiniteProps**: [`InfiniteScrollProps`](InfiniteScrollProps.md)\n\nDefined in: [src/types/ReportingTable/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L81)\n\nOptional InfiniteScroll behavior; when provided, wraps the grid\n\n***\n\n### listProps?\n\n> `optional` **listProps**: `object`\n\nDefined in: [src/types/ReportingTable/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L83)\n\nOptional props applied to the InfiniteScroll container\n\n#### className?\n\n> `optional` **className**: `string`\n\n#### data-testid?\n\n> `optional` **data-testid**: `string`\n\n#### endMessage?\n\n> `optional` **endMessage**: `React.ReactNode`\n\n#### loader?\n\n> `optional` **loader**: `React.ReactNode`\n\n#### scrollThreshold?\n\n> `optional` **scrollThreshold**: `number`\n\n#### style?\n\n> `optional` **style**: `React.CSSProperties`\n\n***\n\n### rows\n\n> **rows**: readonly [`ReportingRow`](ReportingRow.md)[]\n\nDefined in: [src/types/ReportingTable/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/interface.ts#L77)\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/utils/variables/PAGE_SIZE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PAGE\\_SIZE\n\n> `const` **PAGE\\_SIZE**: `number` = `10`\n\nDefined in: [src/types/ReportingTable/utils.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L3)\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/utils/variables/ROW_HEIGHT.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: ROW\\_HEIGHT\n\n> `const` **ROW\\_HEIGHT**: `number` = `60`\n\nDefined in: [src/types/ReportingTable/utils.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/ReportingTable/utils/variables/dataGridStyle.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dataGridStyle\n\n> `const` **dataGridStyle**: `object`\n\nDefined in: [src/types/ReportingTable/utils.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/ReportingTable/utils.ts#L9)\n\nShared sx/style object for DataGrid across the app.\nKeep shape generic to avoid strict MUI theme coupling in the types package.\n\n## Type Declaration\n\n#### & .MuiDataGrid-cell:focus\n\n> **& .MuiDataGrid-cell:focus**: `object`\n\n#### & .MuiDataGrid-cell:focus.outline\n\n> **outline**: `string` = `'none'`\n\n#### & .MuiDataGrid-cell:focus-within\n\n> **& .MuiDataGrid-cell:focus-within**: `object`\n\n#### & .MuiDataGrid-cell:focus-within.outline\n\n> **outline**: `string` = `'none'`\n\n#### & .MuiDataGrid-row\n\n> **& .MuiDataGrid-row**: `object`\n\n#### & .MuiDataGrid-row.&:focus-within\n\n> **&:focus-within**: `object`\n\n#### & .MuiDataGrid-row.&:focus-within.outline\n\n> **outline**: `string` = `'none'`\n\n#### & .MuiDataGrid-row.backgroundColor\n\n> **backgroundColor**: `string` = `'var(--row-background)'`\n\n#### & .MuiDataGrid-row:hover\n\n> **& .MuiDataGrid-row:hover**: `object`\n\n#### & .MuiDataGrid-row:hover.backgroundColor\n\n> **backgroundColor**: `string` = `'var(--row-background)'`\n\n#### & .MuiDataGrid-row.Mui-hovered\n\n> **& .MuiDataGrid-row.Mui-hovered**: `object`\n\n#### & .MuiDataGrid-row.Mui-hovered.backgroundColor\n\n> **backgroundColor**: `string` = `'var(--row-background)'`\n\n### backgroundColor\n\n> **backgroundColor**: `string` = `'var(--row-background)'`\n\n### borderRadius\n\n> **borderRadius**: `string` = `'var(--table-head-radius)'`\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchBarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchBarProps\n\nDefined in: [src/types/SearchBar/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L33)\n\nStrongly typed props for the shared SearchBar component.\n\n## Extends\n\n- `Omit`\\<`React.InputHTMLAttributes`\\<`HTMLInputElement`\\>, `\"onChange\"` \\| `\"size\"`\\>\n\n## Properties\n\n### buttonAriaLabel?\n\n> `optional` **buttonAriaLabel**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L76)\n\nAccessible label for the search button.\n\n***\n\n### buttonClassName?\n\n> `optional` **buttonClassName**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L54)\n\nAdditional class applied to the search button.\n\n***\n\n### buttonLabel?\n\n> `optional` **buttonLabel**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L74)\n\nOptional label shown inside the search button.\n\n***\n\n### buttonTestId?\n\n> `optional` **buttonTestId**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L58)\n\nButton test id override.\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L50)\n\nAdditional class applied to the container.\n\n#### Overrides\n\n`Omit.className`\n\n***\n\n### clearButtonAriaLabel?\n\n> `optional` **clearButtonAriaLabel**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L78)\n\nAccessible label for the clear button.\n\n***\n\n### clearButtonTestId?\n\n> `optional` **clearButtonTestId**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L60)\n\nClear button test id override.\n\n***\n\n### defaultValue?\n\n> `optional` **defaultValue**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L42)\n\nInitial value when used in uncontrolled mode.\n\n#### Overrides\n\n`Omit.defaultValue`\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactNode`\n\nDefined in: [src/types/SearchBar/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L82)\n\nOptional custom icon rendered inside the input field.\n\n***\n\n### inputClassName?\n\n> `optional` **inputClassName**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L52)\n\nAdditional class applied to the input element.\n\n***\n\n### inputTestId?\n\n> `optional` **inputTestId**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L56)\n\nInput test id override.\n\n***\n\n### isLoading?\n\n> `optional` **isLoading**: `boolean`\n\nDefined in: [src/types/SearchBar/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L80)\n\nRenders a loading spinner inside the button when true.\n\n***\n\n### onChange()?\n\n> `optional` **onChange**: (`value`, `event?`) => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L46)\n\nCallback fired whenever the input value changes.\n\n#### Parameters\n\n##### value\n\n`string`\n\n##### event?\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onClear()?\n\n> `optional` **onClear**: () => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L48)\n\nCallback fired after the clear button is pressed.\n\n#### Returns\n\n`void`\n\n***\n\n### onSearch()?\n\n> `optional` **onSearch**: (`value`, `metadata?`) => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L44)\n\nCallback invoked when the user submits a search via button, Enter, or clear.\n\n#### Parameters\n\n##### value\n\n`string`\n\n##### metadata?\n\n[`InterfaceSearchMeta`](InterfaceSearchMeta.md)\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L38)\n\nPlaceholder text for the search input.\n\n#### Overrides\n\n`Omit.placeholder`\n\n***\n\n### showClearButton?\n\n> `optional` **showClearButton**: `boolean`\n\nDefined in: [src/types/SearchBar/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L68)\n\nToggle visibility of the inline clear button. Defaults to true.\n\n***\n\n### showLeadingIcon?\n\n> `optional` **showLeadingIcon**: `boolean`\n\nDefined in: [src/types/SearchBar/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L70)\n\nToggle the leading search icon visibility. Defaults to false.\n\n***\n\n### showSearchButton?\n\n> `optional` **showSearchButton**: `boolean`\n\nDefined in: [src/types/SearchBar/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L66)\n\nToggle visibility of the trailing search button. Defaults to true.\n\n***\n\n### showTrailingIcon?\n\n> `optional` **showTrailingIcon**: `boolean`\n\nDefined in: [src/types/SearchBar/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L72)\n\nToggle the trailing search icon visibility. Defaults to false.\n\n***\n\n### size?\n\n> `optional` **size**: [`SearchBarSize`](../../type/type-aliases/SearchBarSize.md)\n\nDefined in: [src/types/SearchBar/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L62)\n\nVisual size of the component.\n\n***\n\n### value?\n\n> `optional` **value**: `string`\n\nDefined in: [src/types/SearchBar/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L40)\n\nControlled input value.\n\n#### Overrides\n\n`Omit.value`\n\n***\n\n### variant?\n\n> `optional` **variant**: [`SearchBarVariant`](../../type/type-aliases/SearchBarVariant.md)\n\nDefined in: [src/types/SearchBar/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L64)\n\nVisual variant of the component.\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchBarRef.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchBarRef\n\nDefined in: [src/types/SearchBar/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L21)\n\nMethods exposed by the SearchBar ref.\n\n## Properties\n\n### blur()\n\n> **blur**: () => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L25)\n\nProgrammatically blur the search input\n\n#### Returns\n\n`void`\n\n***\n\n### clear()\n\n> **clear**: () => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L27)\n\nClear the search input value and trigger onChange\n\n#### Returns\n\n`void`\n\n***\n\n### focus()\n\n> **focus**: () => `void`\n\nDefined in: [src/types/SearchBar/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L23)\n\nProgrammatically focus the search input\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/interface/interfaces/InterfaceSearchMeta.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchMeta\n\nDefined in: [src/types/SearchBar/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L11)\n\nMetadata about how a search was triggered.\n\n## Properties\n\n### event?\n\n> `optional` **event**: `KeyboardEvent`\\<`HTMLInputElement`\\> \\| `MouseEvent`\\<`HTMLButtonElement`, `MouseEvent`\\>\n\nDefined in: [src/types/SearchBar/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L15)\n\nThe original DOM event that triggered the search, if available\n\n***\n\n### trigger\n\n> **trigger**: [`SearchBarTrigger`](../../type/type-aliases/SearchBarTrigger.md)\n\nDefined in: [src/types/SearchBar/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/interface.ts#L13)\n\nThe trigger source for the search (button click, enter key, etc.)\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarSize.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SearchBarSize\n\n> **SearchBarSize** = `\"sm\"` \\| `\"md\"` \\| `\"lg\"`\n\nDefined in: [src/types/SearchBar/type.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L1)\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarTrigger.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SearchBarTrigger\n\n> **SearchBarTrigger** = `\"button\"` \\| `\"enter\"` \\| `\"clear\"`\n\nDefined in: [src/types/SearchBar/type.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L3)\n" }, { "path": "docs/docs/auto-docs/types/SearchBar/type/type-aliases/SearchBarVariant.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SearchBarVariant\n\n> **SearchBarVariant** = `\"outline\"` \\| `\"filled\"` \\| `\"ghost\"`\n\nDefined in: [src/types/SearchBar/type.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SearchBar/type.ts#L2)\n" }, { "path": "docs/docs/auto-docs/types/SidebarBase/interface/interfaces/ISidebarBaseProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISidebarBaseProps\n\nDefined in: [src/types/SidebarBase/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L4)\n\nInterface for SidebarBase component props.\n\n## Properties\n\n### backgroundColor?\n\n> `optional` **backgroundColor**: `string`\n\nDefined in: [src/types/SidebarBase/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L18)\n\n(Optional) Background color override\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/SidebarBase/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L12)\n\nNavigation items and other content\n\n***\n\n### footerContent?\n\n> `optional` **footerContent**: `ReactNode`\n\nDefined in: [src/types/SidebarBase/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L16)\n\n(Optional) Footer content\n\n***\n\n### headerContent?\n\n> `optional` **headerContent**: `ReactNode`\n\nDefined in: [src/types/SidebarBase/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L14)\n\n(Optional) Content after branding (e.g., org section)\n\n***\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/types/SidebarBase/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L6)\n\nState indicating whether the sidebar is hidden\n\n***\n\n### persistToggleState?\n\n> `optional` **persistToggleState**: `boolean`\n\nDefined in: [src/types/SidebarBase/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L20)\n\n(Optional) Whether to persist toggle state to localStorage\n\n***\n\n### portalType\n\n> **portalType**: `\"user\"` \\| `\"admin\"`\n\nDefined in: [src/types/SidebarBase/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L10)\n\nType of portal (admin or user)\n\n***\n\n### setHideDrawer\n\n> **setHideDrawer**: `Dispatch`\\<`SetStateAction`\\<`boolean`\\>\\>\n\nDefined in: [src/types/SidebarBase/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarBase/interface.ts#L8)\n\nFunction to toggle sidebar visibility\n" }, { "path": "docs/docs/auto-docs/types/SidebarNavItem/interface/interfaces/ISidebarNavItemProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISidebarNavItemProps\n\nDefined in: [src/types/SidebarNavItem/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L7)\n\n## Properties\n\n### dataCy?\n\n> `optional` **dataCy**: `string`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L25)\n\n***\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L17)\n\n***\n\n### icon\n\n> **icon**: `ReactNode`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L11)\n\n***\n\n### iconType?\n\n> `optional` **iconType**: `\"svg\"` \\| `\"react-icon\"`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L23)\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L13)\n\n***\n\n### onClick()?\n\n> `optional` **onClick**: () => `void`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L19)\n\n#### Returns\n\n`void`\n\n***\n\n### testId\n\n> **testId**: `string`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L15)\n\n***\n\n### to\n\n> **to**: `string`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L9)\n\n***\n\n### useSimpleButton?\n\n> `optional` **useSimpleButton**: `boolean`\n\nDefined in: [src/types/SidebarNavItem/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarNavItem/interface.ts#L21)\n" }, { "path": "docs/docs/auto-docs/types/SidebarPluginSection/interface/interfaces/ISidebarPluginSectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISidebarPluginSectionProps\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L6)\n\nInterface for SidebarPluginSection component props.\n\n## Properties\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L10)\n\nWhether the drawer is hidden/collapsed\n\n***\n\n### onItemClick()?\n\n> `optional` **onItemClick**: () => `void`\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L14)\n\n(Optional) Handler for plugin item clicks\n\n#### Returns\n\n`void`\n\n***\n\n### orgId?\n\n> `optional` **orgId**: `string`\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L12)\n\n(Optional) Organization ID for org-specific plugins\n\n***\n\n### pluginItems\n\n> **pluginItems**: [`IDrawerExtension`](../../../../plugin/types/interfaces/IDrawerExtension.md)[]\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L8)\n\nArray of plugin drawer items\n\n***\n\n### useSimpleButton?\n\n> `optional` **useSimpleButton**: `boolean`\n\nDefined in: [src/types/SidebarPluginSection/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/SidebarPluginSection/interface.ts#L16)\n\n(Optional) Use simple button style (for org drawers)\n" }, { "path": "docs/docs/auto-docs/types/UseUserProfile/interfaces/InterfaceUseUserProfileReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUseUserProfileReturn\n\nDefined in: [src/types/UseUserProfile.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L13)\n\nReturn type for the useUserProfile hook.\n\n`@remarks`\nProvides user profile data and actions for rendering profile dropdowns\nand managing user authentication state across the application.\n\n`@example`\n```tsx\nconst { displayedName, userImage, handleLogout } = useUserProfile('user');\n```\n\n## Properties\n\n### displayedName\n\n> **displayedName**: `string`\n\nDefined in: [src/types/UseUserProfile.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L24)\n\nTruncated display name (max 20 characters) with ellipsis if needed.\nUsed for UI rendering to prevent layout overflow.\n\n***\n\n### handleLogout()\n\n> **handleLogout**: () => `Promise`\\<`void`\\>\n\nDefined in: [src/types/UseUserProfile.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L56)\n\nAsync function to handle user logout.\n\n`@remarks`\n- Invokes logout mutation\n- Clears localStorage and session data\n- Navigates to root path\n- Includes race condition protection\n\n`@returns` Promise that resolves when logout completes\n`@throws` Logs errors but does not reject (fail-safe)\n\n#### Returns\n\n`Promise`\\<`void`\\>\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UseUserProfile.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L18)\n\nFull user name retrieved from localStorage.\n`@defaultValue` Empty string if not found\n\n***\n\n### profileDestination\n\n> **profileDestination**: `string`\n\nDefined in: [src/types/UseUserProfile.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L42)\n\nDestination path for \"View Profile\" navigation.\nResolved based on user role and portal context.\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/UseUserProfile.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L64)\n\nTranslation function for common strings.\n\n`@param` key - Translation key from common namespace\n`@returns` Translated string in the current locale\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### userImage\n\n> **userImage**: `string`\n\nDefined in: [src/types/UseUserProfile.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L36)\n\nSanitized avatar URL or empty string if unavailable.\nHandles null, undefined, and string \"null\" values.\n\n***\n\n### userRole\n\n> **userRole**: `string`\n\nDefined in: [src/types/UseUserProfile.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UseUserProfile.ts#L30)\n\nUser's role in the system (e.g., 'ADMIN', 'USER', 'SUPERADMIN').\n`@defaultValue` Empty string if not found\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceChatUser.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceChatUser\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L144)\n\n**`Internal`**\n\nInterface representing a chat user structure.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L145)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L149)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L148)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L146)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L147)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceContactCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceContactCardProps\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L119)\n\nProps for ContactCard component.\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L120)\n\n***\n\n### image\n\n> **image**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L122)\n\n***\n\n### isGroup\n\n> **isGroup**: `boolean`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L125)\n\n***\n\n### lastMessage\n\n> **lastMessage**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L127)\n\n***\n\n### selectedContact\n\n> **selectedContact**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L123)\n\n***\n\n### setSelectedContact\n\n> **setSelectedContact**: `Dispatch`\\<`SetStateAction`\\<`string`\\>\\>\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L124)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L121)\n\n***\n\n### unseenMessages\n\n> **unseenMessages**: `number`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L126)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceGroupChatDetailsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGroupChatDetailsProps\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L99)\n\n## Properties\n\n### chat\n\n> **chat**: [`Chat`](../type-aliases/Chat.md)\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L102)\n\n***\n\n### chatRefetch()\n\n> **chatRefetch**: (`variables?`) => `Promise`\\<`ApolloQueryResult`\\<\\{ `chat`: [`Chat`](../type-aliases/Chat.md); \\}\\>\\>\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L103)\n\n#### Parameters\n\n##### variables?\n\n`Partial`\\<\\{ `after?`: `string`; `beforeMessages?`: `string`; `first?`: `number`; `input`: \\{ `id`: `string`; \\}; `lastMessages?`: `number`; \\}\\>\n\n#### Returns\n\n`Promise`\\<`ApolloQueryResult`\\<\\{ `chat`: [`Chat`](../type-aliases/Chat.md); \\}\\>\\>\n\n***\n\n### groupChatDetailsModalisOpen\n\n> **groupChatDetailsModalisOpen**: `boolean`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L101)\n\n***\n\n### toggleGroupChatDetailsModal()\n\n> **toggleGroupChatDetailsModal**: () => `void`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L100)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceMockMessage.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMockMessage\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L156)\n\n**`Internal`**\n\nInterface representing a mock message structure for testing purposes.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L157)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L158)\n\n***\n\n### media?\n\n> `optional` **media**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L163)\n\n***\n\n### messageContent\n\n> **messageContent**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L160)\n\n***\n\n### replyTo?\n\n> `optional` **replyTo**: `InterfaceMockMessage`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L161)\n\n***\n\n### sender\n\n> **sender**: [`InterfaceChatUser`](InterfaceChatUser.md)\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L159)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L162)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/interfaces/InterfaceOrganizationMember.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationMember\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L133)\n\nOrganization member with their role.\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L136)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L134)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L135)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L137)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Chat/interface/type-aliases/Chat.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Chat\n\n> **Chat** = `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L3)\n\n## Properties\n\n### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L7)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L8)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L10)\n\n***\n\n### creator?\n\n> `optional` **creator**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L41)\n\n#### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L6)\n\n***\n\n### firstUnreadMessageId?\n\n> `optional` **firstUnreadMessageId**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L14)\n\n***\n\n### hasUnread?\n\n> `optional` **hasUnread**: `boolean`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L13)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L4)\n\n***\n\n### isGroup\n\n> **isGroup**: `boolean`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L9)\n\n***\n\n### lastMessage?\n\n> `optional` **lastMessage**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L15)\n\n#### body\n\n> **body**: `string`\n\n#### createdAt\n\n> **createdAt**: `string`\n\n#### creator\n\n> **creator**: `object`\n\n##### creator.avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\n##### creator.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### creator.id\n\n> **id**: `string`\n\n##### creator.name\n\n> **name**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### parentMessage?\n\n> `optional` **parentMessage**: `object`\n\n##### parentMessage.body\n\n> **body**: `string`\n\n##### parentMessage.createdAt\n\n> **createdAt**: `string`\n\n##### parentMessage.creator\n\n> **creator**: `object`\n\n##### parentMessage.creator.id\n\n> **id**: `string`\n\n##### parentMessage.creator.name\n\n> **name**: `string`\n\n##### parentMessage.id\n\n> **id**: `string`\n\n#### updatedAt?\n\n> `optional` **updatedAt**: `string` \\| `null`\n\n***\n\n### members?\n\n> `optional` **members**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L53)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### messages?\n\n> `optional` **messages**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L67)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L5)\n\n***\n\n### organization?\n\n> `optional` **organization**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L36)\n\n#### countryCode?\n\n> `optional` **countryCode**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### unreadMessagesCount?\n\n> `optional` **unreadMessagesCount**: `number`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L12)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `string` \\| `null`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L11)\n\n***\n\n### updater?\n\n> `optional` **updater**: `object`\n\nDefined in: [src/types/UserPortal/Chat/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Chat/interface.ts#L47)\n\n#### avatarMimeType?\n\n> `optional` **avatarMimeType**: `string`\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/CommentCard/interface/interfaces/InterfaceCommentCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCommentCardProps\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L6)\n\nProps for CommentCard component.\n\n## Properties\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L15)\n\nThe creator of the comment, including their ID, name, and optional avatar URL.\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### hasUserVoted?\n\n> `optional` **hasUserVoted**: `object`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L24)\n\nObject indicating if current user has voted and the vote type.\n\n#### voteType\n\n> **voteType**: [`VoteType`](../../../../../utils/interfaces/type-aliases/VoteType.md)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L10)\n\nThe unique identifier of the comment.\n\n***\n\n### refetchComments()?\n\n> `optional` **refetchComments**: () => `void`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L39)\n\nOptional callback to refresh comments after modifications.\n\n#### Returns\n\n`void`\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L34)\n\nThe text content of the comment.\n\n***\n\n### upVoteCount\n\n> **upVoteCount**: `number`\n\nDefined in: [src/types/UserPortal/CommentCard/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CommentCard/interface.ts#L29)\n\nThe number of upvotes (likes) on the comment.\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/interfaces/InterfaceCreateDirectChatProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateDirectChatProps\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L40)\n\nProps for the CreateDirectChat modal.\n\n## Properties\n\n### chats\n\n> **chats**: [`Chat`](../../../Chat/interface/type-aliases/Chat.md)[]\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L44)\n\n***\n\n### chatsListRefetch\n\n> **chatsListRefetch**: [`ChatsListRefetch`](../type-aliases/ChatsListRefetch.md)\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L43)\n\n***\n\n### createDirectChatModalisOpen\n\n> **createDirectChatModalisOpen**: `boolean`\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L42)\n\n***\n\n### toggleCreateDirectChatModal()\n\n> **toggleCreateDirectChatModal**: () => `void`\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L41)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/ChatsListRefetch.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ChatsListRefetch()\n\n> **ChatsListRefetch** = (`variables?`) => `Promise`\\<`ApolloQueryResult`\\<`unknown`\\>\\>\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L11)\n\n## Parameters\n\n### variables?\n\n`Partial`\\<\\{ `id`: `string`; \\}\\>\n\n## Returns\n\n`Promise`\\<`ApolloQueryResult`\\<`unknown`\\>\\>\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/CreateChatMembershipMutation.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateChatMembershipMutation()\n\n> **CreateChatMembershipMutation** = (`options?`) => `Promise`\\<`FetchResult`\\<`unknown`\\>\\>\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L26)\n\n## Parameters\n\n### options?\n\n`MutationFunctionOptions`\\<`unknown`, `OperationVariables`, `DefaultContext`, `ApolloCache`\\<`unknown`\\>\\>\n\n## Returns\n\n`Promise`\\<`FetchResult`\\<`unknown`\\>\\>\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/CreateDirectChat/interface/type-aliases/CreateChatMutation.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateChatMutation()\n\n> **CreateChatMutation** = (`options?`) => `Promise`\\<`FetchResult`\\<`unknown`\\>\\>\n\nDefined in: [src/types/UserPortal/CreateDirectChat/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/CreateDirectChat/interface.ts#L15)\n\n## Parameters\n\n### options?\n\n`MutationFunctionOptions`\\<`unknown`, `OperationVariables`, `DefaultContext`, `ApolloCache`\\<`unknown`\\>\\>\n\n## Returns\n\n`Promise`\\<`FetchResult`\\<`unknown`\\>\\>\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Donation/interface/interfaces/InterfaceDonation.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDonation\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L1)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L2)\n\n***\n\n### amount\n\n> **amount**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L4)\n\n***\n\n### nameOfUser\n\n> **nameOfUser**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L3)\n\n***\n\n### payPalId\n\n> **payPalId**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L6)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L7)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/Donation/interface/interfaces/InterfaceDonationCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDonationCardProps\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L10)\n\n## Properties\n\n### amount\n\n> **amount**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L13)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L11)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L12)\n\n***\n\n### payPalId\n\n> **payPalId**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L15)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L16)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/UserPortal/Donation/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/Donation/interface.ts#L14)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/EmptyChatState/interface/interfaces/InterfaceEmptyChatStateProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEmptyChatStateProps\n\nDefined in: [src/types/UserPortal/EmptyChatState/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EmptyChatState/interface.ts#L4)\n\nProps interface for the EmptyChatState component.\n\n## Properties\n\n### message\n\n> **message**: `string`\n\nDefined in: [src/types/UserPortal/EmptyChatState/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EmptyChatState/interface.ts#L5)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/EventCard/interface/interfaces/InterfaceEventCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventCardProps\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L6)\n\nInterface for EventCard component props.\n\n## Properties\n\n### attendees\n\n> **attendees**: `Partial`\\<[`User`](../../../../Event/type/type-aliases/User.md)\\>[]\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L26)\n\nList of users attending the event\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../../../Event/type/type-aliases/User.md)\\>\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L24)\n\nInformation about the user who created the event\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L12)\n\nDetailed description of the event\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L18)\n\nISO string for the event end date/time\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L22)\n\nformatted end time string (optional)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L8)\n\nUnique identifier for the event\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L31)\n\nDetermines if the event is restricted to invited participants only.\nWhen true, only invited users can see and access the event.\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L14)\n\nPhysical or virtual location of the event\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L10)\n\nName or title of the event\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L16)\n\nISO string for the event start date/time\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/UserPortal/EventCard/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/EventCard/interface.ts#L20)\n\nformatted start time string (optional)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/GroupModal/interface/interfaces/InterfaceGroupModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceGroupModalProps\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L7)\n\nProps for GroupModal component.\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L10)\n\n***\n\n### group\n\n> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md)\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L11)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L9)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L8)\n\n***\n\n### refetchGroups()\n\n> **refetchGroups**: () => `void`\n\nDefined in: [src/types/UserPortal/GroupModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/GroupModal/interface.ts#L12)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/RecurringEventVolunteerModal/interface/interfaces/InterfaceRecurringEventVolunteerModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurringEventVolunteerModalProps\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L4)\n\nInterface for RecurringEventVolunteerModal component props\n\n## Properties\n\n### eventDate\n\n> **eventDate**: `string`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L23)\n\nDate of the event instance (ISO string format)\n\n***\n\n### eventName\n\n> **eventName**: `string`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L18)\n\nName of the event\n\n***\n\n### groupName?\n\n> `optional` **groupName**: `string`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L43)\n\nName of the volunteer group (required when isForGroup is true)\n\n***\n\n### isForGroup?\n\n> `optional` **isForGroup**: `boolean`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L38)\n\nWhether this is for joining a volunteer group (vs individual volunteering)\n\n***\n\n### onHide()\n\n> **onHide**: () => `void`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L13)\n\nCallback function to hide/close the modal\n\n#### Returns\n\n`void`\n\n***\n\n### onSelectInstance()\n\n> **onSelectInstance**: () => `void`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L33)\n\nCallback when user selects to volunteer for a single instance\n\n#### Returns\n\n`void`\n\n***\n\n### onSelectSeries()\n\n> **onSelectSeries**: () => `void`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L28)\n\nCallback when user selects to volunteer for the entire series\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/UserPortal/RecurringEventVolunteerModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/RecurringEventVolunteerModal/interface.ts#L8)\n\nWhether the modal is visible\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalCard/interface/interfaces/InterfaceUserPortalCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserPortalCardProps\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L12)\n\nProps for UserPortalCard — a flexible layout wrapper for User Portal cards.\n\nLayout:\n[ imageSlot ] [ children / content ] [ actionsSlot ]\n\nThis component centralizes layout, spacing, and density while keeping\nall content and text controlled by consuming components.\n\n## Properties\n\n### actionsSlot?\n\n> `optional` **actionsSlot**: `ReactNode`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L18)\n\n(Optional) Right section (buttons, badges, counters)\n\n***\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L26)\n\n(Optional) Accessible label for the card container (i18n required)\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L16)\n\nMain content area (required)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L22)\n\n(Optional) Additional class for the outer container\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L24)\n\n(Optional) Test id prefix for unit/e2e testing\n\n***\n\n### imageSlot?\n\n> `optional` **imageSlot**: `ReactNode`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L14)\n\n(Optional) Left section (avatar, logo, thumbnail, icon)\n\n***\n\n### variant?\n\n> `optional` **variant**: `\"compact\"` \\| `\"standard\"` \\| `\"expanded\"`\n\nDefined in: [src/types/UserPortal/UserPortalCard/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalCard/interface.ts#L20)\n\nVisual density preset controlling padding and spacing\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceLanguageSelectorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceLanguageSelectorProps\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L173)\n\nProps interface for LanguageSelector subcomponent\n\nDefines properties for the language selection dropdown that allows users\nto switch between available interface languages (en, fr, hi, es, zh).\n\n## Properties\n\n### currentLanguageCode?\n\n> `optional` **currentLanguageCode**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L197)\n\nCurrent selected language code\n\n***\n\n### dropDirection?\n\n> `optional` **dropDirection**: `\"start\"` \\| `\"end\"` \\| `\"up\"` \\| `\"down\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L187)\n\nDropdown menu direction\n\n***\n\n### handleLanguageChange()\n\n> **handleLanguageChange**: (`languageCode`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L192)\n\nHandler called when a language is selected\n\n#### Parameters\n\n##### languageCode\n\n`string`\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### showLanguageSelector?\n\n> `optional` **showLanguageSelector**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L177)\n\nWhether to display the language selector dropdown\n\n***\n\n### testIdPrefix?\n\n> `optional` **testIdPrefix**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L182)\n\nPrefix for test IDs\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceUserDropdownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserDropdownProps\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L203)\n\nProps interface for UserDropdown subcomponent\n\n## Properties\n\n### dropDirection\n\n> **dropDirection**: `\"start\"` \\| `\"end\"` \\| `\"up\"` \\| `\"down\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L217)\n\nDropdown menu direction\n\n***\n\n### finalUserName\n\n> **finalUserName**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L227)\n\nFinal resolved user name to display\n\n***\n\n### handleLogout()\n\n> **handleLogout**: () => `void`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L222)\n\nUser profile menu items\n\n#### Returns\n\n`void`\n\n***\n\n### navigate\n\n> **navigate**: `NavigateFunction`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L232)\n\nNavigation function from react-router\n\n***\n\n### PermIdentityIcon\n\n> **PermIdentityIcon**: `OverridableComponent`\\<`SvgIconTypeMap`\\<`object`, `\"svg\"`\\>\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L247)\n\nMaterial UI icon component for profile display\n\n***\n\n### showUserProfile\n\n> **showUserProfile**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L207)\n\nWhether to display the user profile dropdown\n\n***\n\n### styles\n\n> **styles**: `CSSModuleClasses`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L242)\n\nCSS module classes\n\n***\n\n### tCommon\n\n> **tCommon**: `TFunction`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L237)\n\ni18next translation function\n\n***\n\n### testIdPrefix\n\n> **testIdPrefix**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L212)\n\nPrefix for test IDs\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/interfaces/InterfaceUserPortalNavbarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserPortalNavbarProps\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L54)\n\nMain component props interface\n\n## Properties\n\n### branding?\n\n> `optional` **branding**: [`BrandingConfig`](../../types/type-aliases/BrandingConfig.md)\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L64)\n\nBranding configuration for logo and brand name\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L153)\n\nAdditional CSS class names\n\n***\n\n### currentPage?\n\n> `optional` **currentPage**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L76)\n\nCurrent active page identifier (matches NavigationLink.id)\nUsed to highlight the active navigation link\n\n***\n\n### customStyles?\n\n> `optional` **customStyles**: `CSSProperties`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L158)\n\nInline styles\n\n***\n\n### expandBreakpoint?\n\n> `optional` **expandBreakpoint**: `\"sm\"` \\| `\"md\"` \\| `\"lg\"` \\| `\"xl\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L124)\n\nBreakpoint at which navbar expands\ndefault 'md'\n\n***\n\n### fetchOrganizationData?\n\n> `optional` **fetchOrganizationData**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L94)\n\nWhether to fetch organization data via GraphQL\ndefault true when mode === 'organization'\n\n***\n\n### mobileLayout?\n\n> `optional` **mobileLayout**: `\"collapse\"` \\| `\"offcanvas\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L130)\n\nMobile layout style\ndefault 'collapse' for user mode, 'offcanvas' for organization mode\n\n***\n\n### mode?\n\n> `optional` **mode**: `\"organization\"` \\| `\"user\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L59)\n\nNavigation mode - determines default behavior and styling\ndefault 'user'\n\n***\n\n### navigationLinks?\n\n> `optional` **navigationLinks**: [`NavigationLink`](../../types/type-aliases/NavigationLink.md)[]\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L70)\n\nArray of navigation links to display in the navbar\nOnly shown in organization mode or when explicitly provided\n\n***\n\n### onLanguageChange()?\n\n> `optional` **onLanguageChange**: (`languageCode`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L142)\n\nCustom language change handler\nIf not provided, uses default i18next language change\n\n#### Parameters\n\n##### languageCode\n\n`string`\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### onLogout()?\n\n> `optional` **onLogout**: () => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L136)\n\nCustom logout handler\nIf not provided, uses default logout behavior based on mode\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### onNavigation()?\n\n> `optional` **onNavigation**: (`link`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L148)\n\nCustom navigation handler\nIf not provided, uses react-router navigation\n\n#### Parameters\n\n##### link\n\n[`NavigationLink`](../../types/type-aliases/NavigationLink.md)\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### organizationId?\n\n> `optional` **organizationId**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L82)\n\nOrganization ID - required for organization mode\nUsed for GraphQL queries and navigation\n\n***\n\n### organizationName?\n\n> `optional` **organizationName**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L88)\n\nOrganization name - can be provided directly or fetched via GraphQL\nIf not provided and fetchOrganizationData is true, will be fetched\n\n***\n\n### showLanguageSelector?\n\n> `optional` **showLanguageSelector**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L106)\n\nShow language selector dropdown\ndefault true\n\n***\n\n### showNotifications?\n\n> `optional` **showNotifications**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L100)\n\nShow notification icon component\ndefault true when mode === 'user', false when mode === 'organization'\n\n***\n\n### showUserProfile?\n\n> `optional` **showUserProfile**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L112)\n\nShow user profile dropdown\ndefault true\n\n***\n\n### userName?\n\n> `optional` **userName**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L164)\n\nOverride user name (for testing or external state management)\nIf not provided, reads from localStorage\n\n***\n\n### variant?\n\n> `optional` **variant**: `\"dark\"` \\| `\"light\"`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L118)\n\nNavbar color variant\ndefault 'dark'\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/variables/DEFAULT_ORGANIZATION_MODE_PROPS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DEFAULT\\_ORGANIZATION\\_MODE\\_PROPS\n\n> `const` **DEFAULT\\_ORGANIZATION\\_MODE\\_PROPS**: `Partial`\\<[`InterfaceUserPortalNavbarProps`](../interfaces/InterfaceUserPortalNavbarProps.md)\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L267)\n\nDefault props for organization mode\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/interface/variables/DEFAULT_USER_MODE_PROPS.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: DEFAULT\\_USER\\_MODE\\_PROPS\n\n> `const` **DEFAULT\\_USER\\_MODE\\_PROPS**: `Partial`\\<[`InterfaceUserPortalNavbarProps`](../interfaces/InterfaceUserPortalNavbarProps.md)\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/interface.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/interface.ts#L252)\n\nDefault props for user mode\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/BrandingConfig.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: BrandingConfig\n\n> **BrandingConfig** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L74)\n\nBranding configuration for the navbar\n\n## Properties\n\n### brandName?\n\n> `optional` **brandName**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L85)\n\nBrand name to display next to logo\n\n#### Default Value\n\n```ts\n'Talawa' for user mode, organization name for organization mode\n```\n\n***\n\n### logo?\n\n> `optional` **logo**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L79)\n\nLogo image source URL or path\n\n#### Default Value\n\n```ts\nTalawa logo from assets/images/talawa-logo-600x600.png\n```\n\n***\n\n### logoAltText?\n\n> `optional` **logoAltText**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L91)\n\nAlt text for logo image\n\n#### Default Value\n\n```ts\nTranslation key 'userNavbar.talawaBranding'\n```\n\n***\n\n### onBrandClick()?\n\n> `optional` **onBrandClick**: () => `void`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L97)\n\nClick handler for brand/logo\n\n#### Returns\n\n`void`\n\n#### Default Value\n\n```ts\nundefined (no action)\n```\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/Language.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Language\n\n> **Language** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L66)\n\nLanguage configuration (from utils/languages)\n\n## Properties\n\n### code\n\n> **code**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L67)\n\n***\n\n### country\\_code\n\n> **country\\_code**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L69)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L68)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/NavigationLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: NavigationLink\n\n> **NavigationLink** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L103)\n\nNavigation link configuration\n\n## Properties\n\n### icon?\n\n> `optional` **icon**: `React.ComponentType`\\<\\{ `className?`: `string`; \\}\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L128)\n\nIcon component (optional)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L107)\n\nUnique identifier for the link (used for active state)\n\n***\n\n### isActive?\n\n> `optional` **isActive**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L134)\n\nWhether this link is currently active\n\n#### Default Value\n\n```ts\nfalse (will be determined by comparing id with currentPage)\n```\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L112)\n\nDisplay text for the link\n\n***\n\n### onClick()?\n\n> `optional` **onClick**: () => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L139)\n\nClick handler (optional, overrides\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n#### Default Value\n\n```ts\nnavigation)\n```\n\n***\n\n### path\n\n> **path**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L117)\n\nURL path or route\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L144)\n\nAdditional data attributes for testing\n\n***\n\n### translationKey?\n\n> `optional` **translationKey**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L123)\n\nTranslation key (optional, overrides label if provided)\nShould be in format 'namespace:key' or just 'key' (uses default namespace)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/OrganizationData.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OrganizationData\n\n> **OrganizationData** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L181)\n\nOrganization data structure (from GraphQL ORGANIZATION_LIST query)\n\n## Properties\n\n### addressLine1?\n\n> `optional` **addressLine1**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L184)\n\n***\n\n### adminsCount?\n\n> `optional` **adminsCount**: `number`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L188)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L186)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L189)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L185)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L182)\n\n***\n\n### membersCount?\n\n> `optional` **membersCount**: `number`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L187)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L183)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/OrganizationListQueryResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: OrganizationListQueryResponse\n\n> **OrganizationListQueryResponse** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L149)\n\nGraphQL query response structure for organization list\n\n## Properties\n\n### organizations\n\n> **organizations**: [`OrganizationData`](OrganizationData.md)[]\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L150)\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/UserPortalNavbarState.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UserPortalNavbarState\n\n> **UserPortalNavbarState** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L156)\n\nInternal component state\n\n## Properties\n\n### currentLanguageCode\n\n> **currentLanguageCode**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L160)\n\nCurrent selected language code\n\n***\n\n### isMobileMenuOpen\n\n> **isMobileMenuOpen**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L170)\n\nWhether mobile menu is open\n\n***\n\n### organizationDetails\n\n> **organizationDetails**: [`OrganizationData`](OrganizationData.md) \\| `null`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L165)\n\nOrganization details (null for user mode or when not fetched)\n\n***\n\n### userName\n\n> **userName**: `string` \\| `null`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L175)\n\nUser name from localStorage\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserPortalNavigationBar/types/type-aliases/UserProfileMenuItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UserProfileMenuItem\n\n> **UserProfileMenuItem** = `object`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L26)\n\nUser profile menu item configuration\n\n## Properties\n\n### icon?\n\n> `optional` **icon**: `React.ComponentType`\\<\\{ `className?`: `string`; \\}\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L46)\n\nIcon component (optional)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L30)\n\nUnique identifier\n\n***\n\n### isDivider?\n\n> `optional` **isDivider**: `boolean`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L56)\n\nWhether this is a divider item (renders as Dropdown.Divider)\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L35)\n\nDisplay label or translation key\n\n***\n\n### onClick()\n\n> **onClick**: () => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L51)\n\nClick handler\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L61)\n\nTest ID for testing\n\n***\n\n### translationKey?\n\n> `optional` **translationKey**: `string`\n\nDefined in: [src/types/UserPortal/UserPortalNavigationBar/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserPortalNavigationBar/types.ts#L41)\n\nTranslation key prefix (optional)\n\n#### Default Value\n\n```ts\n'common'\n```\n" }, { "path": "docs/docs/auto-docs/types/UserPortal/UserProfile/interface/type-aliases/InterfaceUserProfileProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceUserProfileProps\n\n> **InterfaceUserProfileProps** = `Partial`\\<[`InterfaceUser`](../../../../shared-components/User/interface/interfaces/InterfaceUser.md)\\>\n\nDefined in: [src/types/UserPortal/UserProfile/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/UserPortal/UserProfile/interface.ts#L6)\n\nProps for UserProfile component.\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceCreateVolunteerGroupData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateVolunteerGroupData\n\nDefined in: [src/types/Volunteer/interface.ts:312](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L312)\n\nDefines the structure for create volunteer group mutation data.\n\n## Properties\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:320](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L320)\n\n(Optional) The description of the volunteer group.\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:314](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L314)\n\nThe event ID.\n\n***\n\n### leaderId?\n\n> `optional` **leaderId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L316)\n\n(Optional) The ID of the group leader.\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L318)\n\nThe name of the volunteer group.\n\n***\n\n### recurringEventInstanceId?\n\n> `optional` **recurringEventInstanceId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:328](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L328)\n\n(Optional) Instance ID for recurring events.\n\n***\n\n### scope?\n\n> `optional` **scope**: `\"ENTIRE_SERIES\"` \\| `\"THIS_INSTANCE_ONLY\"`\n\nDefined in: [src/types/Volunteer/interface.ts:326](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L326)\n\n(Optional) Scope for recurring events.\n\n***\n\n### volunteersRequired?\n\n> `optional` **volunteersRequired**: `number`\n\nDefined in: [src/types/Volunteer/interface.ts:322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L322)\n\n(Optional) Number of volunteers required.\n\n***\n\n### volunteerUserIds\n\n> **volunteerUserIds**: `string`[]\n\nDefined in: [src/types/Volunteer/interface.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L324)\n\nArray of volunteer user IDs.\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceEventEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventEdge\n\nDefined in: [src/types/Volunteer/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L44)\n\nDefines the structure for GraphQL event edge from queries.\n\n## Properties\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L46)\n\nThe event node containing all event data.\n\n#### allDay\n\n> **allDay**: `boolean`\n\n#### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\n##### baseEvent.id\n\n> **id**: `string`\n\n##### baseEvent.isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean`\n\n##### baseEvent.name\n\n> **name**: `string`\n\n#### description\n\n> **description**: `string`\n\n#### endAt\n\n> **endAt**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### isRecurringEventTemplate\n\n> **isRecurringEventTemplate**: `boolean`\n\n#### location\n\n> **location**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\n##### recurrenceRule.frequency\n\n> **frequency**: `string`\n\n##### recurrenceRule.id\n\n> **id**: `string`\n\n#### startAt\n\n> **startAt**: `string`\n\n#### volunteerGroups\n\n> **volunteerGroups**: `object`[]\n\n#### volunteers\n\n> **volunteers**: `object`[]\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceEventVolunteerInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventVolunteerInfo\n\nDefined in: [src/types/Volunteer/interface.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L243)\n\nDefines the structure for event volunteer information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L259)\n\nThe creation date of the volunteer record.\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:285](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L285)\n\nThe user object who created this volunteer record.\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the creator\n\n#### name\n\n> **name**: `string`\n\nThe name of the creator\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L272)\n\nThe event object associated with the volunteer.\n\n#### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\n##### baseEvent.id\n\n> **id**: `string`\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the event\n\n#### name\n\n> **name**: `string`\n\nThe name of the event\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\n##### recurrenceRule.id\n\n> **id**: `string`\n\n***\n\n### groups\n\n> **groups**: `object`[]\n\nDefined in: [src/types/Volunteer/interface.ts:299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L299)\n\nArray of groups associated with the volunteer.\n\n#### description\n\n> **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### volunteers\n\n> **volunteers**: `object`[]\n\n***\n\n### hasAccepted\n\n> **hasAccepted**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L247)\n\nIndicates if the volunteer has accepted.\n\n***\n\n### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\nDefined in: [src/types/Volunteer/interface.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L251)\n\nThe number of hours volunteered.\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L245)\n\nThe unique identifier of the event volunteer.\n\n***\n\n### isInstanceException\n\n> **isInstanceException**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:257](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L257)\n\nIndicates if this is an exception to a recurring instance.\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L253)\n\nIndicates if the volunteer profile is public.\n\n***\n\n### isTemplate\n\n> **isTemplate**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:255](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L255)\n\nIndicates if this is a template volunteer record.\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:261](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L261)\n\nThe last update date of the volunteer record.\n\n***\n\n### updater\n\n> **updater**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L292)\n\nThe user object who last updated this volunteer record.\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the updater\n\n#### name\n\n> **name**: `string`\n\nThe name of the updater\n\n***\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L263)\n\nThe user object information of the volunteer.\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nThe avatar URL of the user (optional)\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the user\n\n#### name\n\n> **name**: `string`\n\nThe name of the user\n\n***\n\n### volunteerStatus\n\n> **volunteerStatus**: `\"accepted\"` \\| `\"rejected\"` \\| `\"pending\"`\n\nDefined in: [src/types/Volunteer/interface.ts:249](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L249)\n\nThe status of the volunteer.\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceMappedEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMappedEvent\n\nDefined in: [src/types/Volunteer/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L93)\n\nDefines the structure for mapped event objects used in the UI.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L95)\n\nLegacy ID format.\n\n***\n\n### baseEventId\n\n> **baseEventId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L119)\n\nThe base event ID for recurring events.\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L103)\n\nThe description of the event.\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L111)\n\nThe original endAt field.\n\n***\n\n### endDate\n\n> **endDate**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L107)\n\nThe end date (mapped from endAt).\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L97)\n\nThe unique identifier of the event.\n\n***\n\n### isRecurringInstance\n\n> **isRecurringInstance**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L117)\n\nIndicates if this is a recurring instance.\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L113)\n\nThe location of the event.\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L99)\n\nThe name of the event.\n\n***\n\n### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L121)\n\n(Optional) The recurrence rule for recurring events.\n\n#### frequency\n\n> **frequency**: `string`\n\n#### id\n\n> **id**: `string`\n\n***\n\n### recurring\n\n> **recurring**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L115)\n\nIndicates if the event is recurring.\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L109)\n\nThe original startAt field.\n\n***\n\n### startDate\n\n> **startDate**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L105)\n\nThe start date (mapped from startAt).\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L101)\n\nThe title of the event (mapped from name).\n\n***\n\n### volunteerGroups\n\n> **volunteerGroups**: `object`[]\n\nDefined in: [src/types/Volunteer/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L126)\n\nArray of volunteer groups with mapped structure.\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### description\n\n> **description**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### volunteers\n\n> **volunteers**: `object`[]\n\n#### volunteersRequired\n\n> **volunteersRequired**: `number`\n\n***\n\n### volunteers\n\n> **volunteers**: `object`[]\n\nDefined in: [src/types/Volunteer/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L141)\n\nArray of volunteers.\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\n#### id\n\n> **id**: `string`\n\n#### user\n\n> **user**: `object`\n\n##### user.id\n\n> **id**: `string`\n\n##### user.name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerData\n\nDefined in: [src/types/Volunteer/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L4)\n\nDefines the structure for volunteer data used in mutations.\n\n## Properties\n\n### event\n\n> **event**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L6)\n\nThe event ID.\n\n***\n\n### group\n\n> **group**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L8)\n\nThe group ID, or null for individual volunteering.\n\n***\n\n### recurringEventInstanceId?\n\n> `optional` **recurringEventInstanceId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L16)\n\n(Optional) Instance ID for recurring events.\n\n***\n\n### scope?\n\n> `optional` **scope**: `\"ENTIRE_SERIES\"` \\| `\"THIS_INSTANCE_ONLY\"`\n\nDefined in: [src/types/Volunteer/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L14)\n\n(Optional) Scope for recurring events.\n\n***\n\n### status\n\n> **status**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L10)\n\nThe status of the volunteer request.\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L12)\n\nThe user ID of the volunteer.\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerGroupData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerGroupData\n\nDefined in: [src/types/Volunteer/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L22)\n\nDefines the structure for volunteer group data used in mutations.\n\n## Properties\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L30)\n\nThe description of the volunteer group.\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L24)\n\nThe event ID, can be undefined for recurring events when baseEvent is used.\n\n***\n\n### leaderId?\n\n> `optional` **leaderId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L26)\n\n(Optional) leader ID for the volunteer group.\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L28)\n\nThe name of the volunteer group.\n\n***\n\n### recurringEventInstanceId?\n\n> `optional` **recurringEventInstanceId**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L38)\n\n(Optional) instance ID for recurring events.\n\n***\n\n### scope?\n\n> `optional` **scope**: `\"ENTIRE_SERIES\"` \\| `\"THIS_INSTANCE_ONLY\"`\n\nDefined in: [src/types/Volunteer/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L36)\n\n(Optional) scope for recurring events.\n\n***\n\n### volunteersRequired\n\n> **volunteersRequired**: `number`\n\nDefined in: [src/types/Volunteer/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L32)\n\nThe number of volunteers required, or null if not specified.\n\n***\n\n### volunteerUserIds\n\n> **volunteerUserIds**: `string`[]\n\nDefined in: [src/types/Volunteer/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L34)\n\nArray of user IDs for volunteer group members.\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerMembership.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerMembership\n\nDefined in: [src/types/Volunteer/interface.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L174)\n\nDefines the structure for volunteer membership information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L180)\n\nThe creation date of the volunteer membership record.\n\n***\n\n### createdBy\n\n> **createdBy**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L225)\n\nThe user object who created this membership.\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the creator\n\n#### name\n\n> **name**: `string`\n\nThe name of the creator\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L184)\n\nThe event object associated with the volunteer membership.\n\n#### endAt\n\n> **endAt**: `string`\n\nThe end of the event\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the event\n\n#### name\n\n> **name**: `string`\n\nThe name of the event\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\n##### recurrenceRule.id\n\n> **id**: `string`\n\n#### startAt\n\n> **startAt**: `string`\n\nThe start of the event\n\n***\n\n### group?\n\n> `optional` **group**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L218)\n\n(Optional) The group object associated with the membership.\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the group\n\n#### name\n\n> **name**: `string`\n\nThe name of the group\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L176)\n\nThe unique identifier of the volunteer membership.\n\n***\n\n### status\n\n> **status**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L178)\n\nThe status of the volunteer membership.\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L182)\n\nThe last update date of the volunteer membership record.\n\n***\n\n### updatedBy\n\n> **updatedBy**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L232)\n\nThe user object who last updated this membership.\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the updater\n\n#### name\n\n> **name**: `string`\n\nThe name of the updater\n\n***\n\n### volunteer\n\n> **volunteer**: `object`\n\nDefined in: [src/types/Volunteer/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L198)\n\nThe volunteer object associated with the membership.\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\nWhether the volunteer has accepted\n\n#### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\nHours volunteered\n\n#### id\n\n> **id**: `string`\n\nThe unique identifier of the volunteer\n\n#### user\n\n> **user**: `object`\n\nThe user information of the volunteer\n\n##### user.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nThe avatar URL of the user (optional)\n\n##### user.emailAddress\n\n> **emailAddress**: `string`\n\nThe email address of the user\n\n##### user.id\n\n> **id**: `string`\n\nThe unique identifier of the user\n\n##### user.name\n\n> **name**: `string`\n\nThe name of the user\n" }, { "path": "docs/docs/auto-docs/types/Volunteer/interface/interfaces/InterfaceVolunteerStatus.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerStatus\n\nDefined in: [src/types/Volunteer/interface.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L154)\n\nDefines the structure for volunteer status button configuration.\n\n## Properties\n\n### buttonText\n\n> **buttonText**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L158)\n\nThe text to display on the button.\n\n***\n\n### buttonVariant\n\n> **buttonVariant**: `\"outline-secondary\"` \\| `\"outline-success\"` \\| `\"outline-danger\"` \\| `\"outline-warning\"`\n\nDefined in: [src/types/Volunteer/interface.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L160)\n\nThe Bootstrap variant for the button.\n\n***\n\n### disabled\n\n> **disabled**: `boolean`\n\nDefined in: [src/types/Volunteer/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L166)\n\nWhether the button should be disabled.\n\n***\n\n### icon\n\n> **icon**: `ComponentType`\\<\\{ `className?`: `string`; `size?`: `number`; \\}\\>\n\nDefined in: [src/types/Volunteer/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L168)\n\nThe icon component to display.\n\n***\n\n### status\n\n> **status**: `string`\n\nDefined in: [src/types/Volunteer/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Volunteer/interface.ts#L156)\n\nThe status of the volunteer membership.\n" }, { "path": "docs/docs/auto-docs/types/docker/type-aliases/DockerMode.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DockerMode\n\n> **DockerMode** = `\"ROOTFUL\"` \\| `\"ROOTLESS\"`\n\nDefined in: [src/types/docker.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/docker.ts#L4)\n\nDocker daemon mode options\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/Element.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Element\n\n> **Element** = `ReactSource.Element`\n\nDefined in: [src/types/jsx.d.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementAttributesProperty.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ElementAttributesProperty\n\n> **ElementAttributesProperty** = `ReactSource.ElementAttributesProperty`\n\nDefined in: [src/types/jsx.d.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L11)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementChildrenAttribute.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ElementChildrenAttribute\n\n> **ElementChildrenAttribute** = `ReactSource.ElementChildrenAttribute`\n\nDefined in: [src/types/jsx.d.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/ElementClass.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ElementClass\n\n> **ElementClass** = `ReactSource.ElementClass`\n\nDefined in: [src/types/jsx.d.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicAttributes.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: IntrinsicAttributes\n\n> **IntrinsicAttributes** = `ReactSource.IntrinsicAttributes`\n\nDefined in: [src/types/jsx.d.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L13)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicClassAttributes.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: IntrinsicClassAttributes\\\n\n> **IntrinsicClassAttributes**\\<`T`\\> = `ReactSource.IntrinsicClassAttributes`\\<`T`\\>\n\nDefined in: [src/types/jsx.d.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L15)\n\n## Type Parameters\n\n### T\n\n`T`\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/IntrinsicElements.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: IntrinsicElements\n\n> **IntrinsicElements** = `ReactSource.IntrinsicElements`\n\nDefined in: [src/types/jsx.d.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L17)\n" }, { "path": "docs/docs/auto-docs/types/jsx/namespaces/JSX/type-aliases/LibraryManagedAttributes.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: LibraryManagedAttributes\\\n\n> **LibraryManagedAttributes**\\<`TComponent`, `TProps`\\> = `ReactSource.LibraryManagedAttributes`\\<`TComponent`, `TProps`\\>\n\nDefined in: [src/types/jsx.d.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/jsx.d.ts#L18)\n\n## Type Parameters\n\n### TComponent\n\n`TComponent`\n\n### TProps\n\n`TProps`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IActionItemCategoryInfo\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L3)\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L8)\n\n***\n\n### creatorId?\n\n> `optional` **creatorId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L10)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L6)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L4)\n\n***\n\n### isDisabled\n\n> **isDisabled**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L7)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L5)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L11)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemCategoryList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IActionItemCategoryList\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L14)\n\n## Properties\n\n### actionItemCategoriesByOrganization\n\n> **actionItemCategoriesByOrganization**: [`IActionItemCategoryInfo`](IActionItemCategoryInfo.md)[]\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L15)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IActionItemInfo\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L25)\n\n## Properties\n\n### assignedAt\n\n> **assignedAt**: `Date`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L36)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L29)\n\n***\n\n### category\n\n> **category**: [`IActionItemCategoryInfo`](IActionItemCategoryInfo.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L80)\n\n***\n\n### categoryId\n\n> **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L30)\n\n***\n\n### completionAt\n\n> **completionAt**: `Date`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L37)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L38)\n\n***\n\n### creator\n\n> **creator**: `IActionUserInfo`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L77)\n\n***\n\n### creatorId\n\n> **creatorId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L34)\n\n***\n\n### event\n\n> **event**: [`IEvent`](../../../../Event/interface/interfaces/IEvent.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L78)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L31)\n\n***\n\n### hasExceptions?\n\n> `optional` **hasExceptions**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L43)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L26)\n\n***\n\n### isCompleted\n\n> **isCompleted**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L40)\n\n***\n\n### isInstanceException?\n\n> `optional` **isInstanceException**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L44)\n\n***\n\n### isTemplate?\n\n> `optional` **isTemplate**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L45)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L33)\n\n***\n\n### postCompletionNotes\n\n> **postCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L42)\n\n***\n\n### preCompletionNotes\n\n> **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L41)\n\n***\n\n### recurringEventInstance\n\n> **recurringEventInstance**: [`IEvent`](../../../../Event/interface/interfaces/IEvent.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L79)\n\n***\n\n### recurringEventInstanceId\n\n> **recurringEventInstanceId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L32)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L39)\n\n***\n\n### updaterId\n\n> **updaterId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L35)\n\n***\n\n### volunteer\n\n> **volunteer**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L48)\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\n#### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\n#### id\n\n> **id**: `string`\n\n#### isPublic\n\n> **isPublic**: `boolean`\n\n#### user\n\n> **user**: `object`\n\n##### user.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### user.id\n\n> **id**: `string`\n\n##### user.name\n\n> **name**: `string`\n\n***\n\n### volunteerGroup\n\n> **volunteerGroup**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L59)\n\n#### description\n\n> **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### leader\n\n> **leader**: `object`\n\n##### leader.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### leader.id\n\n> **id**: `string`\n\n##### leader.name\n\n> **name**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### volunteers?\n\n> `optional` **volunteers**: `object`[]\n\n#### volunteersRequired\n\n> **volunteersRequired**: `number`\n\n***\n\n### volunteerGroupId\n\n> **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L28)\n\n***\n\n### volunteerId\n\n> **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L27)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IActionItemList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IActionItemList\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L83)\n\n## Properties\n\n### actionItemsByOrganization\n\n> **actionItemsByOrganization**: [`IActionItemInfo`](IActionItemInfo.md)[]\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L84)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/ICreateActionItemInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreateActionItemInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L87)\n\n## Properties\n\n### assignedAt?\n\n> `optional` **assignedAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L95)\n\n***\n\n### categoryId\n\n> **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L90)\n\n***\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L91)\n\n***\n\n### isTemplate?\n\n> `optional` **isTemplate**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L96)\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L93)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L94)\n\n***\n\n### recurringEventInstanceId?\n\n> `optional` **recurringEventInstanceId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L92)\n\n***\n\n### volunteerGroupId?\n\n> `optional` **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L89)\n\n***\n\n### volunteerId?\n\n> `optional` **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L88)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/ICreateActionItemVariables.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ICreateActionItemVariables\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L99)\n\n## Properties\n\n### input\n\n> **input**: [`ICreateActionItemInput`](ICreateActionItemInput.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L100)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IDeleteActionItemInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IDeleteActionItemInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L113)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L114)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IEventVolunteerGroup.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEventVolunteerGroup\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L171)\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L178)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L179)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L174)\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L198)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L172)\n\n***\n\n### isInstanceException\n\n> **isInstanceException**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L177)\n\n***\n\n### isTemplate\n\n> **isTemplate**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L176)\n\n***\n\n### leader\n\n> **leader**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L184)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L173)\n\n***\n\n### volunteers\n\n> **volunteers**: `object`[]\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L189)\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\n#### id\n\n> **id**: `string`\n\n#### user\n\n> **user**: `object`\n\n##### user.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### user.id\n\n> **id**: `string`\n\n##### user.name\n\n> **name**: `string`\n\n***\n\n### volunteersRequired\n\n> **volunteersRequired**: `number`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L175)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IFormStateType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IFormStateType\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L121)\n\n## Properties\n\n### assignedAt\n\n> **assignedAt**: `Date`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L122)\n\n***\n\n### categoryId\n\n> **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L123)\n\n***\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L126)\n\n***\n\n### isCompleted\n\n> **isCompleted**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L129)\n\n***\n\n### postCompletionNotes\n\n> **postCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L128)\n\n***\n\n### preCompletionNotes\n\n> **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L127)\n\n***\n\n### volunteerGroupId\n\n> **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L125)\n\n***\n\n### volunteerId\n\n> **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L124)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IItemModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IItemModalProps\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L132)\n\n## Properties\n\n### actionItem\n\n> **actionItem**: [`IActionItemInfo`](IActionItemInfo.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L139)\n\n***\n\n### actionItemsRefetch()\n\n> **actionItemsRefetch**: () => `void`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L137)\n\n#### Returns\n\n`void`\n\n***\n\n### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L142)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### editMode\n\n> **editMode**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L140)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L136)\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L134)\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L133)\n\n***\n\n### isRecurring?\n\n> `optional` **isRecurring**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L141)\n\n***\n\n### orgActionItemsRefetch()?\n\n> `optional` **orgActionItemsRefetch**: () => `void`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L138)\n\n#### Returns\n\n`void`\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L135)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IMarkActionItemAsPendingInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IMarkActionItemAsPendingInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L117)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L118)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionForInstanceInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUpdateActionForInstanceInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L161)\n\n## Properties\n\n### actionId\n\n> **actionId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L162)\n\n***\n\n### assignedAt?\n\n> `optional` **assignedAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L167)\n\n***\n\n### categoryId?\n\n> `optional` **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L166)\n\n***\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L163)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L168)\n\n***\n\n### volunteerGroupId?\n\n> `optional` **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L165)\n\n***\n\n### volunteerId?\n\n> `optional` **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L164)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemForInstanceInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUpdateActionItemForInstanceInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L145)\n\n## Properties\n\n### actionId\n\n> **actionId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L146)\n\n***\n\n### assignedAt?\n\n> `optional` **assignedAt**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L154)\n\n***\n\n### categoryId?\n\n> `optional` **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L153)\n\n***\n\n### eventId?\n\n> `optional` **eventId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L150)\n\n***\n\n### isCompleted?\n\n> `optional` **isCompleted**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L149)\n\n***\n\n### postCompletionNotes?\n\n> `optional` **postCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L148)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L147)\n\n***\n\n### volunteerGroupId?\n\n> `optional` **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L152)\n\n***\n\n### volunteerId?\n\n> `optional` **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L151)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemForInstanceVariables.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUpdateActionItemForInstanceVariables\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L157)\n\n## Properties\n\n### input\n\n> **input**: [`IUpdateActionItemForInstanceInput`](IUpdateActionItemForInstanceInput.md)\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L158)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionItems/interface/interfaces/IUpdateActionItemInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUpdateActionItemInput\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L103)\n\n## Properties\n\n### categoryId?\n\n> `optional` **categoryId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L107)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L104)\n\n***\n\n### isCompleted\n\n> **isCompleted**: `boolean`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L108)\n\n***\n\n### postCompletionNotes?\n\n> `optional` **postCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L110)\n\n***\n\n### preCompletionNotes?\n\n> `optional` **preCompletionNotes**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L109)\n\n***\n\n### volunteerGroupId?\n\n> `optional` **volunteerGroupId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L106)\n\n***\n\n### volunteerId?\n\n> `optional` **volunteerId**: `string`\n\nDefined in: [src/types/shared-components/ActionItems/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionItems/interface.ts#L105)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ActionsCell/interface/interfaces/InterfaceActionsCellProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceActionsCellProps\\\n\nDefined in: [src/types/shared-components/ActionsCell/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionsCell/interface.ts#L9)\n\nProps for the ActionsCell component.\n\nUsed to render per-row action buttons in a DataTable.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of the row data\n\n## Properties\n\n### actions\n\n> **actions**: readonly [`IRowAction`](../../../DataTable/hooks/interfaces/IRowAction.md)\\<`T`\\>[]\n\nDefined in: [src/types/shared-components/ActionsCell/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionsCell/interface.ts#L13)\n\nArray of action definitions\n\n***\n\n### row\n\n> **row**: `T`\n\nDefined in: [src/types/shared-components/ActionsCell/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ActionsCell/interface.ts#L11)\n\nThe row data object\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Auth/EmailField/interface/interfaces/InterfaceEmailFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEmailFieldProps\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L10)\n\nProps for the EmailField component.\n\n## Remarks\n\nA specialized field for email input that composes FormField with email-specific defaults.\nSupports optional validator callbacks via the error prop, which accepts string or null.\n\n## Properties\n\n### dataCy?\n\n> `optional` **dataCy**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L33)\n\nOptional data-cy for e2e (Cypress) selectors\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L27)\n\nError message to display - null or undefined means no error\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L12)\n\nOptional label text displayed above the input - defaults to \"Email\"\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L15)\n\nName attribute for the input field - defaults to \"email\"\n\n***\n\n### onChange()\n\n> **onChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L21)\n\nChange handler called when input value changes\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L24)\n\nPlaceholder text for the input - defaults to \"name@example.com\"\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L30)\n\nTest ID for testing purposes\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/Auth/EmailField/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/EmailField/interface.ts#L18)\n\nCurrent email input value\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Auth/FormField/interface/interfaces/InterfaceFormFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormFieldProps\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L9)\n\nProps for the FormField component.\n\n## Remarks\n\nSupports optional validator callbacks and aria-live behaviors for accessibility.\n\n## Properties\n\n### ariaLive?\n\n> `optional` **ariaLive**: `boolean`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L54)\n\nWhether to use aria-live for dynamic error announcements.\nWhen true, error messages are announced to screen readers.\nDefaults to true.\n\n***\n\n### dataCy?\n\n> `optional` **dataCy**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L41)\n\nOptional data-cy for e2e (Cypress) selectors\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L35)\n\nWhether the input is disabled\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L44)\n\nError message to display - null or undefined means no error\n\n***\n\n### helperText?\n\n> `optional` **helperText**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L47)\n\nHelper text to display below the input when no error\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L11)\n\nOptional label text displayed above the input\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L14)\n\nName attribute for the input field (required for form handling)\n\n***\n\n### onBlur()?\n\n> `optional` **onBlur**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L26)\n\nBlur handler called when input loses focus\n\n#### Parameters\n\n##### e\n\n`FocusEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onChange()\n\n> **onChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L23)\n\nChange handler called when input value changes\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L29)\n\nPlaceholder text for the input\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L32)\n\nWhether the field is required - shows asterisk if true\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L38)\n\nTest ID for testing purposes\n\n***\n\n### type?\n\n> `optional` **type**: `\"text\"` \\| `\"email\"` \\| `\"password\"` \\| `\"tel\"`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L17)\n\nInput type - defaults to 'text'\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/Auth/FormField/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/FormField/interface.ts#L20)\n\nCurrent input value\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Auth/PasswordField/interface/interfaces/InterfacePasswordFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePasswordFieldProps\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L7)\n\nProps interface for the PasswordField component.\nExtends basic form field functionality with password visibility toggle features.\n\n## Properties\n\n### dataCy?\n\n> `optional` **dataCy**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L16)\n\nOptional data-cy for e2e (Cypress) selectors\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L13)\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L8)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L9)\n\n***\n\n### onChange()\n\n> **onChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L11)\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onToggleVisibility()?\n\n> `optional` **onToggleVisibility**: () => `void`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L18)\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L12)\n\n***\n\n### showPassword?\n\n> `optional` **showPassword**: `boolean`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L17)\n\n***\n\n### testId?\n\n> `optional` **testId**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L14)\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/Auth/PasswordField/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Auth/PasswordField/interface.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Avatar/interface/interfaces/InterfaceAvatarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAvatarProps\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L1)\n\n## Properties\n\n### alt?\n\n> `optional` **alt**: `string`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L3)\n\n***\n\n### avatarStyle?\n\n> `optional` **avatarStyle**: `string`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L6)\n\n***\n\n### containerStyle?\n\n> `optional` **containerStyle**: `string`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L5)\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L7)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L2)\n\n***\n\n### radius?\n\n> `optional` **radius**: `number`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L8)\n\n***\n\n### size?\n\n> `optional` **size**: `number`\n\nDefined in: [src/types/shared-components/Avatar/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Avatar/interface.ts#L4)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/BaseModal/interface/interfaces/IBaseModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IBaseModalProps\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L30)\n\nBaseModal component props.\n\nA reusable modal wrapper component that standardizes modal structure\nacross the Talawa Admin application. Provides consistent header, body,\nand footer layouts while reducing boilerplate code.\n\n## Remarks\n\nProps:\n- show: Controls modal visibility.\n- onHide: Callback when modal is closed via X button, backdrop click, or Escape key.\n- title: Modal title displayed in header (uses i18n keys).\n- headerContent: Custom header content that overrides the default title and close button.\n- children: Modal body content.\n- footer: Optional footer content with action buttons.\n- size: Modal size variant: sm, lg, xl.\n- centered: Whether to vertically center the modal.\n- backdrop: Backdrop behavior: static prevents close on click, true allows it, false hides backdrop.\n- keyboard: Whether the modal can be closed by pressing the Escape key.\n- className: Additional CSS classes for the modal container.\n- showCloseButton: Whether to show the close button in the header.\n- closeButtonVariant: Bootstrap button variant for the close button.\n- headerClassName: Additional CSS classes for the modal header.\n- headerTestId: Test ID for the modal header.\n- bodyClassName: Additional CSS classes for the modal body.\n- footerClassName: Additional CSS classes for the modal footer.\n- dataTestId: Test ID for automated testing.\n- id: Optional HTML id attribute for the modal container element.\n\n## Properties\n\n### backdrop?\n\n> `optional` **backdrop**: `boolean` \\| `\"static\"`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L39)\n\n***\n\n### bodyClassName?\n\n> `optional` **bodyClassName**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L46)\n\n***\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L38)\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L35)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L41)\n\n***\n\n### closeButtonVariant?\n\n> `optional` **closeButtonVariant**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L43)\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L49)\n\n***\n\n### footer?\n\n> `optional` **footer**: `ReactNode`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L36)\n\n***\n\n### footerClassName?\n\n> `optional` **footerClassName**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L47)\n\n***\n\n### headerClassName?\n\n> `optional` **headerClassName**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L44)\n\n***\n\n### headerContent?\n\n> `optional` **headerContent**: `ReactNode`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L34)\n\n***\n\n### headerTestId?\n\n> `optional` **headerTestId**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L45)\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L48)\n\n***\n\n### keyboard?\n\n> `optional` **keyboard**: `boolean`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L40)\n\n***\n\n### onHide()\n\n> **onHide**: () => `void`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L32)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L31)\n\n***\n\n### showCloseButton?\n\n> `optional` **showCloseButton**: `boolean`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L42)\n\n***\n\n### size?\n\n> `optional` **size**: `\"sm\"` \\| `\"lg\"` \\| `\"xl\"`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L37)\n\n***\n\n### title?\n\n> `optional` **title**: `ReactNode`\n\nDefined in: [src/types/shared-components/BaseModal/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BaseModal/interface.ts#L33)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/BreadcrumbsComponent/interface/interfaces/IBreadcrumbItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IBreadcrumbItem\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L7)\n\nInterface for individual breadcrumb items.\n\nSupports i18n via translation keys, optional navigation,\nand current page marking for accessibility.\n\n## Properties\n\n### isCurrent?\n\n> `optional` **isCurrent**: `boolean`\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L36)\n\nMarks the breadcrumb as the current page.\n\n#### Remarks\n\n- This flag is optional and evaluated at runtime by the BreadcrumbsComponent.\n- If omitted, the component treats the last breadcrumb item as current by convention.\n- If multiple items are marked `isCurrent: true`, the first encountered\n item will be rendered as the active breadcrumb.\n\nApplies `aria-current=\"page\"` for accessibility.\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L17)\n\nFallback label when no translation key is provided.\n\n***\n\n### to?\n\n> `optional` **to**: `string`\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L23)\n\nNavigation path for React Router `Link`.\nIf omitted, breadcrumb is rendered as plain text.\n\n***\n\n### translationKey?\n\n> `optional` **translationKey**: `string`\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L12)\n\ni18n translation key for the breadcrumb label.\nTakes precedence over `label` if provided.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/BreadcrumbsComponent/interface/interfaces/IBreadcrumbsComponentProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IBreadcrumbsComponentProps\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L42)\n\nProps for the BreadcrumbsComponent.\n\n## Properties\n\n### ariaLabelTranslationKey?\n\n> `optional` **ariaLabelTranslationKey**: `string`\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L55)\n\nOptional aria-label translation key for the navigation landmark.\n\n#### Remarks\n\n- Key is resolved from the `common` i18n namespace.\n- Defaults to `'breadcrumbs'` (i.e., `common.breadcrumbs`).\n\n***\n\n### items\n\n> **items**: [`IBreadcrumbItem`](IBreadcrumbItem.md)[]\n\nDefined in: [src/types/shared-components/BreadcrumbsComponent/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BreadcrumbsComponent/interface.ts#L46)\n\nList of breadcrumb items to render.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/BulkActionsBar/interface/interfaces/InterfaceBulkActionsBarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBulkActionsBarProps\n\nDefined in: [src/types/shared-components/BulkActionsBar/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BulkActionsBar/interface.ts#L8)\n\nProps for the BulkActionsBar component.\n\nUsed to display a toolbar when rows are selected in a DataTable.\n\n## Properties\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/BulkActionsBar/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BulkActionsBar/interface.ts#L12)\n\nBulk action buttons to render\n\n***\n\n### count\n\n> **count**: `number`\n\nDefined in: [src/types/shared-components/BulkActionsBar/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BulkActionsBar/interface.ts#L10)\n\nNumber of selected rows\n\n***\n\n### onClear()\n\n> **onClear**: () => `void`\n\nDefined in: [src/types/shared-components/BulkActionsBar/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/BulkActionsBar/interface.ts#L14)\n\nCallback to clear selection\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCRUDModalTemplateProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCRUDModalTemplateProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L92)\n\nProps for the base CRUDModalTemplate component\n\nThis is the foundation component that all specialized modal templates build upon.\n\n## Extends\n\n- [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered)\n\n***\n\n### children?\n\n> `optional` **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L96)\n\nContent to render inside the modal body\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname)\n\n***\n\n### customFooter?\n\n> `optional` **customFooter**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L127)\n\nCustom footer content to replace the default action buttons\nWhen provided, primaryText, secondaryText, and onPrimary are ignored\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error)\n\n***\n\n### hideSecondary?\n\n> `optional` **hideSecondary**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L121)\n\nWhether to hide the secondary (cancel) button\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose)\n\n***\n\n### onPrimary()?\n\n> `optional` **onPrimary**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L102)\n\nCallback function for the primary action button\nIf not provided, the primary button will not be rendered\n\n#### Returns\n\n`void`\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open)\n\n***\n\n### primaryDisabled?\n\n> `optional` **primaryDisabled**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L115)\n\nWhether to disable the primary button\nAutomatically disabled when loading is true\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext)\n\n***\n\n### primaryVariant?\n\n> `optional` **primaryVariant**: `\"primary\"` \\| `\"success\"` \\| `\"danger\"`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L108)\n\nVariant style for the primary button\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext)\n\n***\n\n### showFooter?\n\n> `optional` **showFooter**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L133)\n\nWhether to show the modal footer at all\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCreateModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateModalProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L141)\n\nProps for CreateModal template\n\nSpecialized template for creating new entities with form submission.\n\n## Extends\n\n- [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered)\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L145)\n\nForm content to render inside the modal body\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error)\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose)\n\n***\n\n### onSubmit()\n\n> **onSubmit**: (`event`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L151)\n\nCallback function invoked when the form is submitted\nShould handle the creation logic and return a Promise\n\n#### Parameters\n\n##### event\n\n`FormEvent`\\<`HTMLFormElement`\\>\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open)\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext)\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext)\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size)\n\n***\n\n### submitDisabled?\n\n> `optional` **submitDisabled**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L158)\n\nWhether the submit button should be disabled\nUseful for form validation\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceCrudModalBaseProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCrudModalBaseProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L22)\n\nBase props shared by all CRUD modal templates\n\nThese properties are common across all modal types and provide\nthe fundamental functionality for opening, closing, and displaying modals.\n\n## Extended by\n\n- [`InterfaceCRUDModalTemplateProps`](InterfaceCRUDModalTemplateProps.md)\n- [`InterfaceCreateModalProps`](InterfaceCreateModalProps.md)\n- [`InterfaceEditModalProps`](InterfaceEditModalProps.md)\n- [`InterfaceDeleteModalProps`](InterfaceDeleteModalProps.md)\n- [`InterfaceViewModalProps`](InterfaceViewModalProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceDeleteModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDeleteModalProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L198)\n\nProps for DeleteModal template\n\nSpecialized template for delete confirmation dialogs.\n\n## Extends\n\n- [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered)\n\n***\n\n### children?\n\n> `optional` **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L203)\n\nOptional custom content to display in the modal body\nIf not provided, shows the confirmationMessage\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid)\n\n***\n\n### entityName?\n\n> `optional` **entityName**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L215)\n\nName of the entity being deleted (for display purposes)\nWhen provided, will be shown in the confirmation message\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error)\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading)\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose)\n\n***\n\n### onDelete()\n\n> **onDelete**: () => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L209)\n\nCallback function invoked when deletion is confirmed\nShould handle the delete logic and return a Promise\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open)\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext)\n\n***\n\n### recurringEventContent?\n\n> `optional` **recurringEventContent**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L227)\n\nOptional content to display for recurring event support\nAllows users to choose between deleting series or single instance\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext)\n\n***\n\n### showWarning?\n\n> `optional` **showWarning**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:221](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L221)\n\nWhether to show warning styling (danger variant)\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceEditModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEditModalProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L167)\n\nProps for EditModal template\n\nSpecialized template for editing existing entities.\nParent component handles data fetching and passes pre-populated form fields as children.\n\n## Extends\n\n- [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered)\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L172)\n\nForm content to render inside the modal body\nParent should pass form fields pre-populated with entity data\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error)\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading)\n\n***\n\n### loadingData?\n\n> `optional` **loadingData**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L184)\n\nWhether data is currently being loaded\nShows a loading state while fetching entity data\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose)\n\n***\n\n### onSubmit()\n\n> **onSubmit**: (`event`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L178)\n\nCallback function invoked when the form is submitted\nShould handle the update logic and return a Promise\n\n#### Parameters\n\n##### event\n\n`FormEvent`\\<`HTMLFormElement`\\>\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open)\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext)\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext)\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size)\n\n***\n\n### submitDisabled?\n\n> `optional` **submitDisabled**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L190)\n\nWhether the submit button should be disabled\nUseful for dirty form checking\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceModalFormState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceModalFormState\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:260](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L260)\n\nCommon form state for modals\n\nHelper type for managing form state in modal components\n\n## Properties\n\n### errors?\n\n> `optional` **errors**: `Record`\\<`string`, `string`\\>\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L274)\n\nForm validation errors\n\n***\n\n### isDirty?\n\n> `optional` **isDirty**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:264](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L264)\n\nWhether the form has unsaved changes\n\n***\n\n### isSubmitting?\n\n> `optional` **isSubmitting**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L269)\n\nWhether the form is currently being submitted\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceRecurringEventProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurringEventProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:282](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L282)\n\nProps for recurring event pattern support\n\nCommon pattern for modals that handle recurring events\n\n## Properties\n\n### applyTo?\n\n> `optional` **applyTo**: `\"series\"` \\| `\"instance\"`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L296)\n\nCurrent selection: apply to entire series or single instance\n\n***\n\n### baseEventId?\n\n> `optional` **baseEventId**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L291)\n\nBase event ID for recurring series\n\n***\n\n### isRecurring?\n\n> `optional` **isRecurring**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L286)\n\nWhether the event is recurring\n\n***\n\n### onApplyToChange()?\n\n> `optional` **onApplyToChange**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:301](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L301)\n\nCallback when applyTo selection changes\n\n#### Parameters\n\n##### value\n\n`\"series\"` | `\"instance\"`\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseFormModalReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUseFormModalReturn\\\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:321](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L321)\n\nReturn type for useFormModal hook\n\n## Extends\n\n- [`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md)\n\n## Extended by\n\n- [`InterfaceUseMutationModalReturn`](InterfaceUseMutationModalReturn.md)\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Properties\n\n### close()\n\n> **close**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:313](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L313)\n\nCloses the modal\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`close`](InterfaceUseModalStateReturn.md#close)\n\n***\n\n### formData\n\n> **formData**: `T`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L325)\n\nForm data being edited\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:309](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L309)\n\nWhether the modal is currently open\n\n#### Inherited from\n\n[`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`isOpen`](InterfaceUseModalStateReturn.md#isopen)\n\n***\n\n### isSubmitting\n\n> **isSubmitting**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:331](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L331)\n\nWhether the form is currently submitting\n\n***\n\n### open()\n\n> **open**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L311)\n\nOpens the modal\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`open`](InterfaceUseModalStateReturn.md#open)\n\n***\n\n### openWithData()\n\n> **openWithData**: (`data`) => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:327](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L327)\n\nSets the form data and opens the modal\n\n#### Parameters\n\n##### data\n\n`T`\n\n#### Returns\n\n`void`\n\n***\n\n### reset()\n\n> **reset**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:329](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L329)\n\nResets form data and closes the modal\n\n#### Returns\n\n`void`\n\n***\n\n### setIsSubmitting()\n\n> **setIsSubmitting**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:333](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L333)\n\nSets the submitting state\n\n#### Parameters\n\n##### value\n\n`boolean`\n\n#### Returns\n\n`void`\n\n***\n\n### toggle()\n\n> **toggle**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L315)\n\nToggles the modal open/close state\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseModalStateReturn`](InterfaceUseModalStateReturn.md).[`toggle`](InterfaceUseModalStateReturn.md#toggle)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseModalStateReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUseModalStateReturn\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:307](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L307)\n\nReturn type for useModalState hook\n\n## Extended by\n\n- [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md)\n\n## Properties\n\n### close()\n\n> **close**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:313](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L313)\n\nCloses the modal\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:309](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L309)\n\nWhether the modal is currently open\n\n***\n\n### open()\n\n> **open**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L311)\n\nOpens the modal\n\n#### Returns\n\n`void`\n\n***\n\n### toggle()\n\n> **toggle**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L315)\n\nToggles the modal open/close state\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceUseMutationModalReturn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUseMutationModalReturn\\\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:339](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L339)\n\nReturn type for useMutationModal hook\n\n## Extends\n\n- [`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md)\\<`TData`\\>\n\n## Type Parameters\n\n### TData\n\n`TData`\n\n### TResult\n\n`TResult` = `unknown`\n\n## Properties\n\n### clearError()\n\n> **clearError**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:349](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L349)\n\nClears the error state\n\n#### Returns\n\n`void`\n\n***\n\n### close()\n\n> **close**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:313](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L313)\n\nCloses the modal\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`close`](InterfaceUseFormModalReturn.md#close)\n\n***\n\n### error\n\n> **error**: `Error`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:347](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L347)\n\nError from the last mutation attempt\n\n***\n\n### execute()\n\n> **execute**: (`data?`) => `Promise`\\<`TResult`\\>\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:345](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L345)\n\nExecutes the mutation with current form data\n\n#### Parameters\n\n##### data?\n\n`TData`\n\n#### Returns\n\n`Promise`\\<`TResult`\\>\n\n***\n\n### formData\n\n> **formData**: `TData`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L325)\n\nForm data being edited\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`formData`](InterfaceUseFormModalReturn.md#formdata)\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:309](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L309)\n\nWhether the modal is currently open\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`isOpen`](InterfaceUseFormModalReturn.md#isopen)\n\n***\n\n### isSubmitting\n\n> **isSubmitting**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:331](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L331)\n\nWhether the form is currently submitting\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`isSubmitting`](InterfaceUseFormModalReturn.md#issubmitting)\n\n***\n\n### open()\n\n> **open**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L311)\n\nOpens the modal\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`open`](InterfaceUseFormModalReturn.md#open)\n\n***\n\n### openWithData()\n\n> **openWithData**: (`data`) => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:327](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L327)\n\nSets the form data and opens the modal\n\n#### Parameters\n\n##### data\n\n`TData`\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`openWithData`](InterfaceUseFormModalReturn.md#openwithdata)\n\n***\n\n### reset()\n\n> **reset**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:329](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L329)\n\nResets form data and closes the modal\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`reset`](InterfaceUseFormModalReturn.md#reset)\n\n***\n\n### setIsSubmitting()\n\n> **setIsSubmitting**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:333](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L333)\n\nSets the submitting state\n\n#### Parameters\n\n##### value\n\n`boolean`\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`setIsSubmitting`](InterfaceUseFormModalReturn.md#setissubmitting)\n\n***\n\n### toggle()\n\n> **toggle**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L315)\n\nToggles the modal open/close state\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceUseFormModalReturn`](InterfaceUseFormModalReturn.md).[`toggle`](InterfaceUseFormModalReturn.md#toggle)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/interfaces/InterfaceViewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceViewModalProps\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L236)\n\nProps for ViewModal template\n\nSpecialized template for read-only entity display.\nParent component handles data fetching and passes formatted content as children.\n\n## Extends\n\n- [`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md)\n\n## Properties\n\n### centered?\n\n> `optional` **centered**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L79)\n\nWhether to center the modal vertically on the page\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`centered`](InterfaceCrudModalBaseProps.md#centered)\n\n***\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L241)\n\nContent to display in the modal body\nParent should pass formatted data display as children\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L73)\n\nAdditional CSS class name for the modal\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`className`](InterfaceCrudModalBaseProps.md#classname)\n\n***\n\n### customActions?\n\n> `optional` **customActions**: `ReactNode`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L252)\n\nOptional custom action buttons to display in the footer\nUseful for actions like \"Edit\" or \"Delete\" from the view modal\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L84)\n\nTest ID for the modal container (useful for testing)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`data-testid`](InterfaceCrudModalBaseProps.md#data-testid)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L62)\n\nError message to display in the modal body\nWhen provided, shows an Alert component with the error\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`error`](InterfaceCrudModalBaseProps.md#error)\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L56)\n\nIndicates whether an async operation is in progress\nWhen true, displays a loading spinner and disables action buttons\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`loading`](InterfaceCrudModalBaseProps.md#loading)\n\n***\n\n### loadingData?\n\n> `optional` **loadingData**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L246)\n\nWhether data is currently being loaded\n\n***\n\n### onClose()\n\n> **onClose**: () => `void`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L37)\n\nCallback function invoked when the modal is closed\nTriggered by close button, backdrop click, or Escape key\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`onClose`](InterfaceCrudModalBaseProps.md#onclose)\n\n***\n\n### open?\n\n> `optional` **open**: `boolean`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L26)\n\nControls whether the modal is visible (defaults to false)\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`open`](InterfaceCrudModalBaseProps.md#open)\n\n***\n\n### primaryText?\n\n> `optional` **primaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L43)\n\nText for the primary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`primaryText`](InterfaceCrudModalBaseProps.md#primarytext)\n\n***\n\n### secondaryText?\n\n> `optional` **secondaryText**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L49)\n\nText for the secondary action button\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`secondaryText`](InterfaceCrudModalBaseProps.md#secondarytext)\n\n***\n\n### size?\n\n> `optional` **size**: [`ModalSize`](../type-aliases/ModalSize.md)\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L68)\n\nModal size variant\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`size`](InterfaceCrudModalBaseProps.md#size)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L31)\n\nModal title displayed in the header\n\n#### Inherited from\n\n[`InterfaceCrudModalBaseProps`](InterfaceCrudModalBaseProps.md).[`title`](InterfaceCrudModalBaseProps.md#title)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CRUDModalTemplate/interface/type-aliases/ModalSize.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ModalSize\n\n> **ModalSize** = `\"sm\"` \\| `\"lg\"` \\| `\"xl\"`\n\nDefined in: [src/types/shared-components/CRUDModalTemplate/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CRUDModalTemplate/interface.ts#L14)\n\nSize variants for modals\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceAttendeeCheckIn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAttendeeCheckIn\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L7)\n\n## Properties\n\n### checkInTime\n\n> **checkInTime**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L10)\n\n***\n\n### checkOutTime\n\n> **checkOutTime**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L11)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L8)\n\n***\n\n### isCheckedIn\n\n> **isCheckedIn**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L12)\n\n***\n\n### isCheckedOut\n\n> **isCheckedOut**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L13)\n\n***\n\n### user\n\n> **user**: [`InterfaceUser`](InterfaceUser.md)\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceAttendeeQueryResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAttendeeQueryResponse\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L16)\n\n## Properties\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L17)\n\n#### attendeesCheckInStatus\n\n> **attendeesCheckInStatus**: [`InterfaceAttendeeCheckIn`](InterfaceAttendeeCheckIn.md)[]\n\n#### id\n\n> **id**: `string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceModalProp.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceModalProp\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L23)\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L25)\n\n***\n\n### handleClose()\n\n> **handleClose**: () => `void`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L26)\n\n#### Returns\n\n`void`\n\n***\n\n### onCheckInUpdate()?\n\n> `optional` **onCheckInUpdate**: () => `void`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L27)\n\n#### Returns\n\n`void`\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L24)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceTableCheckIn.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTableCheckIn\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L30)\n\n## Properties\n\n### checkInTime\n\n> **checkInTime**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L34)\n\n***\n\n### checkOutTime\n\n> **checkOutTime**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L35)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L38)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L31)\n\n***\n\n### isCheckedIn\n\n> **isCheckedIn**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L36)\n\n***\n\n### isCheckedOut\n\n> **isCheckedOut**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L37)\n\n***\n\n### isRecurring?\n\n> `optional` **isRecurring**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L39)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L32)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L33)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceTableData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTableData\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L42)\n\n## Properties\n\n### checkInData\n\n> **checkInData**: [`InterfaceTableCheckIn`](InterfaceTableCheckIn.md)\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L45)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L44)\n\n***\n\n### userName\n\n> **userName**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L43)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/interface/interfaces/InterfaceUser.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUser\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L1)\n\n## Properties\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L4)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L2)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/interface.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/interface.ts#L3)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckIn.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CheckIn\n\n> **CheckIn** = `object`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L4)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L5)\n\n***\n\n### allotedRoom?\n\n> `optional` **allotedRoom**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L6)\n\n***\n\n### allotedSeat?\n\n> `optional` **allotedSeat**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L7)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L8)\n\n***\n\n### event\n\n> **event**: [`Event`](../../../../Event/type/type-aliases/Event.md)\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L9)\n\n***\n\n### feedbackSubmitted\n\n> **feedbackSubmitted**: `boolean`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L10)\n\n***\n\n### time\n\n> **time**: `Date`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L11)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `Date`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L12)\n\n***\n\n### user\n\n> **user**: [`User`](../../../User/type/type-aliases/User.md)\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L13)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckInInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CheckInInput\n\n> **CheckInInput** = `object`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L16)\n\n## Properties\n\n### allotedRoom?\n\n> `optional` **allotedRoom**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L17)\n\n***\n\n### allotedSeat?\n\n> `optional` **allotedSeat**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L18)\n\n***\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L19)\n\n***\n\n### userId\n\n> **userId**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L20)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckIn/type/type-aliases/CheckInStatus.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CheckInStatus\n\n> **CheckInStatus** = `object`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L23)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L24)\n\n***\n\n### checkIn?\n\n> `optional` **checkIn**: [`CheckIn`](CheckIn.md)\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L25)\n\n***\n\n### user\n\n> **user**: [`User`](../../../User/type/type-aliases/User.md)\n\nDefined in: [src/types/shared-components/CheckIn/type.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckIn/type.ts#L26)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/CheckInWrapper/interface/interfaces/InterfaceCheckInWrapperProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCheckInWrapperProps\n\nDefined in: [src/types/shared-components/CheckInWrapper/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckInWrapper/interface.ts#L4)\n\nProps for CheckInWrapper component.\n\n## Properties\n\n### eventId\n\n> **eventId**: `string`\n\nDefined in: [src/types/shared-components/CheckInWrapper/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckInWrapper/interface.ts#L6)\n\nThe unique identifier of the event for which members are being checked in.\n\n***\n\n### onCheckInUpdate()?\n\n> `optional` **onCheckInUpdate**: () => `void`\n\nDefined in: [src/types/shared-components/CheckInWrapper/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/CheckInWrapper/interface.ts#L8)\n\nOptional callback invoked after check-in updates.\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/column/interfaces/IColumnDef.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IColumnDef\\\n\nDefined in: [src/types/shared-components/DataTable/column.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L13)\n\nColumn definition for DataTable.\n\nSpecifies how a column should render, behave, and interact with sorting, filtering,\nand searching. Each column maps to a specific property or accessor within row data.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n### TValue\n\n`TValue` = `unknown`\n\nThe type of the value extracted by the accessor (defaults to unknown)\n\n## Properties\n\n### accessor\n\n> **accessor**: [`Accessor`](../../types/type-aliases/Accessor.md)\\<`T`, `TValue`\\>\n\nDefined in: [src/types/shared-components/DataTable/column.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L19)\n\nAccessor function or key to extract the value from row data\n\n***\n\n### header\n\n> **header**: [`HeaderRender`](../../types/type-aliases/HeaderRender.md)\n\nDefined in: [src/types/shared-components/DataTable/column.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L17)\n\nColumn header text or React component to render\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/DataTable/column.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L15)\n\nUnique identifier for this column\n\n***\n\n### meta?\n\n> `optional` **meta**: `object`\n\nDefined in: [src/types/shared-components/DataTable/column.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L32)\n\nMetadata and configuration for column behavior.\n\n#### align?\n\n> `optional` **align**: `\"left\"` \\| `\"right\"` \\| `\"center\"`\n\nText alignment for cell content ('left', 'center', or 'right')\n\n#### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nARIA label for accessibility when header content is not descriptive\n\n#### filterable?\n\n> `optional` **filterable**: `boolean`\n\nWhether this column supports filtering (default: false)\n\n#### filterFn()?\n\n> `optional` **filterFn**: (`row`, `value`) => `boolean`\n\nCustom filter predicate to match rows against a filter value.\n\n##### Parameters\n\n###### row\n\n`T`\n\nRow to evaluate\n\n###### value\n\n`unknown`\n\nFilter value to match against\n\n##### Returns\n\n`boolean`\n\ntrue if row matches the filter\n\n#### getSearchValue()?\n\n> `optional` **getSearchValue**: (`row`) => `string`\n\nCustom function to extract searchable text from a row.\nUsed when performing global search on this column.\n\n##### Parameters\n\n###### row\n\n`T`\n\nRow data to extract search value from\n\n##### Returns\n\n`string`\n\nString representation for search matching\n\n#### searchable?\n\n> `optional` **searchable**: `boolean`\n\nWhether this column is included in global search (default: false)\n\n#### sortable?\n\n> `optional` **sortable**: `boolean`\n\nWhether this column supports sorting (default: true)\n\n#### sortFn()?\n\n> `optional` **sortFn**: (`a`, `b`) => `number`\n\nCustom comparator function for sorting this column.\n\n##### Parameters\n\n###### a\n\n`T`\n\nFirst row for comparison\n\n###### b\n\n`T`\n\nSecond row for comparison\n\n##### Returns\n\n`number`\n\nNegative if a \\< b, 0 if equal, positive if a \\> b\n\n#### width?\n\n> `optional` **width**: `string` \\| `number`\n\nCSS width for this column (e.g., '100px', '20%')\n\n***\n\n### render()?\n\n> `optional` **render**: (`value`, `row`) => `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/column.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/column.ts#L28)\n\nOptional custom render function for cell values.\nReceives the extracted value and the full row data.\n\n#### Parameters\n\n##### value\n\n`TValue`\n\nThe value extracted by the accessor\n\n##### row\n\n`T`\n\nThe complete row data object\n\n#### Returns\n\n`ReactNode`\n\nReact node to render in the cell\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IBulkAction.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IBulkAction\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L157)\n\nConfiguration for an action available on bulk-selected rows.\n\nBulk actions operate on multiple selected rows at once and typically\ninvolve server mutations or data processing.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of row data this action operates on\n\n## Properties\n\n### confirm?\n\n> `optional` **confirm**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L179)\n\nOptional confirmation message to display before executing the action\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean` \\| (`rows`, `keys`) => `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L177)\n\nWhether this action is disabled for the current selection.\nCan be a boolean or a function that evaluates the selection.\n\n#### Param\n\nArray of selected rows\n\n#### Param\n\nArray of keys for the selected rows\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L159)\n\nUnique identifier for this action\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L161)\n\nDisplay label for the bulk action button\n\n***\n\n### onClick()\n\n> **onClick**: (`rows`, `keys`) => `void` \\| `Promise`\\<`void`\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L170)\n\nCallback fired when the bulk action is triggered.\nCan be async to support server operations.\n\n#### Parameters\n\n##### rows\n\n`T`[]\n\nArray of selected rows\n\n##### keys\n\n[`Key`](../../types/type-aliases/Key.md)[]\n\nArray of keys for the selected rows\n\n#### Returns\n\n`void` \\| `Promise`\\<`void`\\>\n\n`void` or `Promise` if async\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IRowAction.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IRowAction\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L129)\n\nConfiguration for an action available on individual table rows.\n\nRow actions appear as contextual buttons or menu items for each row,\nallowing users to perform operations on specific row data.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of row data this action operates on\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L146)\n\nARIA label for accessibility when label alone is not descriptive\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean` \\| (`row`) => `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L144)\n\nWhether this action is disabled.\nCan be a boolean or a function that evaluates the row to determine disabled state.\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L131)\n\nUnique identifier for this action\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L133)\n\nDisplay label for the action button or menu item\n\n***\n\n### onClick()\n\n> **onClick**: (`row`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L139)\n\nCallback fired when the action is triggered on a row.\n\n#### Parameters\n\n##### row\n\n`T`\n\nThe row data the action was triggered for\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseDataTableFilteringOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseDataTableFilteringOptions\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L96)\n\nConfiguration options for table data filtering and search functionality.\n\nProvides comprehensive filtering capabilities including global search across all rows,\nper-column filtering, and control over client-side vs server-side filtering behavior.\nSupports pagination mode detection to manage page reset behavior during filtering.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### columnFilters?\n\n> `optional` **columnFilters**: `Record`\\<`string`, `unknown`\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L108)\n\nRecord of column-specific filter values, keyed by column ID\n\n***\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L100)\n\nColumn definitions that determine which columns are searchable or filterable\n\n***\n\n### data?\n\n> `optional` **data**: `T`[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L98)\n\nArray of row data to filter and search\n\n***\n\n### globalSearch?\n\n> `optional` **globalSearch**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L104)\n\nCurrent global search query string to match against row data\n\n***\n\n### initialGlobalSearch?\n\n> `optional` **initialGlobalSearch**: `string`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L102)\n\nInitial value for global search query, used on mount\n\n***\n\n### onColumnFiltersChange()?\n\n> `optional` **onColumnFiltersChange**: (`filters`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L110)\n\nCallback fired when column filters change, receives updated filter record\n\n#### Parameters\n\n##### filters\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onGlobalSearchChange()?\n\n> `optional` **onGlobalSearchChange**: (`q`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L106)\n\nCallback fired when global search query changes, receives new query string\n\n#### Parameters\n\n##### q\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### onPageReset()?\n\n> `optional` **onPageReset**: () => `void`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L118)\n\nCallback to reset pagination to first page when filters change\n\n#### Returns\n\n`void`\n\n***\n\n### paginationMode?\n\n> `optional` **paginationMode**: `\"client\"` \\| `\"server\"` \\| `\"none\"`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L116)\n\nCurrent pagination mode: 'client' for local paging, 'server' for remote paging, 'none' for no pagination\n\n***\n\n### serverFilter?\n\n> `optional` **serverFilter**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L114)\n\nWhether column filtering is handled server-side instead of client-side\n\n***\n\n### serverSearch?\n\n> `optional` **serverSearch**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L112)\n\nWhether search functionality is handled server-side instead of client-side\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseDataTableSelectionOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseDataTableSelectionOptions\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L190)\n\nConfiguration options for row selection in a DataTable.\n\nControls how rows can be selected, which rows are selectable,\nand provides callbacks for selection changes and bulk actions.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of row data in the table\n\n## Properties\n\n### bulkActions?\n\n> `optional` **bulkActions**: readonly [`IBulkAction`](IBulkAction.md)\\<`T`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L207)\n\nArray of bulk actions available for selected rows\n\n***\n\n### initialSelectedKeys?\n\n> `optional` **initialSelectedKeys**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L205)\n\nInitial set of selected rows on component mount\n\n***\n\n### keysOnPage\n\n> **keysOnPage**: [`Key`](../../types/type-aliases/Key.md)[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L194)\n\nArray of keys for rows on the current page\n\n***\n\n### onSelectionChange()?\n\n> `optional` **onSelectionChange**: (`next`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L203)\n\nCallback fired when the selection changes.\nReceives a new immutable set of selected keys.\n\n#### Parameters\n\n##### next\n\n`ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### paginatedData\n\n> **paginatedData**: readonly `T`[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L192)\n\nArray of rows currently shown on the page\n\n***\n\n### selectable?\n\n> `optional` **selectable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L196)\n\nWhether row selection is enabled for this table\n\n***\n\n### selectedKeys?\n\n> `optional` **selectedKeys**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L198)\n\nSet of currently selected row keys\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseTableDataOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseTableDataOptions\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L32)\n\nConfiguration options for fetching table data from a GraphQL connection.\n\nSupports extracting rows from GraphQL Relay connection patterns and transforming\nnodes into the desired row format. Integrates with Apollo Client for query management.\n\n## Type Parameters\n\n### TNode\n\n`TNode`\n\nThe raw node type from the GraphQL connection\n\n### TRow\n\n`TRow`\n\nThe transformed row type after processing (may differ from TNode)\n\n### TData\n\n`TData` = `unknown`\n\nThe complete GraphQL query result data shape\n\n## Properties\n\n### deps?\n\n> `optional` **deps**: `DependencyList`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L47)\n\nReact dependency array to control when the data fetching updates\n\n***\n\n### path\n\n> **path**: `DataPath`\\<`TNode`, `TData`\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L37)\n\nPath to the connection data within the query result.\nCan be a function that extracts the connection from data, or an array of keys/indices.\n\n***\n\n### transformNode()?\n\n> `optional` **transformNode**: (`node`) => `TRow`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L45)\n\nOptional transform function to convert raw node data into row format.\nCalled for each node in the connection.\n\n#### Parameters\n\n##### node\n\n`TNode`\n\nThe raw node from the connection\n\n#### Returns\n\n`TRow`\n\nTransformed row data, or null/undefined to exclude the node\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/hooks/interfaces/IUseTableDataResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IUseTableDataResult\\\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L59)\n\nResult object from a table data fetching hook.\n\nContains the processed rows, loading states, error information, and methods to\nrefetch data or fetch additional pages in a paginated result set.\n\n## Type Parameters\n\n### TRow\n\n`TRow`\n\nThe type of data for each row\n\n### TData\n\n`TData` = `unknown`\n\nThe shape of the complete GraphQL query result\n\n## Properties\n\n### error\n\n> **error**: `Error`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L67)\n\nError from the most recent query or fetch operation\n\n***\n\n### fetchMore()\n\n> **fetchMore**: \\<`TFetchData`, `TFetchVars`\\>(`fetchMoreOptions`) => `Promise`\\<`ApolloQueryResult`\\<`TFetchData`\\>\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L79)\n\nFunction to fetch additional pages or update pagination cursors.\nFollows Apollo Client's fetchMore signature.\n\n#### Type Parameters\n\n##### TFetchData\n\n`TFetchData` = `TData`\n\n##### TFetchVars\n\n`TFetchVars` *extends* `OperationVariables` = `OperationVariables`\n\n#### Parameters\n\n##### fetchMoreOptions\n\n`FetchMoreQueryOptions`\\<`TFetchVars`, `TFetchData`\\> & `object`\n\n#### Returns\n\n`Promise`\\<`ApolloQueryResult`\\<`TFetchData`\\>\\>\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L63)\n\nWhether the initial data fetch is in progress\n\n***\n\n### loadingMore\n\n> **loadingMore**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L65)\n\nWhether additional pages are currently being fetched\n\n***\n\n### networkStatus\n\n> **networkStatus**: `NetworkStatus`\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L84)\n\nApollo Client network status code.\n1 = loading, 4 = setVariables, 6 = refetch, 7 = poll, 8 = ready, etc.\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfo`](../../pagination/interfaces/InterfacePageInfo.md)\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L69)\n\nPagination state including cursors and next/previous page availability\n\n***\n\n### refetch()\n\n> **refetch**: (`variables?`) => `Promise`\\<`ApolloQueryResult`\\<`TData`\\>\\>\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L74)\n\nFunction to refetch the query with fresh data.\nTypically used to refresh after mutations.\n\n#### Parameters\n\n##### variables?\n\n`Partial`\\<`TVariables`\\>\n\n#### Returns\n\n`Promise`\\<`ApolloQueryResult`\\<`TData`\\>\\>\n\n***\n\n### rows\n\n> **rows**: `TRow`[]\n\nDefined in: [src/types/shared-components/DataTable/hooks.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/hooks.ts#L61)\n\nArray of processed rows ready for display in the table\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/pagination/interfaces/InterfacePageInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePageInfo\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L7)\n\nPagination state information for cursor-based pagination.\n\nUsed in GraphQL Relay connection pattern to track pagination cursors\nand availability of next/previous pages.\n\n## Properties\n\n### endCursor?\n\n> `optional` **endCursor**: `string`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L15)\n\nCursor pointing to the end of the current result set\n\n***\n\n### hasNextPage\n\n> **hasNextPage**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L9)\n\nWhether more items exist after the current set (has next page)\n\n***\n\n### hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L11)\n\nWhether items existed before the current set (has previous page)\n\n***\n\n### startCursor?\n\n> `optional` **startCursor**: `string`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L13)\n\nCursor pointing to the start of the current result set\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/pagination/interfaces/InterfacePaginationControlsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePaginationControlsProps\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L64)\n\nProps for a pagination controls component.\n\nDisplays pagination UI with page indicators and navigation buttons\nallowing users to move between pages of data.\n\n## Properties\n\n### onPageChange()\n\n> **onPageChange**: (`page`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L76)\n\nCallback fired when user navigates to a different page.\n\n#### Parameters\n\n##### page\n\n`number`\n\nThe new page number\n\n#### Returns\n\n`void`\n\n***\n\n### page\n\n> **page**: `number`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L66)\n\nCurrent page number (typically 1-indexed)\n\n***\n\n### pageSize\n\n> **pageSize**: `number`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L68)\n\nNumber of items per page\n\n***\n\n### totalItems\n\n> **totalItems**: `number`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L70)\n\nTotal number of items across all pages\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/Connection.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Connection\\\n\n> **Connection**\\<`TNode`\\> = \\{ `edges?`: [`Edge`](Edge.md)\\<`TNode`\\>[] \\| `null`; `pageInfo?`: [`PageInfo`](PageInfo.md) \\| `null`; \\} \\| `null` \\| `undefined`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L48)\n\nGraphQL Relay connection pattern for paginated data.\n\nContains an array of edges (each wrapping a node or null) and pagination\nmetadata. Consumers should iterate the edges array and safely access node\nvalues (which may be null), then use pageInfo to determine pagination state.\n\n## Type Parameters\n\n### TNode\n\n`TNode`\n\nThe type of node data in the edges\n\n## Type Declaration\n\n\\{ `edges?`: [`Edge`](Edge.md)\\<`TNode`\\>[] \\| `null`; `pageInfo?`: [`PageInfo`](PageInfo.md) \\| `null`; \\}\n\n### edges?\n\n> `optional` **edges**: [`Edge`](Edge.md)\\<`TNode`\\>[] \\| `null`\n\nArray of edges, each optionally containing a node\n\n### pageInfo?\n\n> `optional` **pageInfo**: [`PageInfo`](PageInfo.md) \\| `null`\n\nPagination state (cursors and next/previous availability)\n\n`null`\n\n`undefined`\n\n## Example\n\n```\nconnection?.edges?.forEach(edge => {\n if (edge?.node) {\n // Process non-null node\n }\n});\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/Edge.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Edge\\\n\n> **Edge**\\<`TNode`\\> = \\{ `node`: `TNode` \\| `null`; \\} \\| `null`\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L28)\n\nA single edge in a GraphQL Relay connection.\n\nWraps a node (or null) and can be null itself, representing\na single item in a paginated result set.\n\n## Type Parameters\n\n### TNode\n\n`TNode`\n\nThe type of node data wrapped by this edge\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/pagination/type-aliases/PageInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PageInfo\n\n> **PageInfo** = [`InterfacePageInfo`](../interfaces/InterfacePageInfo.md)\n\nDefined in: [src/types/shared-components/DataTable/pagination.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/pagination.ts#L18)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceBaseDataTableProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBaseDataTableProps\\\n\nDefined in: [src/types/shared-components/DataTable/props.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L17)\n\nBase props for DataTable component configuration.\n\nProvides core table configuration including column definitions, row data,\nsizing, and sorting behavior. Extended by InterfaceDataTableProps for full functionality.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L19)\n\nArray of column definitions specifying how to render each column\n\n***\n\n### keysToShowRows?\n\n> `optional` **keysToShowRows**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L23)\n\nSet of row keys to display; if provided, only these rows are shown\n\n***\n\n### onSortChange()?\n\n> `optional` **onSortChange**: (`event`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L31)\n\nCallback fired when sort state changes\n\n#### Parameters\n\n##### event\n\n[`ISortChangeEvent`](../../types/interfaces/ISortChangeEvent.md)\\<`T`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### rowKey?\n\n> `optional` **rowKey**: keyof `T` \\| (`row`) => [`Key`](../../types/type-aliases/Key.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L25)\n\nKey or property name or function to extract unique identifier for each row\n\n***\n\n### rows?\n\n> `optional` **rows**: `T`[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L21)\n\nArray of row data to display in the table\n\n***\n\n### sortable?\n\n> `optional` **sortable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L27)\n\nWhether columns are sortable (default: true)\n\n***\n\n### sortState?\n\n> `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L29)\n\nCurrent sort state specifying column and direction\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceDataTableSkeletonProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDataTableSkeletonProps\\\n\nDefined in: [src/types/shared-components/DataTable/props.ts:261](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L261)\n\nProps for the DataTableSkeleton loading placeholder component.\n\nConfigures a skeleton table that animates while data is loading,\nproviding visual feedback of expected table structure.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L263)\n\nARIA label for the skeleton table\n\n***\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:265](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L265)\n\nArray of column definitions to match skeleton structure\n\n***\n\n### effectiveSelectable?\n\n> `optional` **effectiveSelectable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L267)\n\nWhether to show selection checkbox column\n\n***\n\n### hasRowActions?\n\n> `optional` **hasRowActions**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L269)\n\nWhether to show actions column\n\n***\n\n### skeletonRows\n\n> **skeletonRows**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L271)\n\nNumber of skeleton rows to display\n\n***\n\n### tableClassNames?\n\n> `optional` **tableClassNames**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:273](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L273)\n\nCSS class names for the table\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceDataTableTableProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDataTableTableProps\\\n\nDefined in: [src/types/shared-components/DataTable/props.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L198)\n\nProps for the DataTableTable component that renders table rows.\n\nProvides data and configuration for rendering paginated table content,\nincluding row selection, actions, and custom empty states.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### activeSortBy?\n\n> `optional` **activeSortBy**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:226](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L226)\n\nID of the currently sorted column\n\n***\n\n### activeSortDir?\n\n> `optional` **activeSortDir**: [`SortDirection`](../../types/type-aliases/SortDirection.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:228](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L228)\n\nCurrent sort direction\n\n***\n\n### allSelectedOnPage?\n\n> `optional` **allSelectedOnPage**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L222)\n\nWhether all rows on page are selected\n\n***\n\n### ariaBusy?\n\n> `optional` **ariaBusy**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:210](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L210)\n\nARIA busy state for the table\n\n***\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L208)\n\nARIA label for the table element\n\n***\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:200](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L200)\n\nArray of column definitions specifying how to render each column\n\n***\n\n### currentSelection\n\n> **currentSelection**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:238](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L238)\n\nCurrent selection state\n\n***\n\n### effectiveRowActions\n\n> **effectiveRowActions**: readonly [`IRowAction`](../../hooks/interfaces/IRowAction.md)\\<`T`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L246)\n\nArray of effective row actions\n\n***\n\n### effectiveSelectable?\n\n> `optional` **effectiveSelectable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L214)\n\nWhether selection is enabled\n\n***\n\n### getKey()\n\n> **getKey**: (`row`, `idx`) => `string` \\| `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L236)\n\nFunction to get unique key for a row\n\n#### Parameters\n\n##### row\n\n`T`\n\n##### idx\n\n`number`\n\n#### Returns\n\n`string` \\| `number`\n\n***\n\n### handleHeaderClick()\n\n> **handleHeaderClick**: (`col`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L230)\n\nCallback when header is clicked for sorting\n\n#### Parameters\n\n##### col\n\n[`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### hasRowActions?\n\n> `optional` **hasRowActions**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L216)\n\nWhether row actions are present\n\n***\n\n### headerCheckboxRef?\n\n> `optional` **headerCheckboxRef**: `RefObject`\\<`HTMLInputElement`\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L218)\n\nRef to the header checkbox for select all\n\n***\n\n### keysToShowRows?\n\n> `optional` **keysToShowRows**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L202)\n\nSet of row keys to display; if provided, only these rows are shown\n\n***\n\n### loadingMore?\n\n> `optional` **loadingMore**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L248)\n\nWhether more rows are loading\n\n***\n\n### renderRow()?\n\n> `optional` **renderRow**: (`row`, `index`) => `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L244)\n\nCustom function to render each row\n\n#### Parameters\n\n##### row\n\n`T`\n\n##### index\n\n`number`\n\n#### Returns\n\n`ReactNode`\n\n***\n\n### selectAllOnPage()\n\n> **selectAllOnPage**: (`checked`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:224](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L224)\n\nCallback to select/deselect all rows on page\n\n#### Parameters\n\n##### checked\n\n`boolean`\n\n#### Returns\n\n`void`\n\n***\n\n### skeletonRows?\n\n> `optional` **skeletonRows**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:250](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L250)\n\nNumber of skeleton rows to show\n\n***\n\n### someSelectedOnPage?\n\n> `optional` **someSelectedOnPage**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:220](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L220)\n\nWhether some rows on page are selected\n\n***\n\n### sortable?\n\n> `optional` **sortable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L204)\n\nWhether columns are sortable (default: true)\n\n***\n\n### sortedRows\n\n> **sortedRows**: readonly `T`[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L232)\n\nArray of sorted rows to display\n\n***\n\n### sortState?\n\n> `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L206)\n\nCurrent sort state specifying column and direction\n\n***\n\n### startIndex\n\n> **startIndex**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L234)\n\nStarting index for row numbering\n\n***\n\n### tableClassNames?\n\n> `optional` **tableClassNames**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L212)\n\nCSS classes to apply to the table\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`, `options?`) => `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L242)\n\nTranslation function for common strings\n\n#### Parameters\n\n##### key\n\n`string`\n\n##### options?\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`string`\n\n***\n\n### toggleRowSelection()\n\n> **toggleRowSelection**: (`key`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L240)\n\nCallback to toggle row selection\n\n#### Parameters\n\n##### key\n\n[`Key`](../../types/type-aliases/Key.md)\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceLoadingMoreRowsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceLoadingMoreRowsProps\\\n\nDefined in: [src/types/shared-components/DataTable/props.ts:284](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L284)\n\nProps for the LoadingMoreRows component.\n\nManages UI state when loading additional pages in infinite-scroll scenarios,\nincluding error recovery with retry capability.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L286)\n\nArray of column definitions to match row structure\n\n***\n\n### columnsCount?\n\n> `optional` **columnsCount**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L294)\n\nNumber of columns in the table (for colspan)\n\n***\n\n### effectiveSelectable?\n\n> `optional` **effectiveSelectable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:288](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L288)\n\nWhether to show selection checkbox column\n\n***\n\n### error?\n\n> `optional` **error**: `Error`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:298](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L298)\n\nError from the most recent load attempt\n\n***\n\n### hasRowActions?\n\n> `optional` **hasRowActions**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L290)\n\nWhether to show actions column\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L296)\n\nWhether more rows are currently loading\n\n***\n\n### retry()?\n\n> `optional` **retry**: () => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:300](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L300)\n\nCallback to retry loading after an error\n\n#### Returns\n\n`void`\n\n***\n\n### skeletonRows?\n\n> `optional` **skeletonRows**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L292)\n\nNumber of skeleton rows to display\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceSearchBarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchBarProps\n\nDefined in: [src/types/shared-components/DataTable/props.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L69)\n\nProps for a searchable input/search bar component.\n\nConfigures search input behavior including value synchronization,\nchange callbacks, debouncing, and accessibility attributes.\n\n## Properties\n\n### aria?\n\n> `optional` **aria**: `object`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L83)\n\nARIA accessibility attributes for the search input\n\n#### label?\n\n> `optional` **label**: `string`\n\nARIA label for the search input\n\n#### labelledBy?\n\n> `optional` **labelledBy**: `string`\n\nARIA labelledBy for linking to external labels\n\n***\n\n### aria-label?\n\n> `optional` **aria-label**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L79)\n\nARIA label for the search input\n\n***\n\n### clear-aria-label?\n\n> `optional` **clear-aria-label**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L81)\n\nARIA label for the clear button\n\n***\n\n### debounceDelay?\n\n> `optional` **debounceDelay**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L90)\n\nMilliseconds to debounce search input changes\n\n***\n\n### onChange()\n\n> **onChange**: (`q`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L73)\n\nCallback fired when search value changes\n\n#### Parameters\n\n##### q\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### onClear()?\n\n> `optional` **onClear**: () => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L75)\n\nCallback fired when search is cleared\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L77)\n\nPlaceholder text to display in the search input\n\n***\n\n### value?\n\n> `optional` **value**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L71)\n\nCurrent search input value\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/interfaces/InterfaceTableLoaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTableLoaderProps\\\n\nDefined in: [src/types/shared-components/DataTable/props.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L42)\n\nProps for table loading states and error/empty conditions.\n\nProvides UI customization and state management for loading indicators,\nerror messages, and empty state displays.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L50)\n\nARIA label for the loading state\n\n***\n\n### asOverlay?\n\n> `optional` **asOverlay**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L48)\n\nWhether to render as an overlay\n\n***\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L44)\n\nArray of column definitions to match table structure\n\n***\n\n### emptyComponent?\n\n> `optional` **emptyComponent**: `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L60)\n\nCustom React component to display when no rows are present\n\n***\n\n### error?\n\n> `optional` **error**: `Error`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L56)\n\nError from the last data fetch operation\n\n***\n\n### errorComponent?\n\n> `optional` **errorComponent**: `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L58)\n\nCustom React component to display when an error occurs\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L52)\n\nWhether the table is loading initial data\n\n***\n\n### loadingMore?\n\n> `optional` **loadingMore**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L54)\n\nWhether additional data is currently loading\n\n***\n\n### rows?\n\n> `optional` **rows**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L46)\n\nNumber of skeleton rows to display\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/props/type-aliases/InterfaceDataTableProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceDataTableProps\\\n\n> **InterfaceDataTableProps**\\<`T`\\> = `object`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L101)\n\nComplete props for the DataTable component.\n\nExtends base configuration with pagination, filtering, searching, selection,\nand bulk actions. Supports both client-side and server-side data handling.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### actionableRows?\n\n> `optional` **actionableRows**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L182)\n\n***\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L139)\n\nARIA label for the table element\n\n***\n\n### bulkActions?\n\n> `optional` **bulkActions**: `ReadonlyArray`\\<[`IBulkAction`](../../hooks/interfaces/IBulkAction.md)\\<`T`\\>\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L181)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L115)\n\nCSS class to apply to the table element\n\n***\n\n### columnFilter?\n\n> `optional` **columnFilter**: `Record`\\<`string`, `unknown`\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L159)\n\n***\n\n### columnFilters?\n\n> `optional` **columnFilters**: `Record`\\<`string`, `unknown`\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L160)\n\n***\n\n### columns\n\n> **columns**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L103)\n\nArray of column definitions specifying how to render each column\n\n***\n\n### currentPage?\n\n> `optional` **currentPage**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L167)\n\n***\n\n### data\n\n> **data**: `T`[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L125)\n\nFor backward compatibility: use rows instead\n\n***\n\n### disableSort?\n\n> `optional` **disableSort**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L185)\n\n***\n\n### emptyMessage?\n\n> `optional` **emptyMessage**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L135)\n\nMessage to display when table is empty\n\n***\n\n### error?\n\n> `optional` **error**: `Error` \\| `null`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L131)\n\nError from the last data fetch operation\n\n***\n\n### globalSearch?\n\n> `optional` **globalSearch**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L157)\n\n***\n\n### initialGlobalSearch?\n\n> `optional` **initialGlobalSearch**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L156)\n\nInitial global search value\n\n***\n\n### initialSelectedKeys?\n\n> `optional` **initialSelectedKeys**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L179)\n\n***\n\n### initialSortBy?\n\n> `optional` **initialSortBy**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L149)\n\nInitial sort property\n\n***\n\n### initialSortDirection?\n\n> `optional` **initialSortDirection**: [`SortDirection`](../../types/type-aliases/SortDirection.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L150)\n\n***\n\n### keysToShowRows?\n\n> `optional` **keysToShowRows**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L107)\n\nSet of row keys to display; if provided, only these rows are shown\n\n***\n\n### loading?\n\n> `optional` **loading**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L127)\n\nWhether the table is loading initial data\n\n***\n\n### loadingMore?\n\n> `optional` **loadingMore**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L129)\n\nWhether additional data is currently loading\n\n***\n\n### loadingOverlay?\n\n> `optional` **loadingOverlay**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L145)\n\nWhether to show a loading overlay during pagination\n\n***\n\n### noHeader?\n\n> `optional` **noHeader**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L111)\n\nWhether to hide the header row\n\n***\n\n### onColumnFilterChange()?\n\n> `optional` **onColumnFilterChange**: (`filters`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L161)\n\n#### Parameters\n\n##### filters\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onColumnFiltersChange()?\n\n> `optional` **onColumnFiltersChange**: (`filters`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L162)\n\n#### Parameters\n\n##### filters\n\n`Record`\\<`string`, `unknown`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onGlobalSearchChange()?\n\n> `optional` **onGlobalSearchChange**: (`q`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L158)\n\n#### Parameters\n\n##### q\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### onLoadMore()?\n\n> `optional` **onLoadMore**: () => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L171)\n\n#### Returns\n\n`void`\n\n***\n\n### onPageChange()?\n\n> `optional` **onPageChange**: (`page`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L168)\n\n#### Parameters\n\n##### page\n\n`number`\n\n#### Returns\n\n`void`\n\n***\n\n### onSelectedRowsChange()?\n\n> `optional` **onSelectedRowsChange**: (`next`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L178)\n\n#### Parameters\n\n##### next\n\n`ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onSelectionChange()?\n\n> `optional` **onSelectionChange**: (`next`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L177)\n\n#### Parameters\n\n##### next\n\n`ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onSortChange()?\n\n> `optional` **onSortChange**: (`event`) => `void`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L123)\n\nCallback fired when sort state changes\n\n#### Parameters\n\n##### event\n\n[`ISortChangeEvent`](../../types/interfaces/ISortChangeEvent.md)\\<`T`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### page?\n\n> `optional` **page**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L166)\n\n***\n\n### pageInfo?\n\n> `optional` **pageInfo**: [`InterfacePageInfo`](../../pagination/interfaces/InterfacePageInfo.md) \\| `null`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L170)\n\n***\n\n### pageSize?\n\n> `optional` **pageSize**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L165)\n\n***\n\n### paginationMode?\n\n> `optional` **paginationMode**: `\"client\"` \\| `\"server\"` \\| `\"none\"`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L164)\n\n***\n\n### refetch?\n\n> `optional` **refetch**: `QueryResult`\\<`unknown`\\>\\[`\"refetch\"`\\]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L184)\n\n***\n\n### renderError()?\n\n> `optional` **renderError**: (`error`) => `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L137)\n\nCustom function to render error state\n\n#### Parameters\n\n##### error\n\n`Error`\n\n#### Returns\n\n`ReactNode`\n\n***\n\n### renderRow()?\n\n> `optional` **renderRow**: (`row`, `index`) => `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L133)\n\nCustom function to render each row\n\n#### Parameters\n\n##### row\n\n`T`\n\n##### index\n\n`number`\n\n#### Returns\n\n`ReactNode`\n\n***\n\n### rowActions?\n\n> `optional` **rowActions**: `ReadonlyArray`\\<[`IRowAction`](../../hooks/interfaces/IRowAction.md)\\<`T`\\>\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L180)\n\n***\n\n### rowKey?\n\n> `optional` **rowKey**: keyof `T` \\| (`row`) => [`Key`](../../types/type-aliases/Key.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L113)\n\nKey or property name or function to extract unique identifier for each row\n\n***\n\n### rows?\n\n> `optional` **rows**: `T`[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L105)\n\nArray of row data to display in the table\n\n***\n\n### searchBarProps?\n\n> `optional` **searchBarProps**: `Omit`\\<[`InterfaceSearchBarProps`](../interfaces/InterfaceSearchBarProps.md), `\"value\"` \\| `\"onChange\"`\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L163)\n\n***\n\n### searchPlaceholder?\n\n> `optional` **searchPlaceholder**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L152)\n\nSearch placeholder text\n\n***\n\n### selectable?\n\n> `optional` **selectable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L174)\n\n***\n\n### selectedKeys?\n\n> `optional` **selectedKeys**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L175)\n\n***\n\n### selectedRows?\n\n> `optional` **selectedRows**: `ReadonlySet`\\<[`Key`](../../types/type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/props.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L176)\n\n***\n\n### serverFilter?\n\n> `optional` **serverFilter**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L173)\n\n***\n\n### serverSearch?\n\n> `optional` **serverSearch**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L172)\n\n***\n\n### serverSort?\n\n> `optional` **serverSort**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L141)\n\nWhether sorting is handled server-side\n\n***\n\n### showSearch?\n\n> `optional` **showSearch**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L154)\n\nWhether to show search bar\n\n***\n\n### showViewMoreButton?\n\n> `optional` **showViewMoreButton**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L183)\n\n***\n\n### size?\n\n> `optional` **size**: `\"sm\"` \\| `\"lg\"`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L109)\n\nBootstrap size variant: 'sm' for small or 'lg' for large\n\n***\n\n### skeletonRows?\n\n> `optional` **skeletonRows**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L143)\n\nNumber of skeleton rows to show during loading\n\n***\n\n### sortable?\n\n> `optional` **sortable**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L119)\n\nWhether columns are sortable (default: true)\n\n***\n\n### sortBy?\n\n> `optional` **sortBy**: [`ISortState`](../../types/interfaces/ISortState.md)[]\n\nDefined in: [src/types/shared-components/DataTable/props.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L147)\n\nCurrent sort state as array (controlled sorting)\n\n***\n\n### sortState?\n\n> `optional` **sortState**: [`ISortState`](../../types/interfaces/ISortState.md)\n\nDefined in: [src/types/shared-components/DataTable/props.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L121)\n\nCurrent sort state specifying column and direction\n\n***\n\n### striped?\n\n> `optional` **striped**: `boolean`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L117)\n\nWhether to apply striped styling to rows\n\n***\n\n### tableBodyClassName?\n\n> `optional` **tableBodyClassName**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L186)\n\n***\n\n### tableClassName?\n\n> `optional` **tableClassName**: `string`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L187)\n\n***\n\n### totalItems?\n\n> `optional` **totalItems**: `number`\n\nDefined in: [src/types/shared-components/DataTable/props.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/props.ts#L169)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/IFilterState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IFilterState\n\nDefined in: [src/types/shared-components/DataTable/types.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L29)\n\nRepresents a single column filter.\n\nPairs a column ID with a filter value to be applied when filtering table rows.\n\n## Properties\n\n### columnId\n\n> **columnId**: `string`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L31)\n\nID of the column being filtered\n\n***\n\n### value\n\n> **value**: `unknown`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L33)\n\nThe filter value to match against rows (type depends on column)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ISortChangeEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISortChangeEvent\\\n\nDefined in: [src/types/shared-components/DataTable/types.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L60)\n\nEvent object passed to onSortChange callback when sort state changes.\n\nProvides complete information about the sort change including the new sort state array,\nthe primary sort direction, and the column definition that triggered the change.\n\n## Type Parameters\n\n### T\n\n`T`\n\nThe type of data for each row in the table\n\n## Properties\n\n### column\n\n> **column**: [`IColumnDef`](../../column/interfaces/IColumnDef.md)\\<`T`, `unknown`\\>\n\nDefined in: [src/types/shared-components/DataTable/types.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L66)\n\nColumn definition that triggered the sort change\n\n***\n\n### sortBy\n\n> **sortBy**: [`ISortState`](ISortState.md)[]\n\nDefined in: [src/types/shared-components/DataTable/types.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L62)\n\nArray of sort states (primary sort first, can include multiple columns)\n\n***\n\n### sortDirection\n\n> **sortDirection**: [`SortDirection`](../type-aliases/SortDirection.md)\n\nDefined in: [src/types/shared-components/DataTable/types.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L64)\n\nDirection of the primary sort\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ISortState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISortState\n\nDefined in: [src/types/shared-components/DataTable/types.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L17)\n\nRepresents the current sort state of a table column.\n\nTracks which column is sorted and in which direction (ascending or descending).\n\n## Properties\n\n### columnId\n\n> **columnId**: `string`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L19)\n\nID of the column being sorted\n\n***\n\n### direction\n\n> **direction**: [`SortDirection`](../type-aliases/SortDirection.md)\n\nDefined in: [src/types/shared-components/DataTable/types.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L21)\n\nSort direction: 'asc' for ascending or 'desc' for descending\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/interfaces/ITableState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ITableState\n\nDefined in: [src/types/shared-components/DataTable/types.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L41)\n\nComplete state of a table including sorting, filtering, and selection.\n\nRepresents the combined state of all table operations for persistence or state management.\n\n## Properties\n\n### filters?\n\n> `optional` **filters**: [`IFilterState`](IFilterState.md)[]\n\nDefined in: [src/types/shared-components/DataTable/types.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L45)\n\nArray of active column filters\n\n***\n\n### globalSearch?\n\n> `optional` **globalSearch**: `string`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L47)\n\nGlobal search query string applied across all searchable columns\n\n***\n\n### selectedRows?\n\n> `optional` **selectedRows**: `ReadonlySet`\\<[`Key`](../type-aliases/Key.md)\\>\n\nDefined in: [src/types/shared-components/DataTable/types.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L49)\n\nImmutable set of currently selected row keys\n\n***\n\n### sorting?\n\n> `optional` **sorting**: [`ISortState`](ISortState.md)[]\n\nDefined in: [src/types/shared-components/DataTable/types.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L43)\n\nArray of active sort states (primary sort first)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/Accessor.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Accessor\\\n\n> **Accessor**\\<`T`, `TValue`\\> = keyof `T` \\| (`row`) => `TValue`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L8)\n\n## Type Parameters\n\n### T\n\n`T`\n\n### TValue\n\n`TValue` = `unknown`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/HeaderRender.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: HeaderRender\n\n> **HeaderRender** = `string` \\| `ReactNode` \\| () => `ReactNode`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L6)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/Key.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Key\n\n> **Key** = `string` \\| `number`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L10)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DataTable/types/type-aliases/SortDirection.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SortDirection\n\n> **SortDirection** = `\"asc\"` \\| `\"desc\"`\n\nDefined in: [src/types/shared-components/DataTable/types.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DataTable/types.ts#L4)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DatePicker/interface/interfaces/InterfaceDatePickerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDatePickerProps\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L7)\n\nComponent Props for DatePicker\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L41)\n\nAdditional CSS class name to be applied to the root element\n\n***\n\n### data-cy?\n\n> `optional` **data-cy**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L45)\n\nTest ID for Cypress testing purposes\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L43)\n\nTest ID for testing purposes, applied to the underlying input\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L31)\n\nWhether the date picker is disabled\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L35)\n\nError message to display when validation fails\n\n***\n\n### format?\n\n> `optional` **format**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L51)\n\nFormat of the date displayed in the input (e.g., \"MM/DD/YYYY\", \"YYYY-MM-DD\")\n\n***\n\n### helpText?\n\n> `optional` **helpText**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L39)\n\nAdditional help text displayed below the field\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L11)\n\nLabel displayed for the date picker\n\n***\n\n### maxDate?\n\n> `optional` **maxDate**: `Dayjs`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L29)\n\nMaximum selectable date constraint\n\n***\n\n### minDate?\n\n> `optional` **minDate**: `Dayjs`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L27)\n\nMinimum selectable date constraint\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L9)\n\nUnique name identifier for the field\n\n***\n\n### onBlur()?\n\n> `optional` **onBlur**: () => `void`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L25)\n\nCallback fired when the field is blurred (for touch tracking)\n\n#### Returns\n\n`void`\n\n***\n\n### onChange()\n\n> **onChange**: (`date`) => `void`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L21)\n\nCallback fired when the date changes.\n\n#### Parameters\n\n##### date\n\n`Dayjs`\n\nThe new date value.\n\n#### Returns\n\n`void`\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L33)\n\nWhether the field is required\n\n***\n\n### slotProps?\n\n> `optional` **slotProps**: `Partial`\\<`DatePickerSlotProps`\\<`false`\\>\\>\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L47)\n\nAdditional props passed to MUI DatePicker slots (e.g., actionBar, layout)\n\n***\n\n### slots?\n\n> `optional` **slots**: `Record`\\<`string`, `React.ElementType`\\>\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L49)\n\nCustom slot component overrides (e.g., openPickerIcon, leftArrowIcon)\n\n***\n\n### touched?\n\n> `optional` **touched**: `boolean`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L37)\n\nWhether the field has been touched (for validation UX)\n\n***\n\n### value?\n\n> `optional` **value**: `Dayjs`\n\nDefined in: [src/types/shared-components/DatePicker/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DatePicker/interface.ts#L16)\n\nCurrent date value.\nRepresented as a Dayjs object or null if no date is selected.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/IDateRangePreset.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IDateRangePreset\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L52)\n\nIDateRangePreset\n\nConfiguration for a preset date range button.\n\n## Param\n\nOptional reference date for relative presets.\nDefaults to the current date if not provided.\n\n## Example\n\n```ts\n{\n key: 'last7days',\n label: 'Last 7 Days',\n getRange: (refDate = new Date()) => ({\n startDate: dayjs(refDate).subtract(7, 'day').toDate(),\n endDate: refDate,\n }),\n}\n```\n\n## Properties\n\n### getRange()\n\n> **getRange**: (`refDate?`) => [`IDateRangeValue`](IDateRangeValue.md)\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L55)\n\n#### Parameters\n\n##### refDate?\n\n`Date`\n\n#### Returns\n\n[`IDateRangeValue`](IDateRangeValue.md)\n\n***\n\n### key\n\n> **key**: `string`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L53)\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L54)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/IDateRangeValue.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IDateRangeValue\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L27)\n\nIDateRangeValue\n\nRepresents a controlled date range.\n\n## Properties\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L29)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L28)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/interfaces/InterfaceDateRangePickerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDateRangePickerProps\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L63)\n\nInterfaceDateRangePickerProps\n\nControlled props for the DateRangePicker component.\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L70)\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L71)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L67)\n\n***\n\n### error?\n\n> `optional` **error**: `boolean`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L68)\n\n***\n\n### helperText?\n\n> `optional` **helperText**: `string`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L69)\n\n***\n\n### onChange()\n\n> **onChange**: (`val`) => `void`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L65)\n\n#### Parameters\n\n##### val\n\n[`IDateRangeValue`](IDateRangeValue.md)\n\n#### Returns\n\n`void`\n\n***\n\n### presets?\n\n> `optional` **presets**: [`IDateRangePreset`](IDateRangePreset.md)[]\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L66)\n\n***\n\n### showPresets?\n\n> `optional` **showPresets**: `boolean`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L72)\n\n***\n\n### value\n\n> **value**: [`IDateRangeValue`](IDateRangeValue.md)\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L64)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DateRangePicker/interface/type-aliases/DateOrNull.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: DateOrNull\n\n> **DateOrNull** = `Date` \\| `null`\n\nDefined in: [src/types/shared-components/DateRangePicker/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DateRangePicker/interface.ts#L20)\n\nDateRangePicker shared types\n\n## Remarks\n\nAll date values are local `Date` objects.\nTimezone conversion and serialization (ISO strings, server formats)\nmust be handled by GraphQL middleware or API adapters.\n\n## Example\n\n```tsx\nconst [range, setRange] = useState({\n startDate: null,\n endDate: null,\n});\n\n\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownButtonProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropDownButtonProps\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L66)\n\nInterface for dropdown button component props.\n\n## Extends\n\n- [`InterfaceDropDownProps`](InterfaceDropDownProps.md)\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L95)\n\nARIA label for accessibility.\n\n***\n\n### btnStyle?\n\n> `optional` **btnStyle**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L41)\n\nBase class(es) for the toggle button. Applied first; often set by the wrapping component.\nUse this for default button layout/theme.\n\n#### Inherited from\n\n[`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`btnStyle`](InterfaceDropDownProps.md#btnstyle)\n\n***\n\n### buttonLabel?\n\n> `optional` **buttonLabel**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L126)\n\nThe label of the button.\n\n***\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L53)\n\nConsumer override: extra class name(s) for the dropdown container, merged with\nparentContainerStyle. Use from parent screens (e.g. CSS module classes) to style the\ncontainer without coupling to test IDs.\n\n#### Inherited from\n\n[`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`containerClassName`](InterfaceDropDownProps.md#containerclassname)\n\n***\n\n### dataTestIdPrefix?\n\n> `optional` **dataTestIdPrefix**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L100)\n\nData test id prefix for testing purposes.\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L136)\n\nWhether the dropdown button is disabled.\n\n***\n\n### drop?\n\n> `optional` **drop**: `\"start\"` \\| `\"end\"` \\| `\"up\"` \\| `\"down\"`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L80)\n\nDirection the dropdown menu opens.\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactNode`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L131)\n\nThe icon to be displayed on the button.\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L70)\n\nThe id of the dropdown button.\n\n***\n\n### menuClassName?\n\n> `optional` **menuClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L46)\n\nCustom class name for the dropdown menu.\n\n#### Inherited from\n\n[`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`menuClassName`](InterfaceDropDownProps.md#menuclassname)\n\n***\n\n### onSelect()\n\n> **onSelect**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L90)\n\nCallback function when an option is selected.\n\n#### Parameters\n\n##### value\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### options\n\n> **options**: [`InterfaceDropDownOption`](InterfaceDropDownOption.md)[]\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L75)\n\nThe options to be displayed in the dropdown.\n\n***\n\n### parentContainerStyle?\n\n> `optional` **parentContainerStyle**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L35)\n\nBase class(es) for the dropdown container. Applied first; often set by the wrapping component\n(e.g. SortingButton, Navbar). Use this for default layout/theme.\n\n#### Inherited from\n\n[`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`parentContainerStyle`](InterfaceDropDownProps.md#parentcontainerstyle)\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L141)\n\nPlaceholder text when no option is selected.\n\n***\n\n### searchable?\n\n> `optional` **searchable**: `boolean`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L146)\n\nWhether the dropdown should be searchable.\n\n***\n\n### searchPlaceholder?\n\n> `optional` **searchPlaceholder**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L151)\n\nPlaceholder text for the search input.\n\n***\n\n### selectedValue?\n\n> `optional` **selectedValue**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L85)\n\nThe currently selected value.\n\n***\n\n### showCaret?\n\n> `optional` **showCaret**: `boolean`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L156)\n\nWhether to show the caret icon on the dropdown button.\n\n#### Default Value\n\n```ts\ntrue\n```\n\n***\n\n### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L60)\n\nConsumer override: extra class name(s) for the toggle button, merged with btnStyle.\nUse from parent screens (e.g. CSS module classes) to style the toggle without\ncoupling to test IDs.\n\n#### Inherited from\n\n[`InterfaceDropDownProps`](InterfaceDropDownProps.md).[`toggleClassName`](InterfaceDropDownProps.md#toggleclassname)\n\n***\n\n### variant?\n\n> `optional` **variant**: `\"primary\"` \\| `\"secondary\"` \\| `\"success\"` \\| `\"danger\"` \\| `\"warning\"` \\| `\"info\"` \\| `\"dark\"` \\| `\"light\"` \\| `\"outline-primary\"` \\| `\"outline-secondary\"` \\| `\"outline-success\"` \\| `\"outline-danger\"` \\| `\"outline-warning\"` \\| `\"outline-info\"` \\| `\"outline-dark\"` \\| `\"outline-light\"`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L105)\n\nThe variant/style of the button.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropDownOption\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L4)\n\nInterface for a single dropdown option.\n\n## Properties\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L18)\n\nWhether the option is disabled.\n\n***\n\n### label\n\n> **label**: `ReactNode`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L13)\n\nThe label of the option.\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L8)\n\nThe value of the option.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceDropDownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropDownProps\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L30)\n\nInterface for dropdown component props.\n\nStyling props:\n- **Base (component/default layout):** `parentContainerStyle` and `btnStyle` are applied first\n (e.g. from SortingButton or Navbar defaults).\n- **Consumer overrides:** `containerClassName` and `toggleClassName` are merged with the base\n so parent screens can add their own CSS module classes without replacing defaults.\n\n## Extended by\n\n- [`InterfaceDropDownButtonProps`](InterfaceDropDownButtonProps.md)\n\n## Properties\n\n### btnStyle?\n\n> `optional` **btnStyle**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L41)\n\nBase class(es) for the toggle button. Applied first; often set by the wrapping component.\nUse this for default button layout/theme.\n\n***\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L53)\n\nConsumer override: extra class name(s) for the dropdown container, merged with\nparentContainerStyle. Use from parent screens (e.g. CSS module classes) to style the\ncontainer without coupling to test IDs.\n\n***\n\n### menuClassName?\n\n> `optional` **menuClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L46)\n\nCustom class name for the dropdown menu.\n\n***\n\n### parentContainerStyle?\n\n> `optional` **parentContainerStyle**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L35)\n\nBase class(es) for the dropdown container. Applied first; often set by the wrapping component\n(e.g. SortingButton, Navbar). Use this for default layout/theme.\n\n***\n\n### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L60)\n\nConsumer override: extra class name(s) for the toggle button, merged with btnStyle.\nUse from parent screens (e.g. CSS module classes) to style the toggle without\ncoupling to test IDs.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/DropDownButton/interface/interfaces/InterfaceSearchToggleProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchToggleProps\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L162)\n\nInterface for SearchToggle component props.\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L170)\n\n***\n\n### dataTestIdPrefix\n\n> **dataTestIdPrefix**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L169)\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactNode`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L168)\n\n***\n\n### onChange()\n\n> **onChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L165)\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onClick()\n\n> **onClick**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L163)\n\n#### Parameters\n\n##### e\n\n`MouseEvent`\n\n#### Returns\n\n`void`\n\n***\n\n### onInputClick()\n\n> **onInputClick**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L166)\n\n#### Parameters\n\n##### e\n\n`MouseEvent`\n\n#### Returns\n\n`void`\n\n***\n\n### placeholder?\n\n> `optional` **placeholder**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L167)\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/DropDownButton/interface.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/DropDownButton/interface.ts#L164)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EmptyState/interface/interfaces/InterfaceEmptyStateProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEmptyStateProps\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L4)\n\nProps interface for the EmptyState component.\n\n## Properties\n\n### action?\n\n> `optional` **action**: `object`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L23)\n\nAction button configuration.\n\n#### label\n\n> **label**: `string`\n\n#### onClick()\n\n> **onClick**: () => `void`\n\n##### Returns\n\n`void`\n\n#### variant?\n\n> `optional` **variant**: `\"primary\"` \\| `\"secondary\"` \\| `\"outlined\"`\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L32)\n\nCustom CSS class name.\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L37)\n\nTest identifier.\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L13)\n\n(Optional) Secondary description text.\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactNode`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L18)\n\nIcon to display above the message.\n\n***\n\n### message\n\n> **message**: `string`\n\nDefined in: [src/types/shared-components/EmptyState/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EmptyState/interface.ts#L8)\n\nPrimary message to display (i18n key or plain string) (Required).\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceErrorBoundaryWrapperProps\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L27)\n\nProps for ErrorBoundaryWrapper component\n\nErrorBoundaryWrapper catches JavaScript errors anywhere in the child component tree,\nlogs those errors, and displays a fallback UI instead of crashing the entire app.\n\n**Key Features:**\n- Catches render errors that try-catch cannot handle\n- Provides default and custom fallback UI options\n- Integrates with toast notification system\n- Supports error recovery via reset mechanism\n- Allows error logging/tracking integration\n\n## Example\n\n```tsx\n logToService(error, info)}\n onReset={() => navigate('/dashboard')}\n>\n \n\n```\n\n## Properties\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L29)\n\nChild components to wrap with error boundary\n\n***\n\n### errorMessage?\n\n> `optional` **errorMessage**: `string`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L48)\n\nCustom error message to display in toast notification.\nFalls back to error.message or 'An unexpected error occurred' if not provided.\n\n***\n\n### fallback?\n\n> `optional` **fallback**: `ReactNode`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L35)\n\nCustom fallback UI (JSX element) to display when an error occurs.\nTakes precedence over default fallback but not over fallbackComponent.\n\n***\n\n### fallbackComponent?\n\n> `optional` **fallbackComponent**: `ComponentType`\\<[`InterfaceErrorFallbackProps`](InterfaceErrorFallbackProps.md)\\>\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L42)\n\nCustom fallback component that receives error details and reset function.\nTakes precedence over both default fallback and custom JSX fallback.\nReceives error and onReset as props.\n\n***\n\n### fallbackErrorMessage\n\n> **fallbackErrorMessage**: `string`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L77)\n\nTranslated fallback error message when error.message is unavailable.\n\n***\n\n### fallbackTitle\n\n> **fallbackTitle**: `string`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L72)\n\nTranslated title text for default fallback UI.\n\n***\n\n### onError()?\n\n> `optional` **onError**: (`error`, `errorInfo`) => `void`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L61)\n\nCallback invoked when an error is caught.\nUseful for logging errors to external services (e.g., Sentry, LogRocket).\nReceives the Error object and ErrorInfo containing component stack trace.\n\n#### Parameters\n\n##### error\n\n`Error`\n\n##### errorInfo\n\n`ErrorInfo`\n\n#### Returns\n\n`void`\n\n***\n\n### onReset()?\n\n> `optional` **onReset**: () => `void`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L67)\n\nCallback invoked when user attempts to reset error state via the reset button.\nCan be used to navigate away, refresh data, or perform cleanup operations.\n\n#### Returns\n\n`void`\n\n***\n\n### resetButtonAriaLabel\n\n> **resetButtonAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L87)\n\nTranslated aria-label for reset button (accessibility).\n\n***\n\n### resetButtonText\n\n> **resetButtonText**: `string`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L82)\n\nTranslated reset button text.\n\n***\n\n### showToast?\n\n> `optional` **showToast**: `boolean`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L54)\n\nWhether to show toast notification on error.\n\n#### Default Value\n\n```ts\ntrue\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorBoundaryWrapperState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceErrorBoundaryWrapperState\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L96)\n\nInternal state for ErrorBoundaryWrapper component.\n\nTracks whether an error has occurred and stores error details for rendering\nin the fallback UI.\n\n## Properties\n\n### error\n\n> `readonly` **error**: `Error`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L100)\n\nThe error that was caught\n\n***\n\n### errorInfo\n\n> `readonly` **errorInfo**: `ErrorInfo`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L102)\n\nAdditional error information including component stack.\n\n***\n\n### hasError\n\n> `readonly` **hasError**: `boolean`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L98)\n\nWhether an error has been caught\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ErrorBoundaryWrapper/interface/interfaces/InterfaceErrorFallbackProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceErrorFallbackProps\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L122)\n\nProps passed to custom fallback components.\n\nWhen using `fallbackComponent`, the component will receive these props\nto render a custom error UI with access to error details and reset functionality.\n\n## Example\n\n```tsx\nconst CustomErrorFallback = ({ error, onReset }: InterfaceErrorFallbackProps) => (\n
\n

Custom Error UI

\n

{error?.message}

\n \n
\n);\n```\n\n## Properties\n\n### error\n\n> **error**: `Error`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L124)\n\nThe error that was caught by the error boundary\n\n***\n\n### onReset()\n\n> **onReset**: () => `void`\n\nDefined in: [src/types/shared-components/ErrorBoundaryWrapper/interface.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ErrorBoundaryWrapper/interface.ts#L126)\n\nFunction to reset the error boundary state and attempt to re-render children\n\n#### Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCard.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventListCard\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L9)\n\nEvent list card props extending InterfaceEvent.\n\n## Remarks\n\nrefetchEvents is optional and triggers a refresh when provided.\n\n## Extends\n\n- [`InterfaceEvent`](../../../../Event/interface/type-aliases/InterfaceEvent.md)\n\n## Properties\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L51)\n\n#### Inherited from\n\n`InterfaceEvent.allDay`\n\n***\n\n### attendees\n\n> **attendees**: `Partial`\\<[`User`](../../../../Event/type/type-aliases/User.md)\\>[]\n\nDefined in: [src/types/Event/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L64)\n\n#### Inherited from\n\n`InterfaceEvent.attendees`\n\n***\n\n### averageFeedbackScore?\n\n> `optional` **averageFeedbackScore**: `number`\n\nDefined in: [src/types/Event/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L66)\n\n#### Inherited from\n\n`InterfaceEvent.averageFeedbackScore`\n\n***\n\n### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\nDefined in: [src/types/Event/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L70)\n\n#### id\n\n> **id**: `string`\n\n#### Inherited from\n\n`InterfaceEvent.baseEvent`\n\n***\n\n### creator\n\n> **creator**: `Partial`\\<[`User`](../../../../Event/type/type-aliases/User.md)\\>\n\nDefined in: [src/types/Event/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L65)\n\n#### Inherited from\n\n`InterfaceEvent.creator`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/types/Event/interface.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L46)\n\n#### Inherited from\n\n`InterfaceEvent.description`\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L48)\n\n#### Inherited from\n\n`InterfaceEvent.endAt`\n\n***\n\n### endTime?\n\n> `optional` **endTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L50)\n\n#### Inherited from\n\n`InterfaceEvent.endTime`\n\n***\n\n### feedback?\n\n> `optional` **feedback**: [`Feedback`](../../../../Event/type/type-aliases/Feedback.md)[]\n\nDefined in: [src/types/Event/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L67)\n\n#### Inherited from\n\n`InterfaceEvent.feedback`\n\n***\n\n### hasExceptions?\n\n> `optional` **hasExceptions**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L75)\n\n#### Inherited from\n\n`InterfaceEvent.hasExceptions`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/Event/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L43)\n\n#### Inherited from\n\n`InterfaceEvent.id`\n\n***\n\n### isInviteOnly\n\n> **isInviteOnly**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L63)\n\nDetermines if the event is restricted to invited participants only.\nWhen true, only invited users can see and access the event.\n\n#### Inherited from\n\n`InterfaceEvent.isInviteOnly`\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L57)\n\nDetermines if the event is visible to the entire community.\nOften referred to as \"Community Visible\" in the UI.\n\n#### Inherited from\n\n`InterfaceEvent.isPublic`\n\n***\n\n### isRecurringEventTemplate?\n\n> `optional` **isRecurringEventTemplate**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L69)\n\n#### Inherited from\n\n`InterfaceEvent.isRecurringEventTemplate`\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/types/Event/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L58)\n\n#### Inherited from\n\n`InterfaceEvent.isRegisterable`\n\n***\n\n### key?\n\n> `optional` **key**: `string`\n\nDefined in: [src/types/Event/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L42)\n\n#### Inherited from\n\n`InterfaceEvent.key`\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/Event/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L44)\n\n#### Inherited from\n\n`InterfaceEvent.location`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/Event/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L45)\n\n#### Inherited from\n\n`InterfaceEvent.name`\n\n***\n\n### progressLabel?\n\n> `optional` **progressLabel**: `string`\n\nDefined in: [src/types/Event/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L76)\n\n#### Inherited from\n\n`InterfaceEvent.progressLabel`\n\n***\n\n### recurrenceDescription?\n\n> `optional` **recurrenceDescription**: `string`\n\nDefined in: [src/types/Event/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L78)\n\n#### Inherited from\n\n`InterfaceEvent.recurrenceDescription`\n\n***\n\n### recurrenceRule?\n\n> `optional` **recurrenceRule**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/Event/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L79)\n\n#### Inherited from\n\n`InterfaceEvent.recurrenceRule`\n\n***\n\n### refetchEvents()?\n\n> `optional` **refetchEvents**: () => `void`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L10)\n\n#### Returns\n\n`void`\n\n***\n\n### sequenceNumber?\n\n> `optional` **sequenceNumber**: `number`\n\nDefined in: [src/types/Event/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L73)\n\n#### Inherited from\n\n`InterfaceEvent.sequenceNumber`\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/types/Event/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L47)\n\n#### Inherited from\n\n`InterfaceEvent.startAt`\n\n***\n\n### startTime?\n\n> `optional` **startTime**: `string`\n\nDefined in: [src/types/Event/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L49)\n\n#### Inherited from\n\n`InterfaceEvent.startTime`\n\n***\n\n### totalCount?\n\n> `optional` **totalCount**: `number`\n\nDefined in: [src/types/Event/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L74)\n\n#### Inherited from\n\n`InterfaceEvent.totalCount`\n\n***\n\n### userId?\n\n> `optional` **userId**: `string`\n\nDefined in: [src/types/Event/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L52)\n\n#### Inherited from\n\n`InterfaceEvent.userId`\n\n***\n\n### userRole?\n\n> `optional` **userRole**: `string`\n\nDefined in: [src/types/Event/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/Event/interface.ts#L41)\n\n#### Inherited from\n\n`InterfaceEvent.userRole`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventListCardModalsProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventListCardModalsProps\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L21)\n\nProps for EventListCardModals component.\n\n## Param\n\nThe event card properties including event details.\n\n## Param\n\nWhether the modal is currently visible.\n\n## Param\n\nCallback to close the modal.\n\n## Param\n\nTranslation function scoped to 'translation' namespace.\n\n## Param\n\nTranslation function for common strings.\n\n## Properties\n\n### eventListCardProps\n\n> **eventListCardProps**: [`InterfaceEventListCard`](InterfaceEventListCard.md)\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L22)\n\n***\n\n### eventModalIsOpen\n\n> **eventModalIsOpen**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L23)\n\n***\n\n### hideViewModal()\n\n> **hideViewModal**: () => `void`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L24)\n\n#### Returns\n\n`void`\n\n***\n\n### t\n\n> **t**: `TFunction`\\<`\"translation\"`, `undefined`\\>\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L26)\n\n***\n\n### tCommon\n\n> **tCommon**: `TFunction`\\<`\"translation\"`, `undefined`\\>\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L27)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceEventUpdateInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventUpdateInput\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L33)\n\nInput payload for updating an event. Optional fields are included only when changed.\n\n## Properties\n\n### allDay?\n\n> `optional` **allDay**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L41)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L36)\n\n***\n\n### endAt?\n\n> `optional` **endAt**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L43)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L34)\n\n***\n\n### isInviteOnly?\n\n> `optional` **isInviteOnly**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L40)\n\n***\n\n### isPublic?\n\n> `optional` **isPublic**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L38)\n\n***\n\n### isRegisterable?\n\n> `optional` **isRegisterable**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L39)\n\n***\n\n### location?\n\n> `optional` **location**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L37)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L35)\n\n***\n\n### recurrence?\n\n> `optional` **recurrence**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L48)\n\nRecurrence rule for the event.\nThis field is used for updating the recurrence pattern.\n\n***\n\n### startAt?\n\n> `optional` **startAt**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L42)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceFormState.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormState\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L54)\n\nForm state captured from the EventListCard edit modal.\n\n## Properties\n\n### endTime\n\n> **endTime**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L59)\n\n***\n\n### eventDescription\n\n> **eventDescription**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L56)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L57)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L55)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L58)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/EventListCard/interface/interfaces/InterfaceUpdateEventHandlerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUpdateEventHandlerProps\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L65)\n\nArguments for the updateEventHandler function.\n\n## Properties\n\n### allDayChecked\n\n> **allDayChecked**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L68)\n\n***\n\n### closeUpdateModal()\n\n> **closeUpdateModal**: () => `void`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L80)\n\n#### Returns\n\n`void`\n\n***\n\n### eventEndDate\n\n> **eventEndDate**: `Date`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L73)\n\n***\n\n### eventListCardProps\n\n> **eventListCardProps**: [`InterfaceEventListCard`](InterfaceEventListCard.md)\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L66)\n\n***\n\n### eventStartDate\n\n> **eventStartDate**: `Date`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L72)\n\n***\n\n### eventUpdateModalIsOpen\n\n> **eventUpdateModalIsOpen**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L79)\n\n***\n\n### formState\n\n> **formState**: [`InterfaceFormState`](InterfaceFormState.md)\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L67)\n\n***\n\n### hasRecurrenceChanged?\n\n> `optional` **hasRecurrenceChanged**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L76)\n\n***\n\n### hideViewModal()\n\n> **hideViewModal**: () => `void`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L78)\n\n#### Returns\n\n`void`\n\n***\n\n### inviteOnlyChecked\n\n> **inviteOnlyChecked**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L71)\n\n***\n\n### publicChecked\n\n> **publicChecked**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L69)\n\n***\n\n### recurrence\n\n> **recurrence**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L74)\n\n***\n\n### refetchEvents()?\n\n> `optional` **refetchEvents**: () => `void`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L81)\n\n#### Returns\n\n`void`\n\n***\n\n### registerableChecked\n\n> **registerableChecked**: `boolean`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L70)\n\n***\n\n### t\n\n> **t**: `TFunction`\\<`\"translation\"`, `undefined`\\>\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L77)\n\n***\n\n### updateOption\n\n> **updateOption**: `\"single\"` \\| `\"following\"` \\| `\"entireSeries\"`\n\nDefined in: [src/types/shared-components/EventListCard/interface.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/EventListCard/interface.ts#L75)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormCheckFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormCheckFieldProps\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L17)\n\nProps for FormCheckField component.\nUsed for checkbox, radio, and switch inputs.\nSupports standard form attributes like checked, onChange, disabled, etc.\n\n## Extends\n\n- [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md)\n\n## Properties\n\n### checked?\n\n> `optional` **checked**: `boolean`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L20)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L25)\n\n#### Overrides\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`className`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`data-testid`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#data-testid)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L23)\n\n#### Overrides\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`disabled`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#disabled)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`error`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#error)\n\n***\n\n### helpText?\n\n> `optional` **helpText**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`helpText`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#helptext)\n\n***\n\n### hideLabel?\n\n> `optional` **hideLabel**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`hideLabel`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#hidelabel)\n\n***\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L19)\n\n***\n\n### inline?\n\n> `optional` **inline**: `boolean`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L24)\n\n#### Overrides\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inline`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inline)\n\n***\n\n### inputId?\n\n> `optional` **inputId**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inputId`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inputid)\n\n***\n\n### label\n\n> **label**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`label`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#label)\n\n***\n\n### labelClassName?\n\n> `optional` **labelClassName**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`labelClassName`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#labelclassname)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`name`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#name)\n\n***\n\n### onChange()?\n\n> `optional` **onChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L22)\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`required`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#required)\n\n***\n\n### touched?\n\n> `optional` **touched**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`touched`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#touched)\n\n***\n\n### type?\n\n> `optional` **type**: `\"switch\"` \\| `\"checkbox\"` \\| `\"radio\"`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L18)\n\n***\n\n### value?\n\n> `optional` **value**: `string` \\| `number` \\| readonly `string`[]\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L21)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/FormFieldGroup/interface/interfaces/InterfaceFormSelectFieldProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFormSelectFieldProps\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L6)\n\nProps for FormSelectField component.\n\n## Extends\n\n- [`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md)\n\n## Properties\n\n### children\n\n> **children**: `ReactNode`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L9)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L17)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`className`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#classname)\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L13)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`data-testid`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#data-testid)\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L18)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`disabled`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#disabled)\n\n***\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L11)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`error`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#error)\n\n***\n\n### helpText?\n\n> `optional` **helpText**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L10)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`helpText`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#helptext)\n\n***\n\n### hideLabel?\n\n> `optional` **hideLabel**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L16)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`hideLabel`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#hidelabel)\n\n***\n\n### inline?\n\n> `optional` **inline**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L15)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inline`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inline)\n\n***\n\n### inputId?\n\n> `optional` **inputId**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L19)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`inputId`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#inputid)\n\n***\n\n### label\n\n> **label**: `ReactNode`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L8)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`label`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#label)\n\n***\n\n### labelClassName?\n\n> `optional` **labelClassName**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L14)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`labelClassName`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#labelclassname)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L7)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`name`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#name)\n\n***\n\n### onChange()\n\n> **onChange**: (`v`) => `void`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L8)\n\n#### Parameters\n\n##### v\n\n`string`\n\n#### Returns\n\n`void`\n\n***\n\n### required?\n\n> `optional` **required**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L9)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`required`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#required)\n\n***\n\n### touched?\n\n> `optional` **touched**: `boolean`\n\nDefined in: [src/types/FormFieldGroup/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/FormFieldGroup/interface.ts#L12)\n\n#### Inherited from\n\n[`InterfaceFormFieldGroupProps`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md).[`touched`](../../../../FormFieldGroup/interface/interfaces/InterfaceFormFieldGroupProps.md#touched)\n\n***\n\n### value\n\n> **value**: `string`\n\nDefined in: [src/types/shared-components/FormFieldGroup/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/FormFieldGroup/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/LoadingState/interface/type-aliases/InterfaceLoadingStateProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceLoadingStateProps\n\n> **InterfaceLoadingStateProps** = `WithCustomVariant` \\| `WithoutCustomVariant`\n\nDefined in: [src/types/shared-components/LoadingState/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/LoadingState/interface.ts#L59)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Navbar/interface/interfaces/InterfacePageHeaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePageHeaderProps\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L6)\n\nInterface for PageHeader component props.\n\n## Properties\n\n### actions?\n\n> `optional` **actions**: `ReactNode`\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L25)\n\n***\n\n### rootClassName?\n\n> `optional` **rootClassName**: `string`\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L26)\n\n***\n\n### search?\n\n> `optional` **search**: `object`\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L8)\n\n#### buttonTestId?\n\n> `optional` **buttonTestId**: `string`\n\n#### inputTestId?\n\n> `optional` **inputTestId**: `string`\n\n#### onSearch()\n\n> **onSearch**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string`\n\n##### Returns\n\n`void`\n\n#### placeholder\n\n> **placeholder**: `string`\n\n***\n\n### sorting?\n\n> `optional` **sorting**: `object`[]\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L14)\n\n#### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\n#### icon?\n\n> `optional` **icon**: `string`\n\n#### onChange()\n\n> **onChange**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string` | `number`\n\n##### Returns\n\n`void`\n\n#### options\n\n> **options**: `object`[]\n\n#### selected\n\n> **selected**: `string` \\| `number`\n\n#### testIdPrefix\n\n> **testIdPrefix**: `string`\n\n#### title\n\n> **title**: `string`\n\n#### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/shared-components/Navbar/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Navbar/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastHelpers.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceNotificationToastHelpers\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L64)\n\nReusable helper API exposed by `NotificationToast`.\n\n## Properties\n\n### dismiss()\n\n> **dismiss**: () => `void`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L88)\n\nDismiss all active toasts.\n\n#### Returns\n\n`void`\n\n***\n\n### error()\n\n> **error**: (`message`, `options?`) => `Id`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L73)\n\nShow an error toast.\n\n#### Parameters\n\n##### message\n\n[`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\n##### options?\n\n`ToastOptions`\n\n#### Returns\n\n`Id`\n\n***\n\n### info()\n\n> **info**: (`message`, `options?`) => `Id`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L83)\n\nShow an info toast.\n\n#### Parameters\n\n##### message\n\n[`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\n##### options?\n\n`ToastOptions`\n\n#### Returns\n\n`Id`\n\n***\n\n### promise()\n\n> **promise**: \\<`T`\\>(`promisifiedFunction`, `messages`, `options?`) => `Promise`\\<`T`\\>\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L93)\n\nShow a promise toast with pending, success, and error states.\n\n#### Type Parameters\n\n##### T\n\n`T` = `void`\n\n#### Parameters\n\n##### promisifiedFunction\n\n[`PromiseFunction`](../type-aliases/PromiseFunction.md)\\<`T`\\>\n\n##### messages\n\n[`InterfacePromiseMessages`](InterfacePromiseMessages.md)\n\n##### options?\n\n`ToastOptions`\n\n#### Returns\n\n`Promise`\\<`T`\\>\n\n***\n\n### success()\n\n> **success**: (`message`, `options?`) => `Id`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L68)\n\nShow a success toast.\n\n#### Parameters\n\n##### message\n\n[`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\n##### options?\n\n`ToastOptions`\n\n#### Returns\n\n`Id`\n\n***\n\n### warning()\n\n> **warning**: (`message`, `options?`) => `Id`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L78)\n\nShow a warning toast.\n\n#### Parameters\n\n##### message\n\n[`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\n##### options?\n\n`ToastOptions`\n\n#### Returns\n\n`Id`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfaceNotificationToastI18nMessage.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceNotificationToastI18nMessage\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L18)\n\ni18n-backed toast message definition.\n\n## Properties\n\n### key\n\n> **key**: `string`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L25)\n\nThe i18next key to translate.\n\n#### Example\n\n```ts\n'sessionWarning'\n```\n\n***\n\n### namespace?\n\n> `optional` **namespace**: [`NotificationToastNamespace`](../type-aliases/NotificationToastNamespace.md)\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L32)\n\nOptional i18next namespace to use for translation.\n\nDefaults to `'common'` when omitted.\n\n***\n\n### values?\n\n> `optional` **values**: `Record`\\<`string`, `unknown`\\>\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L37)\n\nOptional interpolation values for i18next.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/interfaces/InterfacePromiseMessages.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePromiseMessages\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L50)\n\nPromise toast messages for pending, success, and error states.\n\n## Properties\n\n### error\n\n> **error**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L53)\n\n***\n\n### pending\n\n> **pending**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L51)\n\n***\n\n### success\n\n> **success**: [`NotificationToastMessage`](../type-aliases/NotificationToastMessage.md)\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L52)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastContainerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: NotificationToastContainerProps\n\n> **NotificationToastContainerProps** = `ToastContainerProps`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L103)\n\nProps for the `NotificationToastContainer` wrapper component.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastMessage.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: NotificationToastMessage\n\n> **NotificationToastMessage** = `string` \\| [`InterfaceNotificationToastI18nMessage`](../interfaces/InterfaceNotificationToastI18nMessage.md)\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L43)\n\nA toast message can be a plain string or a translatable i18n key.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/NotificationToastNamespace.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: NotificationToastNamespace\n\n> **NotificationToastNamespace** = `\"translation\"` \\| `\"errors\"` \\| `\"common\"` \\| `string` & `object`\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L9)\n\nSupported i18next namespaces in Talawa Admin.\n\nThe app initializes i18n with `translation`, `errors`, and `common`, but this\ntype also allows custom namespaces for future expansion.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/NotificationToast/interface/type-aliases/PromiseFunction.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: PromiseFunction()\\\n\n> **PromiseFunction**\\<`T`\\> = () => `Promise`\\<`T`\\>\n\nDefined in: [src/types/shared-components/NotificationToast/interface.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/NotificationToast/interface.ts#L59)\n\nPromisified function type.\n\n## Type Parameters\n\n### T\n\n`T` = `void`\n\n## Returns\n\n`Promise`\\<`T`\\>\n" }, { "path": "docs/docs/auto-docs/types/shared-components/PaginationList/interface/interfaces/InterfacePaginationListProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePaginationListProps\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L7)\n\nInterfacePaginationListProps\nInterface for PaginationList component props\n\n## Properties\n\n### count\n\n> **count**: `number`\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L8)\n\n***\n\n### onPageChange()\n\n> **onPageChange**: (`event`, `newPage`) => `void`\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L11)\n\n#### Parameters\n\n##### event\n\n`MouseEvent`\\<`HTMLButtonElement`, `MouseEvent`\\>\n\n##### newPage\n\n`number`\n\n#### Returns\n\n`void`\n\n***\n\n### onRowsPerPageChange()\n\n> **onRowsPerPageChange**: (`event`) => `void`\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L15)\n\n#### Parameters\n\n##### event\n\n`ChangeEvent`\\<`HTMLInputElement` \\| `HTMLTextAreaElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### page\n\n> **page**: `number`\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L10)\n\n***\n\n### rowsPerPage\n\n> **rowsPerPage**: `number`\n\nDefined in: [src/types/shared-components/PaginationList/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PaginationList/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/PeopleTabNavbar/interface/interfaces/InterfacePeopleTabNavbarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePeopleTabNavbarProps\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L6)\n\nProps for PeopleTabNavbar component.\n\n## Properties\n\n### actions?\n\n> `optional` **actions**: `ReactNode`\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L23)\n\n***\n\n### alignmentClassName?\n\n> `optional` **alignmentClassName**: `string`\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L24)\n\n***\n\n### search?\n\n> `optional` **search**: `object`\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L8)\n\n#### buttonTestId?\n\n> `optional` **buttonTestId**: `string`\n\n#### inputTestId?\n\n> `optional` **inputTestId**: `string`\n\n#### onSearch()\n\n> **onSearch**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string`\n\n##### Returns\n\n`void`\n\n#### placeholder\n\n> **placeholder**: `string`\n\n***\n\n### sorting?\n\n> `optional` **sorting**: `object`[]\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L14)\n\n#### icon?\n\n> `optional` **icon**: `string`\n\n#### onChange()\n\n> **onChange**: (`value`) => `void`\n\n##### Parameters\n\n###### value\n\n`string` | `number`\n\n##### Returns\n\n`void`\n\n#### options\n\n> **options**: `object`[]\n\n#### selected\n\n> **selected**: `string` \\| `number`\n\n#### testIdPrefix\n\n> **testIdPrefix**: `string`\n\n#### title\n\n> **title**: `string`\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/shared-components/PeopleTabNavbar/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PeopleTabNavbar/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/PluginRouteRenderer/interface/interfaces/InterfacePluginRouteRendererProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePluginRouteRendererProps\n\nDefined in: [src/types/shared-components/PluginRouteRenderer/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRouteRenderer/interface.ts#L7)\n\nProps for PluginRouteRenderer component.\n\n## Properties\n\n### fallback?\n\n> `optional` **fallback**: `ReactNode`\n\nDefined in: [src/types/shared-components/PluginRouteRenderer/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRouteRenderer/interface.ts#L9)\n\n***\n\n### route\n\n> **route**: [`IRouteExtension`](../../../../../plugin/types/interfaces/IRouteExtension.md)\n\nDefined in: [src/types/shared-components/PluginRouteRenderer/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRouteRenderer/interface.ts#L8)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/PluginRoutes/interface/interfaces/InterfacePluginRoutesProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePluginRoutesProps\n\nDefined in: [src/types/shared-components/PluginRoutes/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRoutes/interface.ts#L6)\n\nProps for PluginRoutes component.\n\n## Properties\n\n### fallback?\n\n> `optional` **fallback**: `ReactElement`\n\nDefined in: [src/types/shared-components/PluginRoutes/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRoutes/interface.ts#L9)\n\n***\n\n### isAdmin?\n\n> `optional` **isAdmin**: `boolean`\n\nDefined in: [src/types/shared-components/PluginRoutes/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRoutes/interface.ts#L8)\n\n***\n\n### userPermissions?\n\n> `optional` **userPermissions**: `string`[]\n\nDefined in: [src/types/shared-components/PluginRoutes/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PluginRoutes/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/PostViewModal/interface/interfaces/InterfacePostViewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostViewModalProps\n\nDefined in: [src/types/shared-components/PostViewModal/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PostViewModal/interface.ts#L11)\n\nProps for PostViewModal component.\n\n## Param\n\nControls the visibility of the modal.\n\n## Param\n\nCallback invoked when the modal should close.\n\n## Param\n\nThe post data to display, or null if not loaded.\n\n## Param\n\nFunction to refresh post data after mutations.\n\n## Properties\n\n### onHide()\n\n> **onHide**: () => `void`\n\nDefined in: [src/types/shared-components/PostViewModal/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PostViewModal/interface.ts#L13)\n\n#### Returns\n\n`void`\n\n***\n\n### post\n\n> **post**: [`InterfacePost`](../../../../Post/interface/interfaces/InterfacePost.md)\n\nDefined in: [src/types/shared-components/PostViewModal/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PostViewModal/interface.ts#L14)\n\n***\n\n### refetch()\n\n> **refetch**: () => `Promise`\\<`unknown`\\>\n\nDefined in: [src/types/shared-components/PostViewModal/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PostViewModal/interface.ts#L15)\n\n#### Returns\n\n`Promise`\\<`unknown`\\>\n\n***\n\n### show\n\n> **show**: `boolean`\n\nDefined in: [src/types/shared-components/PostViewModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/PostViewModal/interface.ts#L12)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ProfileAvatarDisplay/interface/interfaces/InterfaceProfileAvatarDisplayProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceProfileAvatarDisplayProps\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L5)\n\nProps for the ProfileAvatarDisplay component.\n\n## Properties\n\n### border?\n\n> `optional` **border**: `boolean`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L15)\n\n(Optional) Flag to add a border around the avatar.\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L17)\n\n(Optional) Additional CSS class names.\n\n***\n\n### crossOrigin?\n\n> `optional` **crossOrigin**: `\"anonymous\"` \\| `\"use-credentials\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L31)\n\nneed to support other props which are in images\n\n***\n\n### customSize?\n\n> `optional` **customSize**: `number`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L13)\n\n(Optional) Custom size in pixels (used when size='custom').\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L23)\n\n(Optional) Test ID for testing purposes.\n\n***\n\n### decoding?\n\n> `optional` **decoding**: `\"sync\"` \\| `\"async\"` \\| `\"auto\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L33)\n\n(Optional) Decoding strategy for the image element.\n\n***\n\n### enableEnlarge?\n\n> `optional` **enableEnlarge**: `boolean`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L29)\n\nIf true, clicking the avatar opens an enlarged modal view\n\n***\n\n### fallbackName\n\n> **fallbackName**: `string`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L21)\n\nRequired name used for fallback avatar generation.\n\n***\n\n### imageUrl?\n\n> `optional` **imageUrl**: `string`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L7)\n\n(Optional) URL of the avatar image to display.\n\n***\n\n### loading?\n\n> `optional` **loading**: `\"eager\"` \\| `\"lazy\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L35)\n\n(Optional) Loading strategy for the image element.\n\n***\n\n### objectFit?\n\n> `optional` **objectFit**: `\"fill\"` \\| `\"none\"` \\| `\"cover\"` \\| `\"contain\"` \\| `\"scale-down\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L25)\n\n(Optional) CSS object-fit value for the image.\n\n***\n\n### onClick()?\n\n> `optional` **onClick**: () => `void`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L27)\n\n(Optional) Click handler for the avatar.\n\n#### Returns\n\n`void`\n\n***\n\n### onError()?\n\n> `optional` **onError**: () => `void`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L37)\n\nError handler for the image element.\n\n#### Returns\n\n`void`\n\n***\n\n### onLoad()?\n\n> `optional` **onLoad**: () => `void`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L39)\n\nLoad handler for the image element.\n\n#### Returns\n\n`void`\n\n***\n\n### shape?\n\n> `optional` **shape**: `\"circle\"` \\| `\"square\"` \\| `\"rounded\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L11)\n\n(Optional) Shape: 'circle', 'square', or 'rounded'.\n\n***\n\n### size?\n\n> `optional` **size**: `\"small\"` \\| `\"custom\"` \\| `\"medium\"` \\| `\"large\"`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L9)\n\n(Optional) Size preset: 'small', 'medium', 'large', or 'custom'.\n\n***\n\n### style?\n\n> `optional` **style**: `CSSProperties`\n\nDefined in: [src/types/shared-components/ProfileAvatarDisplay/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileAvatarDisplay/interface.ts#L19)\n\n(Optional) Inline React CSS properties.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ProfileCard/interface/interfaces/InterfaceProfileCardProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceProfileCardProps\n\nDefined in: [src/types/shared-components/ProfileCard/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileCard/interface.ts#L6)\n\nProfileCard component displays user profile information in a card format.\nIt includes the user's name, role, and profile image. The component also provides\nnavigation functionality based on the user's role and the specified portal.\n\n## Properties\n\n### portal?\n\n> `optional` **portal**: `\"user\"` \\| `\"admin\"`\n\nDefined in: [src/types/shared-components/ProfileCard/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileCard/interface.ts#L14)\n\nThe portal for which the profile card is being rendered. This determines the navigation\nbehavior when the user clicks on the profile card. The default value is 'admin'.\n- 'admin': Navigates to the admin dashboard or relevant admin pages.\n- 'user': Navigates to the user dashboard or relevant user pages.\n\n#### Default Value\n\n```ts\n'admin'\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/ProfileDropdown/interface/interfaces/InterfaceProfileDropdownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceProfileDropdownProps\n\nDefined in: [src/types/shared-components/ProfileDropdown/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileDropdown/interface.ts#L6)\n\nProfileDropdown component interface definition\nThis file defines the TypeScript interface for the ProfileDropdown component props.\nIt ensures type safety and provides clear documentation for the expected props.\n\n## Properties\n\n### portal?\n\n> `optional` **portal**: `\"user\"` \\| `\"admin\"`\n\nDefined in: [src/types/shared-components/ProfileDropdown/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/ProfileDropdown/interface.ts#L13)\n\nOptional prop to specify the portal type for navigation purposes.\nAcceptable values are 'admin' or 'user'. This prop is used to determine\nthe navigation path when the user clicks on the profile or logout options.\n`@defaultValue` 'admin'\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceEndOptionsSectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceEndOptionsSectionProps\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L11)\n\nProps for the RecurrenceEndOptionsSection component.\n\n## Properties\n\n### frequency\n\n> **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L13)\n\nThe frequency of the recurrence (e.g., DAILY, WEEKLY).\n\n***\n\n### localCount\n\n> **localCount**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L19)\n\nThe local count value for \"End after X occurrences\".\n\n***\n\n### onCountChange()\n\n> **onCountChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L23)\n\nCallback when the occurrence count changes.\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### onRecurrenceEndOptionChange()\n\n> **onRecurrenceEndOptionChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L21)\n\nCallback when the end option selection changes.\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### recurrenceRuleState\n\n> **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L17)\n\nThe current state of the recurrence rule being built.\n\n***\n\n### selectedRecurrenceEndOption\n\n> **selectedRecurrenceEndOption**: [`RecurrenceEndOptionType`](../../../../../utils/recurrenceUtils/recurrenceTypes/type-aliases/RecurrenceEndOptionType.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L15)\n\nThe currently selected end option (NEVER, ON_DATE, AFTER_OCCURRENCES).\n\n***\n\n### setRecurrenceRuleState()\n\n> **setRecurrenceRuleState**: (`state`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L25)\n\nState setter for the recurrence rule.\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<[`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L29)\n\nTranslation function.\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceFrequencySectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceFrequencySectionProps\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L35)\n\nProps for the RecurrenceFrequencySection component.\n\n## Properties\n\n### frequency\n\n> **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L37)\n\nThe selected frequency usage.\n\n***\n\n### localInterval\n\n> **localInterval**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L39)\n\nThe interval value (e.g., every 2 weeks).\n\n***\n\n### onFrequencyChange()\n\n> **onFrequencyChange**: (`newFrequency`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L43)\n\nCallback when the frequency changes.\n\n#### Parameters\n\n##### newFrequency\n\n[`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md)\n\n#### Returns\n\n`void`\n\n***\n\n### onIntervalChange()\n\n> **onIntervalChange**: (`e`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L41)\n\nCallback when the interval changes.\n\n#### Parameters\n\n##### e\n\n`ChangeEvent`\\<`HTMLInputElement`\\>\n\n#### Returns\n\n`void`\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L45)\n\nTranslation function.\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/Recurrence/interface/interfaces/InterfaceRecurrenceMonthlySectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceMonthlySectionProps\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L51)\n\nProps for the RecurrenceMonthlySection component.\n\n## Properties\n\n### frequency\n\n> **frequency**: [`Frequency`](../../../../../utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L53)\n\nThe selected frequency.\n\n***\n\n### recurrenceRuleState\n\n> **recurrenceRuleState**: [`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L55)\n\nThe current state of the recurrence rule being built.\n\n***\n\n### setRecurrenceRuleState()\n\n> **setRecurrenceRuleState**: (`state`) => `void`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L57)\n\nState setter for the recurrence rule.\n\n#### Parameters\n\n##### state\n\n`SetStateAction`\\<[`InterfaceRecurrenceRule`](../../../../../utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\\>\n\n#### Returns\n\n`void`\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L61)\n\nThe start date of the recurrence.\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/shared-components/Recurrence/interface.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/Recurrence/interface.ts#L63)\n\nTranslation function.\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/RecurrenceDropdown/interface/interfaces/InterfaceRecurrenceDropdownProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceDropdownProps\n\nDefined in: [src/types/shared-components/RecurrenceDropdown/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/RecurrenceDropdown/interface.ts#L6)\n\nProps for the RecurrenceDropdown component.\n\n## Properties\n\n### currentLabel\n\n> **currentLabel**: `string`\n\nDefined in: [src/types/shared-components/RecurrenceDropdown/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/RecurrenceDropdown/interface.ts#L8)\n\n***\n\n### onSelect()\n\n> **onSelect**: (`option`) => `void`\n\nDefined in: [src/types/shared-components/RecurrenceDropdown/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/RecurrenceDropdown/interface.ts#L9)\n\n#### Parameters\n\n##### option\n\n[`InterfaceRecurrenceOption`](../../../../../shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md)\n\n#### Returns\n\n`void`\n\n***\n\n### recurrenceOptions\n\n> **recurrenceOptions**: [`InterfaceRecurrenceOption`](../../../../../shared-components/EventForm/utils/recurrenceOptions/interfaces/InterfaceRecurrenceOption.md)[]\n\nDefined in: [src/types/shared-components/RecurrenceDropdown/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/RecurrenceDropdown/interface.ts#L7)\n\n***\n\n### t()\n\n> **t**: (`key`) => `string`\n\nDefined in: [src/types/shared-components/RecurrenceDropdown/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/RecurrenceDropdown/interface.ts#L10)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceDropdownConfig.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceDropdownConfig\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L34)\n\nConfiguration for a single dropdown (sort or filter) in the SearchFilterBar.\nEach dropdown represents either a sorting control or a filter control,\nand is rendered using the SortingButton component.\n\n## Properties\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L113)\n\nOptional extra class for the dropdown container (e.g. from parent CSS module for styling).\n\n***\n\n### dataTestIdPrefix\n\n> **dataTestIdPrefix**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L94)\n\nThe prefix used for generating data-testid attributes for testing.\nThis is passed directly to the SortingButton component's `dataTestIdPrefix` prop.\n\n#### Example\n\n```ts\n\"sortTags\", \"filterPlugins\", \"timeFrame\"\n```\n\n***\n\n### dropdownTestId?\n\n> `optional` **dropdownTestId**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L108)\n\nOptional data-testid for the dropdown element itself.\n**Job:** Enables testing frameworks to identify the entire dropdown component.\n\n#### Example\n\n```ts\n\"filter\", \"sort\", \"timeFrame\"\n```\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L40)\n\nA unique identifier for this dropdown configuration.\nUsed as the React key for stable rendering and should be unique across all dropdowns.\n\n#### Example\n\n```ts\n\"sort-by-date\", \"filter-by-status\", \"group-by-category\"\n```\n\n***\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L47)\n\nThe label/title displayed on the dropdown button.\nThis is typically a user-facing label like \"Sort\", \"Filter\", or \"Time Frame\".\n\n#### Example\n\n```ts\n\"Sort\", \"Filter plugins\", \"Time Frame\"\n```\n\n***\n\n### onOptionChange()\n\n> **onOptionChange**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L87)\n\nCallback function triggered when the user selects a different option.\n**Trigger:** User clicks on a dropdown item in the menu.\n**Job:** Updates the parent component's state with the newly selected value.\n\n#### Parameters\n\n##### value\n\nThe `value` field of the selected option\n\n`string` | `number`\n\n#### Returns\n\n`void`\n\n#### Example\n\n```ts\nonOptionChange={(value) => setSortOrder(value as SortedByType)}\n```\n\n***\n\n### options\n\n> **options**: [`InterfaceSortingOption`](InterfaceSortingOption.md)[]\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L67)\n\nThe list of available options for this dropdown.\nEach option contains a label (display text) and a value (underlying data).\n\n#### Example\n\n```ts\n[\n { label: 'Latest', value: 'DESCENDING' },\n { label: 'Oldest', value: 'ASCENDING' }\n]\n```\n\n***\n\n### selectedOption\n\n> **selectedOption**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L74)\n\nThe currently selected option value.\nThis should match the `value` field of one of the options in the `options` array.\n\n#### Example\n\n```ts\n\"DESCENDING\", \"hours_DESC\", \"all\", 0, 1, 2\n```\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L101)\n\nOptional title attribute for the dropdown element.\n**Job:** Provides tooltip text when hovering over the dropdown.\n\n#### Example\n\n```ts\n\"Filter plugins\", \"Sort options\"\n```\n\n***\n\n### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L118)\n\nOptional extra class for the dropdown toggle button (e.g. from parent CSS module for styling).\n\n***\n\n### type\n\n> **type**: `\"filter\"` \\| `\"sort\"`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L54)\n\nThe type of dropdown control.\n- `'sort'`: Displays a sort icon and is used for ordering data\n- `'filter'`: Displays a filter icon and is used for filtering data\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarAdvanced.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchFilterBarAdvanced\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:302](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L302)\n\nConfiguration for SearchFilterBar with search and dropdown functionality.\n\nUse this variant when you need search capabilities combined with one or more\nsorting/filtering dropdowns.\n\n## Examples\n\n```tsx\n\n```\n\n```tsx\n setSortBy(value as 'hours_DESC' | 'hours_ASC'),\n dataTestIdPrefix: 'sort'\n },\n {\n label: 'Time Frame',\n type: 'filter',\n options: [\n { label: 'All Time', value: 'allTime' },\n { label: 'Weekly', value: 'weekly' }\n ],\n selectedOption: timeFrame,\n onOptionChange: (value) => setTimeFrame(value as TimeFrame),\n dataTestIdPrefix: 'timeFrame'\n }\n ]}\n/>\n```\n\n## Extends\n\n- `InterfaceSearchFilterBarBase`\n\n## Properties\n\n### additionalButtons?\n\n> `optional` **additionalButtons**: `ReactNode`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:343](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L343)\n\nOptional additional React elements to render after the dropdowns.\n**Job:** Allows inserting custom buttons or components (e.g., \"Upload Plugin\" button).\nThese elements are rendered inside the btnsBlockSearchBar container after all dropdowns.\n\n#### Example\n\n```tsx\nadditionalButtons={\n \n}\n```\n\n***\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L192)\n\nOptional custom class name for the container div.\n**Job:** Allows overriding the default container styling for different screen layouts.\ndefault \"btnsContainerSearchBar\"\n\n#### Example\n\n```ts\n\"btnsContainer\", \"btnsContainerSearchBar\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.containerClassName`\n\n***\n\n### debounceDelay?\n\n> `optional` **debounceDelay**: `number`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L201)\n\nOptional delay in milliseconds for debouncing search input changes.\n**Job:** Controls how long to wait after the user stops typing before calling onSearchChange.\nThis prevents excessive API calls while the user is actively typing.\ndefault 300\n\n#### Example\n\n```ts\n300, 500, 1000\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.debounceDelay`\n\n***\n\n### dropdowns\n\n> **dropdowns**: [`InterfaceDropdownConfig`](InterfaceDropdownConfig.md)[]\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:328](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L328)\n\nArray of dropdown configurations for sorting and filtering.\n**Job:** Defines all the dropdown controls that appear alongside the search bar.\nEach dropdown can be either a sort control or a filter control.\nThe order of dropdowns in this array determines their visual order in the UI.\n\n#### Example\n\n```ts\ndropdowns={[\n {\n label: 'Sort',\n type: 'sort',\n options: [...],\n selectedOption: sortBy,\n onOptionChange: setSortBy,\n dataTestIdPrefix: 'sort'\n }\n]}\n```\n\n***\n\n### hasDropdowns\n\n> **hasDropdowns**: `true`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:307](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L307)\n\nDiscriminator property indicating this variant has dropdowns.\n**Job:** When `true`, the `dropdowns` property must be provided.\n\n***\n\n### onSearchChange()\n\n> **onSearchChange**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L152)\n\nCallback function triggered on every keystroke in the search input.\n**Trigger:** User types or deletes characters in the search field (onChange event).\n**Job:** Updates the parent component's search state immediately.\nParent components should handle their own debouncing for expensive operations.\n\n#### Parameters\n\n##### value\n\n`string`\n\nThe current value of the search input field\n\n#### Returns\n\n`void`\n\n#### Example\n\n```ts\nonSearchChange={(value) => setSearchTerm(value)}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.onSearchChange`\n\n***\n\n### onSearchSubmit()?\n\n> `optional` **onSearchSubmit**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L168)\n\nOptional callback function triggered when the user explicitly submits the search.\n**Trigger:** User presses Enter key or clicks the search button.\n**Job:** Performs an immediate search action.\nUseful for triggering search on explicit user action vs typing.\n\n#### Parameters\n\n##### value\n\n`string`\n\nThe current value of the search input field\n\n#### Returns\n\n`void`\n\n#### Example\n\n```ts\nonSearchSubmit={(value) => {\n console.log('User explicitly searched for:', value);\n performSearch(value);\n}}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.onSearchSubmit`\n\n***\n\n### searchButtonTestId?\n\n> `optional` **searchButtonTestId**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L184)\n\nOptional data-testid for the search button.\n**Job:** Enables testing frameworks to identify the search button element.\ndefault \"searchButton\"\n\n#### Example\n\n```ts\n\"searchPluginsBtn\", \"searchBtn\", \"searchButton\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchButtonTestId`\n\n***\n\n### searchInputTestId?\n\n> `optional` **searchInputTestId**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L176)\n\nOptional data-testid for the search input field.\n**Job:** Enables testing frameworks to identify the search input element.\ndefault \"searchInput\"\n\n#### Example\n\n```ts\n\"searchPlugins\", \"searchBy\", \"searchRequests\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchInputTestId`\n\n***\n\n### searchPlaceholder\n\n> **searchPlaceholder**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L131)\n\nPlaceholder text displayed in the search input field.\n**Job:** Provides guidance to users about what they can search for.\n\n#### Example\n\n```ts\n\"Search by volunteer\", \"Search requests\", \"Search plugins\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchPlaceholder`\n\n***\n\n### searchValue\n\n> **searchValue**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L139)\n\nThe current search term value.\n**Job:** Controls the value of the search input field (controlled component pattern).\nThis should be managed in the parent component's state.\n\n#### Example\n\n```ts\n\"John Doe\", \"authentication\", \"\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchValue`\n\n***\n\n### translations?\n\n> `optional` **translations**: [`InterfaceSearchFilterBarTranslations`](InterfaceSearchFilterBarTranslations.md)\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L214)\n\nOptional translation overrides for accessibility and UI customization.\n**Job:** Allows customizing internal component translations while providing sensible defaults.\n\n#### Example\n\n```ts\ntranslations: {\n searchButtonAriaLabel: \"Search for volunteers\",\n dropdownAriaLabel: \"Toggle {label} options\"\n}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.translations`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarSimple.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchFilterBarSimple\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L230)\n\nConfiguration for SearchFilterBar with only search functionality (no dropdowns).\nUse this variant when you only need search capabilities without any sorting or filtering dropdowns.\n\n## Example\n\n```tsx\n\n```\n\n## Extends\n\n- `InterfaceSearchFilterBarBase`\n\n## Properties\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L192)\n\nOptional custom class name for the container div.\n**Job:** Allows overriding the default container styling for different screen layouts.\ndefault \"btnsContainerSearchBar\"\n\n#### Example\n\n```ts\n\"btnsContainer\", \"btnsContainerSearchBar\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.containerClassName`\n\n***\n\n### debounceDelay?\n\n> `optional` **debounceDelay**: `number`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L201)\n\nOptional delay in milliseconds for debouncing search input changes.\n**Job:** Controls how long to wait after the user stops typing before calling onSearchChange.\nThis prevents excessive API calls while the user is actively typing.\ndefault 300\n\n#### Example\n\n```ts\n300, 500, 1000\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.debounceDelay`\n\n***\n\n### hasDropdowns\n\n> **hasDropdowns**: `false`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L236)\n\nDiscriminator property indicating this variant has no dropdowns.\n\n**Job:** When `false`, the `dropdowns` property must be omitted.\n\n***\n\n### onSearchChange()\n\n> **onSearchChange**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L152)\n\nCallback function triggered on every keystroke in the search input.\n**Trigger:** User types or deletes characters in the search field (onChange event).\n**Job:** Updates the parent component's search state immediately.\nParent components should handle their own debouncing for expensive operations.\n\n#### Parameters\n\n##### value\n\n`string`\n\nThe current value of the search input field\n\n#### Returns\n\n`void`\n\n#### Example\n\n```ts\nonSearchChange={(value) => setSearchTerm(value)}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.onSearchChange`\n\n***\n\n### onSearchSubmit()?\n\n> `optional` **onSearchSubmit**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L168)\n\nOptional callback function triggered when the user explicitly submits the search.\n**Trigger:** User presses Enter key or clicks the search button.\n**Job:** Performs an immediate search action.\nUseful for triggering search on explicit user action vs typing.\n\n#### Parameters\n\n##### value\n\n`string`\n\nThe current value of the search input field\n\n#### Returns\n\n`void`\n\n#### Example\n\n```ts\nonSearchSubmit={(value) => {\n console.log('User explicitly searched for:', value);\n performSearch(value);\n}}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.onSearchSubmit`\n\n***\n\n### searchButtonTestId?\n\n> `optional` **searchButtonTestId**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L184)\n\nOptional data-testid for the search button.\n**Job:** Enables testing frameworks to identify the search button element.\ndefault \"searchButton\"\n\n#### Example\n\n```ts\n\"searchPluginsBtn\", \"searchBtn\", \"searchButton\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchButtonTestId`\n\n***\n\n### searchInputTestId?\n\n> `optional` **searchInputTestId**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L176)\n\nOptional data-testid for the search input field.\n**Job:** Enables testing frameworks to identify the search input element.\ndefault \"searchInput\"\n\n#### Example\n\n```ts\n\"searchPlugins\", \"searchBy\", \"searchRequests\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchInputTestId`\n\n***\n\n### searchPlaceholder\n\n> **searchPlaceholder**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L131)\n\nPlaceholder text displayed in the search input field.\n**Job:** Provides guidance to users about what they can search for.\n\n#### Example\n\n```ts\n\"Search by volunteer\", \"Search requests\", \"Search plugins\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchPlaceholder`\n\n***\n\n### searchValue\n\n> **searchValue**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L139)\n\nThe current search term value.\n**Job:** Controls the value of the search input field (controlled component pattern).\nThis should be managed in the parent component's state.\n\n#### Example\n\n```ts\n\"John Doe\", \"authentication\", \"\"\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.searchValue`\n\n***\n\n### translations?\n\n> `optional` **translations**: [`InterfaceSearchFilterBarTranslations`](InterfaceSearchFilterBarTranslations.md)\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L214)\n\nOptional translation overrides for accessibility and UI customization.\n**Job:** Allows customizing internal component translations while providing sensible defaults.\n\n#### Example\n\n```ts\ntranslations: {\n searchButtonAriaLabel: \"Search for volunteers\",\n dropdownAriaLabel: \"Toggle {label} options\"\n}\n```\n\n#### Inherited from\n\n`InterfaceSearchFilterBarBase.translations`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSearchFilterBarTranslations.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSearchFilterBarTranslations\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:351](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L351)\n\nOptional translation overrides for SearchFilterBar component.\nAllows parent components to customize internal translations while\nproviding sensible defaults for accessibility and common UI elements.\n\n## Properties\n\n### clearButtonAriaLabel?\n\n> `optional` **clearButtonAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L359)\n\nClear button accessible label (screen readers)\n\n***\n\n### clearSearchLabel?\n\n> `optional` **clearSearchLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:356](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L356)\n\nClear search button text/label\n\n***\n\n### dropdownAriaLabel?\n\n> `optional` **dropdownAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L371)\n\nDropdown toggle accessible label pattern\n\n***\n\n### filterAndSortOptionsLabel?\n\n> `optional` **filterAndSortOptionsLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:380](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L380)\n\nFilter and sort options toolbar accessible label\n\n***\n\n### filterButtonAriaLabel?\n\n> `optional` **filterButtonAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:377](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L377)\n\nFilter button accessible label\n\n***\n\n### loadingLabel?\n\n> `optional` **loadingLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:362](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L362)\n\nLoading state text\n\n***\n\n### noResultsLabel?\n\n> `optional` **noResultsLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:365](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L365)\n\nNo results found message\n\n***\n\n### searchButtonAriaLabel?\n\n> `optional` **searchButtonAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:353](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L353)\n\nSearch button accessible label (screen readers)\n\n***\n\n### searchInputAriaDescription?\n\n> `optional` **searchInputAriaDescription**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:368](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L368)\n\nSearch input accessible description\n\n***\n\n### sortButtonAriaLabel?\n\n> `optional` **sortButtonAriaLabel**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L374)\n\nSort button accessible label\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/interfaces/InterfaceSortingOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSortingOption\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L14)\n\nRepresents a single option in a sorting or filtering dropdown.\nThis interface is compatible with the SortingButton component's option format.\n\n## Properties\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L19)\n\nThe display text shown to the user in the dropdown menu.\n\n#### Example\n\n```ts\n\"Latest\", \"Oldest\", \"Most Hours\"\n```\n\n***\n\n### value\n\n> **value**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L26)\n\nThe underlying value associated with this option.\nThis value is passed to the onOptionChange callback when the option is selected.\n\n#### Example\n\n```ts\n\"DESCENDING\", \"hours_DESC\", \"all\", 0, 1, 2\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SearchFilterBar/interface/type-aliases/InterfaceSearchFilterBarProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: InterfaceSearchFilterBarProps\n\n> **InterfaceSearchFilterBarProps** = [`InterfaceSearchFilterBarSimple`](../interfaces/InterfaceSearchFilterBarSimple.md) \\| [`InterfaceSearchFilterBarAdvanced`](../interfaces/InterfaceSearchFilterBarAdvanced.md)\n\nDefined in: [src/types/shared-components/SearchFilterBar/interface.ts:426](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SearchFilterBar/interface.ts#L426)\n\nMain props interface for the SearchFilterBar component.\n\nThis is a discriminated union type that ensures type safety:\n- When `hasDropdowns` is `false`, the `dropdowns` property cannot be provided\n- When `hasDropdowns` is `true`, the `dropdowns` property must be provided\n\n## Examples\n\n```tsx\nconst props: InterfaceSearchFilterBarProps = {\n hasDropdowns: false,\n searchPlaceholder: \"Search...\",\n searchValue: searchTerm,\n onSearchChange: setSearchTerm\n};\n```\n\n```tsx\nconst props: InterfaceSearchFilterBarProps = {\n hasDropdowns: true,\n searchPlaceholder: \"Search...\",\n searchValue: searchTerm,\n onSearchChange: setSearchTerm,\n dropdowns: [...]\n};\n```\n\n```tsx\nconst props: InterfaceSearchFilterBarProps = {\n hasDropdowns: true,\n searchPlaceholder: \"Search plugins...\",\n searchValue: searchTerm,\n onSearchChange: setSearchTerm,\n dropdowns: [...],\n translations: {\n searchButtonAriaLabel: \"Search for plugins\",\n dropdownAriaLabel: \"Toggle {label} filters\"\n }\n};\n```\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SidebarOrgSection/interface/interfaces/IOrganizationData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IOrganizationData\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L12)\n\n## Properties\n\n### addressLine1?\n\n> `optional` **addressLine1**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L23)\n\nPrimary address line\n\n***\n\n### addressLine2?\n\n> `optional` **addressLine2**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L26)\n\nSecondary address line\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L41)\n\nURL of the organization's avatar or logo image\n\n***\n\n### city?\n\n> `optional` **city**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L29)\n\nCity where the organization is located\n\n***\n\n### countryCode?\n\n> `optional` **countryCode**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L38)\n\nISO country code representing the organization's country\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L44)\n\nISO timestamp string indicating when the organization was created\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L20)\n\nOptional short description of the organization\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L14)\n\nUnique identifier of the organization\n\n***\n\n### isUserRegistrationRequired?\n\n> `optional` **isUserRegistrationRequired**: `boolean`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L48)\n\nIndicates whether user registration is required\nbefore accessing organization resources\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L17)\n\nDisplay name of the organization\n\n***\n\n### postalCode?\n\n> `optional` **postalCode**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L35)\n\nPostal or ZIP code\n\n***\n\n### state?\n\n> `optional` **state**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L32)\n\nState or province of the organization\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SidebarOrgSection/interface/interfaces/ISidebarOrgSectionProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: ISidebarOrgSectionProps\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L4)\n\nProps for the SidebarOrgSection component.\n\n## Properties\n\n### hideDrawer\n\n> **hideDrawer**: `boolean`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L8)\n\nWhether the drawer is hidden/collapsed.\n\n***\n\n### isProfilePage?\n\n> `optional` **isProfilePage**: `boolean`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L10)\n\nWhether current page is the profile page.\n\n***\n\n### orgId\n\n> **orgId**: `string`\n\nDefined in: [src/types/shared-components/SidebarOrgSection/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SidebarOrgSection/interface.ts#L6)\n\nOrganization ID to fetch and display.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SortingButton/interface/interfaces/InterfaceSortingButtonProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSortingButtonProps\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L14)\n\nProps for the SortingButton component.\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L34)\n\nAccessible label for the dropdown button (screen readers)\n\n***\n\n### buttonLabel?\n\n> `optional` **buttonLabel**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L30)\n\nOptional prop for custom button label\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L28)\n\nCustom class name for the Dropdown\n\n***\n\n### containerClassName?\n\n> `optional` **containerClassName**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L38)\n\nOptional extra class for the dropdown container (e.g. from parent CSS module)\n\n***\n\n### dataTestIdPrefix\n\n> **dataTestIdPrefix**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L24)\n\nThe prefix for data-testid attributes for testing\n\n***\n\n### dropdownTestId?\n\n> `optional` **dropdownTestId**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L26)\n\nThe data-testid attribute for the Dropdown\n\n***\n\n### icon?\n\n> `optional` **icon**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L36)\n\nOptional custom icon to display in the button\n\n***\n\n### onSortChange()\n\n> **onSortChange**: (`value`) => `void`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L22)\n\nCallback function to handle sorting option change\n\n#### Parameters\n\n##### value\n\n`string` | `number`\n\n#### Returns\n\n`void`\n\n***\n\n### selectedOption?\n\n> `optional` **selectedOption**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L20)\n\nThe currently selected sorting option\n\n***\n\n### sortingOptions\n\n> **sortingOptions**: [`InterfaceSortingOption`](InterfaceSortingOption.md)[]\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L18)\n\nThe list of sorting options to display in the Dropdown\n\n***\n\n### title?\n\n> `optional` **title**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L16)\n\nThe title attribute for the Dropdown\n\n***\n\n### toggleClassName?\n\n> `optional` **toggleClassName**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L40)\n\nOptional extra class for the toggle button (e.g. from parent CSS module)\n\n***\n\n### type?\n\n> `optional` **type**: `\"filter\"` \\| `\"sort\"`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L32)\n\nType to determine the icon to display: 'sort' or 'filter'\n" }, { "path": "docs/docs/auto-docs/types/shared-components/SortingButton/interface/interfaces/InterfaceSortingOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceSortingOption\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L4)\n\nRepresents a single sorting option for the SortingButton dropdown.\n\n## Properties\n\n### label\n\n> **label**: `string`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L6)\n\nThe label to display for the sorting option\n\n***\n\n### value\n\n> **value**: `string` \\| `number`\n\nDefined in: [src/types/shared-components/SortingButton/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/SortingButton/interface.ts#L8)\n\nThe value associated with the sorting option\n" }, { "path": "docs/docs/auto-docs/types/shared-components/StatusBadge/interface/interfaces/InterfaceStatusBadgeProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceStatusBadgeProps\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L39)\n\nProps interface for the StatusBadge component.\n\n## Properties\n\n### ariaLabel?\n\n> `optional` **ariaLabel**: `string`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L49)\n\nCustom aria-label for accessibility (optional, overrides default)\n\n***\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L51)\n\nAdditional CSS classes to apply\n\n***\n\n### dataTestId?\n\n> `optional` **dataTestId**: `string`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L53)\n\nTest ID for component testing (forwarded as data-testid)\n\n***\n\n### icon?\n\n> `optional` **icon**: `ReactNode`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L47)\n\nOptional icon to display in the badge\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L45)\n\nCustom label text (optional, overrides i18n)\n\n***\n\n### size?\n\n> `optional` **size**: [`StatusSize`](../type-aliases/StatusSize.md)\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L43)\n\nThe size of the badge (optional, defaults to 'md')\n\n***\n\n### variant\n\n> **variant**: [`StatusVariant`](../type-aliases/StatusVariant.md)\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L41)\n\nThe domain-specific status variant\n" }, { "path": "docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/SemanticVariant.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SemanticVariant\n\n> **SemanticVariant** = `\"success\"` \\| `\"warning\"` \\| `\"error\"` \\| `\"info\"` \\| `\"neutral\"`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L23)\n\nSemantic variants for internal mapping.\nThese represent the visual state of the badge.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/StatusSize.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: StatusSize\n\n> **StatusSize** = `\"sm\"` \\| `\"md\"` \\| `\"lg\"`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L34)\n\nSize variants for the badge.\nSmall (sm), Medium (md), and Large (lg) sizes are available.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/StatusBadge/interface/type-aliases/StatusVariant.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: StatusVariant\n\n> **StatusVariant** = `\"completed\"` \\| `\"pending\"` \\| `\"active\"` \\| `\"inactive\"` \\| `\"approved\"` \\| `\"rejected\"` \\| `\"disabled\"` \\| `\"accepted\"` \\| `\"declined\"` \\| `\"no_response\"`\n\nDefined in: [src/types/shared-components/StatusBadge/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/StatusBadge/interface.ts#L7)\n\nDomain-specific status variants that map to semantic meanings.\nThese represent business logic states that are mapped to visual representations.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/TableLoader/interface/interfaces/InterfaceTableLoaderProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTableLoaderProps\n\nDefined in: [src/types/shared-components/TableLoader/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TableLoader/interface.ts#L8)\n\nProps for the TableLoader component.\n`@property` noOfRows - The number of rows to render in the table body.\n`@property` headerTitles - An array of strings representing the titles for the table headers.\n`@property` noOfCols - The number of columns to render if headerTitles is not provided.\n`@property` data-testid - A custom data-testid attribute for testing purposes.\n\n## Properties\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/TableLoader/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TableLoader/interface.ts#L12)\n\n***\n\n### headerTitles?\n\n> `optional` **headerTitles**: `string`[]\n\nDefined in: [src/types/shared-components/TableLoader/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TableLoader/interface.ts#L10)\n\n***\n\n### noOfCols?\n\n> `optional` **noOfCols**: `number`\n\nDefined in: [src/types/shared-components/TableLoader/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TableLoader/interface.ts#L11)\n\n***\n\n### noOfRows\n\n> **noOfRows**: `number`\n\nDefined in: [src/types/shared-components/TableLoader/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TableLoader/interface.ts#L9)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/TimePicker/interface/interfaces/InterfaceTimePickerProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTimePickerProps\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L7)\n\nComponent Props for TimePicker\n\n## Properties\n\n### className?\n\n> `optional` **className**: `string`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L27)\n\nAdditional CSS class name to be applied to the root element\n\n***\n\n### data-testid?\n\n> `optional` **data-testid**: `string`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L29)\n\nTest ID for testing purposes, applied to the underlying input\n\n***\n\n### disabled?\n\n> `optional` **disabled**: `boolean`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L25)\n\nWhether the time picker is disabled\n\n***\n\n### disableOpenPicker?\n\n> `optional` **disableOpenPicker**: `boolean`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L37)\n\nWhether to disable the open picker button\n\n***\n\n### label?\n\n> `optional` **label**: `string`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L9)\n\nLabel displayed for the time picker\n\n***\n\n### maxTime?\n\n> `optional` **maxTime**: `Dayjs`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L23)\n\nMaximum selectable time constraint\n\n***\n\n### minTime?\n\n> `optional` **minTime**: `Dayjs`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L21)\n\nMinimum selectable time constraint\n\n***\n\n### onChange()\n\n> **onChange**: (`date`) => `void`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L19)\n\nCallback fired when the time changes.\n\n#### Parameters\n\n##### date\n\n`Dayjs`\n\nThe new time value.\n\n#### Returns\n\n`void`\n\n***\n\n### slotProps?\n\n> `optional` **slotProps**: `Partial`\\<`TimePickerSlotProps`\\<`false`\\>\\>\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L31)\n\nAdditional props passed to MUI TimePicker slots (e.g., actionBar, layout)\n\n***\n\n### slots?\n\n> `optional` **slots**: `Record`\\<`string`, `React.ElementType`\\>\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L33)\n\nCustom slot component overrides (e.g., openPickerIcon, leftArrowIcon)\n\n***\n\n### timeSteps?\n\n> `optional` **timeSteps**: `object`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L35)\n\nStep increments for time controls (hours, minutes, seconds)\n\n#### hours?\n\n> `optional` **hours**: `number`\n\n#### minutes?\n\n> `optional` **minutes**: `number`\n\n#### seconds?\n\n> `optional` **seconds**: `number`\n\n***\n\n### value?\n\n> `optional` **value**: `Dayjs`\n\nDefined in: [src/types/shared-components/TimePicker/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TimePicker/interface.ts#L14)\n\nCurrent time value.\nRepresented as a Dayjs object or null if no time is selected.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/TruncatedText/interface/interfaces/InterfaceTruncatedTextProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTruncatedTextProps\n\nDefined in: [src/types/shared-components/TruncatedText/interface.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TruncatedText/interface.ts#L5)\n\nProps for TruncatedText component.\n\n## Properties\n\n### maxWidthOverride?\n\n> `optional` **maxWidthOverride**: `number`\n\nDefined in: [src/types/shared-components/TruncatedText/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TruncatedText/interface.ts#L10)\n\nOptional: Override for the maximum width for truncation.\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/types/shared-components/TruncatedText/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/TruncatedText/interface.ts#L7)\n\nThe full text to display. It may be truncated if it exceeds the maximum width.\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/interface/interfaces/InterfaceUser.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUser\n\nDefined in: [src/types/shared-components/User/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L6)\n\n## Properties\n\n### address?\n\n> `optional` **address**: [`Address`](../../type/type-aliases/Address.md)\n\nDefined in: [src/types/shared-components/User/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L8)\n\n***\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L19)\n\n***\n\n### birthDate?\n\n> `optional` **birthDate**: `Date`\n\nDefined in: [src/types/shared-components/User/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L9)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `string` \\| `Date`\n\nDefined in: [src/types/shared-components/User/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L10)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L11)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L12)\n\n***\n\n### gender?\n\n> `optional` **gender**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L14)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L7)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L15)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L13)\n\n***\n\n### name?\n\n> `optional` **name**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L18)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `Date`\n\nDefined in: [src/types/shared-components/User/interface.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L16)\n\n***\n\n### userType?\n\n> `optional` **userType**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L17)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/interface/interfaces/InterfaceUserAttendee.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserAttendee\n\nDefined in: [src/types/shared-components/User/interface.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L25)\n\nProps for User in attendee context.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L34)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L26)\n\n***\n\n### isRegistered\n\n> **isRegistered**: `boolean`\n\nDefined in: [src/types/shared-components/User/interface.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L33)\n\n***\n\n### time\n\n> **time**: `string`\n\nDefined in: [src/types/shared-components/User/interface.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L35)\n\n***\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/types/shared-components/User/interface.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/interface.ts#L27)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### emailAddress\n\n> **emailAddress**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/Address.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: Address\n\n> **Address** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L17)\n\n## Properties\n\n### city?\n\n> `optional` **city**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L18)\n\n***\n\n### countryCode?\n\n> `optional` **countryCode**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L19)\n\n***\n\n### dependentLocality?\n\n> `optional` **dependentLocality**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L20)\n\n***\n\n### line1?\n\n> `optional` **line1**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L21)\n\n***\n\n### line2?\n\n> `optional` **line2**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L22)\n\n***\n\n### postalCode?\n\n> `optional` **postalCode**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L23)\n\n***\n\n### sortingCode?\n\n> `optional` **sortingCode**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L24)\n\n***\n\n### state?\n\n> `optional` **state**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L25)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/AppUserProfile.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: AppUserProfile\n\n> **AppUserProfile** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L43)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L44)\n\n***\n\n### adminFor\n\n> **adminFor**: [`Organization`](../../../../AdminPortal/Organization/type/type-aliases/Organization.md)[]\n\nDefined in: [src/types/shared-components/User/type.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L45)\n\n***\n\n### appLanguageCode\n\n> **appLanguageCode**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L46)\n\n***\n\n### createdEvents\n\n> **createdEvents**: `Event`[]\n\nDefined in: [src/types/shared-components/User/type.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L47)\n\n***\n\n### createdOrganizations\n\n> **createdOrganizations**: [`Organization`](../../../../AdminPortal/Organization/type/type-aliases/Organization.md)[]\n\nDefined in: [src/types/shared-components/User/type.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L48)\n\n***\n\n### eventAdmin\n\n> **eventAdmin**: `Event`[]\n\nDefined in: [src/types/shared-components/User/type.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L49)\n\n***\n\n### isSuperAdmin\n\n> **isSuperAdmin**: `boolean`\n\nDefined in: [src/types/shared-components/User/type.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L50)\n\n***\n\n### userId\n\n> **userId**: [`User`](User.md)\n\nDefined in: [src/types/shared-components/User/type.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L51)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/CreateUserFamilyInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: CreateUserFamilyInput\n\n> **CreateUserFamilyInput** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L54)\n\n## Properties\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L55)\n\n***\n\n### userIds\n\n> **userIds**: `string`[]\n\nDefined in: [src/types/shared-components/User/type.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L56)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/User.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: User\n\n> **User** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L4)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L5)\n\n***\n\n### address?\n\n> `optional` **address**: [`Address`](Address.md)\n\nDefined in: [src/types/shared-components/User/type.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L6)\n\n***\n\n### birthDate?\n\n> `optional` **birthDate**: `Date`\n\nDefined in: [src/types/shared-components/User/type.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L7)\n\n***\n\n### createdAt\n\n> **createdAt**: `Date`\n\nDefined in: [src/types/shared-components/User/type.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L8)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L9)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L10)\n\n***\n\n### gender?\n\n> `optional` **gender**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L12)\n\n***\n\n### image?\n\n> `optional` **image**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L13)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L11)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `Date`\n\nDefined in: [src/types/shared-components/User/type.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L14)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/UserInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UserInput\n\n> **UserInput** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L34)\n\n## Properties\n\n### appLanguageCode\n\n> **appLanguageCode**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L35)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L36)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L37)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L38)\n\n***\n\n### password\n\n> **password**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L39)\n\n***\n\n### selectedOrganization\n\n> **selectedOrganization**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L40)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/User/type/type-aliases/UserPhone.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: UserPhone\n\n> **UserPhone** = `object`\n\nDefined in: [src/types/shared-components/User/type.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L28)\n\n## Properties\n\n### home?\n\n> `optional` **home**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L29)\n\n***\n\n### mobile?\n\n> `optional` **mobile**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L30)\n\n***\n\n### work?\n\n> `optional` **work**: `string`\n\nDefined in: [src/types/shared-components/User/type.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/User/type.ts#L31)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/VisibilitySelector/interface/interfaces/InterfaceVisibilitySelectorProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVisibilitySelectorProps\n\nDefined in: [src/types/shared-components/VisibilitySelector/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VisibilitySelector/interface.ts#L6)\n\nProps for the VisibilitySelector component.\n\n## Properties\n\n### setVisibility()\n\n> **setVisibility**: (`visibility`) => `void`\n\nDefined in: [src/types/shared-components/VisibilitySelector/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VisibilitySelector/interface.ts#L8)\n\n#### Parameters\n\n##### visibility\n\n[`EventVisibility`](../../../../../shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md)\n\n#### Returns\n\n`void`\n\n***\n\n### tCommon()\n\n> **tCommon**: (`key`) => `string`\n\nDefined in: [src/types/shared-components/VisibilitySelector/interface.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VisibilitySelector/interface.ts#L9)\n\n#### Parameters\n\n##### key\n\n`string`\n\n#### Returns\n\n`string`\n\n***\n\n### visibility\n\n> **visibility**: [`EventVisibility`](../../../../../shared-components/EventForm/utils/visibilityUtils/type-aliases/EventVisibility.md)\n\nDefined in: [src/types/shared-components/VisibilitySelector/interface.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VisibilitySelector/interface.ts#L7)\n" }, { "path": "docs/docs/auto-docs/types/shared-components/VolunteerGroupViewModal/interface/interfaces/InterfaceVolunteerGroupViewModalProps.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerGroupViewModalProps\n\nDefined in: [src/types/shared-components/VolunteerGroupViewModal/interface.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VolunteerGroupViewModal/interface.ts#L6)\n\nProps for VolunteerGroupViewModal component.\n\n## Properties\n\n### group\n\n> **group**: [`InterfaceVolunteerGroupInfo`](../../../../../utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md)\n\nDefined in: [src/types/shared-components/VolunteerGroupViewModal/interface.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VolunteerGroupViewModal/interface.ts#L12)\n\nThe volunteer group information to display.\n\n***\n\n### hide()\n\n> **hide**: () => `void`\n\nDefined in: [src/types/shared-components/VolunteerGroupViewModal/interface.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VolunteerGroupViewModal/interface.ts#L10)\n\nFunction to close the modal.\n\n#### Returns\n\n`void`\n\n***\n\n### isOpen\n\n> **isOpen**: `boolean`\n\nDefined in: [src/types/shared-components/VolunteerGroupViewModal/interface.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/types/shared-components/VolunteerGroupViewModal/interface.ts#L8)\n\nIndicates whether the modal is open.\n" }, { "path": "docs/docs/auto-docs/utils/MinioDownload/functions/useMinioDownload.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useMinioDownload()\n\n> **useMinioDownload**(): `InterfaceMinioDownload`\n\nDefined in: [src/utils/MinioDownload.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/MinioDownload.ts#L11)\n\n## Returns\n\n`InterfaceMinioDownload`\n" }, { "path": "docs/docs/auto-docs/utils/MinioUpload/functions/useMinioUpload.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useMinioUpload()\n\n> **useMinioUpload**(): `InterfaceMinioUpload`\n\nDefined in: [src/utils/MinioUpload.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/MinioUpload.ts#L12)\n\n## Returns\n\n`InterfaceMinioUpload`\n" }, { "path": "docs/docs/auto-docs/utils/SanitizeInput/functions/sanitizeInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: sanitizeInput()\n\n> **sanitizeInput**(`input`): `string`\n\nDefined in: [src/utils/SanitizeInput.tsx:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/SanitizeInput.tsx#L8)\n\nSanitizes user input to prevent XSS attacks\nUses multiple passes and stricter pattern matching\n\n## Parameters\n\n### input\n\n`string`\n\nThe string to sanitize\n\n## Returns\n\n`string`\n\nThe sanitized string with dangerous content removed\n" }, { "path": "docs/docs/auto-docs/utils/StaticMockLink/classes/StaticMockLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Class: StaticMockLink\n\nDefined in: [src/utils/StaticMockLink.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L42)\n\nSimilar to the standard Apollo MockLink, but doesn't consume a mock\nwhen it is used allowing it to be used in places like Storybook.\n\n## Extends\n\n- `ApolloLink`\n\n## Constructors\n\n### Constructor\n\n> **new StaticMockLink**(`mockedResponses`, `addTypename`): `StaticMockLink`\n\nDefined in: [src/utils/StaticMockLink.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L47)\n\n#### Parameters\n\n##### mockedResponses\n\nreadonly `MockedResponse`\\<`Record`\\<`string`, `any`\\>, `Record`\\<`string`, `any`\\>\\>[]\n\n##### addTypename\n\n`boolean` = `true`\n\n#### Returns\n\n`StaticMockLink`\n\n#### Overrides\n\n`ApolloLink.constructor`\n\n## Properties\n\n### addTypename\n\n> **addTypename**: `boolean` = `true`\n\nDefined in: [src/utils/StaticMockLink.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L44)\n\n***\n\n### operation?\n\n> `optional` **operation**: `Operation`\n\nDefined in: [src/utils/StaticMockLink.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L43)\n\n## Methods\n\n### addMockedResponse()\n\n> **addMockedResponse**(`mockedResponse`): `void`\n\nDefined in: [src/utils/StaticMockLink.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L57)\n\n#### Parameters\n\n##### mockedResponse\n\n`MockedResponse`\n\n#### Returns\n\n`void`\n\n***\n\n### request()\n\n> **request**(`operation`): `Observable`\\<`FetchResult`\\>\n\nDefined in: [src/utils/StaticMockLink.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L72)\n\n#### Parameters\n\n##### operation\n\n`Operation`\n\n#### Returns\n\n`Observable`\\<`FetchResult`\\>\n\n#### Overrides\n\n`ApolloLink.request`\n" }, { "path": "docs/docs/auto-docs/utils/StaticMockLink/functions/mockSingleLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: mockSingleLink()\n\n> **mockSingleLink**(...`mockedResponses`): [`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md)\n\nDefined in: [src/utils/StaticMockLink.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L195)\n\n## Parameters\n\n### mockedResponses\n\n...(`boolean` \\| `MockedResponse`\\<`Record`\\<`string`, `any`\\>, `Record`\\<`string`, `any`\\>\\>)[]\n\n## Returns\n\n[`InterfaceMockApolloLink`](../interfaces/InterfaceMockApolloLink.md)\n" }, { "path": "docs/docs/auto-docs/utils/StaticMockLink/interfaces/InterfaceMockApolloLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMockApolloLink\n\nDefined in: [src/utils/StaticMockLink.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L188)\n\n## Extends\n\n- `ApolloLink`\n\n## Properties\n\n### operation?\n\n> `optional` **operation**: `Operation`\n\nDefined in: [src/utils/StaticMockLink.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/StaticMockLink.ts#L189)\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/functions/getInstalledAdminPlugins.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getInstalledAdminPlugins()\n\n> **getInstalledAdminPlugins**(): `Promise`\\<`object`[]\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L386)\n\nGets all installed admin plugins from the file system via server API\n\n## Returns\n\n`Promise`\\<`object`[]\\>\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/functions/installAdminPluginFromZip.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: installAdminPluginFromZip()\n\n> **installAdminPluginFromZip**(`__namedParameters`): `Promise`\\<[`IAdminPluginInstallationResult`](../interfaces/IAdminPluginInstallationResult.md)\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L252)\n\nInstalls a plugin from a zip file (supports both admin and API)\nFlow: 1) Create plugin in DB, 2) Install files, 3) Installation is handled separately\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`IAdminPluginInstallationOptions`](../interfaces/IAdminPluginInstallationOptions.md)\n\n## Returns\n\n`Promise`\\<[`IAdminPluginInstallationResult`](../interfaces/IAdminPluginInstallationResult.md)\\>\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/functions/removeAdminPlugin.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: removeAdminPlugin()\n\n> **removeAdminPlugin**(`pluginId`): `Promise`\\<`boolean`\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:409](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L409)\n\nRemoves an admin plugin from the file system via server API\n\n## Parameters\n\n### pluginId\n\n`string`\n\n## Returns\n\n`Promise`\\<`boolean`\\>\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/functions/validateAdminPluginStructure.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateAdminPluginStructure()\n\n> **validateAdminPluginStructure**(`files`): `object`\n\nDefined in: [src/utils/adminPluginInstaller.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L198)\n\nValidates admin plugin structure\n\n## Parameters\n\n### files\n\n`Record`\\<`string`, `string`\\>\n\n## Returns\n\n`object`\n\n### error?\n\n> `optional` **error**: `string`\n\n### valid\n\n> **valid**: `boolean`\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/functions/validateAdminPluginZip.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateAdminPluginZip()\n\n> **validateAdminPluginZip**(`zipFile`): `Promise`\\<[`IAdminPluginZipStructure`](../interfaces/IAdminPluginZipStructure.md)\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L54)\n\nValidates the structure of a plugin zip file (supports both admin and API)\n\n## Parameters\n\n### zipFile\n\n`File`\n\n## Returns\n\n`Promise`\\<[`IAdminPluginZipStructure`](../interfaces/IAdminPluginZipStructure.md)\\>\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginInstallationOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IAdminPluginInstallationOptions\n\nDefined in: [src/utils/adminPluginInstaller.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L45)\n\n## Properties\n\n### apolloClient?\n\n> `optional` **apolloClient**: `ApolloClient`\\<`NormalizedCacheObject`\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L48)\n\n***\n\n### backup?\n\n> `optional` **backup**: `boolean`\n\nDefined in: [src/utils/adminPluginInstaller.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L47)\n\n***\n\n### zipFile\n\n> **zipFile**: `File`\n\nDefined in: [src/utils/adminPluginInstaller.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L46)\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginInstallationResult.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IAdminPluginInstallationResult\n\nDefined in: [src/utils/adminPluginInstaller.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L37)\n\n## Properties\n\n### error?\n\n> `optional` **error**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L42)\n\n***\n\n### installedComponents\n\n> **installedComponents**: `string`[]\n\nDefined in: [src/utils/adminPluginInstaller.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L41)\n\n***\n\n### manifest\n\n> **manifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md)\n\nDefined in: [src/utils/adminPluginInstaller.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L40)\n\n***\n\n### pluginId\n\n> **pluginId**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L39)\n\n***\n\n### success\n\n> **success**: `boolean`\n\nDefined in: [src/utils/adminPluginInstaller.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L38)\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginManifest.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IAdminPluginManifest\n\nDefined in: [src/utils/adminPluginInstaller.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L10)\n\n## Properties\n\n### author\n\n> **author**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L14)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L13)\n\n***\n\n### extensionPoints?\n\n> `optional` **extensionPoints**: `object`\n\nDefined in: [src/utils/adminPluginInstaller.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L17)\n\n#### routes?\n\n> `optional` **routes**: `object`[]\n\n***\n\n### main\n\n> **main**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L15)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L11)\n\n***\n\n### pluginId\n\n> **pluginId**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L16)\n\n***\n\n### version\n\n> **version**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L12)\n" }, { "path": "docs/docs/auto-docs/utils/adminPluginInstaller/interfaces/IAdminPluginZipStructure.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IAdminPluginZipStructure\n\nDefined in: [src/utils/adminPluginInstaller.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L27)\n\n## Properties\n\n### adminManifest?\n\n> `optional` **adminManifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md)\n\nDefined in: [src/utils/adminPluginInstaller.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L30)\n\n***\n\n### apiFiles?\n\n> `optional` **apiFiles**: `string`[]\n\nDefined in: [src/utils/adminPluginInstaller.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L34)\n\n***\n\n### apiManifest?\n\n> `optional` **apiManifest**: [`IAdminPluginManifest`](IAdminPluginManifest.md)\n\nDefined in: [src/utils/adminPluginInstaller.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L31)\n\n***\n\n### files\n\n> **files**: `Record`\\<`string`, `string`\\>\n\nDefined in: [src/utils/adminPluginInstaller.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L33)\n\n***\n\n### hasAdminFolder\n\n> **hasAdminFolder**: `boolean`\n\nDefined in: [src/utils/adminPluginInstaller.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L28)\n\n***\n\n### hasApiFolder\n\n> **hasApiFolder**: `boolean`\n\nDefined in: [src/utils/adminPluginInstaller.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L29)\n\n***\n\n### pluginId?\n\n> `optional` **pluginId**: `string`\n\nDefined in: [src/utils/adminPluginInstaller.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/adminPluginInstaller.ts#L32)\n" }, { "path": "docs/docs/auto-docs/utils/autocompleteHelpers/functions/areOptionsEqual.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: areOptionsEqual()\n\n> **areOptionsEqual**(`option`, `value`): `boolean`\n\nDefined in: [src/utils/autocompleteHelpers.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/autocompleteHelpers.ts#L10)\n\nCompares two user options by their IDs to determine equality in Autocomplete.\n\n## Parameters\n\n### option\n\n[`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md)\n\nThe option from the list\n\n### value\n\n[`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md)\n\nThe currently selected value\n\n## Returns\n\n`boolean`\n\ntrue if the IDs match\n" }, { "path": "docs/docs/auto-docs/utils/autocompleteHelpers/functions/getMemberLabel.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getMemberLabel()\n\n> **getMemberLabel**(`member`): `string`\n\nDefined in: [src/utils/autocompleteHelpers.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/autocompleteHelpers.ts#L21)\n\nGets the display label for a member, preferring First Last name, falling back to name.\n\n## Parameters\n\n### member\n\n[`InterfaceUserInfoPG`](../../interfaces/interfaces/InterfaceUserInfoPG.md)\n\nThe user/member object\n\n## Returns\n\n`string`\n\nThe formatted name string\n" }, { "path": "docs/docs/auto-docs/utils/chartToPdf/functions/exportDemographicsToCSV.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: exportDemographicsToCSV()\n\n> **exportDemographicsToCSV**(`selectedCategory`, `categoryLabels`, `categoryData`): `void`\n\nDefined in: [src/utils/chartToPdf.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L82)\n\n## Parameters\n\n### selectedCategory\n\n`string`\n\n### categoryLabels\n\n`string`[]\n\n### categoryData\n\n`number`[]\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/chartToPdf/functions/exportToCSV.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: exportToCSV()\n\n> **exportToCSV**(`data`, `filename`): `void`\n\nDefined in: [src/utils/chartToPdf.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L5)\n\n## Parameters\n\n### data\n\n`CSVData`\n\n### filename\n\n`string`\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/chartToPdf/functions/exportTrendsToCSV.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: exportTrendsToCSV()\n\n> **exportTrendsToCSV**(`eventLabels`, `attendeeCounts`, `maleCounts`, `femaleCounts`, `otherCounts`): `void`\n\nDefined in: [src/utils/chartToPdf.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/chartToPdf.ts#L52)\n\n## Parameters\n\n### eventLabels\n\n`string`[]\n\n### attendeeCounts\n\n`number`[]\n\n### maleCounts\n\n`number`[]\n\n### femaleCounts\n\n`number`[]\n\n### otherCounts\n\n`number`[]\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/currency/variables/currencyOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: currencyOptions\n\n> `const` **currencyOptions**: `object`[]\n\nDefined in: [src/utils/currency.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/currency.ts#L1)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'AED'`\n\n### value\n\n> **value**: `string` = `'AED'`\n" }, { "path": "docs/docs/auto-docs/utils/currency/variables/currencySymbols.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: currencySymbols\n\n> `const` **currencySymbols**: `object`\n\nDefined in: [src/utils/currency.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/currency.ts#L166)\n\n## Index Signature\n\n\\[`key`: `string`\\]: `string`\n" }, { "path": "docs/docs/auto-docs/utils/dateFormatter/functions/formatDate.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: formatDate()\n\n> **formatDate**(`dateString`): `string`\n\nDefined in: [src/utils/dateFormatter.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/dateFormatter.ts#L1)\n\n## Parameters\n\n### dateString\n\n`string`\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/utils/errorHandler/functions/errorHandler.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: errorHandler()\n\n> **errorHandler**(`a`, `error`): `void`\n\nDefined in: [src/utils/errorHandler.tsx:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/errorHandler.tsx#L9)\n\nThis function is used to handle api errors in the application.\nIt takes in the error object and displays the error message to the user.\nIf the error is due to the Talawa API being unavailable, it displays a custom message. And for other error cases, it is using regular expression (case-insensitive) to match and show valid messages\n\n## Parameters\n\n### a\n\n`unknown`\n\n### error\n\n`unknown`\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/fieldTypes/variables/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: default\n\n> `const` **default**: `string`[]\n\nDefined in: [src/utils/fieldTypes.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/fieldTypes.ts#L1)\n" }, { "path": "docs/docs/auto-docs/utils/fileValidation/functions/validateFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateFile()\n\n> **validateFile**(`file`, `maxSizeInMB`, `allowedTypes`): `IFileValidationResult`\n\nDefined in: [src/utils/fileValidation.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/fileValidation.ts#L23)\n\nValidates a file for size and type\n\n## Parameters\n\n### file\n\n`File`\n\nThe file to validate\n\n### maxSizeInMB\n\n`number` = `FILE_UPLOAD_MAX_SIZE_MB`\n\nMaximum file size in MB (default: 5MB)\n\n### allowedTypes\n\nreadonly `string`[] = `FILE_UPLOAD_ALLOWED_TYPES`\n\nArray of allowed MIME types (default: ['image/jpeg', 'image/png', 'image/gif'])\n\n## Returns\n\n`IFileValidationResult`\n\nIFileValidationResult - Object containing validation status and error message if any\n" }, { "path": "docs/docs/auto-docs/utils/filehash/functions/calculateFileHash.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: calculateFileHash()\n\n> **calculateFileHash**(`file`): `Promise`\\<`string`\\>\n\nDefined in: [src/utils/filehash.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/filehash.ts#L1)\n\n## Parameters\n\n### file\n\n`File`\n\n## Returns\n\n`Promise`\\<`string`\\>\n" }, { "path": "docs/docs/auto-docs/utils/formEnumFields/variables/countryOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: countryOptions\n\n> `const` **countryOptions**: `object`[]\n\nDefined in: [src/utils/formEnumFields.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L1)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'Afghanistan'`\n\n### value\n\n> **value**: `string` = `'af'`\n" }, { "path": "docs/docs/auto-docs/utils/formEnumFields/variables/educationGradeEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: educationGradeEnum\n\n> `const` **educationGradeEnum**: `object`[]\n\nDefined in: [src/utils/formEnumFields.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L202)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'No-Grade'`\n\n### value\n\n> **value**: `string` = `'no_grade'`\n" }, { "path": "docs/docs/auto-docs/utils/formEnumFields/variables/employmentStatusEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: employmentStatusEnum\n\n> `const` **employmentStatusEnum**: `object`[]\n\nDefined in: [src/utils/formEnumFields.ts:311](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L311)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'Full-Time'`\n\n### value\n\n> **value**: `string` = `'full_time'`\n" }, { "path": "docs/docs/auto-docs/utils/formEnumFields/variables/genderEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: genderEnum\n\n> `const` **genderEnum**: `object`[]\n\nDefined in: [src/utils/formEnumFields.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L296)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'Male'`\n\n### value\n\n> **value**: `string` = `'male'`\n" }, { "path": "docs/docs/auto-docs/utils/formEnumFields/variables/maritalStatusEnum.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: maritalStatusEnum\n\n> `const` **maritalStatusEnum**: `object`[]\n\nDefined in: [src/utils/formEnumFields.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/formEnumFields.ts#L269)\n\n## Type Declaration\n\n### label\n\n> **label**: `string` = `'Single'`\n\n### value\n\n> **value**: `string` = `'single'`\n" }, { "path": "docs/docs/auto-docs/utils/getRefreshToken/functions/handleTokenRefresh.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: handleTokenRefresh()\n\n> **handleTokenRefresh**(): `Promise`\\<`void`\\>\n\nDefined in: [src/utils/getRefreshToken.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/getRefreshToken.ts#L45)\n\nAttempts to refresh the token and reload the page if successful.\nFalls back to clearing storage and redirecting to login if refresh fails.\n\n## Returns\n\n`Promise`\\<`void`\\>\n" }, { "path": "docs/docs/auto-docs/utils/getRefreshToken/functions/refreshToken.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: refreshToken()\n\n> **refreshToken**(): `Promise`\\<`boolean`\\>\n\nDefined in: [src/utils/getRefreshToken.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/getRefreshToken.ts#L13)\n\nRefreshes the access token using HTTP-Only cookies.\nThe refresh token is automatically sent via cookies by the browser.\nThis function is called when the current access token expires.\n\n## Returns\n\n`Promise`\\<`boolean`\\>\n\nReturns true if token refresh was successful, false otherwise\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/AdvertisementTypePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: AdvertisementTypePg\n\nDefined in: [src/utils/interfaces.ts:324](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L324)\n\nRepresents the type of an advertisement.\n\n## Enumeration Members\n\n### BANNER\n\n> **BANNER**: `\"banner\"`\n\nDefined in: [src/utils/interfaces.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L325)\n\n***\n\n### MENU\n\n> **MENU**: `\"menu\"`\n\nDefined in: [src/utils/interfaces.ts:326](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L326)\n\n***\n\n### POP\\_UP\n\n> **POP\\_UP**: `\"pop_up\"`\n\nDefined in: [src/utils/interfaces.ts:327](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L327)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/Iso3166Alpha2CountryCode.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: Iso3166Alpha2CountryCode\n\nDefined in: [src/utils/interfaces.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L4)\n\nRepresents the ISO 3166-1 alpha-2 country codes.\n\n## Enumeration Members\n\n### ad\n\n> **ad**: `\"ad\"`\n\nDefined in: [src/utils/interfaces.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L5)\n\n***\n\n### ae\n\n> **ae**: `\"ae\"`\n\nDefined in: [src/utils/interfaces.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L6)\n\n***\n\n### af\n\n> **af**: `\"af\"`\n\nDefined in: [src/utils/interfaces.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L7)\n\n***\n\n### ag\n\n> **ag**: `\"ag\"`\n\nDefined in: [src/utils/interfaces.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L8)\n\n***\n\n### ai\n\n> **ai**: `\"ai\"`\n\nDefined in: [src/utils/interfaces.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L9)\n\n***\n\n### al\n\n> **al**: `\"al\"`\n\nDefined in: [src/utils/interfaces.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L10)\n\n***\n\n### am\n\n> **am**: `\"am\"`\n\nDefined in: [src/utils/interfaces.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L11)\n\n***\n\n### ao\n\n> **ao**: `\"ao\"`\n\nDefined in: [src/utils/interfaces.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L12)\n\n***\n\n### aq\n\n> **aq**: `\"aq\"`\n\nDefined in: [src/utils/interfaces.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L13)\n\n***\n\n### ar\n\n> **ar**: `\"ar\"`\n\nDefined in: [src/utils/interfaces.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L14)\n\n***\n\n### as\n\n> **as**: `\"as\"`\n\nDefined in: [src/utils/interfaces.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L15)\n\n***\n\n### at\n\n> **at**: `\"at\"`\n\nDefined in: [src/utils/interfaces.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L16)\n\n***\n\n### au\n\n> **au**: `\"au\"`\n\nDefined in: [src/utils/interfaces.ts:17](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L17)\n\n***\n\n### aw\n\n> **aw**: `\"aw\"`\n\nDefined in: [src/utils/interfaces.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L18)\n\n***\n\n### ax\n\n> **ax**: `\"ax\"`\n\nDefined in: [src/utils/interfaces.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L19)\n\n***\n\n### az\n\n> **az**: `\"az\"`\n\nDefined in: [src/utils/interfaces.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L20)\n\n***\n\n### ba\n\n> **ba**: `\"ba\"`\n\nDefined in: [src/utils/interfaces.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L21)\n\n***\n\n### bb\n\n> **bb**: `\"bb\"`\n\nDefined in: [src/utils/interfaces.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L22)\n\n***\n\n### bd\n\n> **bd**: `\"bd\"`\n\nDefined in: [src/utils/interfaces.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L23)\n\n***\n\n### be\n\n> **be**: `\"be\"`\n\nDefined in: [src/utils/interfaces.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L24)\n\n***\n\n### bf\n\n> **bf**: `\"bf\"`\n\nDefined in: [src/utils/interfaces.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L25)\n\n***\n\n### bg\n\n> **bg**: `\"bg\"`\n\nDefined in: [src/utils/interfaces.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L26)\n\n***\n\n### bh\n\n> **bh**: `\"bh\"`\n\nDefined in: [src/utils/interfaces.ts:27](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L27)\n\n***\n\n### bi\n\n> **bi**: `\"bi\"`\n\nDefined in: [src/utils/interfaces.ts:28](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L28)\n\n***\n\n### bj\n\n> **bj**: `\"bj\"`\n\nDefined in: [src/utils/interfaces.ts:29](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L29)\n\n***\n\n### bl\n\n> **bl**: `\"bl\"`\n\nDefined in: [src/utils/interfaces.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L30)\n\n***\n\n### bm\n\n> **bm**: `\"bm\"`\n\nDefined in: [src/utils/interfaces.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L31)\n\n***\n\n### bn\n\n> **bn**: `\"bn\"`\n\nDefined in: [src/utils/interfaces.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L32)\n\n***\n\n### bo\n\n> **bo**: `\"bo\"`\n\nDefined in: [src/utils/interfaces.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L33)\n\n***\n\n### bq\n\n> **bq**: `\"bq\"`\n\nDefined in: [src/utils/interfaces.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L34)\n\n***\n\n### br\n\n> **br**: `\"br\"`\n\nDefined in: [src/utils/interfaces.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L35)\n\n***\n\n### bs\n\n> **bs**: `\"bs\"`\n\nDefined in: [src/utils/interfaces.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L36)\n\n***\n\n### bt\n\n> **bt**: `\"bt\"`\n\nDefined in: [src/utils/interfaces.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L37)\n\n***\n\n### bv\n\n> **bv**: `\"bv\"`\n\nDefined in: [src/utils/interfaces.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L38)\n\n***\n\n### bw\n\n> **bw**: `\"bw\"`\n\nDefined in: [src/utils/interfaces.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L39)\n\n***\n\n### by\n\n> **by**: `\"by\"`\n\nDefined in: [src/utils/interfaces.ts:40](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L40)\n\n***\n\n### bz\n\n> **bz**: `\"bz\"`\n\nDefined in: [src/utils/interfaces.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L41)\n\n***\n\n### ca\n\n> **ca**: `\"ca\"`\n\nDefined in: [src/utils/interfaces.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L42)\n\n***\n\n### cc\n\n> **cc**: `\"cc\"`\n\nDefined in: [src/utils/interfaces.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L43)\n\n***\n\n### cd\n\n> **cd**: `\"cd\"`\n\nDefined in: [src/utils/interfaces.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L44)\n\n***\n\n### cf\n\n> **cf**: `\"cf\"`\n\nDefined in: [src/utils/interfaces.ts:45](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L45)\n\n***\n\n### cg\n\n> **cg**: `\"cg\"`\n\nDefined in: [src/utils/interfaces.ts:46](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L46)\n\n***\n\n### ch\n\n> **ch**: `\"ch\"`\n\nDefined in: [src/utils/interfaces.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L47)\n\n***\n\n### ci\n\n> **ci**: `\"ci\"`\n\nDefined in: [src/utils/interfaces.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L48)\n\n***\n\n### ck\n\n> **ck**: `\"ck\"`\n\nDefined in: [src/utils/interfaces.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L49)\n\n***\n\n### cl\n\n> **cl**: `\"cl\"`\n\nDefined in: [src/utils/interfaces.ts:50](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L50)\n\n***\n\n### cm\n\n> **cm**: `\"cm\"`\n\nDefined in: [src/utils/interfaces.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L51)\n\n***\n\n### cn\n\n> **cn**: `\"cn\"`\n\nDefined in: [src/utils/interfaces.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L52)\n\n***\n\n### co\n\n> **co**: `\"co\"`\n\nDefined in: [src/utils/interfaces.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L53)\n\n***\n\n### cr\n\n> **cr**: `\"cr\"`\n\nDefined in: [src/utils/interfaces.ts:54](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L54)\n\n***\n\n### cu\n\n> **cu**: `\"cu\"`\n\nDefined in: [src/utils/interfaces.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L55)\n\n***\n\n### cv\n\n> **cv**: `\"cv\"`\n\nDefined in: [src/utils/interfaces.ts:56](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L56)\n\n***\n\n### cw\n\n> **cw**: `\"cw\"`\n\nDefined in: [src/utils/interfaces.ts:57](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L57)\n\n***\n\n### cx\n\n> **cx**: `\"cx\"`\n\nDefined in: [src/utils/interfaces.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L58)\n\n***\n\n### cy\n\n> **cy**: `\"cy\"`\n\nDefined in: [src/utils/interfaces.ts:59](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L59)\n\n***\n\n### cz\n\n> **cz**: `\"cz\"`\n\nDefined in: [src/utils/interfaces.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L60)\n\n***\n\n### de\n\n> **de**: `\"de\"`\n\nDefined in: [src/utils/interfaces.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L61)\n\n***\n\n### dj\n\n> **dj**: `\"dj\"`\n\nDefined in: [src/utils/interfaces.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L62)\n\n***\n\n### dk\n\n> **dk**: `\"dk\"`\n\nDefined in: [src/utils/interfaces.ts:63](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L63)\n\n***\n\n### dm\n\n> **dm**: `\"dm\"`\n\nDefined in: [src/utils/interfaces.ts:64](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L64)\n\n***\n\n### do\n\n> **do**: `\"do\"`\n\nDefined in: [src/utils/interfaces.ts:65](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L65)\n\n***\n\n### dz\n\n> **dz**: `\"dz\"`\n\nDefined in: [src/utils/interfaces.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L66)\n\n***\n\n### ec\n\n> **ec**: `\"ec\"`\n\nDefined in: [src/utils/interfaces.ts:67](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L67)\n\n***\n\n### ee\n\n> **ee**: `\"ee\"`\n\nDefined in: [src/utils/interfaces.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L68)\n\n***\n\n### eg\n\n> **eg**: `\"eg\"`\n\nDefined in: [src/utils/interfaces.ts:69](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L69)\n\n***\n\n### eh\n\n> **eh**: `\"eh\"`\n\nDefined in: [src/utils/interfaces.ts:70](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L70)\n\n***\n\n### er\n\n> **er**: `\"er\"`\n\nDefined in: [src/utils/interfaces.ts:71](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L71)\n\n***\n\n### es\n\n> **es**: `\"es\"`\n\nDefined in: [src/utils/interfaces.ts:72](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L72)\n\n***\n\n### et\n\n> **et**: `\"et\"`\n\nDefined in: [src/utils/interfaces.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L73)\n\n***\n\n### fi\n\n> **fi**: `\"fi\"`\n\nDefined in: [src/utils/interfaces.ts:74](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L74)\n\n***\n\n### fj\n\n> **fj**: `\"fj\"`\n\nDefined in: [src/utils/interfaces.ts:75](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L75)\n\n***\n\n### fk\n\n> **fk**: `\"fk\"`\n\nDefined in: [src/utils/interfaces.ts:76](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L76)\n\n***\n\n### fm\n\n> **fm**: `\"fm\"`\n\nDefined in: [src/utils/interfaces.ts:77](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L77)\n\n***\n\n### fo\n\n> **fo**: `\"fo\"`\n\nDefined in: [src/utils/interfaces.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L78)\n\n***\n\n### fr\n\n> **fr**: `\"fr\"`\n\nDefined in: [src/utils/interfaces.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L79)\n\n***\n\n### ga\n\n> **ga**: `\"ga\"`\n\nDefined in: [src/utils/interfaces.ts:80](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L80)\n\n***\n\n### gb\n\n> **gb**: `\"gb\"`\n\nDefined in: [src/utils/interfaces.ts:81](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L81)\n\n***\n\n### gd\n\n> **gd**: `\"gd\"`\n\nDefined in: [src/utils/interfaces.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L82)\n\n***\n\n### ge\n\n> **ge**: `\"ge\"`\n\nDefined in: [src/utils/interfaces.ts:83](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L83)\n\n***\n\n### gf\n\n> **gf**: `\"gf\"`\n\nDefined in: [src/utils/interfaces.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L84)\n\n***\n\n### gg\n\n> **gg**: `\"gg\"`\n\nDefined in: [src/utils/interfaces.ts:85](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L85)\n\n***\n\n### gh\n\n> **gh**: `\"gh\"`\n\nDefined in: [src/utils/interfaces.ts:86](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L86)\n\n***\n\n### gi\n\n> **gi**: `\"gi\"`\n\nDefined in: [src/utils/interfaces.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L87)\n\n***\n\n### gl\n\n> **gl**: `\"gl\"`\n\nDefined in: [src/utils/interfaces.ts:88](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L88)\n\n***\n\n### gm\n\n> **gm**: `\"gm\"`\n\nDefined in: [src/utils/interfaces.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L89)\n\n***\n\n### gn\n\n> **gn**: `\"gn\"`\n\nDefined in: [src/utils/interfaces.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L90)\n\n***\n\n### gp\n\n> **gp**: `\"gp\"`\n\nDefined in: [src/utils/interfaces.ts:91](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L91)\n\n***\n\n### gq\n\n> **gq**: `\"gq\"`\n\nDefined in: [src/utils/interfaces.ts:92](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L92)\n\n***\n\n### gr\n\n> **gr**: `\"gr\"`\n\nDefined in: [src/utils/interfaces.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L93)\n\n***\n\n### gs\n\n> **gs**: `\"gs\"`\n\nDefined in: [src/utils/interfaces.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L94)\n\n***\n\n### gt\n\n> **gt**: `\"gt\"`\n\nDefined in: [src/utils/interfaces.ts:95](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L95)\n\n***\n\n### gu\n\n> **gu**: `\"gu\"`\n\nDefined in: [src/utils/interfaces.ts:96](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L96)\n\n***\n\n### gw\n\n> **gw**: `\"gw\"`\n\nDefined in: [src/utils/interfaces.ts:97](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L97)\n\n***\n\n### gy\n\n> **gy**: `\"gy\"`\n\nDefined in: [src/utils/interfaces.ts:98](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L98)\n\n***\n\n### hk\n\n> **hk**: `\"hk\"`\n\nDefined in: [src/utils/interfaces.ts:99](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L99)\n\n***\n\n### hm\n\n> **hm**: `\"hm\"`\n\nDefined in: [src/utils/interfaces.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L100)\n\n***\n\n### hn\n\n> **hn**: `\"hn\"`\n\nDefined in: [src/utils/interfaces.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L101)\n\n***\n\n### hr\n\n> **hr**: `\"hr\"`\n\nDefined in: [src/utils/interfaces.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L102)\n\n***\n\n### ht\n\n> **ht**: `\"ht\"`\n\nDefined in: [src/utils/interfaces.ts:103](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L103)\n\n***\n\n### hu\n\n> **hu**: `\"hu\"`\n\nDefined in: [src/utils/interfaces.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L104)\n\n***\n\n### id\n\n> **id**: `\"id\"`\n\nDefined in: [src/utils/interfaces.ts:105](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L105)\n\n***\n\n### ie\n\n> **ie**: `\"ie\"`\n\nDefined in: [src/utils/interfaces.ts:106](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L106)\n\n***\n\n### il\n\n> **il**: `\"il\"`\n\nDefined in: [src/utils/interfaces.ts:107](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L107)\n\n***\n\n### im\n\n> **im**: `\"im\"`\n\nDefined in: [src/utils/interfaces.ts:108](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L108)\n\n***\n\n### in\n\n> **in**: `\"in\"`\n\nDefined in: [src/utils/interfaces.ts:109](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L109)\n\n***\n\n### io\n\n> **io**: `\"io\"`\n\nDefined in: [src/utils/interfaces.ts:110](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L110)\n\n***\n\n### iq\n\n> **iq**: `\"iq\"`\n\nDefined in: [src/utils/interfaces.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L111)\n\n***\n\n### ir\n\n> **ir**: `\"ir\"`\n\nDefined in: [src/utils/interfaces.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L112)\n\n***\n\n### is\n\n> **is**: `\"is\"`\n\nDefined in: [src/utils/interfaces.ts:113](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L113)\n\n***\n\n### it\n\n> **it**: `\"it\"`\n\nDefined in: [src/utils/interfaces.ts:114](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L114)\n\n***\n\n### je\n\n> **je**: `\"je\"`\n\nDefined in: [src/utils/interfaces.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L115)\n\n***\n\n### jm\n\n> **jm**: `\"jm\"`\n\nDefined in: [src/utils/interfaces.ts:116](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L116)\n\n***\n\n### jo\n\n> **jo**: `\"jo\"`\n\nDefined in: [src/utils/interfaces.ts:117](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L117)\n\n***\n\n### jp\n\n> **jp**: `\"jp\"`\n\nDefined in: [src/utils/interfaces.ts:118](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L118)\n\n***\n\n### ke\n\n> **ke**: `\"ke\"`\n\nDefined in: [src/utils/interfaces.ts:119](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L119)\n\n***\n\n### kg\n\n> **kg**: `\"kg\"`\n\nDefined in: [src/utils/interfaces.ts:120](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L120)\n\n***\n\n### kh\n\n> **kh**: `\"kh\"`\n\nDefined in: [src/utils/interfaces.ts:121](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L121)\n\n***\n\n### ki\n\n> **ki**: `\"ki\"`\n\nDefined in: [src/utils/interfaces.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L122)\n\n***\n\n### km\n\n> **km**: `\"km\"`\n\nDefined in: [src/utils/interfaces.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L123)\n\n***\n\n### kn\n\n> **kn**: `\"kn\"`\n\nDefined in: [src/utils/interfaces.ts:124](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L124)\n\n***\n\n### kp\n\n> **kp**: `\"kp\"`\n\nDefined in: [src/utils/interfaces.ts:125](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L125)\n\n***\n\n### kr\n\n> **kr**: `\"kr\"`\n\nDefined in: [src/utils/interfaces.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L126)\n\n***\n\n### kw\n\n> **kw**: `\"kw\"`\n\nDefined in: [src/utils/interfaces.ts:127](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L127)\n\n***\n\n### ky\n\n> **ky**: `\"ky\"`\n\nDefined in: [src/utils/interfaces.ts:128](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L128)\n\n***\n\n### kz\n\n> **kz**: `\"kz\"`\n\nDefined in: [src/utils/interfaces.ts:129](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L129)\n\n***\n\n### la\n\n> **la**: `\"la\"`\n\nDefined in: [src/utils/interfaces.ts:130](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L130)\n\n***\n\n### lb\n\n> **lb**: `\"lb\"`\n\nDefined in: [src/utils/interfaces.ts:131](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L131)\n\n***\n\n### lc\n\n> **lc**: `\"lc\"`\n\nDefined in: [src/utils/interfaces.ts:132](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L132)\n\n***\n\n### li\n\n> **li**: `\"li\"`\n\nDefined in: [src/utils/interfaces.ts:133](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L133)\n\n***\n\n### lk\n\n> **lk**: `\"lk\"`\n\nDefined in: [src/utils/interfaces.ts:134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L134)\n\n***\n\n### lr\n\n> **lr**: `\"lr\"`\n\nDefined in: [src/utils/interfaces.ts:135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L135)\n\n***\n\n### ls\n\n> **ls**: `\"ls\"`\n\nDefined in: [src/utils/interfaces.ts:136](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L136)\n\n***\n\n### lt\n\n> **lt**: `\"lt\"`\n\nDefined in: [src/utils/interfaces.ts:137](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L137)\n\n***\n\n### lu\n\n> **lu**: `\"lu\"`\n\nDefined in: [src/utils/interfaces.ts:138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L138)\n\n***\n\n### lv\n\n> **lv**: `\"lv\"`\n\nDefined in: [src/utils/interfaces.ts:139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L139)\n\n***\n\n### ly\n\n> **ly**: `\"ly\"`\n\nDefined in: [src/utils/interfaces.ts:140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L140)\n\n***\n\n### ma\n\n> **ma**: `\"ma\"`\n\nDefined in: [src/utils/interfaces.ts:141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L141)\n\n***\n\n### mc\n\n> **mc**: `\"mc\"`\n\nDefined in: [src/utils/interfaces.ts:142](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L142)\n\n***\n\n### md\n\n> **md**: `\"md\"`\n\nDefined in: [src/utils/interfaces.ts:143](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L143)\n\n***\n\n### me\n\n> **me**: `\"me\"`\n\nDefined in: [src/utils/interfaces.ts:144](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L144)\n\n***\n\n### mf\n\n> **mf**: `\"mf\"`\n\nDefined in: [src/utils/interfaces.ts:145](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L145)\n\n***\n\n### mg\n\n> **mg**: `\"mg\"`\n\nDefined in: [src/utils/interfaces.ts:146](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L146)\n\n***\n\n### mh\n\n> **mh**: `\"mh\"`\n\nDefined in: [src/utils/interfaces.ts:147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L147)\n\n***\n\n### mk\n\n> **mk**: `\"mk\"`\n\nDefined in: [src/utils/interfaces.ts:148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L148)\n\n***\n\n### ml\n\n> **ml**: `\"ml\"`\n\nDefined in: [src/utils/interfaces.ts:149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L149)\n\n***\n\n### mm\n\n> **mm**: `\"mm\"`\n\nDefined in: [src/utils/interfaces.ts:150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L150)\n\n***\n\n### mn\n\n> **mn**: `\"mn\"`\n\nDefined in: [src/utils/interfaces.ts:151](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L151)\n\n***\n\n### mo\n\n> **mo**: `\"mo\"`\n\nDefined in: [src/utils/interfaces.ts:152](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L152)\n\n***\n\n### mp\n\n> **mp**: `\"mp\"`\n\nDefined in: [src/utils/interfaces.ts:153](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L153)\n\n***\n\n### mq\n\n> **mq**: `\"mq\"`\n\nDefined in: [src/utils/interfaces.ts:154](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L154)\n\n***\n\n### mr\n\n> **mr**: `\"mr\"`\n\nDefined in: [src/utils/interfaces.ts:155](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L155)\n\n***\n\n### ms\n\n> **ms**: `\"ms\"`\n\nDefined in: [src/utils/interfaces.ts:156](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L156)\n\n***\n\n### mt\n\n> **mt**: `\"mt\"`\n\nDefined in: [src/utils/interfaces.ts:157](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L157)\n\n***\n\n### mu\n\n> **mu**: `\"mu\"`\n\nDefined in: [src/utils/interfaces.ts:158](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L158)\n\n***\n\n### mv\n\n> **mv**: `\"mv\"`\n\nDefined in: [src/utils/interfaces.ts:159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L159)\n\n***\n\n### mw\n\n> **mw**: `\"mw\"`\n\nDefined in: [src/utils/interfaces.ts:160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L160)\n\n***\n\n### mx\n\n> **mx**: `\"mx\"`\n\nDefined in: [src/utils/interfaces.ts:161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L161)\n\n***\n\n### my\n\n> **my**: `\"my\"`\n\nDefined in: [src/utils/interfaces.ts:162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L162)\n\n***\n\n### mz\n\n> **mz**: `\"mz\"`\n\nDefined in: [src/utils/interfaces.ts:163](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L163)\n\n***\n\n### na\n\n> **na**: `\"na\"`\n\nDefined in: [src/utils/interfaces.ts:164](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L164)\n\n***\n\n### nc\n\n> **nc**: `\"nc\"`\n\nDefined in: [src/utils/interfaces.ts:165](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L165)\n\n***\n\n### ne\n\n> **ne**: `\"ne\"`\n\nDefined in: [src/utils/interfaces.ts:166](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L166)\n\n***\n\n### nf\n\n> **nf**: `\"nf\"`\n\nDefined in: [src/utils/interfaces.ts:167](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L167)\n\n***\n\n### ng\n\n> **ng**: `\"ng\"`\n\nDefined in: [src/utils/interfaces.ts:168](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L168)\n\n***\n\n### ni\n\n> **ni**: `\"ni\"`\n\nDefined in: [src/utils/interfaces.ts:169](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L169)\n\n***\n\n### nl\n\n> **nl**: `\"nl\"`\n\nDefined in: [src/utils/interfaces.ts:170](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L170)\n\n***\n\n### no\n\n> **no**: `\"no\"`\n\nDefined in: [src/utils/interfaces.ts:171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L171)\n\n***\n\n### np\n\n> **np**: `\"np\"`\n\nDefined in: [src/utils/interfaces.ts:172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L172)\n\n***\n\n### nr\n\n> **nr**: `\"nr\"`\n\nDefined in: [src/utils/interfaces.ts:173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L173)\n\n***\n\n### nu\n\n> **nu**: `\"nu\"`\n\nDefined in: [src/utils/interfaces.ts:174](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L174)\n\n***\n\n### nz\n\n> **nz**: `\"nz\"`\n\nDefined in: [src/utils/interfaces.ts:175](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L175)\n\n***\n\n### om\n\n> **om**: `\"om\"`\n\nDefined in: [src/utils/interfaces.ts:176](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L176)\n\n***\n\n### pa\n\n> **pa**: `\"pa\"`\n\nDefined in: [src/utils/interfaces.ts:177](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L177)\n\n***\n\n### pe\n\n> **pe**: `\"pe\"`\n\nDefined in: [src/utils/interfaces.ts:178](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L178)\n\n***\n\n### pf\n\n> **pf**: `\"pf\"`\n\nDefined in: [src/utils/interfaces.ts:179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L179)\n\n***\n\n### pg\n\n> **pg**: `\"pg\"`\n\nDefined in: [src/utils/interfaces.ts:180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L180)\n\n***\n\n### ph\n\n> **ph**: `\"ph\"`\n\nDefined in: [src/utils/interfaces.ts:181](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L181)\n\n***\n\n### pk\n\n> **pk**: `\"pk\"`\n\nDefined in: [src/utils/interfaces.ts:182](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L182)\n\n***\n\n### pl\n\n> **pl**: `\"pl\"`\n\nDefined in: [src/utils/interfaces.ts:183](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L183)\n\n***\n\n### pm\n\n> **pm**: `\"pm\"`\n\nDefined in: [src/utils/interfaces.ts:184](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L184)\n\n***\n\n### pn\n\n> **pn**: `\"pn\"`\n\nDefined in: [src/utils/interfaces.ts:185](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L185)\n\n***\n\n### pr\n\n> **pr**: `\"pr\"`\n\nDefined in: [src/utils/interfaces.ts:186](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L186)\n\n***\n\n### ps\n\n> **ps**: `\"ps\"`\n\nDefined in: [src/utils/interfaces.ts:187](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L187)\n\n***\n\n### pt\n\n> **pt**: `\"pt\"`\n\nDefined in: [src/utils/interfaces.ts:188](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L188)\n\n***\n\n### pw\n\n> **pw**: `\"pw\"`\n\nDefined in: [src/utils/interfaces.ts:189](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L189)\n\n***\n\n### py\n\n> **py**: `\"py\"`\n\nDefined in: [src/utils/interfaces.ts:190](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L190)\n\n***\n\n### qa\n\n> **qa**: `\"qa\"`\n\nDefined in: [src/utils/interfaces.ts:191](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L191)\n\n***\n\n### re\n\n> **re**: `\"re\"`\n\nDefined in: [src/utils/interfaces.ts:192](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L192)\n\n***\n\n### ro\n\n> **ro**: `\"ro\"`\n\nDefined in: [src/utils/interfaces.ts:193](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L193)\n\n***\n\n### rs\n\n> **rs**: `\"rs\"`\n\nDefined in: [src/utils/interfaces.ts:194](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L194)\n\n***\n\n### ru\n\n> **ru**: `\"ru\"`\n\nDefined in: [src/utils/interfaces.ts:195](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L195)\n\n***\n\n### rw\n\n> **rw**: `\"rw\"`\n\nDefined in: [src/utils/interfaces.ts:196](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L196)\n\n***\n\n### sa\n\n> **sa**: `\"sa\"`\n\nDefined in: [src/utils/interfaces.ts:197](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L197)\n\n***\n\n### sb\n\n> **sb**: `\"sb\"`\n\nDefined in: [src/utils/interfaces.ts:198](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L198)\n\n***\n\n### sc\n\n> **sc**: `\"sc\"`\n\nDefined in: [src/utils/interfaces.ts:199](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L199)\n\n***\n\n### sd\n\n> **sd**: `\"sd\"`\n\nDefined in: [src/utils/interfaces.ts:200](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L200)\n\n***\n\n### se\n\n> **se**: `\"se\"`\n\nDefined in: [src/utils/interfaces.ts:201](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L201)\n\n***\n\n### sg\n\n> **sg**: `\"sg\"`\n\nDefined in: [src/utils/interfaces.ts:202](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L202)\n\n***\n\n### sh\n\n> **sh**: `\"sh\"`\n\nDefined in: [src/utils/interfaces.ts:203](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L203)\n\n***\n\n### si\n\n> **si**: `\"si\"`\n\nDefined in: [src/utils/interfaces.ts:204](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L204)\n\n***\n\n### sj\n\n> **sj**: `\"sj\"`\n\nDefined in: [src/utils/interfaces.ts:205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L205)\n\n***\n\n### sk\n\n> **sk**: `\"sk\"`\n\nDefined in: [src/utils/interfaces.ts:206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L206)\n\n***\n\n### sl\n\n> **sl**: `\"sl\"`\n\nDefined in: [src/utils/interfaces.ts:207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L207)\n\n***\n\n### sm\n\n> **sm**: `\"sm\"`\n\nDefined in: [src/utils/interfaces.ts:208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L208)\n\n***\n\n### sn\n\n> **sn**: `\"sn\"`\n\nDefined in: [src/utils/interfaces.ts:209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L209)\n\n***\n\n### so\n\n> **so**: `\"so\"`\n\nDefined in: [src/utils/interfaces.ts:210](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L210)\n\n***\n\n### sr\n\n> **sr**: `\"sr\"`\n\nDefined in: [src/utils/interfaces.ts:211](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L211)\n\n***\n\n### ss\n\n> **ss**: `\"ss\"`\n\nDefined in: [src/utils/interfaces.ts:212](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L212)\n\n***\n\n### st\n\n> **st**: `\"st\"`\n\nDefined in: [src/utils/interfaces.ts:213](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L213)\n\n***\n\n### sv\n\n> **sv**: `\"sv\"`\n\nDefined in: [src/utils/interfaces.ts:214](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L214)\n\n***\n\n### sx\n\n> **sx**: `\"sx\"`\n\nDefined in: [src/utils/interfaces.ts:215](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L215)\n\n***\n\n### sy\n\n> **sy**: `\"sy\"`\n\nDefined in: [src/utils/interfaces.ts:216](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L216)\n\n***\n\n### sz\n\n> **sz**: `\"sz\"`\n\nDefined in: [src/utils/interfaces.ts:217](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L217)\n\n***\n\n### tc\n\n> **tc**: `\"tc\"`\n\nDefined in: [src/utils/interfaces.ts:218](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L218)\n\n***\n\n### td\n\n> **td**: `\"td\"`\n\nDefined in: [src/utils/interfaces.ts:219](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L219)\n\n***\n\n### tf\n\n> **tf**: `\"tf\"`\n\nDefined in: [src/utils/interfaces.ts:220](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L220)\n\n***\n\n### tg\n\n> **tg**: `\"tg\"`\n\nDefined in: [src/utils/interfaces.ts:221](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L221)\n\n***\n\n### th\n\n> **th**: `\"th\"`\n\nDefined in: [src/utils/interfaces.ts:222](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L222)\n\n***\n\n### tj\n\n> **tj**: `\"tj\"`\n\nDefined in: [src/utils/interfaces.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L223)\n\n***\n\n### tk\n\n> **tk**: `\"tk\"`\n\nDefined in: [src/utils/interfaces.ts:224](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L224)\n\n***\n\n### tl\n\n> **tl**: `\"tl\"`\n\nDefined in: [src/utils/interfaces.ts:225](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L225)\n\n***\n\n### tm\n\n> **tm**: `\"tm\"`\n\nDefined in: [src/utils/interfaces.ts:226](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L226)\n\n***\n\n### tn\n\n> **tn**: `\"tn\"`\n\nDefined in: [src/utils/interfaces.ts:227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L227)\n\n***\n\n### to\n\n> **to**: `\"to\"`\n\nDefined in: [src/utils/interfaces.ts:228](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L228)\n\n***\n\n### tr\n\n> **tr**: `\"tr\"`\n\nDefined in: [src/utils/interfaces.ts:229](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L229)\n\n***\n\n### tt\n\n> **tt**: `\"tt\"`\n\nDefined in: [src/utils/interfaces.ts:230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L230)\n\n***\n\n### tv\n\n> **tv**: `\"tv\"`\n\nDefined in: [src/utils/interfaces.ts:231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L231)\n\n***\n\n### tw\n\n> **tw**: `\"tw\"`\n\nDefined in: [src/utils/interfaces.ts:232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L232)\n\n***\n\n### tz\n\n> **tz**: `\"tz\"`\n\nDefined in: [src/utils/interfaces.ts:233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L233)\n\n***\n\n### ua\n\n> **ua**: `\"ua\"`\n\nDefined in: [src/utils/interfaces.ts:234](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L234)\n\n***\n\n### ug\n\n> **ug**: `\"ug\"`\n\nDefined in: [src/utils/interfaces.ts:235](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L235)\n\n***\n\n### um\n\n> **um**: `\"um\"`\n\nDefined in: [src/utils/interfaces.ts:236](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L236)\n\n***\n\n### us\n\n> **us**: `\"us\"`\n\nDefined in: [src/utils/interfaces.ts:237](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L237)\n\n***\n\n### uy\n\n> **uy**: `\"uy\"`\n\nDefined in: [src/utils/interfaces.ts:238](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L238)\n\n***\n\n### uz\n\n> **uz**: `\"uz\"`\n\nDefined in: [src/utils/interfaces.ts:239](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L239)\n\n***\n\n### va\n\n> **va**: `\"va\"`\n\nDefined in: [src/utils/interfaces.ts:240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L240)\n\n***\n\n### vc\n\n> **vc**: `\"vc\"`\n\nDefined in: [src/utils/interfaces.ts:241](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L241)\n\n***\n\n### ve\n\n> **ve**: `\"ve\"`\n\nDefined in: [src/utils/interfaces.ts:242](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L242)\n\n***\n\n### vg\n\n> **vg**: `\"vg\"`\n\nDefined in: [src/utils/interfaces.ts:243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L243)\n\n***\n\n### vi\n\n> **vi**: `\"vi\"`\n\nDefined in: [src/utils/interfaces.ts:244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L244)\n\n***\n\n### vn\n\n> **vn**: `\"vn\"`\n\nDefined in: [src/utils/interfaces.ts:245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L245)\n\n***\n\n### vu\n\n> **vu**: `\"vu\"`\n\nDefined in: [src/utils/interfaces.ts:246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L246)\n\n***\n\n### wf\n\n> **wf**: `\"wf\"`\n\nDefined in: [src/utils/interfaces.ts:247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L247)\n\n***\n\n### ws\n\n> **ws**: `\"ws\"`\n\nDefined in: [src/utils/interfaces.ts:248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L248)\n\n***\n\n### ye\n\n> **ye**: `\"ye\"`\n\nDefined in: [src/utils/interfaces.ts:249](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L249)\n\n***\n\n### yt\n\n> **yt**: `\"yt\"`\n\nDefined in: [src/utils/interfaces.ts:250](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L250)\n\n***\n\n### za\n\n> **za**: `\"za\"`\n\nDefined in: [src/utils/interfaces.ts:251](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L251)\n\n***\n\n### zm\n\n> **zm**: `\"zm\"`\n\nDefined in: [src/utils/interfaces.ts:252](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L252)\n\n***\n\n### zw\n\n> **zw**: `\"zw\"`\n\nDefined in: [src/utils/interfaces.ts:253](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L253)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/UserEducationGrade.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserEducationGrade\n\nDefined in: [src/utils/interfaces.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L259)\n\nRepresents the education grades for a user.\n\n## Enumeration Members\n\n### GRADE\\_1\n\n> **GRADE\\_1**: `\"grade_1\"`\n\nDefined in: [src/utils/interfaces.ts:260](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L260)\n\n***\n\n### GRADE\\_10\n\n> **GRADE\\_10**: `\"grade_10\"`\n\nDefined in: [src/utils/interfaces.ts:269](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L269)\n\n***\n\n### GRADE\\_11\n\n> **GRADE\\_11**: `\"grade_11\"`\n\nDefined in: [src/utils/interfaces.ts:270](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L270)\n\n***\n\n### GRADE\\_12\n\n> **GRADE\\_12**: `\"grade_12\"`\n\nDefined in: [src/utils/interfaces.ts:271](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L271)\n\n***\n\n### GRADE\\_2\n\n> **GRADE\\_2**: `\"grade_2\"`\n\nDefined in: [src/utils/interfaces.ts:261](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L261)\n\n***\n\n### GRADE\\_3\n\n> **GRADE\\_3**: `\"grade_3\"`\n\nDefined in: [src/utils/interfaces.ts:262](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L262)\n\n***\n\n### GRADE\\_4\n\n> **GRADE\\_4**: `\"grade_4\"`\n\nDefined in: [src/utils/interfaces.ts:263](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L263)\n\n***\n\n### GRADE\\_5\n\n> **GRADE\\_5**: `\"grade_5\"`\n\nDefined in: [src/utils/interfaces.ts:264](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L264)\n\n***\n\n### GRADE\\_6\n\n> **GRADE\\_6**: `\"grade_6\"`\n\nDefined in: [src/utils/interfaces.ts:265](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L265)\n\n***\n\n### GRADE\\_7\n\n> **GRADE\\_7**: `\"grade_7\"`\n\nDefined in: [src/utils/interfaces.ts:266](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L266)\n\n***\n\n### GRADE\\_8\n\n> **GRADE\\_8**: `\"grade_8\"`\n\nDefined in: [src/utils/interfaces.ts:267](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L267)\n\n***\n\n### GRADE\\_9\n\n> **GRADE\\_9**: `\"grade_9\"`\n\nDefined in: [src/utils/interfaces.ts:268](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L268)\n\n***\n\n### GRADUATE\n\n> **GRADUATE**: `\"graduate\"`\n\nDefined in: [src/utils/interfaces.ts:272](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L272)\n\n***\n\n### KG\n\n> **KG**: `\"kg\"`\n\nDefined in: [src/utils/interfaces.ts:273](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L273)\n\n***\n\n### NO\\_GRADE\n\n> **NO\\_GRADE**: `\"no_grade\"`\n\nDefined in: [src/utils/interfaces.ts:274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L274)\n\n***\n\n### PRE\\_KG\n\n> **PRE\\_KG**: `\"pre_kg\"`\n\nDefined in: [src/utils/interfaces.ts:275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L275)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/UserEmploymentStatus.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserEmploymentStatus\n\nDefined in: [src/utils/interfaces.ts:281](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L281)\n\nRepresents the employment status of a user.\n\n## Enumeration Members\n\n### FULL\\_TIME\n\n> **FULL\\_TIME**: `\"full_time\"`\n\nDefined in: [src/utils/interfaces.ts:282](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L282)\n\n***\n\n### PART\\_TIME\n\n> **PART\\_TIME**: `\"part_time\"`\n\nDefined in: [src/utils/interfaces.ts:283](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L283)\n\n***\n\n### UNEMPLOYED\n\n> **UNEMPLOYED**: `\"unemployed\"`\n\nDefined in: [src/utils/interfaces.ts:284](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L284)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/UserMaritalStatus.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserMaritalStatus\n\nDefined in: [src/utils/interfaces.ts:290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L290)\n\nRepresents the marital status of a user.\n\n## Enumeration Members\n\n### DIVORCED\n\n> **DIVORCED**: `\"divorced\"`\n\nDefined in: [src/utils/interfaces.ts:291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L291)\n\n***\n\n### ENGAGED\n\n> **ENGAGED**: `\"engaged\"`\n\nDefined in: [src/utils/interfaces.ts:292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L292)\n\n***\n\n### MARRIED\n\n> **MARRIED**: `\"married\"`\n\nDefined in: [src/utils/interfaces.ts:293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L293)\n\n***\n\n### SEPARATED\n\n> **SEPARATED**: `\"separated\"`\n\nDefined in: [src/utils/interfaces.ts:294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L294)\n\n***\n\n### SINGLE\n\n> **SINGLE**: `\"single\"`\n\nDefined in: [src/utils/interfaces.ts:295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L295)\n\n***\n\n### WIDOWED\n\n> **WIDOWED**: `\"widowed\"`\n\nDefined in: [src/utils/interfaces.ts:296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L296)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/UserNatalSex.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserNatalSex\n\nDefined in: [src/utils/interfaces.ts:302](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L302)\n\nRepresents the natal sex of a user.\n\n## Enumeration Members\n\n### FEMALE\n\n> **FEMALE**: `\"female\"`\n\nDefined in: [src/utils/interfaces.ts:303](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L303)\n\n***\n\n### INTERSEX\n\n> **INTERSEX**: `\"intersex\"`\n\nDefined in: [src/utils/interfaces.ts:304](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L304)\n\n***\n\n### MALE\n\n> **MALE**: `\"male\"`\n\nDefined in: [src/utils/interfaces.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L305)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/enumerations/UserRole.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: UserRole\n\nDefined in: [src/utils/interfaces.ts:316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L316)\n\nRepresents the role of a user within the system.\n\n## Enumeration Members\n\n### Administrator\n\n> **Administrator**: `\"administrator\"`\n\nDefined in: [src/utils/interfaces.ts:317](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L317)\n\n***\n\n### Regular\n\n> **Regular**: `\"regular\"`\n\nDefined in: [src/utils/interfaces.ts:318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L318)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/IEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: IEvent\n\nDefined in: [src/utils/interfaces.ts:729](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L729)\n\n## Properties\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/utils/interfaces.ts:730](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L730)\n\n#### attachments\n\n> **attachments**: [`InterfaceEventAttachmentPg`](InterfaceEventAttachmentPg.md)[]\n\n#### createdAt\n\n> **createdAt**: `string`\n\n#### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\n#### description\n\n> **description**: `string`\n\n#### endAt\n\n> **endAt**: `string`\n\n#### id\n\n> **id**: `ID`\n\n#### name\n\n> **name**: `string`\n\n#### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\n#### startAt\n\n> **startAt**: `string`\n\n#### updatedAt\n\n> **updatedAt**: `string`\n\n#### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAddress.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAddress\n\nDefined in: [src/utils/interfaces.ts:1568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1568)\n\nDefines the structure for an address.\n\n## Properties\n\n### city\n\n> **city**: `string`\n\nDefined in: [src/utils/interfaces.ts:1569](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1569)\n\n***\n\n### countryCode\n\n> **countryCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1570](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1570)\n\n***\n\n### dependentLocality\n\n> **dependentLocality**: `string`\n\nDefined in: [src/utils/interfaces.ts:1571](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1571)\n\n***\n\n### line1\n\n> **line1**: `string`\n\nDefined in: [src/utils/interfaces.ts:1572](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1572)\n\n***\n\n### line2\n\n> **line2**: `string`\n\nDefined in: [src/utils/interfaces.ts:1573](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1573)\n\n***\n\n### postalCode\n\n> **postalCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1574](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1574)\n\n***\n\n### sortingCode\n\n> **sortingCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1575](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1575)\n\n***\n\n### state\n\n> **state**: `string`\n\nDefined in: [src/utils/interfaces.ts:1576](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1576)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementAttachmentPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAdvertisementAttachmentPg\n\nDefined in: [src/utils/interfaces.ts:581](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L581)\n\nDefines the structure for an advertisement attachment with PostgreSQL-specific fields.\n\n## Properties\n\n### mimeType\n\n> **mimeType**: `string`\n\nDefined in: [src/utils/interfaces.ts:582](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L582)\n\n***\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/utils/interfaces.ts:583](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L583)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceAdvertisementPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceAdvertisementPg\n\nDefined in: [src/utils/interfaces.ts:563](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L563)\n\nDefines the structure for an advertisement with PostgreSQL-specific fields.\n\n## Properties\n\n### attachments\n\n> **attachments**: [`InterfaceAdvertisementAttachmentPg`](InterfaceAdvertisementAttachmentPg.md)[]\n\nDefined in: [src/utils/interfaces.ts:575](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L575)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:570](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L570)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:572](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L572)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:566](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L566)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:569](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L569)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:564](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L564)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:565](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L565)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:574](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L574)\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:568](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L568)\n\n***\n\n### type\n\n> **type**: [`AdvertisementTypePg`](../enumerations/AdvertisementTypePg.md)\n\nDefined in: [src/utils/interfaces.ts:567](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L567)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:571](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L571)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:573](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L573)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceBaseEvent.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceBaseEvent\n\nDefined in: [src/utils/interfaces.ts:382](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L382)\n\nBase interface for common event properties.\n\n## Extended by\n\n- [`InterfaceQueryOrganizationEventListItem`](InterfaceQueryOrganizationEventListItem.md)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:383](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L383)\n\n***\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L391)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:385](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L385)\n\n***\n\n### endDate\n\n> **endDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:387](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L387)\n\n***\n\n### endTime\n\n> **endTime**: `string`\n\nDefined in: [src/utils/interfaces.ts:390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L390)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/utils/interfaces.ts:388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L388)\n\n***\n\n### recurring\n\n> **recurring**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L392)\n\n***\n\n### startDate\n\n> **startDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L386)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/utils/interfaces.ts:389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L389)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/utils/interfaces.ts:384](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L384)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCampaignInfo\n\nDefined in: [src/utils/interfaces.ts:1315](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1315)\n\nDefines the structure for campaign information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1321](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1321)\n\n***\n\n### currencyCode\n\n> **currencyCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1322](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1322)\n\n***\n\n### endAt\n\n> **endAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1320](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1320)\n\n***\n\n### fundingRaised?\n\n> `optional` **fundingRaised**: `number`\n\nDefined in: [src/utils/interfaces.ts:1323](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1323)\n\n***\n\n### goalAmount\n\n> **goalAmount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1318](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1318)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1316](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1316)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1317](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1317)\n\n***\n\n### startAt\n\n> **startAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1319](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1319)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCampaignInfoPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCampaignInfoPG\n\nDefined in: [src/utils/interfaces.ts:1274](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1274)\n\nDefines the structure for campaign information with PostgreSQL-specific fields.\n\n## Properties\n\n### currency\n\n> **currency**: `string`\n\nDefined in: [src/utils/interfaces.ts:1279](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1279)\n\n***\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1278](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1278)\n\n***\n\n### goal\n\n> **goal**: `number`\n\nDefined in: [src/utils/interfaces.ts:1276](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1276)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1275)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1277](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1277)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatMessagePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceChatMessagePg\n\nDefined in: [src/utils/interfaces.ts:637](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L637)\n\nDefines the structure for a chat message with PostgreSQL-specific fields.\n\n## Properties\n\n### body\n\n> **body**: `string`\n\nDefined in: [src/utils/interfaces.ts:639](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L639)\n\n***\n\n### chat\n\n> **chat**: [`InterfaceChatPg`](InterfaceChatPg.md)\n\nDefined in: [src/utils/interfaces.ts:640](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L640)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:641](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L641)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:642](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L642)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:638](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L638)\n\n***\n\n### parentMessage\n\n> **parentMessage**: `InterfaceChatMessagePg`\n\nDefined in: [src/utils/interfaces.ts:643](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L643)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:644](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L644)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceChatPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceChatPg\n\nDefined in: [src/utils/interfaces.ts:621](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L621)\n\nDefines the structure for a chat with PostgreSQL-specific fields.\n\n## Properties\n\n### avatarMimeType\n\n> **avatarMimeType**: `string`\n\nDefined in: [src/utils/interfaces.ts:625](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L625)\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:626](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L626)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L627)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:629](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L629)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:624](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L624)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:622](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L622)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:623](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L623)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:631](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L631)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:628](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L628)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:630](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L630)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceComment.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceComment\n\nDefined in: [src/utils/interfaces.ts:1618](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1618)\n\n## Properties\n\n### body\n\n> **body**: `string`\n\nDefined in: [src/utils/interfaces.ts:1620](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1620)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1626](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1626)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/utils/interfaces.ts:1621](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1621)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### downVotesCount\n\n> **downVotesCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1628](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1628)\n\n***\n\n### hasUserVoted?\n\n> `optional` **hasUserVoted**: `object`\n\nDefined in: [src/utils/interfaces.ts:1629](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1629)\n\n#### hasVoted\n\n> **hasVoted**: `boolean`\n\n#### voteType\n\n> **voteType**: [`VoteType`](../type-aliases/VoteType.md)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1619](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1619)\n\n***\n\n### upVotesCount\n\n> **upVotesCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1627](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1627)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCommentEdge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCommentEdge\n\nDefined in: [src/utils/interfaces.ts:1635](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1635)\n\n## Properties\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/utils/interfaces.ts:1636](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1636)\n\n#### body\n\n> **body**: `string`\n\n#### createdAt\n\n> **createdAt**: `string`\n\n#### creator\n\n> **creator**: `object`\n\n##### creator.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### creator.id\n\n> **id**: `string`\n\n##### creator.name\n\n> **name**: `string`\n\n#### downVotesCount\n\n> **downVotesCount**: `number`\n\n#### hasUserVoted?\n\n> `optional` **hasUserVoted**: `object`\n\n##### hasUserVoted.hasVoted\n\n> **hasVoted**: `boolean`\n\n##### hasUserVoted.voteType\n\n> **voteType**: [`VoteType`](../type-aliases/VoteType.md)\n\n#### id\n\n> **id**: `string`\n\n#### upVotesCount\n\n> **upVotesCount**: `number`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateFund.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateFund\n\nDefined in: [src/utils/interfaces.ts:1582](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1582)\n\nDefines the structure for creating a fund.\n\n## Properties\n\n### fundName\n\n> **fundName**: `string`\n\nDefined in: [src/utils/interfaces.ts:1583](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1583)\n\n***\n\n### fundRef\n\n> **fundRef**: `string`\n\nDefined in: [src/utils/interfaces.ts:1584](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1584)\n\n***\n\n### isArchived\n\n> **isArchived**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1586](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1586)\n\n***\n\n### isDefault\n\n> **isDefault**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1585](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1585)\n\n***\n\n### isTaxDeductible\n\n> **isTaxDeductible**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1587](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1587)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreatePledge.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreatePledge\n\nDefined in: [src/utils/interfaces.ts:1657](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1657)\n\nDefines the structure for creating a pledge.\n\n## Properties\n\n### pledgeAmount\n\n> **pledgeAmount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1659](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1659)\n\n***\n\n### pledgeCurrency\n\n> **pledgeCurrency**: `string`\n\nDefined in: [src/utils/interfaces.ts:1660](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1660)\n\n***\n\n### pledgeUsers\n\n> **pledgeUsers**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[]\n\nDefined in: [src/utils/interfaces.ts:1658](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1658)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCreateVolunteerGroup.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCreateVolunteerGroup\n\nDefined in: [src/utils/interfaces.ts:1762](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1762)\n\nDefines the structure for creating a volunteer group.\n\n## Properties\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:1764](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1764)\n\n***\n\n### leader\n\n> **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md)\n\nDefined in: [src/utils/interfaces.ts:1765](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1765)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1763](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1763)\n\n***\n\n### volunteersRequired\n\n> **volunteersRequired**: `number`\n\nDefined in: [src/utils/interfaces.ts:1766](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1766)\n\n***\n\n### volunteerUsers\n\n> **volunteerUsers**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[]\n\nDefined in: [src/utils/interfaces.ts:1767](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1767)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCurrentUserTypePG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCurrentUserTypePG\n\nDefined in: [src/utils/interfaces.ts:357](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L357)\n\nDefines the structure for the current user type with PostgreSQL-specific fields.\n\n## Properties\n\n### currentUser\n\n> **currentUser**: `object`\n\nDefined in: [src/utils/interfaces.ts:358](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L358)\n\n#### emailAddress\n\n> **emailAddress**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### role\n\n> **role**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceCustomFieldData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceCustomFieldData\n\nDefined in: [src/utils/interfaces.ts:1691](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1691)\n\nDefines the structure for custom field data.\n\n## Properties\n\n### id?\n\n> `optional` **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1692](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1692)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1693](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1693)\n\n***\n\n### organizationId?\n\n> `optional` **organizationId**: `string`\n\nDefined in: [src/utils/interfaces.ts:1695](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1695)\n\n***\n\n### type\n\n> **type**: `string`\n\nDefined in: [src/utils/interfaces.ts:1694](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1694)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventAttachmentPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventAttachmentPg\n\nDefined in: [src/utils/interfaces.ts:748](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L748)\n\nDefines the structure for an event attachment with PostgreSQL-specific fields.\n\n## Properties\n\n### mimeType\n\n> **mimeType**: `string`\n\nDefined in: [src/utils/interfaces.ts:749](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L749)\n\n***\n\n### url\n\n> **url**: `string`\n\nDefined in: [src/utils/interfaces.ts:750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L750)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceEventVolunteerInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceEventVolunteerInfo\n\nDefined in: [src/utils/interfaces.ts:1701](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1701)\n\nDefines the structure for event volunteer information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1709](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1709)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\nDefined in: [src/utils/interfaces.ts:1722](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1722)\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/utils/interfaces.ts:1712](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1712)\n\n#### baseEvent?\n\n> `optional` **baseEvent**: `object`\n\n##### baseEvent.id\n\n> **id**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\n##### recurrenceRule.id\n\n> **id**: `string`\n\n***\n\n### groups\n\n> **groups**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1724](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1724)\n\n#### description\n\n> **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### volunteers\n\n> **volunteers**: `object`[]\n\n***\n\n### hasAccepted\n\n> **hasAccepted**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1703](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1703)\n\n***\n\n### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\nDefined in: [src/utils/interfaces.ts:1705](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1705)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1702](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1702)\n\n***\n\n### isInstanceException\n\n> **isInstanceException**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1708](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1708)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1706](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1706)\n\n***\n\n### isTemplate\n\n> **isTemplate**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1707](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1707)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1710](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1710)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\nDefined in: [src/utils/interfaces.ts:1723](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1723)\n\n***\n\n### user\n\n> **user**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\nDefined in: [src/utils/interfaces.ts:1711](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1711)\n\n***\n\n### volunteerStatus\n\n> **volunteerStatus**: `\"accepted\"` \\| `\"rejected\"` \\| `\"pending\"`\n\nDefined in: [src/utils/interfaces.ts:1704](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1704)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFundInfo\n\nDefined in: [src/utils/interfaces.ts:1285](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1285)\n\nDefines the structure for fund information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1292](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1292)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/utils/interfaces.ts:1294](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1294)\n\n#### name\n\n> **name**: `string`\n\n***\n\n### edges\n\n> **edges**: `object`\n\nDefined in: [src/utils/interfaces.ts:1299](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1299)\n\n#### node\n\n> **node**: `object`\n\n##### node.createdAt\n\n> **createdAt**: `string`\n\n##### node.currency\n\n> **currency**: `string`\n\n##### node.endDate\n\n> **endDate**: `string`\n\n##### node.fundingGoal\n\n> **fundingGoal**: `number`\n\n##### node.id\n\n> **id**: `string`\n\n##### node.name\n\n> **name**: `string`\n\n##### node.startDate\n\n> **startDate**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1286](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1286)\n\n***\n\n### isArchived\n\n> **isArchived**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1290](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1290)\n\n***\n\n### isDefault\n\n> **isDefault**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1291](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1291)\n\n***\n\n### isTaxDeductible\n\n> **isTaxDeductible**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1289](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1289)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1287](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1287)\n\n***\n\n### organization\n\n> **organization**: `object`\n\nDefined in: [src/utils/interfaces.ts:1295](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1295)\n\n#### name\n\n> **name**: `string`\n\n***\n\n### organizationId\n\n> **organizationId**: `string`\n\nDefined in: [src/utils/interfaces.ts:1293](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1293)\n\n***\n\n### refrenceNumber\n\n> **refrenceNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1288](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1288)\n\n***\n\n### updater\n\n> **updater**: `object`\n\nDefined in: [src/utils/interfaces.ts:1296](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1296)\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceFundPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceFundPg\n\nDefined in: [src/utils/interfaces.ts:772](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L772)\n\nDefines the structure for a fund with PostgreSQL-specific fields.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:776](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L776)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:778](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L778)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:773](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L773)\n\n***\n\n### isTaxDeductible\n\n> **isTaxDeductible**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:780](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L780)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:774](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L774)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:775](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L775)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:777](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L777)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:779](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L779)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMapType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMapType\n\nDefined in: [src/utils/interfaces.ts:1684](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1684)\n\nDefines a generic map type where keys and values are strings.\n\n## Indexable\n\n\\[`key`: `string`\\]: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMemberInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMemberInfo\n\nDefined in: [src/utils/interfaces.ts:408](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L408)\n\nDefines the structure for member information.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:409](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L409)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:414](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L414)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/utils/interfaces.ts:412](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L412)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/utils/interfaces.ts:410](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L410)\n\n***\n\n### image\n\n> **image**: `string`\n\nDefined in: [src/utils/interfaces.ts:413](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L413)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/utils/interfaces.ts:411](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L411)\n\n***\n\n### organizationsBlockedBy\n\n> **organizationsBlockedBy**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:415](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L415)\n\n#### \\_id\n\n> **\\_id**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceMembersList.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceMembersList\n\nDefined in: [src/utils/interfaces.ts:398](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L398)\n\nDefines the structure for a list of organizations with their members.\n\n## Properties\n\n### organizations\n\n> **organizations**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:399](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L399)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### members\n\n> **members**: [`InterfaceMemberInfo`](InterfaceMemberInfo.md)[]\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgConnectionInfoType\n\nDefined in: [src/utils/interfaces.ts:423](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L423)\n\nDefines the structure for organization connection information.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:424](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L424)\n\n***\n\n### address\n\n> **address**: [`InterfaceAddress`](InterfaceAddress.md)\n\nDefined in: [src/utils/interfaces.ts:439](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L439)\n\n***\n\n### admins\n\n> **admins**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:435](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L435)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:438](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L438)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/utils/interfaces.ts:426](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L426)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n\n***\n\n### image\n\n> **image**: `string`\n\nDefined in: [src/utils/interfaces.ts:425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L425)\n\n***\n\n### members\n\n> **members**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:432](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L432)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:431](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L431)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgConnectionInfoTypePG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgConnectionInfoTypePG\n\nDefined in: [src/utils/interfaces.ts:445](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L445)\n\nDefines the structure for organization connection information with PostgreSQL-specific fields.\n\n## Properties\n\n### organizations\n\n> **organizations**: [`InterfaceOrgInfoTypePG`](InterfaceOrgInfoTypePG.md)[]\n\nDefined in: [src/utils/interfaces.ts:446](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L446)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrgInfoTypePG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrgInfoTypePG\n\nDefined in: [src/utils/interfaces.ts:452](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L452)\n\nDefines the structure for organization information with PostgreSQL-specific fields.\n\n## Properties\n\n### addressLine1\n\n> **addressLine1**: `string`\n\nDefined in: [src/utils/interfaces.ts:455](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L455)\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:457](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L457)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:458](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L458)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:456](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L456)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:453](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L453)\n\n***\n\n### isMember?\n\n> `optional` **isMember**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L469)\n\n***\n\n### members?\n\n> `optional` **members**: `object`\n\nDefined in: [src/utils/interfaces.ts:460](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L460)\n\n#### edges\n\n> **edges**: `object`[]\n\n#### id?\n\n> `optional` **id**: `string`\n\n***\n\n### membersCount?\n\n> `optional` **membersCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:459](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L459)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:454](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L454)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/utils/interfaces.ts:468](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L468)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationAdvertisementsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:597](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L597)\n\nDefines the structure for an edge in the organization advertisements connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:598](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L598)\n\n***\n\n### node\n\n> **node**: [`InterfaceAdvertisementPg`](InterfaceAdvertisementPg.md)\n\nDefined in: [src/utils/interfaces.ts:599](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L599)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationAdvertisementsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationAdvertisementsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:589](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L589)\n\nDefines the structure for a connection of organization advertisements with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationAdvertisementsConnectionEdgePg`](InterfaceOrganizationAdvertisementsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:590](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L590)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L591)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationBlockedUsersConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationBlockedUsersConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:605](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L605)\n\nDefines the structure for an edge in the organization blocked users connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:606](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L606)\n\n***\n\n### node\n\n> **node**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:607](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L607)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationBlockedUsersConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationBlockedUsersConnectionPg\n\nDefined in: [src/utils/interfaces.ts:613](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L613)\n\nDefines the structure for a connection of organization blocked users with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationBlockedUsersConnectionEdgePg`](InterfaceOrganizationBlockedUsersConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:614](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L614)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:615](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L615)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationEventsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:724](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L724)\n\nDefines the structure for an edge in the organization events connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:725](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L725)\n\n***\n\n### node\n\n> **node**: [`IEvent`](IEvent.md)\n\nDefined in: [src/utils/interfaces.ts:726](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L726)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationEventsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationEventsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:716](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L716)\n\nDefines the structure for a connection of organization events with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationEventsConnectionEdgePg`](InterfaceOrganizationEventsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:717](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L717)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:718](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L718)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationFundsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:764](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L764)\n\nDefines the structure for an edge in the organization funds connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:765](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L765)\n\n***\n\n### node\n\n> **node**: [`InterfaceFundPg`](InterfaceFundPg.md)\n\nDefined in: [src/utils/interfaces.ts:766](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L766)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationFundsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationFundsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:756](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L756)\n\nDefines the structure for a connection of organization funds with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationFundsConnectionEdgePg`](InterfaceOrganizationFundsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:757](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L757)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:758](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L758)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationMembersConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:794](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L794)\n\nDefines the structure for an edge in the organization members connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:795](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L795)\n\n***\n\n### node\n\n> **node**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:796](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L796)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationMembersConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationMembersConnectionPg\n\nDefined in: [src/utils/interfaces.ts:786](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L786)\n\nDefines the structure for a connection of organization members with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationMembersConnectionEdgePg`](InterfaceOrganizationMembersConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:787](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L787)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:788](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L788)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPg\n\nDefined in: [src/utils/interfaces.ts:954](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L954)\n\nDefines the structure for an organization with PostgreSQL-specific fields.\n\n## Properties\n\n### organization\n\n> **organization**: `object`\n\nDefined in: [src/utils/interfaces.ts:955](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L955)\n\n#### addressLine1\n\n> **addressLine1**: `string`\n\n#### addressLine2\n\n> **addressLine2**: `string`\n\n#### adminsCount\n\n> **adminsCount**: `number`\n\n#### advertisements\n\n> **advertisements**: [`InterfaceOrganizationAdvertisementsConnectionPg`](InterfaceOrganizationAdvertisementsConnectionPg.md)\n\n#### avatarMimeType\n\n> **avatarMimeType**: `string`\n\n#### avatarURL\n\n> **avatarURL**: `string`\n\n#### blockedUsers\n\n> **blockedUsers**: [`InterfaceOrganizationBlockedUsersConnectionPg`](InterfaceOrganizationBlockedUsersConnectionPg.md)\n\n#### chats\n\n> **chats**: `InterfaceOrganizationChatsConnectionPg`\n\n#### city\n\n> **city**: `string`\n\n#### countryCode\n\n> **countryCode**: [`Iso3166Alpha2CountryCode`](../enumerations/Iso3166Alpha2CountryCode.md)\n\n#### createdAt\n\n> **createdAt**: `Date`\n\n#### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\n#### description\n\n> **description**: `string`\n\n#### events\n\n> **events**: [`InterfaceOrganizationEventsConnectionPg`](InterfaceOrganizationEventsConnectionPg.md)\n\n#### funds\n\n> **funds**: [`InterfaceOrganizationFundsConnectionPg`](InterfaceOrganizationFundsConnectionPg.md)\n\n#### id\n\n> **id**: `string`\n\n#### members\n\n> **members**: [`InterfaceOrganizationMembersConnectionPg`](InterfaceOrganizationMembersConnectionPg.md)\n\n#### membersCount\n\n> **membersCount**: `number`\n\n#### name\n\n> **name**: `string`\n\n#### pinnedPosts\n\n> **pinnedPosts**: [`InterfaceOrganizationPinnedPostsConnectionPg`](InterfaceOrganizationPinnedPostsConnectionPg.md)\n\n#### pinnedPostsCount\n\n> **pinnedPostsCount**: `number`\n\n#### posts\n\n> **posts**: [`InterfaceOrganizationPostsConnectionPg`](InterfaceOrganizationPostsConnectionPg.md)\n\n#### postsCount\n\n> **postsCount**: `number`\n\n#### tagFolders\n\n> **tagFolders**: [`InterfaceOrganizationTagFoldersConnectionPg`](InterfaceOrganizationTagFoldersConnectionPg.md)\n\n#### tags\n\n> **tags**: [`InterfaceOrganizationTagsConnectionPg`](InterfaceOrganizationTagsConnectionPg.md)\n\n#### updatedAt\n\n> **updatedAt**: `Date`\n\n#### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\n#### venues\n\n> **venues**: [`InterfaceOrganizationVenuesConnectionPg`](InterfaceOrganizationVenuesConnectionPg.md)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPinnedPostsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:810](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L810)\n\nDefines the structure for an edge in the organization pinned posts connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:811](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L811)\n\n***\n\n### node\n\n> **node**: [`InterfacePostPg`](InterfacePostPg.md)\n\nDefined in: [src/utils/interfaces.ts:812](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L812)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPinnedPostsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPinnedPostsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:802](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L802)\n\nDefines the structure for a connection of organization pinned posts with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationPinnedPostsConnectionEdgePg`](InterfaceOrganizationPinnedPostsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:803](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L803)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:804](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L804)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPostsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:843](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L843)\n\nDefines the structure for an edge in the organization posts connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:844](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L844)\n\n***\n\n### node\n\n> **node**: [`InterfacePostPg`](InterfacePostPg.md)\n\nDefined in: [src/utils/interfaces.ts:845](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L845)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationPostsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationPostsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:835](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L835)\n\nDefines the structure for a connection of organization posts with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationPostsConnectionEdgePg`](InterfaceOrganizationPostsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:836](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L836)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:837](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L837)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagFoldersConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:859](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L859)\n\nDefines the structure for an edge in the organization tag folders connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:860](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L860)\n\n***\n\n### node\n\n> **node**: [`InterfaceTagFolderPg`](InterfaceTagFolderPg.md)\n\nDefined in: [src/utils/interfaces.ts:861](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L861)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagFoldersConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagFoldersConnectionPg\n\nDefined in: [src/utils/interfaces.ts:851](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L851)\n\nDefines the structure for a connection of organization tag folders with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationTagFoldersConnectionEdgePg`](InterfaceOrganizationTagFoldersConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:852](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L852)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:853](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L853)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagsConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:888](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L888)\n\nDefines the structure for an edge in the organization tags connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:889](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L889)\n\n***\n\n### node\n\n> **node**: [`InterfaceTagPg`](InterfaceTagPg.md)\n\nDefined in: [src/utils/interfaces.ts:890](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L890)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationTagsConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagsConnectionPg\n\nDefined in: [src/utils/interfaces.ts:880](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L880)\n\nDefines the structure for a connection of organization tags with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationTagsConnectionEdgePg`](InterfaceOrganizationTagsConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:881](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L881)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:882](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L882)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionEdgePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationVenuesConnectionEdgePg\n\nDefined in: [src/utils/interfaces.ts:917](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L917)\n\nDefines the structure for an edge in the organization venues connection with PostgreSQL-specific fields.\n\n## Properties\n\n### cursor\n\n> **cursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:918](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L918)\n\n***\n\n### node\n\n> **node**: [`InterfaceVenuePg`](InterfaceVenuePg.md)\n\nDefined in: [src/utils/interfaces.ts:919](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L919)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceOrganizationVenuesConnectionPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationVenuesConnectionPg\n\nDefined in: [src/utils/interfaces.ts:909](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L909)\n\nDefines the structure for a connection of organization venues with PostgreSQL-specific fields.\n\n## Properties\n\n### edges\n\n> **edges**: [`InterfaceOrganizationVenuesConnectionEdgePg`](InterfaceOrganizationVenuesConnectionEdgePg.md)[]\n\nDefined in: [src/utils/interfaces.ts:910](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L910)\n\n***\n\n### pageInfo\n\n> **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n\nDefined in: [src/utils/interfaces.ts:911](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L911)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePageInfoPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePageInfoPg\n\nDefined in: [src/utils/interfaces.ts:520](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L520)\n\nDefines the structure for pagination information in PostgreSQL-backed connections.\n\n## Properties\n\n### endCursor\n\n> **endCursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:521](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L521)\n\n***\n\n### hasNextPage\n\n> **hasNextPage**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:522](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L522)\n\n***\n\n### hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:523](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L523)\n\n***\n\n### startCursor\n\n> **startCursor**: `string`\n\nDefined in: [src/utils/interfaces.ts:524](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L524)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePaginationArgs.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePaginationArgs\n\nDefined in: [src/utils/interfaces.ts:944](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L944)\n\nDefines the arguments for pagination.\n\n## Properties\n\n### after\n\n> **after**: `string`\n\nDefined in: [src/utils/interfaces.ts:945](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L945)\n\n***\n\n### before\n\n> **before**: `string`\n\nDefined in: [src/utils/interfaces.ts:946](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L946)\n\n***\n\n### first\n\n> **first**: `number`\n\nDefined in: [src/utils/interfaces.ts:947](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L947)\n\n***\n\n### last\n\n> **last**: `number`\n\nDefined in: [src/utils/interfaces.ts:948](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L948)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePledgeInfo\n\nDefined in: [src/utils/interfaces.ts:1329](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1329)\n\nDefines the structure for pledge information.\n\n## Properties\n\n### amount\n\n> **amount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1338](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1338)\n\n***\n\n### campaign?\n\n> `optional` **campaign**: `object`\n\nDefined in: [src/utils/interfaces.ts:1331](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1331)\n\n#### currencyCode\n\n> **currencyCode**: `string`\n\n#### endAt\n\n> **endAt**: `Date`\n\n#### goalAmount\n\n> **goalAmount**: `number`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1341](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1341)\n\n***\n\n### currency\n\n> **currency**: `string`\n\nDefined in: [src/utils/interfaces.ts:1340](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1340)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1330](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1330)\n\n***\n\n### note?\n\n> `optional` **note**: `string`\n\nDefined in: [src/utils/interfaces.ts:1339](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1339)\n\n***\n\n### pledger\n\n> **pledger**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\nDefined in: [src/utils/interfaces.ts:1343](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1343)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1342](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1342)\n\n***\n\n### users?\n\n> `optional` **users**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)[]\n\nDefined in: [src/utils/interfaces.ts:1344](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1344)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePledgeInfoPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePledgeInfoPG\n\nDefined in: [src/utils/interfaces.ts:1350](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1350)\n\nDefines the structure for pledge information with PostgreSQL-specific fields.\n\n## Properties\n\n### amount\n\n> **amount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1359](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1359)\n\n***\n\n### campaign?\n\n> `optional` **campaign**: `object`\n\nDefined in: [src/utils/interfaces.ts:1352](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1352)\n\n#### currencyCode\n\n> **currencyCode**: `string`\n\n#### endDate\n\n> **endDate**: `Date`\n\n#### goalAmount\n\n> **goalAmount**: `number`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1361](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1361)\n\n***\n\n### currencyCode\n\n> **currencyCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1360](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1360)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1351](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1351)\n\n***\n\n### pledger\n\n> **pledger**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\nDefined in: [src/utils/interfaces.ts:1363](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1363)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1362](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1362)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostCard.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostCard\n\nDefined in: [src/utils/interfaces.ts:1596](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1596)\n\nDefines the structure for a post card.\n\n## Properties\n\n### attachmentURL?\n\n> `optional` **attachmentURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:1608](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1608)\n\n***\n\n### body?\n\n> `optional` **body**: `string`\n\nDefined in: [src/utils/interfaces.ts:1610](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1610)\n\n***\n\n### commentCount\n\n> **commentCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1612](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1612)\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/utils/interfaces.ts:1599](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1599)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### downVoteCount\n\n> **downVoteCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1614](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1614)\n\n***\n\n### fetchPosts()\n\n> **fetchPosts**: () => `Promise`\\<`unknown`\\>\n\nDefined in: [src/utils/interfaces.ts:1615](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1615)\n\n#### Returns\n\n`Promise`\\<`unknown`\\>\n\n***\n\n### hasUserVoted\n\n> **hasUserVoted**: [`VoteState`](../type-aliases/VoteState.md)\n\nDefined in: [src/utils/interfaces.ts:1604](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1604)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1597](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1597)\n\n***\n\n### isModalView?\n\n> `optional` **isModalView**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1598](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1598)\n\n***\n\n### mimeType?\n\n> `optional` **mimeType**: `string`\n\nDefined in: [src/utils/interfaces.ts:1607](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1607)\n\n***\n\n### pinnedAt?\n\n> `optional` **pinnedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1606](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1606)\n\n***\n\n### postedAt\n\n> **postedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1605](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1605)\n\n***\n\n### text\n\n> **text**: `string`\n\nDefined in: [src/utils/interfaces.ts:1611](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1611)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/utils/interfaces.ts:1609](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1609)\n\n***\n\n### upVoteCount\n\n> **upVoteCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1613](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1613)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostForm.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostForm\n\nDefined in: [src/utils/interfaces.ts:1011](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1011)\n\nDefines the structure for a post form.\n\n## Properties\n\n### pinned\n\n> **pinned**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1016](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1016)\n\n***\n\n### postinfo\n\n> **postinfo**: `string`\n\nDefined in: [src/utils/interfaces.ts:1013](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1013)\n\n***\n\n### postphoto\n\n> **postphoto**: `string`\n\nDefined in: [src/utils/interfaces.ts:1014](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1014)\n\n***\n\n### posttitle\n\n> **posttitle**: `string`\n\nDefined in: [src/utils/interfaces.ts:1012](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1012)\n\n***\n\n### postvideo\n\n> **postvideo**: `string`\n\nDefined in: [src/utils/interfaces.ts:1015](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1015)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfacePostPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfacePostPg\n\nDefined in: [src/utils/interfaces.ts:818](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L818)\n\nDefines the structure for a post with PostgreSQL-specific fields.\n\n## Properties\n\n### caption\n\n> **caption**: `string`\n\nDefined in: [src/utils/interfaces.ts:820](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L820)\n\n***\n\n### commentsCount\n\n> **commentsCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:821](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L821)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:822](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L822)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:823](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L823)\n\n***\n\n### downVotesCount\n\n> **downVotesCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:824](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L824)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:819](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L819)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:825](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L825)\n\n***\n\n### pinnedAt\n\n> **pinnedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:826](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L826)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:828](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L828)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:829](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L829)\n\n***\n\n### upVotesCount\n\n> **upVotesCount**: `number`\n\nDefined in: [src/utils/interfaces.ts:827](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L827)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryBlockPageMemberListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryBlockPageMemberListItem\n\nDefined in: [src/utils/interfaces.ts:1388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1388)\n\nDefines the structure for a blocked page member list item returned from a query.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1389)\n\n***\n\n### email\n\n> **email**: `string`\n\nDefined in: [src/utils/interfaces.ts:1392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1392)\n\n***\n\n### firstName\n\n> **firstName**: `string`\n\nDefined in: [src/utils/interfaces.ts:1390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1390)\n\n***\n\n### lastName\n\n> **lastName**: `string`\n\nDefined in: [src/utils/interfaces.ts:1391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1391)\n\n***\n\n### organizationsBlockedBy\n\n> **organizationsBlockedBy**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1393](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1393)\n\n#### \\_id\n\n> **\\_id**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryFundCampaignsPledges.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryFundCampaignsPledges\n\nDefined in: [src/utils/interfaces.ts:1239](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1239)\n\nDefines the structure for a query result containing fund campaigns and their pledges.\n\n## Properties\n\n### currencyCode\n\n> **currencyCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1245](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1245)\n\n***\n\n### endAt\n\n> **endAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1247](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1247)\n\n***\n\n### fundId\n\n> **fundId**: `object`\n\nDefined in: [src/utils/interfaces.ts:1240](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1240)\n\n#### name\n\n> **name**: `string`\n\n***\n\n### goalAmount\n\n> **goalAmount**: `number`\n\nDefined in: [src/utils/interfaces.ts:1244](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1244)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1243](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1243)\n\n***\n\n### pledges\n\n> **pledges**: `object`\n\nDefined in: [src/utils/interfaces.ts:1248](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1248)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### startAt\n\n> **startAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1246](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1246)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryMembershipRequestsListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryMembershipRequestsListItem\n\nDefined in: [src/utils/interfaces.ts:1666](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1666)\n\nDefines the structure for a membership requests list item returned from a query.\n\n## Properties\n\n### organizations\n\n> **organizations**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1667](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1667)\n\n#### id\n\n> **id**: `string`\n\n#### membershipRequests\n\n> **membershipRequests**: `object`[]\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationAdvertisementListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationAdvertisementListItem\n\nDefined in: [src/utils/interfaces.ts:1179](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1179)\n\nDefines the structure for an organization advertisement list item returned from a query.\n\n## Properties\n\n### advertisements\n\n> **advertisements**: `object`\n\nDefined in: [src/utils/interfaces.ts:1180](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1180)\n\n#### edges\n\n> **edges**: `object`[]\n\n#### pageInfo\n\n> **pageInfo**: `object`\n\n##### pageInfo.endCursor\n\n> **endCursor**: `string`\n\n##### pageInfo.hasNextPage\n\n> **hasNextPage**: `boolean`\n\n##### pageInfo.hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\n##### pageInfo.startCursor\n\n> **startCursor**: `string`\n\n#### totalCount\n\n> **totalCount**: `number`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationEventListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationEventListItem\n\nDefined in: [src/utils/interfaces.ts:1380](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1380)\n\nExtends InterfaceBaseEvent with additional properties for an organization event list item.\n\n## Extends\n\n- [`InterfaceBaseEvent`](InterfaceBaseEvent.md)\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:383](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L383)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`_id`](InterfaceBaseEvent.md#_id)\n\n***\n\n### allDay\n\n> **allDay**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:391](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L391)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`allDay`](InterfaceBaseEvent.md#allday)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:385](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L385)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`description`](InterfaceBaseEvent.md#description)\n\n***\n\n### endDate\n\n> **endDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:387](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L387)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endDate`](InterfaceBaseEvent.md#enddate)\n\n***\n\n### endTime\n\n> **endTime**: `string`\n\nDefined in: [src/utils/interfaces.ts:390](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L390)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`endTime`](InterfaceBaseEvent.md#endtime)\n\n***\n\n### isPublic\n\n> **isPublic**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1381](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1381)\n\n***\n\n### isRegisterable\n\n> **isRegisterable**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1382](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1382)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/utils/interfaces.ts:388](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L388)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`location`](InterfaceBaseEvent.md#location)\n\n***\n\n### recurring\n\n> **recurring**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:392](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L392)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`recurring`](InterfaceBaseEvent.md#recurring)\n\n***\n\n### startDate\n\n> **startDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L386)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startDate`](InterfaceBaseEvent.md#startdate)\n\n***\n\n### startTime\n\n> **startTime**: `string`\n\nDefined in: [src/utils/interfaces.ts:389](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L389)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`startTime`](InterfaceBaseEvent.md#starttime)\n\n***\n\n### title\n\n> **title**: `string`\n\nDefined in: [src/utils/interfaces.ts:384](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L384)\n\n#### Inherited from\n\n[`InterfaceBaseEvent`](InterfaceBaseEvent.md).[`title`](InterfaceBaseEvent.md#title)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationFundCampaigns.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationFundCampaigns\n\nDefined in: [src/utils/interfaces.ts:1205](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1205)\n\nDefines the structure for a query result containing organization fund campaigns.\n\n## Properties\n\n### campaigns\n\n> **campaigns**: `object`\n\nDefined in: [src/utils/interfaces.ts:1209](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1209)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1206](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1206)\n\n***\n\n### isArchived\n\n> **isArchived**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1208)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1207](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1207)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationListObject.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationListObject\n\nDefined in: [src/utils/interfaces.ts:1001](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1001)\n\nDefines the structure for an organization list object returned from a query.\n\n## Properties\n\n### addressLine1\n\n> **addressLine1**: `string`\n\nDefined in: [src/utils/interfaces.ts:1004](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1004)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:1005](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1005)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1002](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1002)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1003](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1003)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationPostListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationPostListItem\n\nDefined in: [src/utils/interfaces.ts:1022](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1022)\n\nDefines the structure for an organization post list item returned from a query.\n\n## Properties\n\n### posts\n\n> **posts**: `object`\n\nDefined in: [src/utils/interfaces.ts:1023](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1023)\n\n#### edges\n\n> **edges**: `object`[]\n\n#### pageInfo\n\n> **pageInfo**: `object`\n\n##### pageInfo.endCursor\n\n> **endCursor**: `string`\n\n##### pageInfo.hasNextPage\n\n> **hasNextPage**: `boolean`\n\n##### pageInfo.hasPreviousPage\n\n> **hasPreviousPage**: `boolean`\n\n##### pageInfo.startCursor\n\n> **startCursor**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTags.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationUserTags\n\nDefined in: [src/utils/interfaces.ts:1134](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1134)\n\nDefines the structure for a query result containing organization user tags.\n\n## Properties\n\n### userTags\n\n> **userTags**: `InterfaceTagNodeData`\n\nDefined in: [src/utils/interfaces.ts:1135](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1135)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationUserTagsPG\n\nDefined in: [src/utils/interfaces.ts:1138](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1138)\n\n## Properties\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1139](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1139)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1140](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1140)\n\n***\n\n### tags\n\n> **tags**: `InterfaceTagNodeDataPG`\n\nDefined in: [src/utils/interfaces.ts:1141](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1141)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryOrganizationsListObject.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryOrganizationsListObject\n\nDefined in: [src/utils/interfaces.ts:475](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L475)\n\nDefines the structure for an organization object returned from a query.\n\n## Properties\n\n### address\n\n> **address**: [`InterfaceAddress`](InterfaceAddress.md)\n\nDefined in: [src/utils/interfaces.ts:485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L485)\n\n***\n\n### admins\n\n> **admins**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:494](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L494)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### createdAt\n\n> **createdAt**: `string`\n\n#### email\n\n> **email**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n\n***\n\n### blockedUsers\n\n> **blockedUsers**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:509](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L509)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### email\n\n> **email**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n\n***\n\n### creator\n\n> **creator**: `object`\n\nDefined in: [src/utils/interfaces.ts:478](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L478)\n\n#### email\n\n> **email**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:484](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L484)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:476](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L476)\n\n***\n\n### image\n\n> **image**: `string`\n\nDefined in: [src/utils/interfaces.ts:477](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L477)\n\n***\n\n### members\n\n> **members**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:488](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L488)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### email\n\n> **email**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n\n***\n\n### membershipRequests\n\n> **membershipRequests**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:501](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L501)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### user\n\n> **user**: `object`\n\n##### user.email\n\n> **email**: `string`\n\n##### user.firstName\n\n> **firstName**: `string`\n\n##### user.lastName\n\n> **lastName**: `string`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:483](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L483)\n\n***\n\n### userRegistrationRequired\n\n> **userRegistrationRequired**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:486](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L486)\n\n***\n\n### visibleInSearch\n\n> **visibleInSearch**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:487](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L487)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserListItem\n\nDefined in: [src/utils/interfaces.ts:1421](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1421)\n\nDefines the structure for a user list item returned from a query.\n\n## Properties\n\n### appUserProfile?\n\n> `optional` **appUserProfile**: `object`\n\nDefined in: [src/utils/interfaces.ts:1469](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1469)\n\n#### adminFor?\n\n> `optional` **adminFor**: `object`[]\n\n#### isSuperAdmin?\n\n> `optional` **isSuperAdmin**: `boolean`\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:1425](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1425)\n\n***\n\n### birthDate\n\n> **birthDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:1426](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1426)\n\n***\n\n### city\n\n> **city**: `string`\n\nDefined in: [src/utils/interfaces.ts:1427](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1427)\n\n***\n\n### countryCode\n\n> **countryCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1428](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1428)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1429](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1429)\n\n***\n\n### createdOrganizations\n\n> **createdOrganizations**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1444](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1444)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### educationGrade\n\n> **educationGrade**: `string`\n\nDefined in: [src/utils/interfaces.ts:1431](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1431)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/utils/interfaces.ts:1424](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1424)\n\n***\n\n### employmentStatus\n\n> **employmentStatus**: `string`\n\nDefined in: [src/utils/interfaces.ts:1432](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1432)\n\n***\n\n### homePhoneNumber\n\n> **homePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1441](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1441)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1422](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1422)\n\n***\n\n### isEmailAddressVerified\n\n> **isEmailAddressVerified**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1433](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1433)\n\n***\n\n### maritalStatus\n\n> **maritalStatus**: `string`\n\nDefined in: [src/utils/interfaces.ts:1434](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1434)\n\n***\n\n### mobilePhoneNumber\n\n> **mobilePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1440](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1440)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1423](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1423)\n\n***\n\n### natalSex\n\n> **natalSex**: `string`\n\nDefined in: [src/utils/interfaces.ts:1435](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1435)\n\n***\n\n### naturalLanguageCode\n\n> **naturalLanguageCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1436](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1436)\n\n***\n\n### organizationsWhereMember\n\n> **organizationsWhereMember**: `object`\n\nDefined in: [src/utils/interfaces.ts:1450](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1450)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### postalCode\n\n> **postalCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1437](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1437)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/utils/interfaces.ts:1438](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1438)\n\n***\n\n### state\n\n> **state**: `string`\n\nDefined in: [src/utils/interfaces.ts:1439](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1439)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1430](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1430)\n\n***\n\n### workPhoneNumber\n\n> **workPhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1442](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1442)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserListItemForAdmin.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserListItemForAdmin\n\nDefined in: [src/utils/interfaces.ts:1475](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1475)\n\n## Properties\n\n### appUserProfile?\n\n> `optional` **appUserProfile**: `object`\n\nDefined in: [src/utils/interfaces.ts:1542](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1542)\n\n#### adminFor?\n\n> `optional` **adminFor**: `object`[]\n\n#### isSuperAdmin?\n\n> `optional` **isSuperAdmin**: `boolean`\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:1479](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1479)\n\n***\n\n### birthDate\n\n> **birthDate**: `string`\n\nDefined in: [src/utils/interfaces.ts:1480](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1480)\n\n***\n\n### city\n\n> **city**: `string`\n\nDefined in: [src/utils/interfaces.ts:1481](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1481)\n\n***\n\n### countryCode\n\n> **countryCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1482](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1482)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1483](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1483)\n\n***\n\n### createdOrganizations\n\n> **createdOrganizations**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1498](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1498)\n\n#### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### educationGrade\n\n> **educationGrade**: `string`\n\nDefined in: [src/utils/interfaces.ts:1485](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1485)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/utils/interfaces.ts:1478](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1478)\n\n***\n\n### employmentStatus\n\n> **employmentStatus**: `string`\n\nDefined in: [src/utils/interfaces.ts:1486](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1486)\n\n***\n\n### homePhoneNumber\n\n> **homePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1495](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1495)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1476](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1476)\n\n***\n\n### isEmailAddressVerified\n\n> **isEmailAddressVerified**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1487](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1487)\n\n***\n\n### maritalStatus\n\n> **maritalStatus**: `string`\n\nDefined in: [src/utils/interfaces.ts:1488](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1488)\n\n***\n\n### mobilePhoneNumber\n\n> **mobilePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1494](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1494)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1477](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1477)\n\n***\n\n### natalSex\n\n> **natalSex**: `string`\n\nDefined in: [src/utils/interfaces.ts:1489](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1489)\n\n***\n\n### naturalLanguageCode\n\n> **naturalLanguageCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1490](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1490)\n\n***\n\n### organizationsWhereMember\n\n> **organizationsWhereMember**: `object`\n\nDefined in: [src/utils/interfaces.ts:1504](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1504)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### orgsWhereUserIsBlocked?\n\n> `optional` **orgsWhereUserIsBlocked**: `object`\n\nDefined in: [src/utils/interfaces.ts:1524](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1524)\n\n#### edges\n\n> **edges**: `object`[]\n\n***\n\n### postalCode\n\n> **postalCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:1491](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1491)\n\n***\n\n### role\n\n> **role**: `string`\n\nDefined in: [src/utils/interfaces.ts:1492](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1492)\n\n***\n\n### state\n\n> **state**: `string`\n\nDefined in: [src/utils/interfaces.ts:1493](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1493)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1484](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1484)\n\n***\n\n### workPhoneNumber\n\n> **workPhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:1496](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1496)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagChildTags.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserTagChildTags\n\nDefined in: [src/utils/interfaces.ts:1147](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1147)\n\nDefines the structure for a query result containing user tag child tags.\n\n## Properties\n\n### ancestorTags\n\n> **ancestorTags**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1150](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1150)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### childTags\n\n> **childTags**: `InterfaceTagNodeData`\n\nDefined in: [src/utils/interfaces.ts:1149](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1149)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1148](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1148)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserTagsAssignedMembers\n\nDefined in: [src/utils/interfaces.ts:1159](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1159)\n\nDefines the structure for a query result containing user tags and their assigned members.\n\n## Properties\n\n### ancestorTags\n\n> **ancestorTags**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1162](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1162)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1160](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1160)\n\n***\n\n### usersAssignedTo\n\n> **usersAssignedTo**: `InterfaceTagMembersData`\n\nDefined in: [src/utils/interfaces.ts:1161](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1161)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryUserTagsMembersToAssignTo\n\nDefined in: [src/utils/interfaces.ts:1171](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1171)\n\nDefines the structure for a query result containing user tags and members available to assign.\n\n## Properties\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1172](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1172)\n\n***\n\n### usersToAssignTo\n\n> **usersToAssignTo**: `InterfaceTagMembersData`\n\nDefined in: [src/utils/interfaces.ts:1173](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1173)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceQueryVenueListItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceQueryVenueListItem\n\nDefined in: [src/utils/interfaces.ts:1551](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1551)\n\nDefines the structure for a venue list item returned from a query.\n\n## Properties\n\n### node\n\n> **node**: `object`\n\nDefined in: [src/utils/interfaces.ts:1552](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1552)\n\n#### attachments?\n\n> `optional` **attachments**: `object`[]\n\n#### capacity?\n\n> `optional` **capacity**: `number`\n\n#### description\n\n> **description**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### image?\n\n> `optional` **image**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagData.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagData\n\nDefined in: [src/utils/interfaces.ts:1048](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1048)\n\nDefines the structure for tag data.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1049](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1049)\n\n***\n\n### ancestorTags\n\n> **ancestorTags**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1058](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1058)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### childTags\n\n> **childTags**: `object`\n\nDefined in: [src/utils/interfaces.ts:1055](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1055)\n\n#### totalCount\n\n> **totalCount**: `number`\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1050](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1050)\n\n***\n\n### parentTag\n\n> **parentTag**: `object`\n\nDefined in: [src/utils/interfaces.ts:1051](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1051)\n\n#### \\_id\n\n> **\\_id**: `string`\n\n***\n\n### usersAssignedTo\n\n> **usersAssignedTo**: `object`\n\nDefined in: [src/utils/interfaces.ts:1052](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1052)\n\n#### totalCount\n\n> **totalCount**: `number`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagDataPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagDataPG\n\nDefined in: [src/utils/interfaces.ts:1064](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1064)\n\n## Properties\n\n### ancestorTags\n\n> **ancestorTags**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1074](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1074)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### childTags\n\n> **childTags**: `object`\n\nDefined in: [src/utils/interfaces.ts:1071](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1071)\n\n#### totalCount\n\n> **totalCount**: `number`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1065](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1065)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1066](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1066)\n\n***\n\n### parentTag\n\n> **parentTag**: `object`\n\nDefined in: [src/utils/interfaces.ts:1067](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1067)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### usersAssignedTo\n\n> **usersAssignedTo**: `object`\n\nDefined in: [src/utils/interfaces.ts:1068](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1068)\n\n#### totalCount\n\n> **totalCount**: `number`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagFolderPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagFolderPg\n\nDefined in: [src/utils/interfaces.ts:867](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L867)\n\nDefines the structure for a tag folder with PostgreSQL-specific fields.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:870](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L870)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:872](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L872)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:868](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L868)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:869](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L869)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:874](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L874)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:871](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L871)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:873](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L873)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceTagPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagPg\n\nDefined in: [src/utils/interfaces.ts:896](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L896)\n\nDefines the structure for a tag with PostgreSQL-specific fields.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:899](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L899)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:901](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L901)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:897](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L897)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:898](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L898)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:903](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L903)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:900](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L900)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:902](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L902)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserCampaign.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserCampaign\n\nDefined in: [src/utils/interfaces.ts:1227](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1227)\n\nDefines the structure for a user campaign.\n\n## Properties\n\n### \\_id\n\n> **\\_id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1228](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1228)\n\n***\n\n### currency\n\n> **currency**: `string`\n\nDefined in: [src/utils/interfaces.ts:1233](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1233)\n\n***\n\n### endDate\n\n> **endDate**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1232](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1232)\n\n***\n\n### fundingGoal\n\n> **fundingGoal**: `number`\n\nDefined in: [src/utils/interfaces.ts:1230](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1230)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1229](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1229)\n\n***\n\n### startDate\n\n> **startDate**: `Date`\n\nDefined in: [src/utils/interfaces.ts:1231](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1231)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserEvents.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserEvents\n\nDefined in: [src/utils/interfaces.ts:1828](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1828)\n\nDefines the structure for user-related events with volunteer information.\n\n## Properties\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:1831](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1831)\n\n***\n\n### endAt\n\n> **endAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1833](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1833)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1829](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1829)\n\n***\n\n### location\n\n> **location**: `string`\n\nDefined in: [src/utils/interfaces.ts:1834](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1834)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1830](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1830)\n\n***\n\n### startAt\n\n> **startAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1832](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1832)\n\n***\n\n### volunteerGroups\n\n> **volunteerGroups**: [`InterfaceVolunteerGroupInfo`](InterfaceVolunteerGroupInfo.md)[]\n\nDefined in: [src/utils/interfaces.ts:1835](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1835)\n\n***\n\n### volunteers\n\n> **volunteers**: [`InterfaceEventVolunteerInfo`](InterfaceEventVolunteerInfo.md)[]\n\nDefined in: [src/utils/interfaces.ts:1836](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1836)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserInfo\n\nDefined in: [src/utils/interfaces.ts:369](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L369)\n\nDefines the basic information for a user.\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:373](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L373)\n\n***\n\n### createdAt?\n\n> `optional` **createdAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:375](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L375)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/utils/interfaces.ts:372](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L372)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:370](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L370)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L371)\n\n***\n\n### role?\n\n> `optional` **role**: `string`\n\nDefined in: [src/utils/interfaces.ts:374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L374)\n\n***\n\n### updatedAt?\n\n> `optional` **updatedAt**: `Date`\n\nDefined in: [src/utils/interfaces.ts:376](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L376)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserInfoPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserInfoPG\n\nDefined in: [src/utils/interfaces.ts:1369](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1369)\n\nDefines the structure for user information with PostgreSQL-specific fields.\n\n## Properties\n\n### avatarURL?\n\n> `optional` **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:1374](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1374)\n\n***\n\n### firstName?\n\n> `optional` **firstName**: `string`\n\nDefined in: [src/utils/interfaces.ts:1370](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1370)\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1373](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1373)\n\n***\n\n### lastName?\n\n> `optional` **lastName**: `string`\n\nDefined in: [src/utils/interfaces.ts:1371](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1371)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1372](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1372)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserListQueryResponse.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserListQueryResponse\n\nDefined in: [src/utils/interfaces.ts:1401](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1401)\n\nGraphQL response type for user list queries.\n\n## Properties\n\n### allUsers?\n\n> `optional` **allUsers**: `object`\n\nDefined in: [src/utils/interfaces.ts:1402](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1402)\n\n#### edges?\n\n> `optional` **edges**: `object`[]\n\n#### pageInfo?\n\n> `optional` **pageInfo**: [`InterfacePageInfoPg`](InterfacePageInfoPg.md)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserPg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserPg\n\nDefined in: [src/utils/interfaces.ts:530](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L530)\n\nDefines the structure for a user with PostgreSQL-specific fields.\n\n## Properties\n\n### addressLine1\n\n> **addressLine1**: `string`\n\nDefined in: [src/utils/interfaces.ts:531](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L531)\n\n***\n\n### addressLine2\n\n> **addressLine2**: `string`\n\nDefined in: [src/utils/interfaces.ts:532](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L532)\n\n***\n\n### avatarMimeType\n\n> **avatarMimeType**: `string`\n\nDefined in: [src/utils/interfaces.ts:533](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L533)\n\n***\n\n### avatarURL\n\n> **avatarURL**: `string`\n\nDefined in: [src/utils/interfaces.ts:534](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L534)\n\n***\n\n### birthDate\n\n> **birthDate**: `Date`\n\nDefined in: [src/utils/interfaces.ts:535](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L535)\n\n***\n\n### city\n\n> **city**: `string`\n\nDefined in: [src/utils/interfaces.ts:536](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L536)\n\n***\n\n### countryCode\n\n> **countryCode**: [`Iso3166Alpha2CountryCode`](../enumerations/Iso3166Alpha2CountryCode.md)\n\nDefined in: [src/utils/interfaces.ts:537](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L537)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:538](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L538)\n\n***\n\n### creator\n\n> **creator**: `InterfaceUserPg`\n\nDefined in: [src/utils/interfaces.ts:539](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L539)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:540](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L540)\n\n***\n\n### educationGrade\n\n> **educationGrade**: [`UserEducationGrade`](../enumerations/UserEducationGrade.md)\n\nDefined in: [src/utils/interfaces.ts:541](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L541)\n\n***\n\n### emailAddress\n\n> **emailAddress**: `string`\n\nDefined in: [src/utils/interfaces.ts:542](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L542)\n\n***\n\n### employmentStatus\n\n> **employmentStatus**: [`UserEmploymentStatus`](../enumerations/UserEmploymentStatus.md)\n\nDefined in: [src/utils/interfaces.ts:543](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L543)\n\n***\n\n### homePhoneNumber\n\n> **homePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:544](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L544)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:545](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L545)\n\n***\n\n### isEmailAddressVerified\n\n> **isEmailAddressVerified**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:546](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L546)\n\n***\n\n### maritalStatus\n\n> **maritalStatus**: [`UserMaritalStatus`](../enumerations/UserMaritalStatus.md)\n\nDefined in: [src/utils/interfaces.ts:547](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L547)\n\n***\n\n### mobilePhoneNumber\n\n> **mobilePhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:548](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L548)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:549](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L549)\n\n***\n\n### natalSex\n\n> **natalSex**: [`UserNatalSex`](../enumerations/UserNatalSex.md)\n\nDefined in: [src/utils/interfaces.ts:550](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L550)\n\n***\n\n### naturalLanguageCode\n\n> **naturalLanguageCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:557](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L557)\n\n***\n\n### postalCode\n\n> **postalCode**: `string`\n\nDefined in: [src/utils/interfaces.ts:551](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L551)\n\n***\n\n### role\n\n> **role**: [`UserRole`](../enumerations/UserRole.md)\n\nDefined in: [src/utils/interfaces.ts:552](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L552)\n\n***\n\n### state\n\n> **state**: `string`\n\nDefined in: [src/utils/interfaces.ts:553](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L553)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:554](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L554)\n\n***\n\n### updater\n\n> **updater**: `InterfaceUserPg`\n\nDefined in: [src/utils/interfaces.ts:555](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L555)\n\n***\n\n### workPhoneNumber\n\n> **workPhoneNumber**: `string`\n\nDefined in: [src/utils/interfaces.ts:556](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L556)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserType.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserType\n\nDefined in: [src/utils/interfaces.ts:333](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L333)\n\nDefines the structure for a basic user type.\n\n## Properties\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/utils/interfaces.ts:334](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L334)\n\n#### email\n\n> **email**: `string`\n\n#### firstName\n\n> **firstName**: `string`\n\n#### image\n\n> **image**: `string`\n\n#### lastName\n\n> **lastName**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceUserTypePG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceUserTypePG\n\nDefined in: [src/utils/interfaces.ts:345](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L345)\n\nDefines the structure for a user type with PostgreSQL-specific fields.\n\n## Properties\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/utils/interfaces.ts:346](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L346)\n\n#### emailAddress\n\n> **emailAddress**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### role\n\n> **role**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVenuePg.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVenuePg\n\nDefined in: [src/utils/interfaces.ts:925](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L925)\n\nDefines the structure for a venue with PostgreSQL-specific fields.\n\n## Properties\n\n### attachments?\n\n> `optional` **attachments**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:930](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L930)\n\n#### mimeType\n\n> **mimeType**: `string`\n\n#### url\n\n> **url**: `string`\n\n***\n\n### capacity?\n\n> `optional` **capacity**: `number`\n\nDefined in: [src/utils/interfaces.ts:929](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L929)\n\n***\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:934](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L934)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:936](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L936)\n\n***\n\n### description?\n\n> `optional` **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:928](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L928)\n\n***\n\n### id\n\n> **id**: `ID`\n\nDefined in: [src/utils/interfaces.ts:926](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L926)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:927](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L927)\n\n***\n\n### organization\n\n> **organization**: [`InterfaceOrganizationPg`](InterfaceOrganizationPg.md)\n\nDefined in: [src/utils/interfaces.ts:938](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L938)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:935](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L935)\n\n***\n\n### updater\n\n> **updater**: [`InterfaceUserPg`](InterfaceUserPg.md)\n\nDefined in: [src/utils/interfaces.ts:937](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L937)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerGroupInfo.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerGroupInfo\n\nDefined in: [src/utils/interfaces.ts:1737](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1737)\n\nDefines the structure for volunteer group information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1747](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1747)\n\n***\n\n### creator\n\n> **creator**: [`InterfaceUserInfo`](InterfaceUserInfo.md)\n\nDefined in: [src/utils/interfaces.ts:1748](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1748)\n\n***\n\n### description\n\n> **description**: `string`\n\nDefined in: [src/utils/interfaces.ts:1740](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1740)\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/utils/interfaces.ts:1741](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1741)\n\n#### id\n\n> **id**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1738](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1738)\n\n***\n\n### isInstanceException\n\n> **isInstanceException**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1746](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1746)\n\n***\n\n### isTemplate\n\n> **isTemplate**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1745](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1745)\n\n***\n\n### leader\n\n> **leader**: [`InterfaceUserInfo`](InterfaceUserInfo.md)\n\nDefined in: [src/utils/interfaces.ts:1749](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1749)\n\n***\n\n### name\n\n> **name**: `string`\n\nDefined in: [src/utils/interfaces.ts:1739](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1739)\n\n***\n\n### volunteers\n\n> **volunteers**: `object`[]\n\nDefined in: [src/utils/interfaces.ts:1750](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1750)\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\n#### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\n#### id\n\n> **id**: `string`\n\n#### isPublic\n\n> **isPublic**: `boolean`\n\n#### user\n\n> **user**: [`InterfaceUserInfoPG`](InterfaceUserInfoPG.md)\n\n***\n\n### volunteersRequired\n\n> **volunteersRequired**: `number`\n\nDefined in: [src/utils/interfaces.ts:1744](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1744)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerMembership.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerMembership\n\nDefined in: [src/utils/interfaces.ts:1773](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1773)\n\nDefines the structure for volunteer membership information.\n\n## Properties\n\n### createdAt\n\n> **createdAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1776](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1776)\n\n***\n\n### createdBy\n\n> **createdBy**: `object`\n\nDefined in: [src/utils/interfaces.ts:1802](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1802)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### event\n\n> **event**: `object`\n\nDefined in: [src/utils/interfaces.ts:1778](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1778)\n\n#### endAt\n\n> **endAt**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n#### recurrenceRule?\n\n> `optional` **recurrenceRule**: `object`\n\n##### recurrenceRule.id\n\n> **id**: `string`\n\n#### startAt\n\n> **startAt**: `string`\n\n***\n\n### group?\n\n> `optional` **group**: `object`\n\nDefined in: [src/utils/interfaces.ts:1798](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1798)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### id\n\n> **id**: `string`\n\nDefined in: [src/utils/interfaces.ts:1774](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1774)\n\n***\n\n### status\n\n> **status**: `string`\n\nDefined in: [src/utils/interfaces.ts:1775](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1775)\n\n***\n\n### updatedAt\n\n> **updatedAt**: `string`\n\nDefined in: [src/utils/interfaces.ts:1777](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1777)\n\n***\n\n### updatedBy\n\n> **updatedBy**: `object`\n\nDefined in: [src/utils/interfaces.ts:1806](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1806)\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n\n***\n\n### volunteer\n\n> **volunteer**: `object`\n\nDefined in: [src/utils/interfaces.ts:1787](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1787)\n\n#### hasAccepted\n\n> **hasAccepted**: `boolean`\n\n#### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\n#### id\n\n> **id**: `string`\n\n#### user\n\n> **user**: `object`\n\n##### user.avatarURL?\n\n> `optional` **avatarURL**: `string`\n\n##### user.emailAddress\n\n> **emailAddress**: `string`\n\n##### user.id\n\n> **id**: `string`\n\n##### user.name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/interfaces/InterfaceVolunteerRank.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceVolunteerRank\n\nDefined in: [src/utils/interfaces.ts:1815](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1815)\n\nDefines the structure for volunteer ranking information.\n\n## Properties\n\n### hoursVolunteered\n\n> **hoursVolunteered**: `number`\n\nDefined in: [src/utils/interfaces.ts:1817](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1817)\n\n***\n\n### rank\n\n> **rank**: `number`\n\nDefined in: [src/utils/interfaces.ts:1816](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1816)\n\n***\n\n### user\n\n> **user**: `object`\n\nDefined in: [src/utils/interfaces.ts:1818](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1818)\n\n#### avatarURL\n\n> **avatarURL**: `string`\n\n#### id\n\n> **id**: `string`\n\n#### name\n\n> **name**: `string`\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/type-aliases/VoteState.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: VoteState\n\n> **VoteState** = `object`\n\nDefined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591)\n\n## Properties\n\n### hasVoted\n\n> **hasVoted**: `boolean`\n\nDefined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591)\n\n***\n\n### voteType\n\n> **voteType**: [`VoteType`](VoteType.md)\n\nDefined in: [src/utils/interfaces.ts:1591](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1591)\n" }, { "path": "docs/docs/auto-docs/utils/interfaces/type-aliases/VoteType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: VoteType\n\n> **VoteType** = `\"up_vote\"` \\| `\"down_vote\"` \\| `null`\n\nDefined in: [src/utils/interfaces.ts:1590](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/interfaces.ts#L1590)\n" }, { "path": "docs/docs/auto-docs/utils/languages/variables/languageArray.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: languageArray\n\n> `const` **languageArray**: `string`[]\n\nDefined in: [src/utils/languages.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/languages.ts#L1)\n" }, { "path": "docs/docs/auto-docs/utils/languages/variables/languages.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: languages\n\n> `const` **languages**: `object`[]\n\nDefined in: [src/utils/languages.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/languages.ts#L3)\n\n## Type Declaration\n\n### code\n\n> **code**: `string` = `'en'`\n\n### country\\_code\n\n> **country\\_code**: `string` = `'gb'`\n\n### name\n\n> **name**: `string` = `'English'`\n" }, { "path": "docs/docs/auto-docs/utils/linkValidator/functions/isValidLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: isValidLink()\n\n> **isValidLink**(`link`): `boolean`\n\nDefined in: [src/utils/linkValidator.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/linkValidator.ts#L1)\n\n## Parameters\n\n### link\n\n`string`\n\n## Returns\n\n`boolean`\n" }, { "path": "docs/docs/auto-docs/utils/oauth/oauthFlowHandler/functions/handleOAuthLink.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: handleOAuthLink()\n\n> **handleOAuthLink**(`client`, `provider`, `authorizationCode`, `redirectUri`): `Promise`\\<[`InterfaceOAuthLinkResponse`](../../../../types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md)\\>\n\nDefined in: [src/utils/oauth/oauthFlowHandler.ts:102](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/oauth/oauthFlowHandler.ts#L102)\n\nLinks an existing user account with an OAuth provider.\n\nThis function associates a user's existing account with an OAuth provider\nby exchanging the authorization code. This allows users to sign in with\nmultiple OAuth providers or add additional sign-in methods to their account.\n\n## Parameters\n\n### client\n\n`ApolloClient`\\<`unknown`\\>\n\nApollo GraphQL client instance for making API requests\n\n### provider\n\n[`OAuthProviderKey`](../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md)\n\nOAuth provider to link (e.g., 'GOOGLE', 'GITHUB')\n\n### authorizationCode\n\n`string`\n\nAuthorization code received from OAuth provider callback\n\n### redirectUri\n\n`string`\n\nRedirect URI used in the OAuth flow for validation\n\n## Returns\n\n`Promise`\\<[`InterfaceOAuthLinkResponse`](../../../../types/Auth/auth/interfaces/InterfaceOAuthLinkResponse.md)\\>\n\nPromise that resolves to the linking operation result containing user data with linked OAuth accounts\n\n## Throws\n\nError When GraphQL errors are returned from the server\n\n## Throws\n\nError When no response data is received despite successful request\n\n## Throws\n\nApolloError When network or Apollo Client errors occur\n\n## Example\n\n```typescript\nconst linkResult = await handleOAuthLink(\n apolloClient,\n 'GITHUB',\n 'auth-code-456',\n 'http://localhost:3000/callback'\n);\nconsole.log('User ID:', linkResult.id);\nconsole.log('Linked accounts:', linkResult.oauthAccounts);\n```\n" }, { "path": "docs/docs/auto-docs/utils/oauth/oauthFlowHandler/functions/handleOAuthLogin.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: handleOAuthLogin()\n\n> **handleOAuthLogin**(`client`, `provider`, `authorizationCode`, `redirectUri`): `Promise`\\<[`InterfaceAuthenticationPayload`](../../../../types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md)\\>\n\nDefined in: [src/utils/oauth/oauthFlowHandler.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/oauth/oauthFlowHandler.ts#L43)\n\nHandles OAuth login flow by exchanging an authorization code for authentication tokens.\n\nThis function performs the OAuth sign-in process by sending the authorization code\nand other required parameters to the GraphQL mutation. It validates the response\nand returns the authentication payload containing user data and tokens.\n\n## Parameters\n\n### client\n\n`ApolloClient`\\<`unknown`\\>\n\nApollo GraphQL client instance for making API requests\n\n### provider\n\n[`OAuthProviderKey`](../../../../types/Auth/auth/type-aliases/OAuthProviderKey.md)\n\nOAuth provider (e.g., 'GOOGLE', 'GITHUB')\n\n### authorizationCode\n\n`string`\n\nAuthorization code received from OAuth provider callback\n\n### redirectUri\n\n`string`\n\nRedirect URI used in the OAuth flow for validation\n\n## Returns\n\n`Promise`\\<[`InterfaceAuthenticationPayload`](../../../../types/Auth/auth/interfaces/InterfaceAuthenticationPayload.md)\\>\n\nPromise that resolves to authentication payload with user data and tokens\n\n## Throws\n\nError When GraphQL errors are returned from the server\n\n## Throws\n\nError When no authentication data is received despite successful request\n\n## Throws\n\nApolloError When network or Apollo Client errors occur\n\n## Example\n\n```typescript\nconst authPayload = await handleOAuthLogin(\n apolloClient,\n 'GOOGLE',\n 'auth-code-123',\n 'http://localhost:3000/callback'\n);\nconsole.log(authPayload.user.name); // User's name\nconsole.log(authPayload.authenticationToken); // JWT access token\n```\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationSubTagsQuery.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationSubTagsQuery\n\nDefined in: [src/utils/organizationTagsUtils.ts:100](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L100)\n\n## Extends\n\n- `InterfaceBaseQueryResult`\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:101](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L101)\n\n#### getChildTags\n\n> **getChildTags**: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md)\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.error`\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L104)\n\n#### Parameters\n\n##### options\n\n`InterfaceBaseFetchMoreOptions`\\<\\{ `getChildTags`: [`InterfaceQueryUserTagChildTags`](../../interfaces/interfaces/InterfaceQueryUserTagChildTags.md); \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.loading`\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.refetch`\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQuery.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagsQuery\n\nDefined in: [src/utils/organizationTagsUtils.ts:78](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L78)\n\n## Extends\n\n- `InterfaceBaseQueryResult`\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:79](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L79)\n\n#### organizations\n\n> **organizations**: [`InterfaceQueryOrganizationUserTags`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTags.md)[]\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.error`\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L82)\n\n#### Parameters\n\n##### options\n\n`InterfaceBaseFetchMoreOptions`\\<\\{ `organizations`: [`InterfaceQueryOrganizationUserTags`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTags.md)[]; \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.loading`\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.refetch`\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceOrganizationTagsQueryPG.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceOrganizationTagsQueryPG\n\nDefined in: [src/utils/organizationTagsUtils.ts:89](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L89)\n\n## Extends\n\n- `InterfaceBaseQueryResult`\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:90](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L90)\n\n#### organization\n\n> **organization**: [`InterfaceQueryOrganizationUserTagsPG`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md)\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.error`\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:93](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L93)\n\n#### Parameters\n\n##### options\n\n`InterfaceBaseFetchMoreOptions`\\<\\{ `organization`: [`InterfaceQueryOrganizationUserTagsPG`](../../interfaces/interfaces/InterfaceQueryOrganizationUserTagsPG.md); \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.loading`\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.refetch`\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagAssignedMembersQuery.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagAssignedMembersQuery\n\nDefined in: [src/utils/organizationTagsUtils.ts:111](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L111)\n\n## Extends\n\n- `InterfaceBaseQueryResult`\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:112](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L112)\n\n#### getAssignedUsers\n\n> **getAssignedUsers**: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md)\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.error`\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:115](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L115)\n\n#### Parameters\n\n##### options\n\n`InterfaceBaseFetchMoreOptions`\\<\\{ `getAssignedUsers`: [`InterfaceQueryUserTagsAssignedMembers`](../../interfaces/interfaces/InterfaceQueryUserTagsAssignedMembers.md); \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.loading`\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.refetch`\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/interfaces/InterfaceTagUsersToAssignToQuery.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceTagUsersToAssignToQuery\n\nDefined in: [src/utils/organizationTagsUtils.ts:122](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L122)\n\n## Extends\n\n- `InterfaceBaseQueryResult`\n\n## Properties\n\n### data?\n\n> `optional` **data**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:123](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L123)\n\n#### getUsersToAssignTo\n\n> **getUsersToAssignTo**: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md)\n\n***\n\n### error?\n\n> `optional` **error**: `ApolloError`\n\nDefined in: [src/utils/organizationTagsUtils.ts:61](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L61)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.error`\n\n***\n\n### fetchMore()\n\n> **fetchMore**: (`options`) => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:126](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L126)\n\n#### Parameters\n\n##### options\n\n`InterfaceBaseFetchMoreOptions`\\<\\{ `getUsersToAssignTo`: [`InterfaceQueryUserTagsMembersToAssignTo`](../../interfaces/interfaces/InterfaceQueryUserTagsMembersToAssignTo.md); \\}\\>\n\n#### Returns\n\n`void`\n\n***\n\n### loading\n\n> **loading**: `boolean`\n\nDefined in: [src/utils/organizationTagsUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L60)\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.loading`\n\n***\n\n### refetch()?\n\n> `optional` **refetch**: () => `void`\n\nDefined in: [src/utils/organizationTagsUtils.ts:62](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L62)\n\n#### Returns\n\n`void`\n\n#### Inherited from\n\n`InterfaceBaseQueryResult.refetch`\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/SortedByType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SortedByType\n\n> **SortedByType** = `\"ASCENDING\"` \\| `\"DESCENDING\"`\n\nDefined in: [src/utils/organizationTagsUtils.ts:55](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L55)\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/type-aliases/TagActionType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: TagActionType\n\n> **TagActionType** = `\"assignToTags\"` \\| `\"removeFromTags\"`\n\nDefined in: [src/utils/organizationTagsUtils.ts:52](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L52)\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/variables/TAGS_QUERY_DATA_CHUNK_SIZE.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: TAGS\\_QUERY\\_DATA\\_CHUNK\\_SIZE\n\n> `const` **TAGS\\_QUERY\\_DATA\\_CHUNK\\_SIZE**: `10` = `10`\n\nDefined in: [src/utils/organizationTagsUtils.ts:49](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L49)\n" }, { "path": "docs/docs/auto-docs/utils/organizationTagsUtils/variables/dataGridStyle.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dataGridStyle\n\n> `const` **dataGridStyle**: `object`\n\nDefined in: [src/utils/organizationTagsUtils.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/organizationTagsUtils.ts#L13)\n\n## Type Declaration\n\n#### & .MuiDataGrid-cell:focus\n\n> **& .MuiDataGrid-cell:focus**: `object`\n\n#### & .MuiDataGrid-cell:focus.outline\n\n> **outline**: `string` = `'2px solid #000'`\n\n#### & .MuiDataGrid-cell:focus.outlineOffset\n\n> **outlineOffset**: `string` = `'-2px'`\n\n#### & .MuiDataGrid-main\n\n> **& .MuiDataGrid-main**: `object`\n\n#### & .MuiDataGrid-main.borderRadius\n\n> **borderRadius**: `string` = `'0.1rem'`\n\n#### & .MuiDataGrid-root\n\n> **& .MuiDataGrid-root**: `object`\n\n#### & .MuiDataGrid-root.borderRadius\n\n> **borderRadius**: `string` = `'0.1rem'`\n\n#### & .MuiDataGrid-row:hover\n\n> **& .MuiDataGrid-row:hover**: `object`\n\n#### & .MuiDataGrid-row:hover.backgroundColor\n\n> **backgroundColor**: `string` = `'transparent'`\n\n#### & .MuiDataGrid-row:hover.boxShadow\n\n> **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'`\n\n#### & .MuiDataGrid-row.Mui-hovered\n\n> **& .MuiDataGrid-row.Mui-hovered**: `object`\n\n#### & .MuiDataGrid-row.Mui-hovered.backgroundColor\n\n> **backgroundColor**: `string` = `'transparent'`\n\n#### & .MuiDataGrid-row.Mui-hovered.boxShadow\n\n> **boxShadow**: `string` = `'0 0 0 1px rgba(0, 0, 0, 0.1)'`\n\n#### & .MuiDataGrid-topContainer\n\n> **& .MuiDataGrid-topContainer**: `object`\n\n#### & .MuiDataGrid-topContainer.position\n\n> **position**: `string` = `'fixed'`\n\n#### & .MuiDataGrid-topContainer.top\n\n> **top**: `number` = `290`\n\n#### & .MuiDataGrid-topContainer.zIndex\n\n> **zIndex**: `number` = `1`\n\n#### & .MuiDataGrid-virtualScrollerContent\n\n> **& .MuiDataGrid-virtualScrollerContent**: `object`\n\n#### & .MuiDataGrid-virtualScrollerContent.marginTop\n\n> **marginTop**: `number` = `6.5`\n\n#### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within\n\n> **&.MuiDataGrid-root .MuiDataGrid-cell:focus-within**: `object`\n\n#### &.MuiDataGrid-root .MuiDataGrid-cell:focus-within.outline\n\n> **outline**: `string` = `'none !important'`\n\n#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within\n\n> **&.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within**: `object`\n\n#### &.MuiDataGrid-root .MuiDataGrid-columnHeader:focus-within.outline\n\n> **outline**: `string` = `'none'`\n" }, { "path": "docs/docs/auto-docs/utils/passwordValidator/functions/validatePassword.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validatePassword()\n\n> **validatePassword**(`password`): `string`\n\nDefined in: [src/utils/passwordValidator.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/passwordValidator.ts#L1)\n\n## Parameters\n\n### password\n\n`string`\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/utils/profileNavigation/functions/resolveProfileNavigation.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: resolveProfileNavigation()\n\n> **resolveProfileNavigation**(`__namedParameters`): `string`\n\nDefined in: [src/utils/profileNavigation.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L10)\n\nResolves the appropriate profile route based on portal context, role, and org id.\n\n## Parameters\n\n### \\_\\_namedParameters\n\n[`InterfaceProfileNavigationOptions`](../interfaces/InterfaceProfileNavigationOptions.md)\n\n## Returns\n\n`string`\n" }, { "path": "docs/docs/auto-docs/utils/profileNavigation/interfaces/InterfaceProfileNavigationOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceProfileNavigationOptions\n\nDefined in: [src/utils/profileNavigation.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L3)\n\n## Properties\n\n### portal?\n\n> `optional` **portal**: [`ProfilePortal`](../type-aliases/ProfilePortal.md)\n\nDefined in: [src/utils/profileNavigation.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L4)\n\n***\n\n### role?\n\n> `optional` **role**: `string`\n\nDefined in: [src/utils/profileNavigation.ts:5](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L5)\n" }, { "path": "docs/docs/auto-docs/utils/profileNavigation/type-aliases/ProfilePortal.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: ProfilePortal\n\n> **ProfilePortal** = `\"admin\"` \\| `\"user\"`\n\nDefined in: [src/utils/profileNavigation.ts:1](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/profileNavigation.ts#L1)\n" }, { "path": "docs/docs/auto-docs/utils/recaptcha/functions/getRecaptchaToken.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getRecaptchaToken()\n\n> **getRecaptchaToken**(`siteKey`, `action`): `Promise`\\<`string`\\>\n\nDefined in: [src/utils/recaptcha.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recaptcha.ts#L94)\n\nGet a reCAPTCHA token for the specified action\n\n## Parameters\n\n### siteKey\n\n`string`\n\nThe reCAPTCHA site key\n\n### action\n\n`string`\n\nThe action name for this reCAPTCHA request\n\n## Returns\n\n`Promise`\\<`string`\\>\n\nPromise that resolves to the reCAPTCHA token\n" }, { "path": "docs/docs/auto-docs/utils/recaptcha/functions/loadRecaptchaScript.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: loadRecaptchaScript()\n\n> **loadRecaptchaScript**(`siteKey`): `Promise`\\<`void`\\>\n\nDefined in: [src/utils/recaptcha.ts:21](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recaptcha.ts#L21)\n\nLoad the reCAPTCHA script if not already loaded\n\n## Parameters\n\n### siteKey\n\n`string`\n\nThe reCAPTCHA site key\n\n## Returns\n\n`Promise`\\<`void`\\>\n\nPromise that resolves when script is loaded\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/Days.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: Days\n\n> `const` **Days**: [`WeekDays`](../../recurrenceTypes/enumerations/WeekDays.md)[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L19)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/dayNames.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dayNames\n\n> `const` **dayNames**: `object`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L42)\n\n## Type Declaration\n\n### FR\n\n> **FR**: `string` = `'Friday'`\n\n### MO\n\n> **MO**: `string` = `'Monday'`\n\n### SA\n\n> **SA**: `string` = `'Saturday'`\n\n### SU\n\n> **SU**: `string` = `'Sunday'`\n\n### TH\n\n> **TH**: `string` = `'Thursday'`\n\n### TU\n\n> **TU**: `string` = `'Tuesday'`\n\n### WE\n\n> **WE**: `string` = `'Wednesday'`\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/daysOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: daysOptions\n\n> `const` **daysOptions**: `string`[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L16)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsAfter.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: endsAfter\n\n> `const` **endsAfter**: [`after`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#after) = `RecurrenceEndOption.after`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:39](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L39)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsNever.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: endsNever\n\n> `const` **endsNever**: [`never`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#never) = `RecurrenceEndOption.never`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L37)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/endsOn.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: endsOn\n\n> `const` **endsOn**: [`on`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md#on) = `RecurrenceEndOption.on`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:38](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L38)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/frequencies.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: frequencies\n\n> `const` **frequencies**: `object`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L8)\n\n## Type Declaration\n\n### DAILY\n\n> **DAILY**: `string` = `'Daily'`\n\n### MONTHLY\n\n> **MONTHLY**: `string` = `'Monthly'`\n\n### WEEKLY\n\n> **WEEKLY**: `string` = `'Weekly'`\n\n### YEARLY\n\n> **YEARLY**: `string` = `'Yearly'`\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/monthNames.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: monthNames\n\n> `const` **monthNames**: `string`[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:53](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L53)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceConstants/variables/recurrenceEndOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: recurrenceEndOptions\n\n> `const` **recurrenceEndOptions**: [`RecurrenceEndOption`](../../recurrenceTypes/enumerations/RecurrenceEndOption.md)[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceConstants.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceConstants.ts#L30)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/Frequency.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: Frequency\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:22](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L22)\n\n## Enumeration Members\n\n### DAILY\n\n> **DAILY**: `\"DAILY\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L23)\n\n***\n\n### MONTHLY\n\n> **MONTHLY**: `\"MONTHLY\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:25](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L25)\n\n***\n\n### WEEKLY\n\n> **WEEKLY**: `\"WEEKLY\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:24](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L24)\n\n***\n\n### YEARLY\n\n> **YEARLY**: `\"YEARLY\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L26)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/RecurrenceEndOption.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: RecurrenceEndOption\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:41](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L41)\n\n## Enumeration Members\n\n### after\n\n> **after**: `\"after\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:44](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L44)\n\n***\n\n### never\n\n> **never**: `\"never\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:42](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L42)\n\n***\n\n### on\n\n> **on**: `\"on\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:43](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L43)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/enumerations/WeekDays.md", "content": "[Admin Docs](/)\n\n***\n\n# Enumeration: WeekDays\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L30)\n\n## Enumeration Members\n\n### FR\n\n> **FR**: `\"FR\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:36](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L36)\n\n***\n\n### MO\n\n> **MO**: `\"MO\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L32)\n\n***\n\n### SA\n\n> **SA**: `\"SA\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:37](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L37)\n\n***\n\n### SU\n\n> **SU**: `\"SU\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L31)\n\n***\n\n### TH\n\n> **TH**: `\"TH\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:35](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L35)\n\n***\n\n### TU\n\n> **TU**: `\"TU\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:33](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L33)\n\n***\n\n### WE\n\n> **WE**: `\"WE\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:34](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L34)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/interfaces/InterfaceRecurrenceRule.md", "content": "[Admin Docs](/)\n\n***\n\n# Interface: InterfaceRecurrenceRule\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:7](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L7)\n\nRecurrence types for event scheduling\nBased on RFC 5545 (iCalendar) specification\n\n## Properties\n\n### byDay?\n\n> `optional` **byDay**: [`WeekDays`](../enumerations/WeekDays.md)[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:14](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L14)\n\n***\n\n### byMonth?\n\n> `optional` **byMonth**: `number`[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:15](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L15)\n\n***\n\n### byMonthDay?\n\n> `optional` **byMonthDay**: `number`[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L16)\n\n***\n\n### bySetPos?\n\n> `optional` **bySetPos**: `number`[]\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:18](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L18)\n\nRFC 5545 BYSETPOS: which occurrence of byDay within the month (e.g. [3] = 3rd Monday)\n\n***\n\n### count?\n\n> `optional` **count**: `number`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L12)\n\n***\n\n### endDate?\n\n> `optional` **endDate**: `Date`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:10](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L10)\n\n***\n\n### frequency\n\n> **frequency**: [`Frequency`](../enumerations/Frequency.md)\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L8)\n\n***\n\n### interval?\n\n> `optional` **interval**: `number`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:9](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L9)\n\n***\n\n### never?\n\n> `optional` **never**: `boolean`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:13](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L13)\n\n***\n\n### recurrenceEndDate?\n\n> `optional` **recurrenceEndDate**: `Date`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:11](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L11)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceTypes/type-aliases/RecurrenceEndOptionType.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: RecurrenceEndOptionType\n\n> **RecurrenceEndOptionType** = `\"never\"` \\| `\"on\"` \\| `\"after\"`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceTypes.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceTypes.ts#L48)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/areRecurrenceRulesEqual.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: areRecurrenceRulesEqual()\n\n> **areRecurrenceRulesEqual**(`rule1`, `rule2`): `boolean`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:275](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L275)\n\nChecks if two recurrence rules are equal\n\n## Parameters\n\n### rule1\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nFirst recurrence rule\n\n### rule2\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nSecond recurrence rule\n\n## Returns\n\n`boolean`\n\nTrue if rules are equal\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/createDefaultRecurrenceRule.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: createDefaultRecurrenceRule()\n\n> **createDefaultRecurrenceRule**(`startDate`, `frequency`): [`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:223](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L223)\n\nCreates a default recurrence rule based on the event start date\n\n## Parameters\n\n### startDate\n\n`Date`\n\nThe event start date\n\n### frequency\n\n[`Frequency`](../../recurrenceTypes/enumerations/Frequency.md)\n\nThe desired frequency\n\n## Returns\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nDefault recurrence rule\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/formatRecurrenceForApi.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: formatRecurrenceForApi()\n\n> **formatRecurrenceForApi**(`recurrence`): `Omit`\\<[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `\"endDate\"`\\> & `object`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:305](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L305)\n\nFormats a recurrence rule for API submission.\nConverts Date object to ISO string for `endDate`.\n\n## Parameters\n\n### recurrence\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nThe recurrence rule to format.\n\n## Returns\n\n`Omit`\\<[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md), `\"endDate\"`\\> & `object`\n\nA recurrence rule object suitable for API submission.\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getDayName.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getDayName()\n\n> **getDayName**(`dayIndex`): `string`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:377](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L377)\n\nGets the full day name from a day index\n\n## Parameters\n\n### dayIndex\n\n`number`\n\nThe day index (0-6, where 0 is Sunday)\n\n## Returns\n\n`string`\n\nThe full day name\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getEndTypeFromRecurrence.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getEndTypeFromRecurrence()\n\n> **getEndTypeFromRecurrence**(`recurrence`): [`RecurrenceEndOptionType`](../../recurrenceTypes/type-aliases/RecurrenceEndOptionType.md)\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:259](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L259)\n\nDetermines the end type from a recurrence rule\n\n## Parameters\n\n### recurrence\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nThe recurrence rule\n\n## Returns\n\n[`RecurrenceEndOptionType`](../../recurrenceTypes/type-aliases/RecurrenceEndOptionType.md)\n\nThe end type\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getMonthlyOptions.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getMonthlyOptions()\n\n> **getMonthlyOptions**(`startDate`): `object`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:386](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L386)\n\nGenerates monthly recurrence options based on the start date\n\n## Parameters\n\n### startDate\n\n`Date`\n\nThe event start date\n\n## Returns\n\n`object`\n\nObject containing monthly recurrence display strings and values\n\n### byDate\n\n> **byDate**: `string`\n\n### byWeekday\n\n> **byWeekday**: `string`\n\n### dateValue\n\n> **dateValue**: `number` = `dayOfMonth`\n\n### weekdayValue\n\n> **weekdayValue**: `object`\n\n#### weekdayValue.day\n\n> **day**: [`WeekDays`](../../recurrenceTypes/enumerations/WeekDays.md)\n\n#### weekdayValue.week\n\n> **week**: `number` = `weekdayOccurrence`\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getOrdinalString.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getOrdinalString()\n\n> **getOrdinalString**(`num`): `string`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:367](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L367)\n\nConverts a number to its ordinal string representation\n\n## Parameters\n\n### num\n\n`number`\n\nThe number to convert (1-5)\n\n## Returns\n\n`string`\n\nThe ordinal string (e.g., \"first\", \"second\", etc.)\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getOrdinalSuffix.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getOrdinalSuffix()\n\n> **getOrdinalSuffix**(`num`): `string`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:208](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L208)\n\nGets ordinal suffix for a number (st, nd, rd, th)\n\n## Parameters\n\n### num\n\n`number`\n\nThe number\n\n## Returns\n\n`string`\n\nOrdinal suffix\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getRecurrenceRuleText.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getRecurrenceRuleText()\n\n> **getRecurrenceRuleText**(`recurrence`, `startDate`, `endDate?`): `string`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:104](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L104)\n\nGenerates a human-readable description of the recurrence rule\n\n## Parameters\n\n### recurrence\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nThe recurrence rule\n\n### startDate\n\n`Date`\n\nThe event start date\n\n### endDate?\n\n`Date`\n\n## Returns\n\n`string`\n\nHuman-readable description\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/getWeekOfMonth.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getWeekOfMonth()\n\n> **getWeekOfMonth**(`date`): `number`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:325](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L325)\n\nCalculates which week of the month a given date falls in (calendar row), using UTC.\n\n## Parameters\n\n### date\n\n`Date`\n\nThe date to calculate the week for\n\n## Returns\n\n`number`\n\nThe week number (1-6) within the month\n" }, { "path": "docs/docs/auto-docs/utils/recurrenceUtils/recurrenceUtilityFunctions/functions/validateRecurrenceInput.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateRecurrenceInput()\n\n> **validateRecurrenceInput**(`recurrence`, `startDate`): `object`\n\nDefined in: [src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/recurrenceUtils/recurrenceUtilityFunctions.ts#L20)\n\nValidates recurrence input data\n\n## Parameters\n\n### recurrence\n\n[`InterfaceRecurrenceRule`](../../recurrenceTypes/interfaces/InterfaceRecurrenceRule.md)\n\nThe recurrence rule to validate\n\n### startDate\n\n`Date`\n\nThe event start date\n\n## Returns\n\n`object`\n\nValidation result with errors\n\n### errors\n\n> **errors**: `string`[]\n\n### isValid\n\n> **isValid**: `boolean`\n" }, { "path": "docs/docs/auto-docs/utils/sanitizeAvatar/functions/sanitizeAvatarURL.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: sanitizeAvatarURL()\n\n> **sanitizeAvatarURL**(`url`): `string`\n\nDefined in: [src/utils/sanitizeAvatar.ts:47](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/sanitizeAvatar.ts#L47)\n\nNormalizes an avatar URL by converting null-like values to an empty string.\n\n## Parameters\n\n### url\n\n`string`\n\nThe avatar URL to normalize\n\n## Returns\n\n`string`\n\nThe original URL, or an empty string if the input is falsy or the literal string \"null\"\n" }, { "path": "docs/docs/auto-docs/utils/sanitizeAvatar/functions/sanitizeAvatars.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: sanitizeAvatars()\n\n> **sanitizeAvatars**(`file`, `fallbackUrl`): `string`\n\nDefined in: [src/utils/sanitizeAvatar.ts:8](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/sanitizeAvatar.ts#L8)\n\nSanitizes a file-based or URL-based avatar source.\n\n## Parameters\n\n### file\n\n`File`\n\nAn image File to create an object URL from, or null\n\n### fallbackUrl\n\n`string`\n\nA URL string to validate and return if no file is provided\n\n## Returns\n\n`string`\n\nA safe blob: or https: URL, or an empty string\n" }, { "path": "docs/docs/auto-docs/utils/testConstants/variables/SIDEBAR_TEST_BG_COLOR.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: SIDEBAR\\_TEST\\_BG\\_COLOR\n\n> `const` **SIDEBAR\\_TEST\\_BG\\_COLOR**: `\"#f0f7fb\"` = `'#f0f7fb'`\n\nDefined in: [src/utils/testConstants.ts:4](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/testConstants.ts#L4)\n\nBackground color used for sidebar tests.\n" }, { "path": "docs/docs/auto-docs/utils/timezoneUtils/dateTimeConfig/variables/dateTimeFields.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: dateTimeFields\n\n> `const` **dateTimeFields**: `object`\n\nDefined in: [src/utils/timezoneUtils/dateTimeConfig.ts:3](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeConfig.ts#L3)\n\n## Type Declaration\n\n### directFields\n\n> **directFields**: `string`[]\n\n### pairedFields\n\n> **pairedFields**: `object`[]\n" }, { "path": "docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/requestMiddleware.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: requestMiddleware\n\n> `const` **requestMiddleware**: `ApolloLink`\n\nDefined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:84](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeMiddleware.ts#L84)\n" }, { "path": "docs/docs/auto-docs/utils/timezoneUtils/dateTimeMiddleware/variables/responseMiddleware.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: responseMiddleware\n\n> `const` **responseMiddleware**: `ApolloLink`\n\nDefined in: [src/utils/timezoneUtils/dateTimeMiddleware.ts:94](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/timezoneUtils/dateTimeMiddleware.ts#L94)\n" }, { "path": "docs/docs/auto-docs/utils/tokenValues/functions/getSpacingValue.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getSpacingValue()\n\n> **getSpacingValue**(`token`): `number`\n\nDefined in: [src/utils/tokenValues.ts:66](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L66)\n\nConverts a spacing token name to its pixel value.\n\n## Parameters\n\n### token\n\n`string`\n\nThe spacing token name (e.g., 'space-15')\n\n## Returns\n\n`number`\n\nThe pixel value as a number\n\n## Throws\n\nError if the token name is not found\n\n## Example\n\n```ts\ngetSpacingValue('space-15') // returns 150\ngetSpacingValue('space-8') // returns 32\n```\n" }, { "path": "docs/docs/auto-docs/utils/tokenValues/functions/isSpacingToken.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: isSpacingToken()\n\n> **isSpacingToken**(`value`): `value is string`\n\nDefined in: [src/utils/tokenValues.ts:82](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L82)\n\nType guard to check if a value is a valid spacing token name.\n\n## Parameters\n\n### value\n\n`unknown`\n\nThe value to check\n\n## Returns\n\n`value is string`\n\nTrue if the value is a valid spacing token name\n" }, { "path": "docs/docs/auto-docs/utils/tokenValues/type-aliases/SpacingToken.md", "content": "[Admin Docs](/)\n\n***\n\n# Type Alias: SpacingToken\n\n> **SpacingToken** = keyof *typeof* [`spacingTokens`](../variables/spacingTokens.md)\n\nDefined in: [src/utils/tokenValues.ts:51](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L51)\n\nType representing valid spacing token names\n" }, { "path": "docs/docs/auto-docs/utils/tokenValues/variables/spacingTokens.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: spacingTokens\n\n> `const` **spacingTokens**: `Record`\\<`string`, `number`\\>\n\nDefined in: [src/utils/tokenValues.ts:16](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/tokenValues.ts#L16)\n\nMapping of spacing token names to their pixel values.\nToken names match the CSS variable names without the '--' prefix.\n" }, { "path": "docs/docs/auto-docs/utils/urlToFile/functions/urlToFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: urlToFile()\n\n> **urlToFile**(`url`): `Promise`\\<`File`\\>\n\nDefined in: [src/utils/urlToFile.ts:2](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/urlToFile.ts#L2)\n\n## Parameters\n\n### url\n\n`string`\n\n## Returns\n\n`Promise`\\<`File`\\>\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/clearAllItems.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: clearAllItems()\n\n> **clearAllItems**(`prefix`): `void`\n\nDefined in: [src/utils/useLocalstorage.ts:68](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L68)\n\nClears all items from localStorage with the given prefix.\n\n## Parameters\n\n### prefix\n\n`string`\n\nPrefix to be added to the key, common for all keys.\n\n## Returns\n\n`void`\n\nvoid\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/getItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getItem()\n\n> **getItem**\\<`T`\\>(`prefix`, `key`): `T`\n\nDefined in: [src/utils/useLocalstorage.ts:30](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L30)\n\nRetrieves the stored value for the given key from local storage.\n\n## Type Parameters\n\n### T\n\n`T`\n\n## Parameters\n\n### prefix\n\n`string`\n\nPrefix to be added to the key, common for all keys.\n\n### key\n\n`string`\n\nThe unique name identifying the value.\n\n## Returns\n\n`T`\n\n- The stored value parsed as type T or null.\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/getStorageKey.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getStorageKey()\n\n> **getStorageKey**(`prefix`, `key`): `string`\n\nDefined in: [src/utils/useLocalstorage.ts:20](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L20)\n\nGenerates the prefixed key for storage.\n\n## Parameters\n\n### prefix\n\n`string`\n\nPrefix to be added to the key, common for all keys.\n\n### key\n\n`string`\n\nThe unique name identifying the value.\n\n## Returns\n\n`string`\n\n- Prefixed key.\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/removeItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: removeItem()\n\n> **removeItem**(`prefix`, `key`): `void`\n\nDefined in: [src/utils/useLocalstorage.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L58)\n\nRemoves the value associated with the given key from local storage.\n\n## Parameters\n\n### prefix\n\n`string`\n\nPrefix to be added to the key, common for all keys.\n\n### key\n\n`string`\n\nThe unique name identifying the value.\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/setItem.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: setItem()\n\n> **setItem**(`prefix`, `key`, `value`): `void`\n\nDefined in: [src/utils/useLocalstorage.ts:48](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L48)\n\nSets the value for the given key in local storage.\n\n## Parameters\n\n### prefix\n\n`string`\n\nPrefix to be added to the key, common for all keys.\n\n### key\n\n`string`\n\nThe unique name identifying the value.\n\n### value\n\n`unknown`\n\nThe value to be stored (any type that can be serialized).\n\n## Returns\n\n`void`\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/functions/useLocalStorage.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: useLocalStorage()\n\n> **useLocalStorage**(`prefix`): `InterfaceStorageHelper`\n\nDefined in: [src/utils/useLocalstorage.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L87)\n\nFactory function that returns localStorage helper methods with a common prefix.\n\n## Parameters\n\n### prefix\n\n`string` = `PREFIX`\n\nPrefix to be added to all keys, defaults to 'Talawa-admin'.\n\n## Returns\n\n`InterfaceStorageHelper`\n\nInterfaceStorageHelper with getItem, setItem, removeItem, getStorageKey, and clearAllItems methods.\n" }, { "path": "docs/docs/auto-docs/utils/useLocalstorage/variables/PREFIX.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PREFIX\n\n> `const` **PREFIX**: `\"Talawa-admin\"` = `'Talawa-admin'`\n\nDefined in: [src/utils/useLocalstorage.ts:12](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useLocalstorage.ts#L12)\n" }, { "path": "docs/docs/auto-docs/utils/useSession/functions/default.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: default()\n\n> **default**(): `UseSessionReturnType`\n\nDefined in: [src/utils/useSession.tsx:32](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/useSession.tsx#L32)\n\nCustom hook for managing user session timeouts in a React application.\n\nThis hook handles:\n- Starting and ending the user session.\n- Displaying a warning toast at half of the session timeout duration.\n- Logging the user out and displaying a session expiration toast when the session times out.\n- Automatically resetting the timers when user activity is detected.\n- Pausing session timers when the tab is inactive and resuming them when it becomes active again.\n\n## Returns\n\n`UseSessionReturnType`\n\nUseSessionReturnType - An object with methods to start and end the session, and to handle logout.\n" }, { "path": "docs/docs/auto-docs/utils/userUpdateUtils/functions/removeEmptyFields.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: removeEmptyFields()\n\n> **removeEmptyFields**\\<`T`\\>(`obj`): `Partial`\\<`T`\\>\n\nDefined in: [src/utils/userUpdateUtils.ts:23](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/userUpdateUtils.ts#L23)\n\nRemoves empty fields from an object, filtering out null, undefined, and empty/whitespace-only strings.\nFile objects are preserved regardless of their content.\n\nThis function accepts a generic type T that extends Record with string keys and values that can be\nstring, File, null\n\n## Type Parameters\n\n### T\n\n`T` *extends* `Record`\\<`string`, `string` \\| `File`\\>\n\n## Parameters\n\n### obj\n\n`T`\n\nThe object to filter\n\n## Returns\n\n`Partial`\\<`T`\\>\n\nA partial object with empty fields removed\n\n## Example\n\n```typescript\nconst input = { name: 'John', email: '', age: null };\nconst result = removeEmptyFields(input);\n// Returns: { name: 'John' }\n```\n" }, { "path": "docs/docs/auto-docs/utils/userUpdateUtils/functions/validateImageFile.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateImageFile()\n\n> **validateImageFile**(`file`, `tCommon`): `boolean`\n\nDefined in: [src/utils/userUpdateUtils.ts:60](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/userUpdateUtils.ts#L60)\n\nValidates an image file for type and size constraints.\nShows error notifications for invalid files using the provided translation function.\n\n## Parameters\n\n### file\n\n`File`\n\nThe file to validate, or undefined if no file is selected\n\n### tCommon\n\n(`key`, `options?`) => `string`\n\nTranslation function for error messages, accepts a key and optional interpolation options\n\n## Returns\n\n`boolean`\n\n`true` if the file is valid, `false` otherwise\n\n## Remarks\n\n- Accepted file types: JPEG, PNG, GIF\n- Maximum file size: 5MB\n- Returns `false` immediately if no file is provided\n- Displays error notifications for invalid files\n\n## Example\n\n```typescript\nconst { t: tCommon } = useTranslation('common');\nconst isValid = validateImageFile(selectedFile, tCommon);\nif (isValid) {\n // Process the valid image file\n}\n```\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/functions/getPasswordRequirements.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: getPasswordRequirements()\n\n> **getPasswordRequirements**(`password`): [`InterfacePasswordRequirements`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md)\n\nDefined in: [src/utils/validators/authValidators.ts:87](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L87)\n\nChecks password requirements status.\n\n## Parameters\n\n### password\n\n`string`\n\nPassword to check\n\n## Returns\n\n[`InterfacePasswordRequirements`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfacePasswordRequirements.md)\n\nObject indicating which requirements are met\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/functions/validateEmail.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateEmail()\n\n> **validateEmail**(`email`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nDefined in: [src/utils/validators/authValidators.ts:19](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L19)\n\nValidates email format.\nNote: Uses basic regex validation. Does not enforce RFC 5322 compliance.\n\n## Parameters\n\n### email\n\n`string`\n\nEmail address to validate\n\n## Returns\n\n[`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nValidation result with error message if invalid\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/functions/validateName.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validateName()\n\n> **validateName**(`name`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nDefined in: [src/utils/validators/authValidators.ts:58](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L58)\n\nValidates name field requirements.\n\n## Parameters\n\n### name\n\n`string`\n\nName to validate\n\n## Returns\n\n[`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nValidation result with error message if invalid\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/functions/validatePassword.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validatePassword()\n\n> **validatePassword**(`password`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nDefined in: [src/utils/validators/authValidators.ts:31](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L31)\n\nValidates password complexity requirements.\n\n## Parameters\n\n### password\n\n`string`\n\nPassword to validate\n\n## Returns\n\n[`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nValidation result with error message if invalid\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/functions/validatePasswordConfirmation.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: validatePasswordConfirmation()\n\n> **validatePasswordConfirmation**(`password`, `confirmPassword`): [`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nDefined in: [src/utils/validators/authValidators.ts:73](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L73)\n\nValidates password confirmation matches original password.\n\n## Parameters\n\n### password\n\n`string`\n\nOriginal password\n\n### confirmPassword\n\n`string`\n\nConfirmation password\n\n## Returns\n\n[`InterfaceValidationResult`](../../../../types/Auth/ValidationInterfaces/interfaces/InterfaceValidationResult.md)\n\nValidation result with error message if passwords don't match\n" }, { "path": "docs/docs/auto-docs/utils/validators/authValidators/variables/PASSWORD_REGEX.md", "content": "[Admin Docs](/)\n\n***\n\n# Variable: PASSWORD\\_REGEX\n\n> `const` **PASSWORD\\_REGEX**: `object`\n\nDefined in: [src/utils/validators/authValidators.ts:6](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/validators/authValidators.ts#L6)\n\n## Type Declaration\n\n### lowercase\n\n> `readonly` **lowercase**: `RegExp`\n\n### numeric\n\n> `readonly` **numeric**: `RegExp`\n\n### specialChar\n\n> `readonly` **specialChar**: `RegExp`\n\n### uppercase\n\n> `readonly` **uppercase**: `RegExp`\n" }, { "path": "docs/docs/auto-docs/utils/volunteerStatusMapper/functions/mapVolunteerStatusToVariant.md", "content": "[Admin Docs](/)\n\n***\n\n# Function: mapVolunteerStatusToVariant()\n\n> **mapVolunteerStatusToVariant**(`status`): `object`\n\nDefined in: [src/utils/volunteerStatusMapper.ts:26](https://github.com/PalisadoesFoundation/talawa-admin/blob/main/src/utils/volunteerStatusMapper.ts#L26)\n\nMaps volunteer membership status to StatusBadge variant.\n\nThis function provides a single source of truth for status→variant mapping,\nensuring consistent visual representation across the application.\n\n## Parameters\n\n### status\n\n`string`\n\nThe membership status string (e.g., 'requested', 'invited', 'accepted', 'rejected')\n\n## Returns\n\n`object`\n\nObject containing the StatusBadge variant\n\n### variant\n\n> **variant**: [`StatusVariant`](../../../types/shared-components/StatusBadge/interface/type-aliases/StatusVariant.md)\n\n## Example\n\n```typescript\nconst badgeProps = mapVolunteerStatusToVariant('invited');\n// Returns: { variant: 'pending' }\n```\n" }, { "path": "docs/docs/docs/developer-resources/actionitems-components.md", "content": "---\r\nid: actionitems-components\r\ntitle: ActionItems Modal Components\r\nslug: /developer-resources/actionitems-components\r\nsidebar_position: 44\r\n---\r\n\r\n## Overview\r\n\r\nThe ActionItems modal system provides reusable components for managing action items (tasks assigned to volunteers or volunteer groups) in Talawa Admin. It includes specialized modals for creating, viewing, and deleting action items with support for recurring events and group assignments.\r\n\r\n**Key Features:**\r\n\r\n- Create and edit action items with category, volunteer/group assignment, and dates\r\n- View detailed action item information in read-only mode\r\n- Delete action items with confirmation and recurring event handling\r\n- Support for assigning to individual volunteers or volunteer groups\r\n- Template vs. instance distinction for recurring event management\r\n- MUI Autocomplete for volunteer/group/category selection with keyboard navigation\r\n- Completion tracking with pre/post-completion notes\r\n- i18n ready with full internationalization support\r\n\r\n**Why Use ActionItems Components:**\r\n\r\n- **Consistent UI:** Standardized modals for all action item operations across the application\r\n- **Accessibility:** WCAG 2.1 Level AA compliant with proper labels, roles, and keyboard navigation\r\n- **Flexibility:** Handles both one-time and recurring event action items with different mutation strategies\r\n- **Type Safety:** Fully typed interfaces for all props and data structures\r\n- **Testing:** Comprehensive test coverage with proper MUI Autocomplete interaction patterns\r\n\r\n## Component Location\r\n\r\n```text\r\nsrc/shared-components/ActionItems/\r\n ├── ActionItemModal/\r\n │ ├── [ActionItemModal.tsx](http://_vscodecontentref_/0) # Create/Edit action item modal\r\n │ ├── ActionItemModal.module.css\r\n │ └── ActionItemModal.spec.tsx\r\n ├── ActionItemViewModal/\r\n │ ├── [ActionItemViewModal.tsx](http://_vscodecontentref_/1) # Read-only view modal\r\n │ ├── ActionItemViewModal.module.css\r\n │ └── ActionItemViewModal.spec.tsx\r\n ├── ActionItemDeleteModal/\r\n │ ├── [ActionItemDeleteModal.tsx](http://_vscodecontentref_/2) # Delete confirmation modal\r\n │ ├── ActionItemDeleteModal.module.css\r\n │ └── ActionItemDeleteModal.spec.tsx\r\n ├── ActionItemUpdateModal/ # Status update modals\r\n ├── [ActionItem.mocks.ts](http://_vscodecontentref_/3) # GraphQL query/mutation mocks\r\n └── ActionItemUpdateModal/\r\n```\r\n\r\n## Type Definitions:\r\n\r\n```text\r\nsrc/types/shared-components/ActionItems/interface.ts\r\n```\r\n\r\n## Related Components:\r\n\r\n`AssignmentTypeSelector` - Chip-based toggle for volunteer vs. volunteer group selection\r\n`ApplyToSelector` - Radio group for series vs. instance selection (recurring events)\r\n`FormFieldGroup` - Wrapper for form fields\r\n`DatePicker` - Date selection component\r\n`BaseModal` - Base modal wrapper with backdrop handling Quick Start\r\n`ActionItemModal` (Create/Edit)\r\n\r\n\r\n## Quick Start\r\n### ActionItemModal (Create/Edit)\r\n```tsx\r\nimport ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal';\r\n\r\n setShowModal(false)}\r\n orgId=\"organization-123\"\r\n eventId=\"event-456\"\r\n actionItem={null} // null for create, object for edit\r\n editMode={false}\r\n actionItemsRefetch={refetchActionItems}\r\n isRecurring={false}\r\n/>\r\n```\r\n\r\n### ActionItemViewModal (Read-Only)\r\n```tsx\r\nimport ActionItemViewModal from 'shared-components/ActionItems/ActionItemViewModal/ActionItemViewModal';\r\n\r\n setShowModal(false)}\r\n item={actionItemData}\r\n/>\r\n```\r\n\r\n### ActionItemDeleteModal (Confirmation)\r\n```tsx\r\nimport ActionItemDeleteModal from 'shared-components/ActionItems/ActionItemDeleteModal/ActionItemDeleteModal';\r\n\r\n setShowModal(false)}\r\n actionItem={actionItemData}\r\n actionItemsRefetch={refetchActionItems}\r\n eventId=\"event-456\"\r\n isRecurring={true}\r\n/>\r\n```\r\n\r\n## Usage Examples\r\n### Complete Create Flow\r\n```tsx\r\nimport React, { useState } from 'react';\r\nimport ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal';\r\nimport { Button } from 'react-bootstrap';\r\nimport { useQuery } from '@apollo/client';\r\nimport { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries';\r\n\r\nexport const ActionItemsManager = ({ eventId, orgId }) => {\r\n const [showModal, setShowModal] = useState(false);\r\n const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, {\r\n variables: { input: { id: eventId } },\r\n });\r\n\r\n return (\r\n <>\r\n \r\n \r\n setShowModal(false)}\r\n orgId={orgId}\r\n eventId={eventId}\r\n actionItem={null}\r\n editMode={false}\r\n actionItemsRefetch={refetchActionItems}\r\n />\r\n \r\n );\r\n};\r\n```\r\n\r\n### Edit Flow with Recurring Support\r\n```tsx\r\nimport React, { useState } from 'react';\r\nimport ActionItemModal from 'shared-components/ActionItems/ActionItemModal/ActionItemModal';\r\nimport { useQuery } from '@apollo/client';\r\nimport { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries';\r\n\r\nexport const EditActionItem = ({ actionItem, eventId, orgId, isRecurringEvent }) => {\r\n const [showModal, setShowModal] = useState(false);\r\n const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, {\r\n variables: { input: { id: eventId } },\r\n });\r\n\r\n return (\r\n <>\r\n \r\n \r\n setShowModal(false)}\r\n orgId={orgId}\r\n eventId={eventId}\r\n actionItem={actionItem}\r\n editMode={true}\r\n actionItemsRefetch={refetchActionItems}\r\n isRecurring={isRecurringEvent}\r\n baseEvent={actionItem.event}\r\n />\r\n \r\n );\r\n};\r\n```\r\n\r\n### Delete With Confirmation\r\n```tsx\r\nimport React, { useState } from 'react';\r\nimport ActionItemDeleteModal from 'shared-components/ActionItems/ActionItemDeleteModal/ActionItemDeleteModal';\r\nimport { Button } from 'react-bootstrap';\r\nimport { useQuery } from '@apollo/client';\r\nimport { GET_EVENT_ACTION_ITEMS } from 'GraphQl/Queries/ActionItemQueries';\r\n\r\nexport const DeleteActionItem = ({ actionItem, eventId, isRecurringEvent }) => {\r\n const [showModal, setShowModal] = useState(false);\r\n const { refetch: refetchActionItems } = useQuery(GET_EVENT_ACTION_ITEMS, {\r\n variables: { input: { id: eventId } },\r\n });\r\n\r\n return (\r\n <>\r\n \r\n \r\n setShowModal(false)}\r\n actionItem={actionItem}\r\n actionItemsRefetch={refetchActionItems}\r\n eventId={eventId}\r\n isRecurring={isRecurringEvent}\r\n />\r\n \r\n );\r\n};\r\n```\r\n\r\n## Component API\r\n\r\n---\r\n\r\n### ActionItemModal Props\r\n\r\n| Prop | Type | Required | Default | Description |\r\n|------------------------|-----------------------------------|----------|---------|-------------|\r\n| `isOpen` | `boolean` | Yes | – | Controls modal visibility |\r\n| `hide` | `() => void` | Yes | – | Callback to close the modal |\r\n| `orgId` | `string` | Yes | – | Organization ID for category/volunteer queries |\r\n| `eventId` | `string \\| undefined` | Yes | – | Event ID for volunteer group queries (`undefined` for organization-level) |\r\n| `actionItem` | `IActionItemInfo \\| null` | Yes | – | Action item object for edit mode, `null` for create |\r\n| `editMode` | `boolean` | Yes | – | Controls form behavior (create vs. edit) |\r\n| `actionItemsRefetch` | `() => void` | Yes | – | Callback to refetch action items after mutation |\r\n| `orgActionItemsRefetch`| `() => void` | No | – | Optional callback for organization-level refetch |\r\n| `isRecurring` | `boolean` | No | `false` | Show series/instance selector for recurring events |\r\n| `baseEvent` | `{ id: string } \\| null` | No | – | Base event reference for recurring event handling |\r\n\r\n---\r\n\r\n### ActionItemViewModal Props\r\n\r\n| Prop | Type | Required | Default | Description |\r\n|----------|--------------------|----------|---------|-------------|\r\n| `isOpen` | `boolean` | Yes | – | Controls modal visibility |\r\n| `hide` | `() => void` | Yes | – | Callback to close the modal |\r\n| `item` | `IActionItemInfo` | Yes | – | Action item data to display |\r\n\r\n---\r\n\r\n### ActionItemDeleteModal Props\r\n\r\n| Prop | Type | Required | Default | Description |\r\n|----------------------|--------------------|----------|---------|-------------|\r\n| `isOpen` | `boolean` | Yes | – | Controls modal visibility |\r\n| `hide` | `() => void` | Yes | – | Callback to close the modal |\r\n| `actionItem` | `IActionItemInfo` | Yes | – | Action item to delete |\r\n| `actionItemsRefetch` | `() => void` | Yes | – | Callback to refetch after deletion |\r\n| `eventId` | `string` | No | – | Event ID for instance-specific deletion |\r\n| `isRecurring` | `boolean` | No | `false` | Show series/instance selector for recurring events |\r\n\r\n\r\n" }, { "path": "docs/docs/docs/developer-resources/contributing.md", "content": "---\nid: contributing\ntitle: Contributing\nslug: /developer-resources/contributing\nsidebar_position: 15\n---\n\nPlease read the [Palisadoes Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing) for a complete guide on how to get started with submitting code.\n" }, { "path": "docs/docs/docs/developer-resources/crud-modal-template.md", "content": "---\nid: crud-modal-template\ntitle: CRUDModalTemplate Component\nslug: /developer-resources/crud-modal-template\nsidebar_position: 38\n---\n\n## Overview\n\nThe `CRUDModalTemplate` is a standardized, reusable modal system for performing Create, Read, Update, and Delete operations across the Talawa Admin application. It provides consistent modal behavior, loading states, error handling, and accessibility features.\n\n**Key Features:**\n\n- Four specialized modal types: Create, Edit, Delete, and View\n- Built-in loading states for data fetching and form submission\n- Auto-focus on first input field\n- Keyboard accessibility (Escape to close)\n- Consistent styling and layout\n- i18n ready\n\n**Why Use CRUDModalTemplate:**\n\n- **Consistency:** Ensures all CRUD modals across the application have uniform behavior and appearance\n- **Reduced Boilerplate:** Common features like loading states and form handling are pre-integrated\n- **Maintainability:** Changes to modal behavior can be made in one place\n- **Accessibility:** Built-in keyboard navigation and focus management\n\n## Component Location\n\n```text\nsrc/shared-components/CRUDModalTemplate/\n ├── CRUDModalTemplate.tsx # Base modal component\n ├── CRUDModalTemplate.module.css\n ├── CRUDModalTemplate.spec.tsx\n ├── CreateModal.tsx # Create entity modal\n ├── EditModal.tsx # Edit entity modal\n ├── DeleteModal.tsx # Delete entity modal\n └── ViewModal.tsx # View entity modal (read-only)\n```\n\n**Type Definitions:**\n\n```text\nsrc/types/shared-components/CRUDModalTemplate/interface.ts\n```\n\n## Quick Start\n\n### CreateModal\n\n```tsx\nimport { CreateModal } from 'shared-components/CRUDModalTemplate/CreateModal';\nimport { Form } from 'react-bootstrap';\n\n setShowModal(false)}\n onSubmit={handleSubmit}\n loading={isSubmitting}\n submitDisabled={!isFormValid}\n>\n \n Event Name\n setEventName(e.target.value)}\n />\n \n\n```\n\n### EditModal\n\n```tsx\nimport { EditModal } from 'shared-components/CRUDModalTemplate/EditModal';\nimport { Form } from 'react-bootstrap';\n\n setShowModal(false)}\n onSubmit={handleSubmit}\n loading={isSubmitting}\n loadingData={isFetchingData}\n submitDisabled={!hasChanges}\n>\n \n Event Name\n setEventName(e.target.value)}\n />\n \n\n```\n\n### DeleteModal\n\n```tsx\nimport { DeleteModal } from 'shared-components/CRUDModalTemplate/DeleteModal';\n\n setShowModal(false)}\n onDelete={handleDelete}\n showWarning={true}\n/>\n```\n\n### ViewModal\n\n```tsx\nimport { ViewModal } from 'shared-components/CRUDModalTemplate/ViewModal';\nimport { Button } from 'react-bootstrap';\n\n setShowModal(false)}\n loadingData={isFetchingData}\n customActions={\n <>\n \n \n }\n>\n
\n Event Name:\n

Annual Conference 2024

\n
\n\n```\n\n## Component API\n\n### CreateModal Props\n\n| Prop | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `title` | `string` | Yes | - | The title displayed in the modal header |\n| `onClose` | `() => void` | Yes | - | Callback function when the modal is closed |\n| `onSubmit` | `(e: FormEvent) => void` | Yes | - | Callback function when the form is submitted |\n| `children` | `ReactNode` | Yes | - | Form fields to render inside the modal body |\n| `loading` | `boolean` | No | `false` | Shows a loading spinner on the submit button |\n| `submitDisabled` | `boolean` | No | `false` | Disables the submit button |\n\n### EditModal Props\n\n| Prop | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `title` | `string` | Yes | - | The title displayed in the modal header |\n| `onClose` | `() => void` | Yes | - | Callback function when the modal is closed |\n| `onSubmit` | `(e: FormEvent) => void` | Yes | - | Callback function when the form is submitted |\n| `children` | `ReactNode` | Yes | - | Form fields to render inside the modal body |\n| `loading` | `boolean` | No | `false` | Shows a loading spinner on the submit button |\n| `loadingData` | `boolean` | No | `false` | Shows a full modal loading state when fetching entity data |\n| `submitDisabled` | `boolean` | No | `false` | Disables the submit button |\n\n### DeleteModal Props\n\n| Prop | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `title` | `string` | Yes | - | The title displayed in the modal header |\n| `onClose` | `() => void` | Yes | - | Callback function when the modal is closed |\n| `onDelete` | `() => void` | Yes | - | Callback function when the delete action is confirmed |\n| `entityName` | `string` | Yes | - | The name of the entity being deleted |\n| `showWarning` | `boolean` | No | `false` | Shows a warning alert about the irreversible nature of the action |\n| `recurringEventContent` | `ReactNode` | No | - | Optional content for handling recurring event deletion options |\n\n### ViewModal Props\n\n| Prop | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `title` | `string` | Yes | - | The title displayed in the modal header |\n| `onClose` | `() => void` | Yes | - | Callback function when the modal is closed |\n| `children` | `ReactNode` | Yes | - | Content to display inside the modal body |\n| `loadingData` | `boolean` | No | `false` | Shows a loading state when fetching entity data |\n| `customActions` | `ReactNode` | No | - | Optional custom action buttons for the modal footer |\n\n## Usage Examples\n\n### CreateModal with Validation\n\n```tsx\nimport React, { useState } from 'react';\nimport { CreateModal } from 'shared-components/CRUDModalTemplate/CreateModal';\nimport { Form } from 'react-bootstrap';\n\nexport const CreateEventModal = ({ show, onClose, onSuccess }) => {\n const [eventName, setEventName] = useState('');\n const [loading, setLoading] = useState(false);\n\n const isFormValid = eventName.trim().length > 0;\n\n const handleSubmit = async (e) => {\n e.preventDefault();\n setLoading(true);\n try {\n await createEvent({ name: eventName });\n onSuccess();\n onClose();\n } catch (error) {\n console.error('Failed to create event:', error);\n } finally {\n setLoading(false);\n }\n };\n\n if (!show) return null;\n\n return (\n \n \n Event Name\n setEventName(e.target.value)}\n required\n />\n \n \n );\n};\n```\n\n### EditModal with Data Fetching\n\n```tsx\nimport React, { useState, useEffect } from 'react';\nimport { EditModal } from 'shared-components/CRUDModalTemplate/EditModal';\nimport { Form } from 'react-bootstrap';\n\nexport const EditEventModal = ({ show, eventId, onClose, onSuccess }) => {\n const [eventName, setEventName] = useState('');\n const [loading, setLoading] = useState(false);\n const [loadingData, setLoadingData] = useState(true);\n\n useEffect(() => {\n if (show && eventId) {\n setLoadingData(true);\n fetchEvent(eventId)\n .then((event) => setEventName(event.name))\n .finally(() => setLoadingData(false));\n }\n }, [show, eventId]);\n\n const handleSubmit = async (e) => {\n e.preventDefault();\n setLoading(true);\n try {\n await updateEvent(eventId, { name: eventName });\n onSuccess();\n onClose();\n } finally {\n setLoading(false);\n }\n };\n\n if (!show) return null;\n\n return (\n \n \n Event Name\n setEventName(e.target.value)}\n required\n />\n \n \n );\n};\n```\n\n### DeleteModal with Recurring Events\n\n```tsx\nimport React, { useState } from 'react';\nimport { DeleteModal } from 'shared-components/CRUDModalTemplate/DeleteModal';\n\nexport const DeleteEventModal = ({ show, event, onClose, onSuccess }) => {\n const [deleteOption, setDeleteOption] = useState('single');\n\n const handleDelete = async () => {\n try {\n await deleteEvent(event.id, { deleteOption });\n onSuccess();\n onClose();\n } catch (error) {\n console.error('Failed to delete event:', error);\n }\n };\n\n if (!show) return null;\n\n const recurringContent = event.isRecurring ? (\n
\n

This is a recurring event. How would you like to proceed?

\n
\n \n \n
\n
\n ) : null;\n\n return (\n \n );\n};\n```\n\n### ViewModal with Custom Actions\n\n```tsx\nimport React from 'react';\nimport { ViewModal } from 'shared-components/CRUDModalTemplate/ViewModal';\nimport { Button } from 'react-bootstrap';\n\nexport const ViewEventModal = ({ show, event, loadingData, onClose, onEdit, onDelete }) => {\n if (!show) return null;\n\n return (\n \n \n \n \n }\n >\n
\n Event Name:\n

{event?.name}

\n
\n
\n Date:\n

{event?.date}

\n
\n
\n Location:\n

{event?.location}

\n
\n
\n Description:\n

{event?.description}

\n
\n \n );\n};\n```\n\n## Common Patterns and Best Practices\n\n### Form Validation\n\nAlways validate form inputs before enabling the submit button:\n\n```tsx\n// ✅ Good: Submit disabled until form is valid\nconst isFormValid = name.trim() && email.includes('@');\n\n\n {/* form fields */}\n\n```\n\n### Loading States\n\nUse appropriate loading states for different scenarios:\n\n```tsx\n// ✅ Good: Separate loading states\n\n {/* form fields */}\n\n```\n\n### Error Handling\n\nHandle errors gracefully and provide feedback to users:\n\n```tsx\n// ✅ Good: Error handling with user feedback\nconst handleSubmit = async (e) => {\n e.preventDefault();\n setLoading(true);\n try {\n await createEntity(formData);\n onSuccess();\n onClose();\n } catch (error) {\n toast.error('Failed to create entity. Please try again.');\n } finally {\n setLoading(false);\n }\n};\n```\n\n### Controlled Modal Visibility\n\nControl modal visibility from the parent component:\n\n```tsx\n// ✅ Good: Parent controls visibility\nconst ParentComponent = () => {\n const [showCreateModal, setShowCreateModal] = useState(false);\n\n return (\n <>\n \n {showCreateModal && (\n setShowCreateModal(false)}\n onSubmit={handleSubmit}\n >\n {/* form fields */}\n \n )}\n \n );\n};\n```\n\n### i18n Support\n\nUse translation keys for user-facing text:\n\n```tsx\nimport { useTranslation } from 'react-i18next';\n\nconst { t } = useTranslation('events');\n\n\n \n {t('eventName')}\n \n \n\n```\n\n### Delete Confirmation\n\nAlways use `showWarning` for destructive actions:\n\n```tsx\n// ✅ Good: Warning shown for delete\n\n```\n\n## Accessibility\n\nThe CRUDModalTemplate components include built-in accessibility features:\n\n- **Focus Management:** Auto-focus on the first input field when the modal opens\n- **Keyboard Navigation:** Press Escape to close the modal\n- **ARIA Attributes:** Proper role and label attributes for screen readers\n- **Focus Trapping:** Focus is trapped within the modal while open\n\n## Testing\n\nWhen testing components that use CRUDModalTemplate:\n\n```tsx\nimport { render, screen, fireEvent } from '@testing-library/react';\nimport { CreateModal } from 'shared-components/CRUDModalTemplate/CreateModal';\n\ndescribe('CreateModal', () => {\n test('renders modal with title', () => {\n render(\n \n \n \n );\n\n expect(screen.getByText('Create Item')).toBeInTheDocument();\n });\n\n test('calls onClose when cancel button is clicked', () => {\n const onClose = jest.fn();\n\n render(\n \n \n \n );\n\n fireEvent.click(screen.getByText('Cancel'));\n expect(onClose).toHaveBeenCalled();\n });\n\n test('disables submit button when submitDisabled is true', () => {\n render(\n \n \n \n );\n\n expect(screen.getByText('Create')).toBeDisabled();\n });\n});\n```\n\n## FAQ\n\n**Q: When should I use CreateModal vs EditModal?**\n\nA: Use `CreateModal` when creating a new entity (empty form) and `EditModal` when modifying an existing entity (pre-populated form with `loadingData` support).\n\n**Q: How do I add custom buttons to the modal footer?**\n\nA: For `ViewModal`, use the `customActions` prop. For `CreateModal` and `EditModal`, the footer buttons are standardized (Cancel/Submit). If you need different buttons, consider using the base `CRUDModalTemplate` directly.\n\n**Q: Can I use these modals with React Hook Form?**\n\nA: Yes, the modals work with any form library. Simply pass your form fields as children and handle the `onSubmit` callback:\n\n```tsx\nimport { useForm } from 'react-hook-form';\n\nconst { register, handleSubmit } = useForm();\n\n\n \n\n```\n\n**Q: How do I customize the modal size?**\n\nA: The modal size is standardized for consistency. If you need a different size for a specific use case, you can use the base `CRUDModalTemplate` component directly and pass size props to the underlying `BaseModal`.\n\n## Related Components\n\n- **BaseModal**: The underlying modal component used by CRUDModalTemplate\n- **LoadingState**: Used for loading indicators within modals\n- **Form Components**: React Bootstrap form components used for inputs\n\n## See Also\n\n- [Reusable Components Guide](./reusable-components.md)\n- [Design Token System](./design-token-system.md)\n- [Testing Guide](./testing.md)\n" }, { "path": "docs/docs/docs/developer-resources/data-grid-wrapper.md", "content": "---\nid: data-grid-wrapper\ntitle: DataGridWrapper Component\nslug: /developer-resources/data-grid-wrapper\nsidebar_position: 37\n---\n\n## Overview\n\nThe `DataGridWrapper` is a standardized, reusable component that wraps Material-UI's `DataGrid` to provide consistent table functionality across the Talawa Admin application. It includes built-in support for search, sorting, pagination, loading states, and error handling.\n\n**Key Features:**\n\n- Integrated search with configurable fields\n- Flexible sorting with custom options\n- Built-in pagination controls\n- Custom loading states and error handling\n- Action column support\n- Fully type-safe with TypeScript generics\n- i18n ready\n\n**Why Use DataGridWrapper:**\n\n- **Consistency:** Ensures all data grids across the application have uniform behavior and appearance\n- **Policy Enforcement:** The linter prevents direct `@mui/x-data-grid` imports in `src/screens/**`, enforcing use of this wrapper\n- **Reduced Boilerplate:** Common features like search and pagination are pre-integrated\n- **Maintainability:** Changes to grid behavior can be made in one place\n\n## Component Location\n\n```text\nsrc/shared-components/DataGridWrapper/\n ├── DataGridWrapper.tsx\n ├── DataGridWrapper.spec.tsx\n ├── DataGridWrapper.module.css\n ├── DataGridLoadingOverlay.tsx\n └── DataGridErrorOverlay.tsx\n```\n\n**Type Definitions:**\n\n```text\nsrc/types/DataGridWrapper/interface.ts\n```\n\n## Quick Start\n\n### Basic Usage\n\n```tsx\nimport { DataGridWrapper } from 'src/shared-components/DataGridWrapper/DataGridWrapper';\nimport type { GridColDef } from '@mui/x-data-grid';\n\ntype User = { id: string; name: string; email: string };\n\nconst columns: GridColDef[] = [\n { field: 'name', headerName: 'Name', width: 200 },\n { field: 'email', headerName: 'Email', width: 250 },\n];\n\nconst users: User[] = [\n { id: '1', name: 'John Doe', email: 'john@example.com' },\n { id: '2', name: 'Jane Smith', email: 'jane@example.com' },\n];\n\n\n rows={users}\n columns={columns}\n/>\n```\n\n## Component API\n\n### Props Reference\n\n| Prop | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `rows` | `GridRowsProp` | Yes | - | Array of data rows. Each row must have a unique `id` property |\n| `columns` | `GridColDef[]` | Yes | - | Column configuration defining headers, widths, and rendering |\n| `loading` | `boolean` | No | `false` | Shows loading overlay when `true` |\n| `searchConfig` | `SearchConfig` | No | - | Configuration for search functionality |\n| `sortConfig` | `SortConfig` | No | - | Configuration for sorting options |\n| `paginationConfig` | `PaginationConfig` | No | - | Configuration for pagination |\n| `onRowClick` | `(row: T) => void` | No | - | Callback fired when a row is clicked |\n| `actionColumn` | `(row: T) => ReactNode` | No | - | Render function for custom actions column |\n| `emptyStateProps` | `InterfaceEmptyStateProps` | No | - | Full customization of empty state with icon, description, and actions. Takes precedence over `emptyStateMessage` |\n| `emptyStateMessage` | `string` | No | \"No results found\" | Message shown when no rows are available |\n| `error` | `string \\| ReactNode` | No | - | Error message or component to display |\n\n\n### SearchConfig\n\n```typescript\ninterface SearchConfig {\n /** Enable the search bar */\n enabled: boolean;\n /** Fields to search across */\n fields: Array;\n /** Custom placeholder text */\n placeholder?: string;\n /** Debounce delay in milliseconds */\n debounceMs?: number;\n}\n```\n\n### SortConfig\n\n```typescript\ninterface SortConfig {\n /** Default field to sort by */\n defaultSortField?: string;\n /** Default sort direction */\n defaultSortOrder?: 'asc' | 'desc';\n /** Array of sorting options */\n sortingOptions?: Array<{\n label: string;\n value: string | number;\n }>;\n}\n```\n\n### PaginationConfig\n\n```typescript\ninterface PaginationConfig {\n /** Enable pagination */\n enabled: boolean;\n /** Default number of rows per page */\n defaultPageSize?: number;\n /** Available page size options */\n pageSizeOptions?: number[];\n}\n```\n\n## Usage Examples\n\n\n### With Custom Empty State\n\n```tsx\n\n rows={users}\n columns={columns}\n emptyStateProps={{\n icon: 'users',\n message: 'noUsersFound',\n description: 'inviteFirstUser',\n action: {\n label: 'inviteUser',\n onClick: handleInvite,\n variant: 'primary'\n },\n dataTestId: 'users-empty-state'\n }}\n/>\n```\n\n### WithSearch\n\n```tsx\n\n rows={users}\n columns={columns}\n searchConfig={{\n enabled: true,\n fields: ['name', 'email'],\n placeholder: 'Search users...',\n }}\n/>\n```\n\nThe search performs case-insensitive filtering across all specified fields.\n\n### With Sorting\n\n```tsx\n\n rows={users}\n columns={columns}\n sortConfig={{\n defaultSortField: 'name',\n defaultSortOrder: 'asc',\n sortingOptions: [\n { label: 'Name (A-Z)', value: 'name_asc' },\n { label: 'Name (Z-A)', value: 'name_desc' },\n { label: 'Email (A-Z)', value: 'email_asc' },\n { label: 'Email (Z-A)', value: 'email_desc' },\n ],\n }}\n/>\n```\n\n### With Pagination\n\n```tsx\n\n rows={users}\n columns={columns}\n paginationConfig={{\n enabled: true,\n defaultPageSize: 25,\n pageSizeOptions: [10, 25, 50, 100],\n }}\n/>\n```\n\n### With Loading State\n\n```tsx\nconst { data, loading } = useQuery(GET_USERS);\n\n\n rows={data?.users || []}\n columns={columns}\n loading={loading}\n/>\n```\n\nThe component displays a custom loading overlay using the `LoadingState` component.\n\n### With Error Handling\n\n```tsx\nconst { data, loading, error } = useQuery(GET_USERS);\n\n\n rows={data?.users || []}\n columns={columns}\n loading={loading}\n error={error ? 'Failed to load users. Please try again.' : undefined}\n/>\n```\n\nThe error state is displayed using a custom error overlay component (`DataGridErrorOverlay`) that appears in place of the data grid, providing a consistent UX with the loading and empty states. The overlay includes an error icon and message, with proper accessibility attributes (`role=\"alert\"`, `aria-live=\"assertive\"`).\n\n> [!NOTE]\n> The error overlay uses the DataGrid's `slots` API for consistency. When an error is present, it takes precedence over the empty state overlay.\n\n### With Action Column\n\n```tsx\nimport { IconButton } from '@mui/material';\nimport { Edit, Delete } from '@mui/icons-material';\n\n\n rows={users}\n columns={columns}\n actionColumn={(row) => (\n <>\n handleEdit(row.id)} aria-label=\"Edit user\">\n \n \n handleDelete(row.id)} aria-label=\"Delete user\">\n \n \n \n )}\n/>\n```\n\n### With Row Click Handler\n\n```tsx\n\n rows={users}\n columns={columns}\n onRowClick={(row) => {\n navigate(`/admin/users/${row.id}`);\n }}\n/>\n```\n\n### Complete Example\n\n```tsx\nimport React from 'react';\nimport { useQuery } from '@apollo/client';\nimport { useNavigate } from 'react-router-dom';\nimport { DataGridWrapper } from 'src/shared-components/DataGridWrapper/DataGridWrapper';\nimport { GET_USERS } from 'src/GraphQl/Queries/Queries';\nimport type { GridColDef } from '@mui/x-data-grid';\n\ntype User = {\n id: string;\n name: string;\n email: string;\n role: string;\n};\n\nexport const UsersScreen = () => {\n const navigate = useNavigate();\n const { data, loading, error } = useQuery(GET_USERS);\n\n const columns: GridColDef[] = [\n { field: 'name', headerName: 'Name', width: 200 },\n { field: 'email', headerName: 'Email', width: 250 },\n { field: 'role', headerName: 'Role', width: 150 },\n ];\n\n return (\n \n rows={data?.users || []}\n columns={columns}\n loading={loading}\n error={error ? 'Failed to load users' : undefined}\n searchConfig={{\n enabled: true,\n fields: ['name', 'email', 'role'],\n placeholder: 'Search users by name, email, or role...',\n }}\n sortConfig={{\n defaultSortField: 'name',\n defaultSortOrder: 'asc',\n sortingOptions: [\n { label: 'Name (A-Z)', value: 'name_asc' },\n { label: 'Name (Z-A)', value: 'name_desc' },\n { label: 'Email (A-Z)', value: 'email_asc' },\n { label: 'Email (Z-A)', value: 'email_desc' },\n ],\n }}\n paginationConfig={{\n enabled: true,\n defaultPageSize: 25,\n pageSizeOptions: [10, 25, 50, 100],\n }}\n onRowClick={(row) => navigate(`/admin/users/${row.id}`)}\n emptyStateMessage=\"No users found\"\n />\n );\n};\n```\n\n## Migration Guide\n\n### From Direct DataGrid Usage\n\nIf you're currently using `@mui/x-data-grid` directly in `src/screens/**`, follow these steps to migrate:\n\n#### Step 1: Replace Import\n\n**Before:**\n```tsx\nimport { DataGrid } from '@mui/x-data-grid';\nimport type { GridColDef } from '@mui/x-data-grid';\n```\n\n**After:**\n```tsx\nimport { DataGridWrapper } from 'src/shared-components/DataGridWrapper/DataGridWrapper';\nimport type { GridColDef } from '@mui/x-data-grid';\n```\n\n#### Step 2: Update Component Usage\n\n**Before:**\n```tsx\n handleRowClick(params.row)}\n/>\n```\n\n**After:**\n```tsx\n\n rows={users}\n columns={columns}\n loading={loading}\n paginationConfig={{\n enabled: true,\n defaultPageSize: 25,\n pageSizeOptions: [10, 25, 50],\n }}\n onRowClick={(row) => handleRowClick(row)}\n/>\n```\n\n#### Step 3: Move Search Logic\n\nIf you have custom search logic:\n\n**Before:**\n```tsx\nconst [searchTerm, setSearchTerm] = useState('');\nconst filteredUsers = users.filter(u => \n u.name.toLowerCase().includes(searchTerm.toLowerCase()) ||\n u.email.toLowerCase().includes(searchTerm.toLowerCase())\n);\n\n<>\n setSearchTerm(e.target.value)}\n placeholder=\"Search...\"\n />\n \n\n```\n\n**After:**\n```tsx\n\n rows={users}\n columns={columns}\n searchConfig={{\n enabled: true,\n fields: ['name', 'email'],\n placeholder: 'Search...',\n }}\n/>\n```\n\n#### Step 4: Move Sorting Logic\n\nIf you have custom sorting:\n\n**Before:**\n```tsx\nconst [sortModel, setSortModel] = useState([\n { field: 'name', sort: 'asc' }\n]);\n\n\n```\n\n**After:**\n```tsx\n\n rows={users}\n columns={columns}\n sortConfig={{\n defaultSortField: 'name',\n defaultSortOrder: 'asc',\n sortingOptions: [\n { label: 'Name (A-Z)', value: 'name_asc' },\n { label: 'Name (Z-A)', value: 'name_desc' },\n ],\n }}\n/>\n```\n\n### Common Migration Patterns\n\n#### Pattern 1: Empty State Handling\n\n**Before:**\n```tsx\n{users.length === 0 && !loading ? (\n
No users found
\n) : (\n \n)}\n```\n\n**After:**\n```tsx\n\n rows={users}\n columns={columns}\n emptyStateMessage=\"No users found\"\n/>\n```\n\n#### Pattern 2: Error Handling\n\n**Before:**\n```tsx\n{error ? (\n
Error: {error.message}
\n) : (\n \n)}\n```\n\n**After:**\n```tsx\n\n rows={users}\n columns={columns}\n error={error ? error.message : undefined}\n/>\n```\n\nThe error now displays as an overlay within the DataGrid using the `slots` API, providing a consistent experience with the loading and empty states.\n\n#### Pattern 3: Action Buttons\n\n**Before:**\n```tsx\nconst columns: GridColDef[] = [\n { field: 'name', headerName: 'Name' },\n {\n field: 'actions',\n headerName: 'Actions',\n renderCell: (params) => (\n \n ),\n },\n];\n```\n\n**After:**\n```tsx\nconst columns: GridColDef[] = [\n { field: 'name', headerName: 'Name' },\n];\n\n\n rows={users}\n columns={columns}\n actionColumn={(row) => (\n \n )}\n/>\n```\n\n## Common Patterns and Best Practices\n\n### Type Safety\n\nAlways provide the generic type parameter for full type safety:\n\n```tsx\n// ✅ Good: Type-safe\n\n rows={users}\n columns={columns}\n onRowClick={(row) => {\n // `row` is correctly typed as User\n console.log(row.name);\n }}\n/>\n\n// ❌ Bad: No type safety\n\n```\n\n### Column Configuration\n\nDefine columns outside the component to prevent re-renders:\n\n```tsx\n// ✅ Good: Defined outside component\nconst columns: GridColDef[] = [\n { field: 'name', headerName: 'Name', width: 200 },\n { field: 'email', headerName: 'Email', width: 250 },\n];\n\nexport const UsersScreen = () => {\n return rows={users} columns={columns} />;\n};\n\n// ❌ Bad: Defined inside component (re-creates on every render)\nexport const UsersScreen = () => {\n const columns = [\n { field: 'name', headerName: 'Name', width: 200 },\n ];\n return rows={users} columns={columns} />;\n};\n```\n\n### Search Fields\n\nOnly include searchable text fields in `searchConfig.fields`:\n\n```tsx\n// ✅ Good: Only text fields\nsearchConfig={{\n enabled: true,\n fields: ['name', 'email', 'organization'],\n}}\n\n// ❌ Bad: Including non-text fields\nsearchConfig={{\n enabled: true,\n fields: ['name', 'createdAt', 'isActive'], // createdAt and isActive won't search well\n}}\n```\n\n### Pagination\n\nEnable pagination for large datasets:\n\n```tsx\n// ✅ Good: Pagination enabled for large lists\n\n rows={users} // 1000+ users\n columns={columns}\n paginationConfig={{\n enabled: true,\n defaultPageSize: 25,\n }}\n/>\n\n// ❌ Bad: No pagination for large dataset\n\n rows={users} // 1000+ users - will cause performance issues\n columns={columns}\n/>\n```\n\n### Loading and Error States\n\nAlways handle loading and error states:\n\n```tsx\n// ✅ Good: Handles all states\nconst { data, loading, error } = useQuery(GET_USERS);\n\n\n rows={data?.users || []}\n columns={columns}\n loading={loading}\n error={error ? 'Failed to load users' : undefined}\n emptyStateMessage=\"No users found\"\n/>\n```\n\n### i18n Support\n\nUse translation keys for user-facing text:\n\n```tsx\nimport { useTranslation } from 'react-i18next';\n\nconst { t } = useTranslation('users');\n\n\n rows={users}\n columns={columns}\n searchConfig={{\n enabled: true,\n fields: ['name', 'email'],\n placeholder: t('searchPlaceholder'),\n }}\n emptyStateMessage={t('noUsersFound')}\n error={error ? t('loadError') : undefined}\n/>\n```\n\n### Accessibility\n\nEnsure action buttons have proper aria labels:\n\n```tsx\n\n rows={users}\n columns={columns}\n actionColumn={(row) => (\n <>\n handleEdit(row.id)}\n aria-label={`Edit user ${row.name}`}\n >\n \n \n handleDelete(row.id)}\n aria-label={`Delete user ${row.name}`}\n >\n \n \n \n )}\n/>\n```\n\n### Sort Format Validation\n\nThe DataGridWrapper validates sort formats and provides helpful console warnings for debugging:\n\n```tsx\n// ✅ Good: Correct sort format\nsortConfig={{\n sortingOptions: [\n { label: 'Name (A-Z)', value: 'name_asc' }, // Correct\n { label: 'Name (Z-A)', value: 'name_desc' }, // Correct\n ],\n}}\n\n// ❌ Bad: Invalid sort format - will log warning\nsortConfig={{\n sortingOptions: [\n { label: 'Name', value: 'name' }, // Missing sort direction\n { label: 'Email', value: 'email-ascending' }, // Wrong separator\n ],\n}}\n```\n\nIf an invalid format is detected, you'll see a console warning:\n```\n[DataGridWrapper] Invalid sort format: \"name\". Expected format: \"field_asc\" or \"field_desc\"\n```\n\nThis helps developers quickly identify and fix configuration errors during development.\n\n## Linter Enforcement\n\nDirect usage of `@mui/x-data-grid` and `@mui/x-data-grid-pro` is enforced via ESLint\n(`no-restricted-imports`) in `eslint.config.js`, with wrapper exemptions managed in\n`scripts/eslint/config/exemptions.ts`.\n\nOnly the `DataGridWrapper` and its associated type definitions are allowed to import\nthese packages directly. All other usage must go through the standardized wrapper.\n\n\n**Linter runs:**\n- Pre-commit (via lint-staged)\n- Pull request CI (via GitHub Actions)\n\n**If you need to use DataGrid features not supported by DataGridWrapper:**\n\n1. First, consider if the feature can be added to `DataGridWrapper`\n2. If not, discuss with the team\n3. The component may need to be refactored or enhanced\n\n## Testing\n\nWhen testing components that use `DataGridWrapper`:\n\n```tsx\nimport { render, screen } from '@testing-library/react';\nimport { DataGridWrapper } from 'src/shared-components/DataGridWrapper/DataGridWrapper';\n\ntest('renders user data correctly', () => {\n const users = [\n { id: '1', name: 'John Doe', email: 'john@example.com' },\n ];\n\n const columns = [\n { field: 'name', headerName: 'Name' },\n { field: 'email', headerName: 'Email' },\n ];\n\n render( rows={users} columns={columns} />);\n\n expect(screen.getByText('John Doe')).toBeInTheDocument();\n expect(screen.getByText('john@example.com')).toBeInTheDocument();\n});\n\ntest('renders empty state message', () => {\n render(\n \n rows={[]}\n columns={[]}\n emptyStateMessage=\"No data available\"\n />\n );\n\n expect(screen.getByText('No data available')).toBeInTheDocument();\n});\n```\n\n## FAQ\n\n**Q: Can I use MUI DataGrid props not exposed by DataGridWrapper?**\n\nA: DataGridWrapper exposes the most commonly used props. If you need additional DataGrid functionality, consider:\n1. Opening an issue to discuss adding it to DataGridWrapper\n2. Proposing changes to enhance the wrapper component\n\n**Q: How do I customize column rendering?**\n\nA: Use the standard MUI `GridColDef` `renderCell` property:\n\n```tsx\nconst columns: GridColDef[] = [\n {\n field: 'status',\n headerName: 'Status',\n renderCell: (params) => (\n \n ),\n },\n];\n```\n\n**Q: How do I handle server-side pagination/sorting?**\n\nA: Currently, DataGridWrapper supports client-side pagination and sorting. For server-side features, you'll need to implement the logic before passing data to the component:\n\n```tsx\nconst { data, loading } = useQuery(GET_USERS, {\n variables: {\n page: currentPage,\n pageSize: 25,\n sortBy: sortField,\n sortOrder: sortOrder,\n },\n});\n\n\n rows={data?.users || []}\n columns={columns}\n loading={loading}\n/>\n```\n\n**Q: Can I disable pagination?**\n\nA: Yes, simply don't provide a `paginationConfig` or set `paginationConfig.enabled` to `false`.\n\n**Q: How do I style the DataGrid?**\n\nA: The DataGrid uses MUI's styling system. You can use the `sx` prop on columns or wrap DataGridWrapper in a styled container. For global styling changes, modify `DataGridWrapper.module.css`.\n\n## Related Components\n\n- **SearchBar**: Used internally by DataGridWrapper for search functionality\n- **SortingButton**: Used internally for sorting dropdown\n- **DataGridLoadingOverlay**: Custom loading overlay component displayed via DataGrid slots\n- **DataGridErrorOverlay**: Custom error overlay component displayed via DataGrid slots when errors occur\n- **EmptyState**: Displayed via DataGrid slots when no data is available\n\n## See Also\n\n- [MUI DataGrid Documentation](https://mui.com/x/react-data-grid/)\n- [Reusable Components Guide](./reusable-components.md)\n- [Design Token System](./design-token-system.md)\n- [Testing Guide](./testing.md)\n" }, { "path": "docs/docs/docs/developer-resources/design-token-system.md", "content": "---\nid: design-token-system\ntitle: Design Token System\nslug: /developer-resources/design-token-system\nsidebar_position: 40\n---\n\n## Overview\n\nThe Design Token System is the single source of truth for all visual values in the codebase.\nEvery colour, spacing value, font size, border radius, shadow, and any other dimensional or stylistic value **must** come from a design token.\nHard-coded hex colours, pixel values, and raw numbers are not permitted anywhere outside the token files themselves.\n\nIf the token you need does not exist yet, add it to the appropriate token file following the naming conventions below, then reference it with `var(--token-name)`.\n\n## Token Files\n\nAll token files live under `src/style/tokens/`:\n\n| File | Purpose |\n|------|---------|\n| `colors.css` | Colour palette (grays, blues, reds, greens, yellows, base colours) |\n| `spacing.css` | Spacing scale used for margin, padding, gap, width, height, and positioning |\n| `typography.css` | Font sizes, line heights, font weights, and letter spacing |\n| `borders.css` | Border widths, border-radius scale, shadow offsets, blur, and spread |\n| `logosizes.css` | Standard logo dimension tokens |\n| `layout.css` | Viewport-relative layout tokens (`vh` and `vw` values for heights, widths, and positioning) |\n| `index.css` | Barrel file that imports all of the above |\n\nToken files are imported globally via `src/index.tsx`, so every token is available everywhere without any additional imports.\n\n> **Note on breakpoints:** CSS custom properties **cannot** be used inside `@media` query conditions (for example `@media (max-width: var(--breakpoint-md))` does not work). For this reason there is no `breakpoints.css` token file. Hard-code the breakpoint values directly inside the `@media` rule — they are the one exception to the \"no raw values\" rule.\n\n## Naming Conventions\n\n| Category | Pattern | Examples |\n|----------|---------|----------|\n| **Colours** | `--color--` or `--color-` | `--color-gray-100`, `--color-white`, `--color-blue-500` |\n| **Spacing** | `--space-` | `--space-0`, `--space-4`, `--space-12` |\n| **Font size** | `--font-size-` | `--font-size-xs`, `--font-size-md`, `--font-size-2xl` |\n| **Line height** | `--line-height-` | `--line-height-tight`, `--line-height-normal` |\n| **Font weight** | `--font-weight-` | `--font-weight-regular`, `--font-weight-bold` |\n| **Letter spacing** | `--letter-spacing-` | `--letter-spacing-normal`, `--letter-spacing-wide` |\n| **Border width** | `--border-` | `--border-1`, `--border-2` |\n| **Border radius** | `--radius-` | `--radius-sm`, `--radius-md`, `--radius-full` |\n| **Shadow offset** | `--shadow-offset-` | `--shadow-offset-xs`, `--shadow-offset-md` |\n| **Shadow blur** | `--shadow-blur-` | `--shadow-blur-sm`, `--shadow-blur-lg` |\n| **Shadow spread** | `--shadow-spread-` | `--shadow-spread-none`, `--shadow-spread-sm` |\n| **Logo sizes** | `--logo-` | `--logo-xs`, `--logo-lg` |\n| **Viewport height** | `--vh-` | `--vh-100`, `--vh-70`, `--vh-2` |\n| **Viewport width** | `--vw-` | `--vw-80`, `--vw-13`, `--vw-8` |\n\nFollow the existing scale order and units in each file when adding new tokens.\n\n---\n\n## Component Styling Architecture\n\n### One CSS Module Per Component\n\nEvery component **must** have its own colocated CSS module file. A component file and its styles always live side-by-side:\n\n```\nsrc/components/UserProfile/\n├── UserProfile.tsx\n├── UserProfile.module.css\n└── UserProfile.spec.tsx\n```\n\n- `UserProfile.tsx` → `UserProfile.module.css`\n- `LoginForm.tsx` → `LoginForm.module.css`\n- `EventCard.tsx` → `EventCard.module.css`\n\nEach CSS module is self-contained and must not depend on any global stylesheet.\n\n### Strict Import Rule\n\nA TSX file may **only** import styles from its own colocated CSS module. The import must follow this exact pattern:\n\n```tsx\n// UserProfile.tsx\nimport styles from './UserProfile.module.css'; // allowed\n\n// These are NOT allowed:\n// import styles from '../../style/app-fixed.module.css';\n// import otherStyles from '../SomeOther/SomeOther.module.css';\n// import globalStyles from '../../style/global.module.css';\n```\n\n**Rule:** If the component file is `Foo.tsx`, the only permitted style import is `./Foo.module.css`. No cross-component style imports. No global sheet imports.\n\n### No Global Stylesheets\n\nComponents must not rely on any global CSS module for their styles. All visual rules for a component belong in its own `.module.css` file.\n\n> **`app-fixed.module.css` — Legacy / Temporary:**\n> The file `src/style/app-fixed.module.css` currently exists as a legacy global stylesheet. It is scheduled for removal. **Do not add new styles to it**, and **do not import from it** in new or refactored components. Ongoing migration work is moving all its classes into the appropriate colocated component CSS modules.\n\n### No `composes`\n\nThe CSS Modules `composes` keyword is **not allowed**:\n\n```css\n/* NOT allowed */\n.button {\n composes: primaryButton from '../../style/app-fixed.module.css';\n}\n\n/* NOT allowed */\n.card {\n composes: baseCard from '../shared.module.css';\n}\n```\n\nInstead, use design tokens directly to style each component:\n\n```css\n/* Correct — use tokens directly */\n.button {\n background-color: var(--color-blue-500);\n color: var(--color-white);\n padding: var(--space-3) var(--space-5);\n border-radius: var(--radius-md);\n font-size: var(--font-size-md);\n font-weight: var(--font-weight-semibold);\n}\n```\n\nIf multiple components need the same visual pattern, extract a shared component (in `src/shared-components/`) rather than sharing CSS classes.\n\n### No Hard-Coded Values in CSS Files\n\nCSS files must not contain any raw/inline values. Every colour, size, spacing, font, border, and shadow value must reference a design token:\n\n```css\n/* NOT allowed — hard-coded values */\n.card {\n background-color: #ffffff;\n padding: 16px;\n border-radius: 8px;\n font-size: 14px;\n color: rgb(33, 37, 41);\n}\n\n/* Correct — tokens only */\n.card {\n background-color: var(--color-white);\n padding: var(--space-5);\n border-radius: var(--radius-md);\n font-size: var(--font-size-sm);\n color: var(--color-gray-900);\n}\n```\n\n### No React Bootstrap Utility Classes\n\nDo **not** use React Bootstrap utility/helper class names (e.g. `d-flex`, `p-3`, `mb-2`, `text-center`, `bg-primary`) or string-based `className` props that reference multiple Bootstrap classes. All styling must be handled through the colocated CSS module using design tokens:\n\n```tsx\n// NOT allowed — React Bootstrap utility classes\n
\n Hello\n
\n\n// Correct — use CSS module classes backed by tokens\nimport styles from './Greeting.module.css';\n\n
\n Hello\n
\n```\n\n```css\n/* Greeting.module.css */\n.container {\n display: flex;\n justify-content: space-between;\n padding: var(--space-4);\n margin-bottom: var(--space-3);\n background-color: var(--color-gray-50);\n border-radius: var(--radius-md);\n}\n\n.label {\n color: var(--color-gray-600);\n font-size: var(--font-size-sm);\n}\n```\n\n---\n\n## Transparency and Colour Mixing\n\nDo **not** use `rgba()` or `hsla()` for transparent colours. Use the modern `color-mix()` function with the `in srgb` colour space instead:\n\n```css\n/* NOT allowed */\n.overlay {\n background: rgba(0, 0, 0, 0.2);\n}\n\n/* Correct — use color-mix with tokens */\n.overlay {\n background: color-mix(in srgb, var(--color-black) 20%, transparent);\n}\n\n.highlight {\n background: color-mix(in srgb, var(--color-blue-500) 10%, transparent);\n}\n\n.border {\n border-color: color-mix(in srgb, var(--color-gray-700) 50%, transparent);\n}\n```\n\nThis approach keeps colour values tied to tokens and avoids scattering raw colour codes throughout the codebase.\n\n---\n\n## Usage Examples\n\n### CSS Module (component-level)\n\n```css\n/* EventCard.module.css */\n.card {\n background-color: var(--color-white);\n border: var(--border-1) solid var(--color-gray-200);\n border-radius: var(--radius-md);\n padding: var(--space-5);\n box-shadow: var(--shadow-offset-xs) var(--shadow-offset-sm) var(--shadow-blur-md) var(--shadow-spread-none)\n color-mix(in srgb, var(--color-black) 10%, transparent);\n}\n\n.title {\n font-size: var(--font-size-lg);\n font-weight: var(--font-weight-semibold);\n line-height: var(--line-height-tight);\n color: var(--color-gray-900);\n}\n\n.subtitle {\n font-size: var(--font-size-sm);\n color: var(--color-gray-600);\n letter-spacing: var(--letter-spacing-wide);\n}\n```\n\n### TSX File\n\n```tsx\n// EventCard.tsx\nimport styles from './EventCard.module.css';\n\nfunction EventCard({ title, subtitle }: EventCardProps) {\n return (\n
\n

{title}

\n

{subtitle}

\n
\n );\n}\n```\n\n### No Inline Styles\n\nInline styles (`style={{ }}`) are **not allowed** in TSX files. All styling must go through the colocated CSS module:\n\n```tsx\n// NOT allowed\n\n Save\n\n\n// Correct — use the CSS module class instead\nimport styles from './SaveButton.module.css';\n\n\n```\n\n```css\n/* SaveButton.module.css */\n.saveButton {\n margin-top: var(--space-4);\n font-size: var(--font-size-md);\n font-weight: var(--font-weight-semibold);\n}\n```\n\n### Responsive Breakpoints\n\n```css\n/* Breakpoints are the one exception — raw values are allowed in @media conditions */\n.container {\n padding: var(--space-5);\n}\n\n@media (max-width: 768px) {\n .container {\n padding: var(--space-3);\n }\n}\n```\n\n---\n\n## Validation and CI/CD Checks\n\nToken usage is enforced by `scripts/validate-tokens.ts`, which scans `src/` CSS/TS/TSX files (excluding token files and `src/assets/css/app.css`) for hard-coded values.\n\n### Detected Patterns\n\n#### CSS/SCSS Files\n\n| Category | Patterns Detected |\n|----------|-------------------|\n| **Colours** | Hex colours (`#fff`, `#ffffff`, `#ffffffaa`), RGB/RGBA (`rgb(0,0,0)`, `rgba(0,0,0,0.5)`), HSL/HSLA (`hsl(0,0%,0%)`, `hsla(0,0%,0%,0.5)`) |\n| **Spacing** | `margin`, `padding`, `width`, `height`, `gap`, `top`, `right`, `bottom`, `left`, `inset` with `px`/`rem`/`em` values (including shorthand like `padding: 8px 16px`) |\n| **Typography** | `font-size` with `px`/`rem`/`em`, `font-weight` with numeric values (100-900), `line-height` with `px`/`rem`/`em` |\n| **Borders** | `border-radius` with `px`/`rem`/`em`, `border-width` with units, `border` shorthand with colours |\n| **Effects** | `box-shadow` with hard-coded offset/blur values and colours |\n\n#### TSX/TS Inline Styles\n\n| Category | Patterns Detected |\n|----------|-------------------|\n| **Spacing** | `marginTop`, `marginRight`, `marginBottom`, `marginLeft`, `paddingTop`, `paddingRight`, `paddingBottom`, `paddingLeft`, `margin`, `padding` (and logical properties like `marginInline`, `paddingBlock`) |\n| **Dimensions** | `width`, `height`, `minWidth`, `minHeight`, `maxWidth`, `maxHeight`, `gap`, `rowGap`, `columnGap`, `top`, `right`, `bottom`, `left` |\n| **Typography** | `fontSize` with numeric or string values, `fontWeight` with numeric values (100-900), `lineHeight` with unit values |\n| **Borders** | `borderRadius` with numeric or string values |\n| **Colours** | `color`, `backgroundColor`, `borderColor`, `background` with hex/rgb/hsl values |\n\n### Allowlisted Patterns\n\nThe following patterns are **not flagged** as violations:\n\n- CSS `var()` usage (e.g. `var(--space-4)`)\n- CSS `calc()` expressions\n- CSS `color-mix()` expressions\n- CSS custom property definitions (`--my-token: value`)\n- Zero values (`0`, `0px`)\n- Percentage values (`50%`, `100%`)\n- Non-dimensional properties: `z-index`, `opacity`, `flex`, `flex-grow`, `flex-shrink`, `order`\n- Time-based values: `animation-duration`, `animation-delay`, `transition-duration`, `transition-delay`\n\n### Local Checks\n\n- `lint-staged` runs `pnpm exec tsx scripts/validate-tokens.ts --files` on staged `*.ts`, `*.tsx`, `*.css`, `*.scss`, `*.sass`.\n- `.husky/pre-commit` runs `lint-staged`, so violations fail the commit before it is created.\n\n### CI/CD Checks\n\n- The PR workflow runs `pnpm exec tsx scripts/validate-tokens.ts --files $CHANGED_FILES` to scan only the files changed in the PR, and the job fails if hard-coded values are found.\n\nThese guardrails catch new hard-coded values before merge and keep token usage consistent without slowing down CI with full-repo scans.\n\n### Run Locally\n\n```bash\n# Check staged files (for pre-commit)\npnpm exec tsx scripts/validate-tokens.ts --staged --all\n\n# Check specific files\npnpm exec tsx scripts/validate-tokens.ts --files src/path/to/file.tsx src/path/to/style.css\n\n# Scan entire repository\npnpm exec tsx scripts/validate-tokens.ts --scan-entire-repo\n```\n\n---\n\n## Quick-Reference Rules\n\n| Rule | Detail |\n|------|--------|\n| **Token-only values** | All colours, spacing, font sizes, weights, radii, and shadows must use `var(--token-name)` |\n| **One CSS module per component** | `Foo.tsx` gets `Foo.module.css` — no exceptions |\n| **Colocated imports only** | `Foo.tsx` may only import from `./Foo.module.css` |\n| **No global sheet imports** | Never import from `app-fixed.module.css` or any other global sheet |\n| **No inline styles** | `style={{ }}` is not allowed in TSX — use CSS module classes instead |\n| **No hard-coded CSS values** | CSS files must not contain raw hex, px, rem, or rgb values — use tokens via `var()` |\n| **No React Bootstrap classes** | Do not use Bootstrap utility classes (`d-flex`, `p-3`, `mb-2`, etc.) — use CSS module classes with tokens |\n| **No `composes`** | Do not use the CSS Modules `composes` keyword — use tokens directly |\n| **`color-mix` for transparency** | Use `color-mix(in srgb, var(--color-*) , transparent)` instead of `rgba`/`hsla` |\n| **Raw breakpoints in `@media`** | CSS custom properties do not work in `@media` conditions — hard-code the pixel value |\n| **Add missing tokens** | If a token doesn't exist, add it in `src/style/tokens/` following the naming conventions |\n" }, { "path": "docs/docs/docs/developer-resources/dropdown-button-api.md", "content": "---\nid: dropdown-button\ntitle: DropDownButton Shared-Component\nslug: /developer-resources/dropdown-button-shared\nsidebar_position: 49\n---\n\n# DropDownButton API\n\nThe `DropDownButton` component is a reusable dropdown selector from the `shared-components` library. It provides a customizable menu for selecting a single value from a list of options, supporting accessibility, keyboard navigation, and flexible customization.\n\n---\n\n## Import\n\n```jsx\nimport DropDownButton from 'shared-components/DropDownButton';\n```\n\n---\n\n## Usage\n\n```jsx\n}\n/>\n```\n\n---\n\n## Props\n\n| Prop | Type | Required | Default | Description |\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------|-----------------------------------------------|\n| `id` | `string` | No | — | The id of the dropdown button. |\n| `buttonLabel` | `string` | No | — | The label of the button. |\n| `options` | `InterfaceDropDownOption[]` | Yes | — | The options to be displayed in the dropdown. |\n| `selectedValue` | `string` | No | — | The currently selected value. |\n| `onSelect` | `(value: string) => void` | Yes | — | Callback function when an option is selected. |\n| `placeholder` | `string` | No | — | Placeholder text when no option is selected. |\n| `disabled` | `boolean` | No | `false` | Whether the dropdown button is disabled. |\n| `parentContainerStyle` | `string` | No | — | Custom styles for the parent container. |\n| `btnStyle` | `string` | No | — | Custom styles for the dropdown button. |\n| `ariaLabel` | `string` | No | — | ARIA label for accessibility. |\n| `dataTestIdPrefix` | `string` | No | — | Data test id prefix for testing purposes. |\n| `variant` | `'primary' \\| 'secondary' \\| 'success' \\| 'danger' \\| 'warning' \\| 'info' \\| 'light' \\| 'dark' \\| 'outline-primary' \\| 'outline-secondary' \\| 'outline-success' \\| 'outline-danger' \\| 'outline-warning' \\| 'outline-info' \\| 'outline-light' \\| 'outline-dark'` | No | — | The variant/style of the button. |\n| `icon` | `React.ReactNode` | No | — | The icon to be displayed on the button. |\n\n---\n\n\n## Option Object\n\nEach item in the `options` array should have the following shape:\n\n```js\n{\n label: 'Display Text',\n value: 'unique-value',\n disabled: false // optional\n}\n```\n\n---\n\n## Example\n\n```jsx\nconst options = [\n { label: 'Admin', value: 'admin' },\n { label: 'Editor', value: 'editor', disabled: true },\n { label: 'Viewer', value: 'viewer' },\n];\n\nfunction RoleSelector() {\n const [role, setRole] = React.useState('');\n\n return (\n \n );\n}\n```\n\n### More Examples\n\n#### Example: Dropdown with Icons\n\n```jsx\nimport { FaUser, FaUserShield, FaUserEdit } from 'react-icons/fa';\n\nconst optionsWithIcons = [\n { label: <> Admin, value: 'admin' },\n { label: <> Editor, value: 'editor' },\n { label: <> Viewer, value: 'viewer' },\n];\n\nfunction IconDropdown() {\n const [role, setRole] = React.useState('');\n\n return (\n }\n />\n );\n}\n```\n\n#### Example: Disabled Dropdown\n\n```jsx\nfunction DisabledDropdown() {\n return (\n \n );\n}\n```\n---\n\n## Accessibility\n\n- Fully keyboard navigable (Tab, Arrow keys, Enter/Escape).\n- ARIA attributes for screen readers.\n- Provide meaningful `ariaLabel`, `buttonLabel`, and `placeholder` for better accessibility.\n\n---\n\n## Customization\n\n- Use the `parentContainerStyle` and `btnStyle` props to apply custom styles.\n- Use the `variant` prop to change the button style.\n- Add an `icon` to the button if needed.\n\n---\n\n\n## Notes\n\n- Always provide a unique `value` for each option.\n- The `onSelect` callback receives the selected value.\n- Supports integration with forms via `id` prop.\n- For advanced usage, refer to the source code or open an issue in the repository.\n" }, { "path": "docs/docs/docs/developer-resources/e2e-testing.md", "content": "---\nid: e2e-testing\ntitle: End to End Testing\nslug: /developer-resources/e2e-testing\nsidebar_position: 70\n---\n\nThis project uses Cypress for comprehensive end-to-end testing to ensure the application works correctly from a user's perspective.\n\n## Additional Resources\n\n- [Online docs](https://docs-admin.talawa.io/docs/developer-resources/e2e-testing)\n- Cypress local quick reference: `cypress/README.md`\n\n## Prerequisites\n\nBefore running Cypress tests, ensure you have the following setup:\n\n### Talawa API Setup\n\n1. **Important**: The [Talawa API](https://github.com/PalisadoesFoundation/talawa-api) must be properly installed, configured, and running before executing any Cypress tests. The tests depend on API endpoints being available and functional.\n2. Please follow the complete installation guide at: https://github.com/PalisadoesFoundation/talawa-api/blob/develop/INSTALLATION.md\n\n### Application Server\n\nEnsure your local development server is running on `http://localhost:4321`.\n\n## Directory Structure\n\nThe tests follow the Page Object Model pattern for maintainability.\n\n```text\ncypress/\n├── e2e/\n│ ├── Auth/\n│ ├── AdminPortal/\n│ │ ├── Dashboard/\n│ │ ├── Organizations/\n│ │ ├── People/\n│ │ ├── Events/\n│ │ ├── ActionItems/\n│ │ ├── Posts/\n│ │ ├── Advertisements/\n│ │ ├── Venues/\n│ │ └── Tags/\n│ ├── UserPortal/\n│ │ ├── Dashboard/\n│ │ ├── OrganizationDiscovery/\n│ │ ├── EventDiscovery/\n│ │ ├── VolunteerSignup/\n│ │ ├── Posts/\n│ │ ├── Profile/\n│ │ └── Transactions/\n│ ├── SharedComponents/\n│ ├── E2EFlows/\n│ ├── ErrorScenarios/\n│ ├── CascadingEffects/\n│ ├── MultiOrganization/\n│ └── Accessibility/\n├── fixtures/\n├── pageObjects/\n│ ├── base/\n│ ├── AdminPortal/\n│ ├── UserPortal/\n│ └── shared/\n└── support/\n```\n\n### Key Components:\n\n1. **e2e/**: Contains all test specification files organized by feature\n1. **fixtures/**: Static data used in tests (JSON files, images, etc.)\n1. **pageObjects/**: Page Object Model implementation for maintainable test code\n1. **support/**: Custom commands and utilities to extend Cypress functionality\n\n## Running Tests\n\nFollow these steps to run end to end tests\n\n### Available Commands\n\n```bash\n\n# Open Cypress Test Runner (Interactive Mode)\n# Preferred for Debugging\n\npnpm run cy:open\n\n# Run all tests in headless mode\n\npnpm run cy:run\n```\n\n### Cypress Configuration Defaults\n\nThe E2E configuration in `cypress.config.ts` is:\n\n- `specPattern`: `cypress/e2e/**/*.cy.ts`\n- `testIsolation`: `true`\n- `retries`: `runMode: 2`, `openMode: 0`\n- `defaultCommandTimeout`: `30000`\n- `requestTimeout`, `responseTimeout`, `pageLoadTimeout`: `30000`\n\n### Running Specific Tests\n\nThere are multiple testing modes.\n\n#### Interactive Mode\n\nFor running specific tests with visual feedback, use the Interactive Mode where you can view all test specs and run individual tests:\n\n```bash\npnpm run cy:open\n```\n\n#### Headless Mode\n\nFor running specific tests in headless mode, use the subset scripts below. These commands start the app server automatically before executing Cypress:\n\n```bash\n# Run Admin Portal specs\npnpm run cy:run:admin\n\n# Run User Portal specs\npnpm run cy:run:user\n\n# Run Auth specs\npnpm run cy:run:auth\n\n# Run Shared Components specs\npnpm run cy:run:shared\n```\n\nFor a single spec file, use `pnpm run cy:open` and select the spec in the\ninteractive runner.\n\n## Writing Tests\n\nFollow these best practices when writing tests.\n\n### Page Object Model\n\nThis project follows the Page Object Model pattern for better test maintenance:\n\n```ts\n// Example usage of a portal-aligned page object\nimport { MemberManagementPage } from '../../../pageObjects/AdminPortal/MemberManagementPage';\n\nconst memberManagementPage = new MemberManagementPage();\n\nit('searches a member', () => {\n memberManagementPage\n .openFromDrawer()\n .searchMemberByName('Wilt Shepherd')\n .verifyMemberInList('Wilt Shepherd');\n});\n```\n\nUse the base class in `cypress/pageObjects/base/BasePage.ts` when creating new\nportal page objects so helpers remain typed and chainable.\n\n### Shared Page Object Utilities\n\nUse shared helpers in `cypress/pageObjects/shared/` to avoid repeating common\nmodal and table interactions across page objects.\n\n```ts\nimport { ModalActions } from '../shared/ModalActions';\nimport { TableActions } from '../shared/TableActions';\n\nconst table = new TableActions('.MuiDataGrid-root');\nconst modal = new ModalActions('[role=\"dialog\"]');\n\ntable\n .waitVisible()\n .clickRowActionByText(\n 'Praise Norris',\n '[data-testid=\"removeMemberModalBtn\"]',\n );\n\nmodal.waitVisible().clickByTestId('removeMemberBtn');\n```\n\nGuidelines:\n\n- Prefer `data-testid` selectors first, then role/semantic selectors.\n- Keep helper methods typed and chainable.\n- Keep network mocking in specs or support utilities; page object helpers should\n only perform UI interactions.\n\n### Custom Commands\n\nCommon commands defined in `cypress/support/commands.ts`:\n\n- **`cy.loginByApi(role)`**:\n Logs in programmatically via GraphQL mutation (bypassing UI).\n - Roles: `'admin'`, `'superAdmin'`, `'user'`.\n - Usage: `cy.loginByApi('admin')`.\n\n- **`cy.assertToast(message)`**:\n Waits for a toast notification and asserts its text.\n - Usage: `cy.assertToast('Organization created successfully')`.\n\n- **`cy.clearAllGraphQLMocks()`**:\n Resets all GraphQL request interceptors.\n\nSee [API-driven test data management](#api-driven-test-data-management) for data setup commands like `createTestOrganization`.\n\n### GraphQL Utilities\n\nTo reduce duplication and improve reliability, use the GraphQL helpers defined in\n`cypress/support/graphql-utils.ts`. These helpers intercept GraphQL requests by\n`operationName` and provide a consistent API to mock, alias, and await calls.\n\n> The interceptor respects `CYPRESS_API_URL` via `Cypress.env('apiUrl')`, and\n> falls back to `**/graphql` if not set.\n\n```ts\n// Mock a successful operation using a fixture\ncy.mockGraphQLOperation(\n 'OrganizationListBasic',\n 'api/graphql/organizations.success.json',\n);\n\n// Wait for the mocked operation\ncy.waitForGraphQLOperation('OrganizationListBasic');\n\n// Mock a GraphQL error response\ncy.mockGraphQLError(\n 'CreateOrganization',\n 'Organization name already exists',\n 'CONFLICT',\n);\n\n// Alias a live operation and wait for it\ncy.aliasGraphQLOperation('OrganizationListBasic');\ncy.waitForGraphQLOperation('OrganizationListBasic');\n```\n\n#### Mock cleanup and test isolation\n\nBecause `testIsolation` is set to `true`, Cypress resets browser state between\ntests. Keep GraphQL mock cleanup in `afterEach` so custom intercepts stay scoped\nand predictable across specs and shards:\n\n```ts\nafterEach(() => {\n cy.clearAllGraphQLMocks();\n});\n```\n\nIf multiple tests in the same spec target the same operationName, explicitly\nclean up at the end of each test:\n\n```ts\nit('mocks a successful query', () => {\n cy.mockGraphQLOperation(\n 'OrganizationListBasic',\n 'api/graphql/organizations.success.json',\n );\n // test steps...\n cy.clearAllGraphQLMocks();\n});\n```\n\nBest practices:\n\n- Keep `testIsolation: true` as the default for E2E reliability.\n- In parallel/sharded runs, keep mocks scoped per test and reset intercepts\n after each test.\n- If multiple mocks target the same operation, explicitly clean up between them\n or scope each mock to a single test.\n\n### Test Data\n\nUse fixtures for consistent test data:\n\n```javascript\n// Load test data from fixtures\ncy.fixture('users').then((users) => {\n // Use users data in tests\n});\n```\n\n#### Fixture library structure\n\nFixtures are organized by domain under `cypress/fixtures/` to keep tests\ndeterministic and consistent:\n\n- `auth/` - credential and user fixtures for login flows\n- `admin/` - organizations, events, people, action items, advertisements, tags,\n venues\n- `user/` - posts, volunteers, campaigns, donations\n- `api/graphql/` - GraphQL responses grouped by operationName\n\nDatasets are intentionally minimal, include edge cases (empty arrays, long\nnames, Unicode), and avoid PII.\n\nNote: `auth/users.json` contains user metadata (id, name, email, role).\nUse `auth/credentials.json` for login credentials in Cypress tests.\n\nExample usage with GraphQL utilities:\n\n```ts\ncy.mockGraphQLOperation(\n 'OrganizationListBasic',\n 'api/graphql/organizations.success.json',\n);\n\ncy.mockGraphQLOperation(\n 'CreateOrganization',\n 'api/graphql/createOrganization.success.json',\n);\n\ncy.mockGraphQLOperation(\n 'CreateOrganization',\n 'api/graphql/createOrganization.error.conflict.json',\n);\n```\n\n### API-driven test data management\n\nWhen a spec needs real data against talawa-api (instead of mocks), use the\ncustom Cypress commands backed by Node tasks in `cypress/support/commands.ts`.\nThese helpers keep setup/cleanup consistent and avoid leaking state between\nspecs:\n\n- `cy.setupTestEnvironment(options?)` → creates an organization and returns\n `{ orgId }`.\n- `cy.createTestOrganization(payload)` → creates an organization and returns\n `{ orgId }`.\n- `cy.seedTestData('events' | 'volunteers' | 'posts', payload)` → creates\n events, volunteers, or posts and returns IDs for reuse.\n- `cy.cleanupTestOrganization(orgId, options?)` → deletes the org and (optionally)\n any test users you created.\n\nThe Node tasks handle GraphQL requests directly, so they can be used even when\ntests are running headless in CI. Credentials are resolved from env vars first,\nthen from fixtures:\n\n- `CYPRESS_E2E_ADMIN_EMAIL` / `CYPRESS_E2E_ADMIN_PASSWORD`\n- `CYPRESS_E2E_SUPERADMIN_EMAIL` / `CYPRESS_E2E_SUPERADMIN_PASSWORD`\n- `CYPRESS_E2E_USER_EMAIL` / `CYPRESS_E2E_USER_PASSWORD`\n\nExample usage:\n\n```ts\nlet orgId = '';\nconst userIds: string[] = [];\n\nbefore(() => {\n cy.setupTestEnvironment().then(({ orgId: createdOrgId }) => {\n orgId = createdOrgId;\n });\n});\n\nafter(() => {\n if (orgId) {\n cy.cleanupTestOrganization(orgId, { userIds });\n }\n});\n\nit('seeds event data', () => {\n cy.seedTestData('events', { orgId }).then(({ eventId }) => {\n expect(eventId).to.be.a('string').and.not.equal('');\n });\n});\n\nit('seeds post data', () => {\n cy.seedTestData('posts', { orgId }).then(({ postId }) => {\n expect(postId).to.be.a('string').and.not.equal('');\n });\n});\n\nit('seeds volunteer data', () => {\n cy.seedTestData('events', { orgId }).then(({ eventId }) => {\n cy.seedTestData('volunteers', { eventId }).then(({ userId }) => {\n if (userId) {\n userIds.push(userId);\n }\n });\n });\n});\n```\n\nBest practices:\n\n- Keep data creation inside `before`/`beforeEach`, and cleanup in `after`/`afterEach`.\n- Use unique names to avoid collisions (`E2E Org ${Date.now()}`, etc.).\n- If you seed volunteers without supplying `userId`, a user is created for you.\n Pass those IDs to `cleanupTestOrganization` via `options.userIds` to avoid\n leaking accounts.\n\nExample usage with JSON fixtures:\n\n```ts\ncy.fixture('admin/organizations').then((data) => {\n expect(data.organizations).to.have.length(2);\n});\n```\n\n### Test Coverage Report\n\nAfter running your Cypress tests, you can generate detailed HTML coverage reports to analyze code coverage:\n\n1. **Run Cypress tests** to collect coverage data:\n\n ```bash\n pnpm run cy:run\n ```\n\n2. **Generate HTML coverage report** using nyc:\n\n ```bash\n npx nyc --reporter=html\n ```\n\n3. **View the coverage report** in your browser:\n ```bash\n open coverage/index.html\n ```\n\nThe HTML report provides an interactive view of:\n\n1. Overall coverage percentages (statements, branches, functions, lines)\n1. File-by-file coverage breakdown\n1. Detailed line-by-line coverage highlighting\n1. Uncovered code sections for easy identification\n\n**Note**: Coverage data is collected during test execution and stored in the `.nyc_output` directory. The HTML report is generated in the `coverage/` directory.\n\n## Contributing\n\nWhen adding new tests:\n\n1. Follow the existing directory structure\n2. Use Page Object Model pattern\n3. Add appropriate fixtures for test data\n4. Ensure tests are independent and repeatable\n5. Document any new custom commands\n\nFor more information about Cypress testing, visit the [official Cypress documentation](https://docs.cypress.io/).\n" }, { "path": "docs/docs/docs/developer-resources/empty-state-migration.md", "content": "---\nid: empty-state-migration\ntitle: EmptyState Migration Tracking\nslug: /developer-resources/empty-state-migration\nsidebar_position: 37\n---\n\nThis document tracks the migration of legacy empty-state implementations\n(e.g. `.notFound` CSS-based patterns) to the shared `EmptyState` component.\n\nIt serves as a reference for:\n\n- Completed migrations\n- Known exceptions\n- Discovered edge cases\n- Guidance for future extensions\n\n---\n\n## Screens Migrated to `EmptyState`\n\nThe following screens have been successfully migrated to use the shared\n`EmptyState` component:\n\n### Admin Portal Screens (8 screens)\n\n#### Core Management Screens\n\n- **Users** (`src/screens/AdminPortal/Users/Users.tsx`)\n - Empty user list\n - Icon: Material-UI component (dynamic)\n - Translations: Uses `common` namespace\n - Status: Implemented & Verified\n\n- **Requests** (`src/screens/AdminPortal/Requests/Requests.tsx`)\n - No membership requests\n - Icon: Material-UI component (dynamic)\n - Translations: Uses `common` namespace\n - Status: Implemented & Verified\n\n- **OrgList** (`src/screens/AdminPortal/OrgList/OrgList.tsx`)\n - No organizations available\n - Icon: Material-UI component (dynamic)\n - Translations: Uses `common` namespace\n - Notes: Admin / non-admin aware messaging\n - Status: Implemented & Verified\n\n#### Fund & Campaign Management\n\n- **Organization Fund Campaigns** (`src/screens/AdminPortal/OrganizationFundCampaign/OrganizationFundCampaigns.tsx`)\n - **Multiple EmptyStates (2):**\n - No campaigns found\n - Icon: `Campaign` (Material-UI)\n - Translation: `orgFundCampaign.noCampaignsFound`\n - Test ID: `campaigns-empty`\n - No search results\n - Icon: `Search` (Material-UI)\n - Translation: `noResultsFound` + dynamic query\n - Test ID: `campaigns-search-empty`\n - Status: Implemented & Verified\n\n- **Organization Funds** (`src/screens/AdminPortal/OrganizationFunds/OrganizationFunds.tsx`)\n - **Multiple EmptyStates (2):**\n - No funds found\n - Icon: `AccountBalanceWallet` (Material-UI)\n - Translation: `funds.noFundsFound`\n - Test ID: `funds-empty`\n - No search results\n - Icon: `Search` (Material-UI)\n - Translation: `noResultsFound` + dynamic query\n - Test ID: `funds-search-empty`\n - Status: Implemented & Verified\n\n#### People & Organization Management\n\n- **Organization People** (`src/screens/AdminPortal/OrganizationPeople/OrganizationPeople.tsx`)\n - Organization members list\n - Icon: Material-UI component (dynamic)\n - Status: Implemented & Verified\n\n#### Plugin & Notification Management\n\n- **Plugin Store** (`src/screens/AdminPortal/PluginStore/components/PluginList.tsx`)\n - No plugins available/installed\n - Icon: `ExtensionOutlined` (Material-UI)\n - Translations: `pluginStore` namespace\n - Test ID: `plugins-empty-state`\n - Notes: Dynamic message based on filter (all/installed/not-installed)\n - Status: Implemented & Verified\n\n- **Notifications** (`src/screens/AdminPortal/Notification/Notification.tsx`)\n - All notifications read/caught up\n - Icon: `NotificationsNone` (Material-UI)\n - Translation: `notifications.allCaughtUp`\n - Test ID: `notifications-empty-state`\n - Status: Implemented & Verified\n\n### User Portal Screens\n\n- **Campaigns** (`src/screens/UserPortal/Campaigns/Campaigns.tsx`)\n - No campaigns found\n - Icon: `Campaign`\n - EmptyState provides view-only state (no create action - campaigns are admin-only)\n - Translations: `userCampaigns.noCampaigns`, `userCampaigns.createFirstCampaign`\n - Test ID: `campaigns-empty-state`\n\n- **Upcoming Events** (`src/screens/UserPortal/Volunteer/UpcomingEvents/UpcomingEvents.tsx`)\n - No upcoming events\n - Icon: `Event`\n - Translations: `userVolunteer.noEvents`\n - Test ID: `events-empty-state`\n - All hardcoded text replaced with translations\n\n### Event Volunteer Screens\n\n- **Volunteers** (`src/screens/EventVolunteers/Volunteers/Volunteers.tsx`)\n - No volunteers for event\n - Icon: `VolunteerActivism`\n - Translations: `eventVolunteers.noVolunteers`\n - Test ID: `volunteers-empty-state`\n\n- **Volunteer Groups** (`src/screens/EventVolunteers/VolunteerGroups/VolunteerGroups.tsx`)\n - No volunteer groups for event\n - Icon: `Groups`\n - Translations: `eventVolunteers.noVolunteerGroups`\n - Test ID: `volunteerGroups-empty-state`\n\n---\n\n## Screens Not Migrated (With Reasons)\n\nThe following screens still use legacy patterns and were intentionally\nleft unchanged:\n\n| Screen | Reason |\n| -------------------------------- | --------------------------------------- |\n| | |\n| | |\n\n> Note: Any future exclusions should be documented here with rationale.\n\n---\n\n## Edge Cases Discovered\n\nDuring migration, the following edge cases were identified:\n\n- **Search vs empty data distinction**\n - Search-based empty states require dynamic descriptions\n - Handled via `description` prop with interpolated i18n values\n\n- **Admin vs non-admin messaging**\n - Certain screens (e.g. OrgList) require role-aware messaging\n - Implemented without branching EmptyState logic\n\n- **Grid / table overlays**\n - DataGrid empty overlays must use `EmptyState` via `noRowsOverlay`\n - Avoid duplicating empty UI outside grid context\n\n---\n\n## Guidance for Future EmptyState Extensions\n\nWhen extending or introducing new EmptyState usage:\n\n- Always prefer the shared `EmptyState` component over custom markup\n- Do not reintroduce `.notFound` CSS patterns\n- Extend `EmptyState` via props, not forks or variants\n- Keep icons semantic and consistent with context\n- Ensure i18n keys exist for all user-visible text\n- Add tests for:\n - Base empty state\n - Search empty state (if applicable)\n\nFor new empty state patterns, update:\n\n- `reusable-components.md`\n- This migration tracking document (if relevant)\n\n---\n\n## Related References\n\n- **Parent Issue:** Phase 1: Create EmptyState Migration (#5087)\n- **Component Docs:** Reusable Components → EmptyState\n" }, { "path": "docs/docs/docs/developer-resources/installation.md", "content": "---\nid: installation\ntitle: Installation\nslug: /developer-resources/installation\nsidebar_position: 5\n---\n\n## OS Detection Library for Install Scripts\n\nThe Talawa Admin repository includes a robust OS detection library (`scripts/install/lib/os-detect.sh`) that provides reliable cross-platform OS identification for bash installation scripts. This library is used internally by the automated installer and can be leveraged by developers creating custom installation or setup scripts.\n\n### Overview\n\nThe OS detection library provides:\n\n- Cross-platform OS detection for macOS, Debian/Ubuntu, RHEL/Fedora, and WSL variants\n- Cached results for performance (subsequent calls are instant)\n- Safe handling of missing system files\n- Alignment with the TypeScript OS detector (`src/install/os/detector.ts`)\n\n### Usage\n\nTo use the OS detection library in your bash scripts:\n\n```bash\n# Source the library\nsource ./scripts/install/lib/os-detect.sh\n\n# Detect the operating system\ndetect_os\n\n# Access the results\necho \"$OS_TYPE\" # e.g., \"macos\", \"debian\", \"wsl-debian\"\necho \"$OS_DISPLAY_NAME\" # e.g., \"macOS\", \"WSL (Debian/Ubuntu)\"\necho \"$IS_WSL\" # \"true\" or \"false\"\n```\n\n### Exported Variables\n\nAfter calling `detect_os`, the following variables are available:\n\n| Variable | Type | Description | Example Values |\n| ----------------- | ------- | ---------------------- | --------------------------------------------------------------------------------- |\n| `OS_TYPE` | String | OS type identifier | `macos`, `debian`, `redhat`, `wsl-debian`, `wsl-redhat`, `wsl-unknown`, `unknown` |\n| `OS_DISPLAY_NAME` | String | Human-readable OS name | `macOS`, `Debian/Ubuntu`, `WSL (Debian/Ubuntu)` |\n| `IS_WSL` | Boolean | Whether running in WSL | `true`, `false` |\n\n### Exported Functions\n\n| Function | Description | Returns |\n| --------------------- | ----------------------------------------------------------------------------- | -------------------------- |\n| `detect_os` | Detects OS and sets exported variables. Idempotent (cached after first call). | Always returns `0` |\n| `get_os_display_name` | Calls `detect_os` and returns the human-readable OS name | OS display name via stdout |\n\n### Supported Operating Systems\n\nThe library detects the following operating system types:\n\n- **macOS** (`OS_TYPE=\"macos\"`) - Native macOS systems\n- **Debian/Ubuntu** (`OS_TYPE=\"debian\"`) - Native Debian-based Linux systems\n- **RHEL/Fedora** (`OS_TYPE=\"redhat\"`) - Native RHEL-based Linux systems\n- **WSL Debian** (`OS_TYPE=\"wsl-debian\"`) - Windows Subsystem for Linux running Debian/Ubuntu\n- **WSL RHEL** (`OS_TYPE=\"wsl-redhat\"`) - Windows Subsystem for Linux running RHEL/Fedora\n- **WSL Unknown** (`OS_TYPE=\"wsl-unknown\"`) - Windows Subsystem for Linux with unrecognized distro\n- **Unknown** (`OS_TYPE=\"unknown\"`) - Fallback for unsupported systems\n\n### Example Script\n\n```bash\n#!/bin/bash\nset -euo pipefail\n\n# Source the OS detection library\nsource \"$(dirname \"$0\")/scripts/install/lib/os-detect.sh\"\n\n# Detect the operating system\ndetect_os\n\n# Use OS information to customize installation\ncase \"$OS_TYPE\" in\n macos)\n echo \"Installing for macOS...\"\n brew install package-name\n ;;\n debian)\n echo \"Installing for Debian/Ubuntu...\"\n sudo apt-get install -y package-name\n ;;\n redhat)\n echo \"Installing for RHEL/Fedora...\"\n sudo dnf install -y package-name\n ;;\n wsl-*)\n echo \"Detected WSL environment: $OS_DISPLAY_NAME\"\n # Special handling for WSL\n ;;\n *)\n echo \"Unsupported OS: $OS_DISPLAY_NAME\"\n exit 1\n ;;\nesac\n```\n\n### Important Notes\n\n- **Multiple Sourcing**: The library is safe to source multiple times - it will only execute once per shell session\n- **Caching**: The `detect_os` function caches results after the first call for performance\n- **Bash Compatibility**: Compatible with Bash 3.2+ (macOS default) and later versions\n- **No System Modifications**: The library only reads system files and never modifies them\n\n### Testing\n\nThe library includes a comprehensive test suite at `scripts/install/lib/os-detect.spec.sh`:\n\n```bash\n# Run all tests\nbash scripts/install/lib/os-detect.spec.sh\n\n# Or make it executable and run\nchmod +x scripts/install/lib/os-detect.spec.sh\n./scripts/install/lib/os-detect.spec.sh\n```\n\nThe test suite covers:\n\n- Detection for all supported OS types\n- WSL detection (via environment variable and `/proc/version`)\n- Caching and idempotency behavior\n- Variable exports and function behavior\n- Edge cases and unknown OS handling\n" }, { "path": "docs/docs/docs/developer-resources/introduction.md", "content": "---\nid: introduction\ntitle: Introduction\nslug: /developer-resources/introduction\nsidebar_position: 10\n---\n\nWelcome to Talawa-Admin\n\nThis section outlines the coding standards and best practices to follow when refactoring or writing TypeScript code for Talawa projects. Following these guidelines ensures readability, maintainability, and scalability across the codebase. Refer to `CODE_STYLE.md` for coding conventions to follow when contributing.\n\n## Before You Begin\n\nIt's important to consider these factors before you start.\n\n### Understand the Code Before Changing\n\n 1. Thoroughly understand the existing code's purpose and functionality before attempting to refactor it.\n\n 2. Identify areas for improvement and define clear refactoring goals. \n\n### Refactor in Small, Incremental Steps\n\n 1. Avoid large, sweeping changes. Break down refactoring into small, manageable tasks and PRs.\n\n 2. Commit changes often: to track progress and easily revert if issues arise. \n\n### Prioritize Testing\n \n 1. Write comprehensive unit tests before refactoring to ensure the code's behavior remains consistent after changes.\n\n 2. Run tests frequently during and after refactoring to catch regressions early. \n\n### Separate Refactoring from Feature Development\n\nAvoid mixing refactoring with new feature development in the same commit or branch to maintain clarity and ease debugging.\n\n## Best Practices\n\nFollow these guidelines for writing reusable TypeScript code.\n\n### Embrace Modularity\n\nModular design is a cornerstone of maintainable software architecture. By breaking down your codebase into smaller, well-defined parts, you make it easier to understand, test, and scale.\n\nTo explore how modularity translates into building consistent and maintainable front-end elements, refer to the [Reusable Components guide](./reusable-components.md)\n\n### Focus on Readability and Maintainability\n\n1. **Maintain Consistent Naming Conventions and Code Style:** Adhere to established naming conventions for variables, functions, and types, and use consistent code formatting. This enhances readability and makes it easier to navigate and understand the codebase.\n\n2. **Break down complex functions:** Use smaller, more focused units.\n\n3. **Eliminate code duplication:** Extract common logic into reusable functions or components.\n\n4. **Use appropriate data types:** Leverage TypeScript's type system for enhanced type safety and clarity. \n\n### Document Your Code:\n\nUse TSDoc comments to document functions, classes, and interfaces, explaining their purpose, parameters, and return values. This improves code readability and makes it easier for others (and your future self) to understand and use your reusable components.\n\n### Leverage TypeScript's Features\n\nThere are many useful practices that you should consider when writing TypeScript code for our repositories. These include the following:\n\n1. **Utilize Generics:** By using generics, you create a scalable and maintainable foundation for your application, allowing for easy expansion and modification as your business needs evolve. Employ generics to create functions, classes, and interfaces that can work with various data types without sacrificing type safety. This allows you to write a single piece of logic that adapts to different inputs. \n 1. Here is an itemized list of advantages:\n 1. Code Reusability: The same interface can be implemented for different types, reducing duplication.\n 2. Type Safety: TypeScript ensures that the correct types are used in each implementation.\n 3. Flexibility: You can easily create new repositories for new entities without writing redundant code.\n 4. Consistency: All repositories follow the same structure, making the codebase more predictable and easier to maintain.\n\n 2. Generics allow you to write a single piece of logic that adapts to different inputs.\n \n ```typescript\n function identity(value: T): T {\n return value;\n }\n ```\n\n 1. For instance, a generic Repository interface can handle different entities like products, orders, or customers.\n\n ```typescript\n interface Repository {\n getById(id: string): Promise;\n getAll(): Promise;\n create(item: T): Promise;\n update(id: string, item: Partial): Promise;\n delete(id: string): Promise;\n }\n\n class ProductRepository implements Repository {\n // Implementation here\n }\n\n class OrderRepository implements Repository {\n // Implementation here\n }\n ```\n\n1. **Define Clear Interfaces and Types:** Use interfaces to define the shape of objects and types for complex data structures. This provides clear contracts for how data should be structured, promoting consistency and easier integration. \n\n```typescript\n interface User {\n id: string;\n name: string;\n email: string;\n }\n```\n\n3. **Use Utility Types:** Take advantage of TypeScript's built-in utility types like Partial, Readonly, Pick, and Omit to create new types based on existing ones, simplifying complex type manipulations and promoting code reuse in type definitions. \n\n```typescript\n // Makes all properties of User optional\n type OptionalUser = Partial; \n```\n\n4. **Implement Type Guards:** Use type guards to perform runtime type checking, ensuring your code handles different types correctly and safely within conditional blocks.\n\n```typescript\n function isNumber(value: unknown): value is number {\n return typeof value === 'number';\n }\n```\n\n5. **Consider using enums:** When sets of related constants are used\n\n6. **Use access modifiers:** Consider (public, private, protected) modifier for better encapsulation in classes. \n\n7. **Avoid `any`** Minimize the use of the `any` type as it defeats the purpose of TypeScript's type safety. Strive to provide explicit types or leverage type inference where possible.\n" }, { "path": "docs/docs/docs/developer-resources/linting.md", "content": "---\nid: linting-guidelines\ntitle: Linting Guidelines\nslug: /developer-resources/linting\nsidebar_position: 25\n---\n\n## Introduction\n\nThis repository uses a comprehensive ESLint configuration with custom rules to maintain code quality, enforce best practices, and catch potential issues early in development. Our modular ESLint setup includes both standard rules and custom rules tailored to our project's specific needs.\n\nThe ESLint configuration is located in `eslint.config.js` and uses modular configs from `scripts/eslint/config/`.\n\n## Custom ESLint Rules\n\n### prefer-crud-modal-template\n\nThis rule encourages the use of `CRUDModalTemplate` over `BaseModal` when building modals that contain CRUD (Create, Read, Update, Delete) functionality.\n\n**Rule Location:** `scripts/eslint/rules/prefer-crud-modal-template.ts`\n\n#### When This Rule Triggers\n\nThe rule flags `BaseModal` usage in these scenarios:\n\n1. **CRUD Handler Props:** When the modal has props that indicate CRUD operations:\n - `onSubmit`\n - `onConfirm` \n - `onPrimary`\n - `onSave`\n\n2. **Form Elements:** When the modal contains `
` or `` elements in its children.\n\n#### Examples\n\n**Incorrect - Using BaseModal with CRUD props:**\n```tsx\nimport { BaseModal } from 'shared-components/BaseModal';\n\nfunction UserEditModal() {\n return (\n \n \n \n \n \n
\n );\n}\n```\n\n**Incorrect - Using BaseModal with form elements:**\n```tsx\nimport { BaseModal } from 'shared-components/BaseModal';\n\nfunction CreatePostModal() {\n return (\n \n
{/* Form element detected */}\n \n